lib/Moose/Meta/Attribute/Native/Trait/Bool.pm

   1 package Moose::Meta::Attribute::Native::Trait::Bool;
   2 use Moose::Role;
   3
   4 with 'Moose::Meta::Attribute::Native::Trait';
   5
   6 sub _default_is  { 'rw' }
   7 sub _helper_type { 'Bool' }
   8
   9 no Moose::Role;
  10
  11 1;
  12
  13 # ABSTRACT: Helper trait for Bool attributes
  14
  15 __END__
  16
  17 =pod
  18
  19 =head1 SYNOPSIS
  20
  21   package Room;
  22   use Moose;
  23
  24   has 'is_lit' => (
  25       traits  => ['Bool'],
  26       is      => 'rw',
  27       isa     => 'Bool',
  28       default => 0,
  29       handles => {
  30           illuminate  => 'set',
  31           darken      => 'unset',
  32           flip_switch => 'toggle',
  33           is_dark     => 'not',
  34       },
  35   );
  36
  37   my $room = Room->new();
  38   $room->illuminate;        # same as $room->is_lit(1);
  39   $room->darken;            # same as $room->is_lit(0);
  40   $room->flip_switch;       # same as $room->is_lit(not $room->is_lit);
  41   return $room->is_dark;    # same as !$room->is_lit
  42
  43 =head1 DESCRIPTION
  44
  45 This trait provides native delegation methods for boolean values. A boolean is
  46 a scalar which can be C<1>, C<0>, C<"">, or C<undef>.
  47
  48 =head1 DEFAULT TYPE
  49
  50 If you don't provide an C<isa> value for your attribute, it will default to
  51 C<Bool>.
  52
  53 =head1 PROVIDED METHODS
  54
  55 None of these methods accept arguments.
  56
  57 =over 4
  58
  59 =item * B<set>
  60
  61 Sets the value to C<1> and returns C<1>.
  62
  63 =item * B<unset>
  64
  65 Set the value to C<0> and returns C<0>.
  66
  67 =item * B<toggle>
  68
  69 Toggles the value. If it's true, set to false, and vice versa.
  70
  71 Returns the new value.
  72
  73 =item * B<not>
  74
  75 Equivalent of 'not C<$value>'.
  76
  77 =back
  78
  79 =head1 BUGS
  80
  81 See L<Moose/BUGS> for details on reporting bugs.
  82
  83 =cut