lib/MooseX/AttributeHelpers/Base.pm

   1
   2 package MooseX::AttributeHelpers::Base;
   3 use Moose;
   4 use Moose::Util::TypeConstraints;
   5
   6 our $VERSION   = '0.01';
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   9 extends 'Moose::Meta::Attribute';
  10
  11 has 'method_constructors' => (
  12     is      => 'ro',
  13     isa     => 'HashRef',
  14     default => sub { {} }
  15 );
  16
  17 has 'provides' => (
  18     is       => 'ro',
  19     isa      => 'HashRef',
  20     required => 1,
  21 );
  22
  23 # extend the parents stuff to make sure
  24 # certain bits are now required ...
  25 has '+$!default'       => (required => 1);
  26 has '+type_constraint' => (required => 1);
  27
  28 ## Methods called prior to instantiation
  29
  30 sub helper_type { () }
  31
  32 sub process_options_for_provides {
  33     my ($self, $options) = @_;
  34     if (my $type = $self->helper_type) {
  35         (exists $options->{isa})
  36             || confess "You must define a type with the $type metaclass";
  37
  38         my $isa = $options->{isa};
  39
  40         unless (blessed($isa) && $isa->isa('Moose::Meta::TypeConstraint')) {
  41             $isa = find_type_constraint($isa);
  42         }
  43
  44         ($isa->is_a_type_of($type))
  45             || confess "The type constraint for a $type ($options->{isa}) must be a subtype of $type";
  46     }
  47
  48     # this can be augmented by subclasses ..
  49     inner();
  50 }
  51
  52 before '_process_options' => sub {
  53     my ($self, $name, $options) = @_;
  54     if (exists $options->{provides}) {
  55         $self->process_options_for_provides($options);
  56     }
  57 };
  58
  59 ## methods called after instantiation
  60
  61 # this confirms that provides has
  62 # all valid possibilities in it
  63 sub check_provides_values {
  64     my $self = shift;
  65     my $method_constructors = $self->method_constructors;
  66     foreach my $key (keys %{$self->provides}) {
  67         (exists $method_constructors->{$key})
  68             || confess "$key is an unsupported method type";
  69     }
  70 }
  71
  72 after 'install_accessors' => sub {
  73     my $attr  = shift;
  74     my $class = $attr->associated_class;
  75
  76     # before we install them, lets
  77     # make sure they are valid
  78     $attr->check_provides_values;
  79
  80     my $method_constructors = $attr->method_constructors;
  81
  82     foreach my $key (keys %{$attr->provides}) {
  83         $class->add_method(
  84             $attr->provides->{$key},
  85             $method_constructors->{$key}->($attr)
  86         );
  87     }
  88 };
  89
  90 no Moose;
  91 no Moose::Util::TypeConstraints;
  92
  93 1;
  94
  95 __END__
  96
  97 =pod
  98
  99 =head1 NAME
 100
 101 MooseX::AttributeHelpers::Base
 102
 103 =head1 SYNOPSIS
 104
 105 =head1 DESCRIPTION
 106
 107 =head1 METHODS
 108
 109 =head1 BUGS
 110
 111 All complex software has bugs lurking in it, and this module is no
 112 exception. If you find a bug please either email me, or add the bug
 113 to cpan-RT.
 114
 115 =head1 AUTHOR
 116
 117 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 118
 119 =head1 COPYRIGHT AND LICENSE
 120
 121 Copyright 2007 by Infinity Interactive, Inc.
 122
 123 L<http://www.iinteractive.com>
 124
 125 This library is free software; you can redistribute it and/or modify
 126 it under the same terms as Perl itself.
 127
 128 =cut