lib/MooseX/AttributeHelpers.pm

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