Add inling for native Code trait

[gitmo/Moose.git] / lib / Moose / Meta / Attribute / Native / Trait / Bool.pm

package Moose::Meta::Attribute::Native::Trait::Bool;
use Moose::Role;

our $VERSION = '1.14';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';

use Moose::Meta::Method::Accessor::Native::Bool::not;
use Moose::Meta::Method::Accessor::Native::Bool::set;
use Moose::Meta::Method::Accessor::Native::Bool::toggle;
use Moose::Meta::Method::Accessor::Native::Bool::unset;

with 'Moose::Meta::Attribute::Native::Trait';

sub _default_is  { 'rw' }
sub _helper_type { 'Bool' }

sub _native_type { 'Bool' }

no Moose::Role;

1;

=pod

=head1 NAME

Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes

=head1 SYNOPSIS

  package Room;
  use Moose;

  has 'is_lit' => (
      traits    => ['Bool'],
      is        => 'rw',
      isa       => 'Bool',
      default   => 0,
      handles   => {
          illuminate  => 'set',
          darken      => 'unset',
          flip_switch => 'toggle',
          is_dark     => 'not',
      },
  );

  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

=head1 DESCRIPTION

This provides a simple boolean attribute, which supports most of the
basic math operations.

=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.

=over 4

=item B<set>

Sets the value to C<1>.

=item B<unset>

Set the value to C<0>.

=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>

=item B<has_method_provider>

=item B<method_provider>

=back

=head1 BUGS

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