lib/MooseX/AttributeHelpers.pm

   1
   2 package MooseX::AttributeHelpers;
   3
   4 our $VERSION   = '0.09';
   5 our $AUTHORITY = 'cpan:STEVAN';
   6
   7 use MooseX::AttributeHelpers::Meta::Method::Provided;
   8
   9 use MooseX::AttributeHelpers::Counter;
  10 use MooseX::AttributeHelpers::Number;
  11 use MooseX::AttributeHelpers::String;
  12 use MooseX::AttributeHelpers::Bool;
  13 use MooseX::AttributeHelpers::Collection::List;
  14 use MooseX::AttributeHelpers::Collection::Array;
  15 use MooseX::AttributeHelpers::Collection::Hash;
  16 use MooseX::AttributeHelpers::Collection::ImmutableHash;
  17 use MooseX::AttributeHelpers::Collection::Bag;
  18
  19 1;
  20
  21 __END__
  22
  23 =pod
  24
  25 =head1 NAME
  26
  27 MooseX::AttributeHelpers - Extend your attribute interfaces
  28
  29 =head1 SYNOPSIS
  30
  31   package MyClass;
  32   use Moose;
  33   use MooseX::AttributeHelpers;
  34
  35   has 'mapping' => (
  36       metaclass => 'Collection::Hash',
  37       is        => 'rw',
  38       isa       => 'HashRef[Str]',
  39       default   => sub { {} },
  40       provides  => {
  41           exists    => 'exists_in_mapping',
  42           keys      => 'ids_in_mapping',
  43           get       => 'get_mapping',
  44           set       => 'set_mapping',
  45       },
  46   );
  47
  48   # ...
  49
  50   my $obj = MyClass->new;
  51   $obj->set_mapping(4, 'foo');
  52   $obj->set_mapping(5, 'bar');
  53   $obj->set_mapping(6, 'baz');
  54
  55   # prints 'bar'
  56   print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
  57
  58   # prints '4, 5, 6'
  59   print join ', ', $obj->ids_in_mapping;
  60
  61 =head1 DESCRIPTION
  62
  63 While L<Moose> attributes provide you with a way to name your accessors,
  64 readers, writers, clearers and predicates, this library provides commonly
  65 used attribute helper methods for more specific types of data.
  66
  67 As seen in the L</SYNOPSIS>, you specify the extension via the
  68 C<metaclass> parameter. Available meta classes are:
  69
  70 =over
  71
  72 =item L<Number|MooseX::AttributeHelpers::Number>
  73
  74 Common numerical operations.
  75
  76 =item L<Counter|MooseX::AttributeHelpers::Counter>
  77
  78 Methods for incrementing and decrementing a counter attribute.
  79
  80 =item L<Counter|MooseX::AttributeHelpers::Bool>
  81
  82 Common methods for boolean values.
  83
  84 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
  85
  86 Common methods for hash references.
  87
  88 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
  89
  90 Common methods for array references.
  91
  92 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
  93
  94 Common list methods for array references.
  95
  96 =back
  97
  98 =head1 CAVEAT
  99
 100 This is an early release of this module. Right now it is in great need
 101 of documentation and tests in the test suite. However, we have used this
 102 module to great success at C<$work> where it has been tested very thoroughly
 103 and deployed into a major production site.
 104
 105 I plan on getting better docs and tests in the next few releases, but until
 106 then please refer to the few tests we do have and feel free email and/or
 107 message me on irc.perl.org if you have any questions.
 108
 109 =head1 TODO
 110
 111 We need tests and docs badly.
 112
 113 =head1 BUGS
 114
 115 All complex software has bugs lurking in it, and this module is no
 116 exception. If you find a bug please either email me, or add the bug
 117 to cpan-RT.
 118
 119 =head1 AUTHOR
 120
 121 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 122
 123 B<with contributions from:>
 124
 125 Robert (rlb3) Boone
 126
 127 Paul (frodwith) Driver
 128
 129 Shawn (Sartak) Moore
 130
 131 Chris (perigrin) Prather
 132
 133 Robert (phaylon) Sedlacek
 134
 135 Tom (dec) Lanyon
 136
 137 Yuval Kogman
 138
 139 Jason May
 140
 141 =head1 COPYRIGHT AND LICENSE
 142
 143 Copyright 2007, 2008 by Infinity Interactive, Inc.
 144
 145 L<http://www.iinteractive.com>
 146
 147 This library is free software; you can redistribute it and/or modify
 148 it under the same terms as Perl itself.
 149
 150 =cut