Commit | Line | Data |
e9d1a9c4 |
1 | package MooseX::AttributeHelpers::Trait::Number; |
2 | use Moose::Role; |
3 | |
2e74144c |
4 | our $VERSION = '0.23'; |
cf0d1310 |
5 | $VERSION = eval $VERSION; |
e9d1a9c4 |
6 | our $AUTHORITY = 'cpan:STEVAN'; |
7 | |
8 | with 'MooseX::AttributeHelpers::Trait::Base'; |
9 | |
10 | sub helper_type { 'Num' } |
11 | |
12 | # NOTE: |
13 | # we don't use the method provider for this |
14 | # module since many of the names of the provied |
15 | # methods would conflict with keywords |
16 | # - SL |
17 | |
18 | has 'method_constructors' => ( |
19 | is => 'ro', |
20 | isa => 'HashRef', |
21 | lazy => 1, |
22 | default => sub { |
23 | return +{ |
24 | set => sub { |
25 | my ($attr, $reader, $writer) = @_; |
26 | return sub { $writer->($_[0], $_[1]) }; |
27 | }, |
28 | add => sub { |
29 | my ($attr, $reader, $writer) = @_; |
30 | return sub { $writer->($_[0], $reader->($_[0]) + $_[1]) }; |
31 | }, |
32 | sub => sub { |
33 | my ($attr, $reader, $writer) = @_; |
34 | return sub { $writer->($_[0], $reader->($_[0]) - $_[1]) }; |
35 | }, |
36 | mul => sub { |
37 | my ($attr, $reader, $writer) = @_; |
38 | return sub { $writer->($_[0], $reader->($_[0]) * $_[1]) }; |
39 | }, |
40 | div => sub { |
41 | my ($attr, $reader, $writer) = @_; |
42 | return sub { $writer->($_[0], $reader->($_[0]) / $_[1]) }; |
43 | }, |
44 | mod => sub { |
45 | my ($attr, $reader, $writer) = @_; |
46 | return sub { $writer->($_[0], $reader->($_[0]) % $_[1]) }; |
47 | }, |
48 | abs => sub { |
49 | my ($attr, $reader, $writer) = @_; |
50 | return sub { $writer->($_[0], abs($reader->($_[0])) ) }; |
51 | }, |
52 | } |
53 | } |
54 | ); |
55 | |
56 | no Moose::Role; |
57 | |
e9d1a9c4 |
58 | 1; |
59 | |
60 | =pod |
61 | |
62 | =head1 NAME |
63 | |
64 | MooseX::AttributeHelpers::Number |
65 | |
66 | =head1 SYNOPSIS |
67 | |
68 | package Real; |
69 | use Moose; |
70 | use MooseX::AttributeHelpers; |
71 | |
72 | has 'integer' => ( |
73 | metaclass => 'Number', |
74 | is => 'ro', |
75 | isa => 'Int', |
76 | default => sub { 5 }, |
77 | provides => { |
78 | set => 'set', |
79 | add => 'add', |
80 | sub => 'sub', |
81 | mul => 'mul', |
82 | div => 'div', |
83 | mod => 'mod', |
84 | abs => 'abs', |
85 | } |
86 | ); |
87 | |
88 | my $real = Real->new(); |
89 | $real->add(5); # same as $real->integer($real->integer + 5); |
90 | $real->sub(2); # same as $real->integer($real->integer - 2); |
91 | |
92 | =head1 DESCRIPTION |
93 | |
94 | This provides a simple numeric attribute, which supports most of the |
95 | basic math operations. |
96 | |
97 | =head1 METHODS |
98 | |
99 | =over 4 |
100 | |
101 | =item B<meta> |
102 | |
103 | =item B<helper_type> |
104 | |
105 | =item B<method_constructors> |
106 | |
107 | =back |
108 | |
109 | =head1 PROVIDED METHODS |
110 | |
111 | It is important to note that all those methods do in place |
112 | modification of the value stored in the attribute. |
113 | |
114 | =over 4 |
115 | |
116 | =item I<set ($value)> |
117 | |
118 | Alternate way to set the value. |
119 | |
120 | =item I<add ($value)> |
121 | |
122 | Adds the current value of the attribute to C<$value>. |
123 | |
124 | =item I<sub ($value)> |
125 | |
126 | Subtracts the current value of the attribute to C<$value>. |
127 | |
128 | =item I<mul ($value)> |
129 | |
130 | Multiplies the current value of the attribute to C<$value>. |
131 | |
132 | =item I<div ($value)> |
133 | |
134 | Divides the current value of the attribute to C<$value>. |
135 | |
136 | =item I<mod ($value)> |
137 | |
138 | Modulus the current value of the attribute to C<$value>. |
139 | |
140 | =item I<abs> |
141 | |
142 | Sets the current value of the attribute to its absolute value. |
143 | |
144 | =back |
145 | |
146 | =head1 BUGS |
147 | |
148 | All complex software has bugs lurking in it, and this module is no |
149 | exception. If you find a bug please either email me, or add the bug |
150 | to cpan-RT. |
151 | |
152 | =head1 AUTHOR |
153 | |
154 | Robert Boone |
155 | |
156 | =head1 COPYRIGHT AND LICENSE |
157 | |
9c5d164e |
158 | Copyright 2007-2009 by Infinity Interactive, Inc. |
e9d1a9c4 |
159 | |
160 | L<http://www.iinteractive.com> |
161 | |
162 | This library is free software; you can redistribute it and/or modify |
163 | it under the same terms as Perl itself. |
164 | |
165 | =cut |