package Moose::Meta::Attribute::Native::Trait::Bool;
use Moose::Role;
-use Moose::Meta::Attribute::Native::MethodProvider::Bool;
-
-our $VERSION = '0.93_02';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
with 'Moose::Meta::Attribute::Native::Trait';
sub _default_is { 'rw' }
sub _helper_type { 'Bool' }
-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
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',
);
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>
+Returns the new value.
-Equivalent of 'not C<$value>'.
-
-=back
+=item * B<not>
-=head1 METHODS
-
-=over 4
-
-=item B<meta>
-
-=item B<has_method_provider>
-
-=item B<method_provider>
+Equivalent of 'not C<$value>'.
=back
See L<Moose/BUGS> for details on reporting bugs.
-=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.
-
=cut