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