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

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