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