Bump to 0.12

[gitmo/MooseX-AttributeHelpers.git] / lib / MooseX / AttributeHelpers / Number.pm

diff --git a/lib/MooseX/AttributeHelpers/Number.pm b/lib/MooseX/AttributeHelpers/Number.pm
index eb03977..47f4ecc 100644 (file)
--- a/lib/MooseX/AttributeHelpers/Number.pm
+++ b/lib/MooseX/AttributeHelpers/Number.pm
@@ -1,54 +1,59 @@
 package MooseX::AttributeHelpers::Number;
 use Moose;
-use Moose::Util::TypeConstraints;
 
-our $VERSION   = '0.01';
+our $VERSION   = '0.12';
 our $AUTHORITY = 'cpan:STEVAN';
 
 extends 'MooseX::AttributeHelpers::Base';
 
 sub helper_type { 'Num' }
 
+# NOTE:
+# we don't use the method provider for this 
+# module since many of the names of the provied
+# methods would conflict with keywords
+# - SL
+
 has '+method_constructors' => (
     default => sub {
         return +{
             set => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], $_[1]) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $_[1]) };
             },
             add => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], $attr->get_value($_[0]) + $_[1]) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $reader->($_[0]) + $_[1]) };
             },
             sub => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], $attr->get_value($_[0]) - $_[1]) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $reader->($_[0]) - $_[1]) };
             },
             mul => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], $attr->get_value($_[0]) * $_[1]) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $reader->($_[0]) * $_[1]) };
             },
             div => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], $attr->get_value($_[0]) / $_[1]) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $reader->($_[0]) / $_[1]) };
             },
             mod => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], abs($attr->get_value($_[0]) % $_[1])) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], $reader->($_[0]) % $_[1]) };
             },
             abs => sub {
-                my $attr = shift;
-                return sub { $attr->set_value($_[0], abs($attr->get_value($_[0])) ) };
+                my ($attr, $reader, $writer) = @_;
+                return sub { $writer->($_[0], abs($reader->($_[0])) ) };
             },
         }
     }
 );
     
 no Moose;
-no Moose::Util::TypeConstraints;
 
 # register the alias ...
-package Moose::Meta::Attribute::Custom::Number;
+package # hide me from search.cpan.org
+    Moose::Meta::Attribute::Custom::Number;
 sub register_implementation { 'MooseX::AttributeHelpers::Number' }
 
 1;
@@ -62,23 +67,24 @@ MooseX::AttributeHelpers::Number
 =head1 SYNOPSIS
   
   package Real;
-   use Moose;
-
-   has 'integer' => (
-       metaclass => 'Number',
-       is        => 'ro',
-       isa       => 'Int',
-       default   => sub { 5 },
-       provides  => {
-           set => 'set',
-           add => 'add',
-           sub => 'sub',
-           mul => 'mul',
-           div => 'div',
-           mod => 'mod',
-           abs => 'abs',
-       }
-   );
+  use Moose;
+  use MooseX::AttributeHelpers;
+  
+  has 'integer' => (
+      metaclass => 'Number',
+      is        => 'ro',
+      isa       => 'Int',
+      default   => sub { 5 },
+      provides  => {
+          set => 'set',
+          add => 'add',
+          sub => 'sub',
+          mul => 'mul',
+          div => 'div',
+          mod => 'mod',
+          abs => 'abs',
+      }
+  );
 
   my $real = Real->new();
   $real->add(5); # same as $real->integer($real->integer + 5);
@@ -86,8 +92,58 @@ MooseX::AttributeHelpers::Number
   
 =head1 DESCRIPTION
 
+This provides a simple numeric attribute, which supports most of the
+basic math operations.
+
 =head1 METHODS
 
+=over 4
+
+=item B<meta>
+
+=item B<helper_type>
+
+=item B<method_constructors>
+
+=back
+
+=head1 PROVIDED METHODS
+
+It is important to note that all those methods do in place
+modification of the value stored in the attribute.
+
+=over 4
+
+=item I<set ($value)>
+
+Alternate way to set the value.
+
+=item I<add ($value)>
+
+Adds the current value of the attribute to C<$value>.
+
+=item I<sub ($value)>
+
+Subtracts the current value of the attribute to C<$value>.
+
+=item I<mul ($value)>
+
+Multiplies the current value of the attribute to C<$value>.
+
+=item I<div ($value)>
+
+Divides the current value of the attribute to C<$value>.
+
+=item I<mod ($value)>
+
+Modulus the current value of the attribute to C<$value>.
+
+=item I<abs>
+
+Sets the current value of the attribute to its absolute value.
+
+=back
+
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no 
@@ -96,15 +152,15 @@ to cpan-RT.
 
 =head1 AUTHOR
 
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
+Robert Boone
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007 by Infinity Interactive, Inc.
+Copyright 2007-2008 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.
 
-=cut
\ No newline at end of file
+=cut