lib/MooseX/AttributeHelpers/Base.pm

   1
   2 package MooseX::AttributeHelpers::Base;
   3 use Moose;
   4 use Moose::Util::TypeConstraints;
   5
   6 our $VERSION   = '0.02';
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   9 extends 'Moose::Meta::Attribute';
  10
  11 # this is the method map you define ...
  12 has 'provides' => (
  13     is      => 'ro',
  14     isa     => 'HashRef',
  15     default => sub {{}}
  16 );
  17
  18
  19 # these next two are the possible methods
  20 # you can use in the 'provides' map.
  21
  22 # provide a Class or Role which we can
  23 # collect the method providers from
  24 has 'method_provider' => (
  25     is        => 'ro',
  26     isa       => 'ClassName',
  27     predicate => 'has_method_provider',
  28 );
  29
  30 # or you can provide a HASH ref of anon subs
  31 # yourself. This will also collect and store
  32 # the methods from a method_provider as well
  33 has 'method_constructors' => (
  34     is      => 'ro',
  35     isa     => 'HashRef',
  36     lazy    => 1,
  37     default => sub {
  38         my $self = shift;
  39         return +{} unless $self->has_method_provider;
  40         # or grab them from the role/class
  41         my $method_provider = $self->method_provider->meta;
  42         return +{
  43             map {
  44                 $_ => $method_provider->get_method($_)
  45             } $method_provider->get_method_list
  46         };
  47     },
  48 );
  49
  50 # extend the parents stuff to make sure
  51 # certain bits are now required ...
  52 has '+$!default'       => (required => 1);
  53 has '+type_constraint' => (required => 1);
  54
  55 ## Methods called prior to instantiation
  56
  57 sub helper_type { () }
  58
  59 sub process_options_for_provides {
  60     my ($self, $options) = @_;
  61
  62     if (my $type = $self->helper_type) {
  63         (exists $options->{isa})
  64             || confess "You must define a type with the $type metaclass";
  65
  66         my $isa = $options->{isa};
  67
  68         unless (blessed($isa) && $isa->isa('Moose::Meta::TypeConstraint')) {
  69             $isa = find_type_constraint($isa);
  70         }
  71
  72         ($isa->is_a_type_of($type))
  73             || confess "The type constraint for a $type ($options->{isa}) must be a subtype of $type";
  74     }
  75 }
  76
  77 before '_process_options' => sub {
  78     my ($self, $name, $options) = @_;
  79     if (exists $options->{provides} ||
  80         exists $options->{isa}      && $options->{isa} =~ /^.*?\[.*?\]$/) {
  81         $self->process_options_for_provides($options);
  82     }
  83 };
  84
  85 ## methods called after instantiation
  86
  87 # this confirms that provides has
  88 # all valid possibilities in it
  89 sub check_provides_values {
  90     my $self = shift;
  91
  92     my $method_constructors = $self->method_constructors;
  93
  94     foreach my $key (keys %{$self->provides}) {
  95         (exists $method_constructors->{$key})
  96             || confess "$key is an unsupported method type";
  97     }
  98 }
  99
 100 after 'install_accessors' => sub {
 101     my $attr  = shift;
 102     my $class = $attr->associated_class;
 103
 104     # grab the reader and writer methods
 105     # as well, this will be useful for
 106     # our method provider constructors
 107     my ($attr_reader, $attr_writer);
 108     if (my $reader = $attr->get_read_method) {
 109         $attr_reader = $class->get_method($reader);
 110     }
 111     else {
 112         $attr_reader = sub { $attr->get_value(@_) };
 113     }
 114
 115     if (my $writer = $attr->get_write_method) {
 116         $attr_writer = $class->get_method($writer);
 117     }
 118     else {
 119         $attr_writer = sub { $attr->set_value(@_) };
 120     }
 121
 122     # before we install them, lets
 123     # make sure they are valid
 124     $attr->check_provides_values;
 125
 126     my $method_constructors = $attr->method_constructors;
 127
 128     foreach my $key (keys %{$attr->provides}) {
 129
 130         my $method_name = $attr->provides->{$key};
 131         my $method_body = $method_constructors->{$key}->(
 132             $attr,
 133             $attr_reader,
 134             $attr_writer,
 135         );
 136
 137         if ($class->has_method($method_name)) {
 138             confess "The method ($method_name) already exists in class (" . $class->name . ")";
 139         }
 140
 141         $class->add_method($method_name =>
 142             MooseX::AttributeHelpers::Meta::Method::Provided->wrap(
 143                 $method_body,
 144             )
 145         );
 146     }
 147 };
 148
 149 no Moose;
 150 no Moose::Util::TypeConstraints;
 151
 152 1;
 153
 154 __END__
 155
 156 =pod
 157
 158 =head1 NAME
 159
 160 MooseX::AttributeHelpers::Base - Base class for attribute helpers
 161
 162 =head1 DESCRIPTION
 163
 164 Documentation to come.
 165
 166 =head1 ATTRIBUTES
 167
 168 =over 4
 169
 170 =item B<provides>
 171
 172 =item B<method_provider>
 173
 174 =item B<method_constructors>
 175
 176 =back
 177
 178 =head1 EXTENDED ATTRIBUTES
 179
 180 =over 4
 181
 182 =item B<$!default>
 183
 184 C<$!default> is now required.
 185
 186 =item B<type_constraint>
 187
 188 C<type_constraint> is now required.
 189
 190 =back
 191
 192 =head1 METHODS
 193
 194 =over 4
 195
 196 =item B<helper_type>
 197
 198 =item B<check_provides_values>
 199
 200 =item B<has_default>
 201
 202 =item B<has_method_provider>
 203
 204 =item B<has_type_constraint>
 205
 206 =item B<install_accessors>
 207
 208 =item B<process_options_for_provides>
 209
 210 =back
 211
 212 =head1 BUGS
 213
 214 All complex software has bugs lurking in it, and this module is no
 215 exception. If you find a bug please either email me, or add the bug
 216 to cpan-RT.
 217
 218 =head1 AUTHOR
 219
 220 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 221
 222 =head1 COPYRIGHT AND LICENSE
 223
 224 Copyright 2007 by Infinity Interactive, Inc.
 225
 226 L<http://www.iinteractive.com>
 227
 228 This library is free software; you can redistribute it and/or modify
 229 it under the same terms as Perl itself.
 230
 231 =cut