fix up some abstracts
[gitmo/Moose.git] / lib / Moose / Meta / Attribute / Native / Trait / Bool.pm
index e2f670a..1b60fc8 100644 (file)
@@ -1,35 +1,20 @@
 package Moose::Meta::Attribute::Native::Trait::Bool;
 use Moose::Role;
-use Moose::Meta::Attribute::Native::MethodProvider::Bool;
-
-our $VERSION = '0.89_02';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
 
 with 'Moose::Meta::Attribute::Native::Trait';
 
 sub _default_is  { 'rw' }
 sub _helper_type { 'Bool' }
 
-# NOTE: we don't use the method provider for this module since many of
-# the names of the provided methods would conflict with keywords - SL
-
-has 'method_provider' => (
-    is        => 'ro',
-    isa       => 'ClassName',
-    predicate => 'has_method_provider',
-    default   => 'Moose::Meta::Attribute::Native::MethodProvider::Bool'
-);
-
 no Moose::Role;
 
 1;
 
-=pod
+# ABSTRACT: Helper trait for Bool attributes
 
-=head1 NAME
+__END__
 
-Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes
+=pod
 
 =head1 SYNOPSIS
 
@@ -37,11 +22,11 @@ Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes
   use Moose;
 
   has 'is_lit' => (
-      traits    => ['Bool'],
-      is        => 'rw',
-      isa       => 'Bool',
-      default   => 0,
-      handles   => {
+      traits  => ['Bool'],
+      is      => 'rw',
+      isa     => 'Bool',
+      default => 0,
+      handles => {
           illuminate  => 'set',
           darken      => 'unset',
           flip_switch => 'toggle',
@@ -50,72 +35,49 @@ Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes
   );
 
   my $room = Room->new();
-  $room->illuminate;     # same as $room->is_lit(1);
-  $room->darken;         # same as $room->is_lit(0);
-  $room->flip_switch;    # same as $room->is_lit(not $room->is_lit);
-  return $room->is_dark; # same as !$room->is_lit
+  $room->illuminate;        # same as $room->is_lit(1);
+  $room->darken;            # same as $room->is_lit(0);
+  $room->flip_switch;       # same as $room->is_lit(not $room->is_lit);
+  return $room->is_dark;    # same as !$room->is_lit
 
 =head1 DESCRIPTION
 
-This provides a simple boolean attribute, which supports most of the
-basic math operations.
+This trait provides native delegation methods for boolean values. A boolean is
+a scalar which can be C<1>, C<0>, C<"">, or C<undef>.
+
+=head1 DEFAULT TYPE
+
+If you don't provide an C<isa> value for your attribute, it will default to
+C<Bool>.
 
 =head1 PROVIDED METHODS
 
-These methods are implemented in
-L<Moose::Meta::Attribute::Native::MethodProvider::Bool>. It is important to
-note that all those methods do in place modification of the value stored in
-the attribute.
+None of these methods accept arguments.
 
 =over 4
 
-=item B<set>
+=item * B<set>
 
-Sets the value to C<1>.
+Sets the value to C<1> and returns C<1>.
 
-=item B<unset>
+=item * B<unset>
 
-Set the value to C<0>.
+Set the value to C<0> and returns C<0>.
 
-=item B<toggle>
+=item * B<toggle>
 
 Toggles the value. If it's true, set to false, and vice versa.
 
-=item B<not>
-
-Equivalent of 'not C<$value>'.
-
-=back
-
-=head1 METHODS
-
-=over 4
-
-=item B<meta>
+Returns the new value.
 
-=item B<has_method_provider>
+=item * B<not>
 
-=item B<method_provider>
+Equivalent of 'not C<$value>'.
 
 =back
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
-
-=head1 AUTHOR
-
-Jason May
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2007-2009 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.
+See L<Moose/BUGS> for details on reporting bugs.
 
 =cut