1 package MooseX::Emulate::Class::Accessor::Fast;
7 use MooseX::Emulate::Class::Accessor::Fast::Meta::Accessor ();
9 our $VERSION = '0.00800';
13 MooseX::Emulate::Class::Accessor::Fast -
14 Emulate Class::Accessor::Fast behavior using Moose attributes
21 with 'MooseX::Emulate::Class::Accessor::Fast';
24 #fields with readers and writers
25 __PACKAGE__->mk_accessors(qw/field1 field2/);
26 #fields with readers only
27 __PACKAGE__->mk_accessors(qw/field3 field4/);
28 #fields with writers only
29 __PACKAGE__->mk_accessors(qw/field5 field6/);
34 This module attempts to emulate the behavior of L<Class::Accessor::Fast> as
35 accurately as possible using the Moose attribute system. The public API of
36 C<Class::Accessor::Fast> is wholly supported, but the private methods are not.
37 If you are only using the public methods (as you should) migration should be a
38 matter of switching your C<use base> line to a C<with> line.
40 While I have attempted to emulate the behavior of Class::Accessor::Fast as closely
41 as possible bugs may still be lurking in edge-cases.
45 Simple documentation is provided here for your convenience, but for more thorough
46 documentation please see L<Class::Accessor::Fast> and L<Class::Accessor>.
48 =head2 A note about introspection
50 Please note that, at this time, the C<is> flag attribute is not being set. To
51 determine the C<reader> and C<writer> methods using introspection in later versions
52 of L<Class::MOP> ( > 0.38) please use the C<get_read_method> and C<get_write_method>
53 methods in L<Class::MOP::Attribute>. Example
55 # with Class::MOP <= 0.38
56 my $attr = $self->meta->find_attribute_by_name($field_name);
57 my $reader_method = $attr->reader || $attr->accessor;
58 my $writer_method = $attr->writer || $attr->accessor;
60 # with Class::MOP > 0.38
61 my $attr = $self->meta->find_attribute_by_name($field_name);
62 my $reader_method = $attr->get_read_method;
63 my $writer_method = $attr->get_write_method;
67 =head2 BUILD $self %args
69 Change the default Moose class building to emulate the behavior of C::A::F and
70 store arguments in the instance hashref.
74 my $locate_metaclass = sub {
75 my $class = Scalar::Util::blessed($_[0]) || $_[0];
76 return Class::MOP::get_metaclass_by_name($class)
77 || Moose::Meta::Class->initialize($class);
83 if (scalar @_ == 1 && defined $_[0] && ref($_[0]) eq 'HASH') {
85 } elsif( scalar(@_) ) {
88 my @extra = grep { !exists($self->{$_}) } keys %args;
89 @{$self}{@extra} = @args{@extra};
93 =head2 mk_accessors @field_names
95 Create read-write accessors. An attribute named C<$field_name> will be created.
96 The name of the c<reader> and C<writer> methods will be determined by the return
97 value of C<accessor_name_for> and C<mutator_name_for>, which by default return the
98 name passed unchanged. If the accessor and mutator names are equal the C<accessor>
99 attribute will be passes to Moose, otherwise the C<reader> and C<writer> attributes
100 will be passed. Please see L<Class::MOP::Attribute> for more information.
106 my $meta = $locate_metaclass->($self);
107 my $class = $meta->name;
108 confess("You are trying to modify ${class}, which has been made immutable, this is ".
109 "not supported. Try subclassing ${class}, rather than monkeypatching it")
110 if $meta->is_immutable;
112 for my $attr_name (@_){
113 $meta->remove_attribute($attr_name)
114 if $meta->find_attribute_by_name($attr_name);
115 my $reader = $self->accessor_name_for($attr_name);
116 my $writer = $self->mutator_name_for( $attr_name);
118 #dont overwrite existing methods
119 if($reader eq $writer){
120 my %opts = ( $meta->has_method($reader) ? () : (accessor => $reader) );
121 my $attr = $meta->find_attribute_by_name($attr_name) || $meta->add_attribute($attr_name, %opts,
122 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
124 if($attr_name eq $reader){
125 my $alias = "_${attr_name}_accessor";
126 next if $meta->has_method($alias);
127 $meta->add_method($alias => $attr->get_read_method_ref);
130 my @opts = ( $meta->has_method($writer) ? () : (writer => $writer) );
131 push(@opts, (reader => $reader)) unless $meta->has_method($reader);
132 my $attr = $meta->find_attribute_by_name($attr_name) || $meta->add_attribute($attr_name, @opts,
133 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
139 =head2 mk_ro_accessors @field_names
141 Create read-only accessors.
145 sub mk_ro_accessors {
147 my $meta = $locate_metaclass->($self);
148 my $class = $meta->name;
149 confess("You are trying to modify ${class}, which has been made immutable, this is ".
150 "not supported. Try subclassing ${class}, rather than monkeypatching it")
151 if $meta->is_immutable;
152 for my $attr_name (@_){
153 $meta->remove_attribute($attr_name)
154 if $meta->find_attribute_by_name($attr_name);
155 my $reader = $self->accessor_name_for($attr_name);
156 my @opts = ($meta->has_method($reader) ? () : (reader => $reader) );
157 my $attr = $meta->add_attribute($attr_name, @opts,
158 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
160 if($reader eq $attr_name && $reader eq $self->mutator_name_for($attr_name)){
161 $meta->add_method("_${attr_name}_accessor" => $attr->get_read_method_ref)
162 unless $meta->has_method("_${attr_name}_accessor");
167 =head2 mk_ro_accessors @field_names
169 Create write-only accessors.
173 #this is retarded.. but we need it for compatibility or whatever.
174 sub mk_wo_accessors {
176 my $meta = $locate_metaclass->($self);
177 my $class = $meta->name;
178 confess("You are trying to modify ${class}, which has been made immutable, this is ".
179 "not supported. Try subclassing ${class}, rather than monkeypatching it")
180 if $meta->is_immutable;
181 for my $attr_name (@_){
182 $meta->remove_attribute($attr_name)
183 if $meta->find_attribute_by_name($attr_name);
184 my $writer = $self->mutator_name_for($attr_name);
185 my @opts = ($meta->has_method($writer) ? () : (writer => $writer) );
186 my $attr = $meta->add_attribute($attr_name, @opts,
187 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
189 if($writer eq $attr_name && $writer eq $self->accessor_name_for($attr_name)){
190 $meta->add_method("_${attr_name}_accessor" => $attr->get_write_method_ref)
191 unless $meta->has_method("_${attr_name}_accessor");
196 =head2 follow_best_practices
198 Preface readers with 'get_' and writers with 'set_'.
199 See original L<Class::Accessor> documentation for more information.
203 sub follow_best_practice {
205 my $meta = $locate_metaclass->($self);
207 $meta->remove_method('mutator_name_for');
208 $meta->remove_method('accessor_name_for');
209 $meta->add_method('mutator_name_for', sub{ return "set_".$_[1] });
210 $meta->add_method('accessor_name_for', sub{ return "get_".$_[1] });
213 =head2 mutator_name_for
215 =head2 accessor_name_for
217 See original L<Class::Accessor> documentation for more information.
221 sub mutator_name_for { return $_[1] }
222 sub accessor_name_for { return $_[1] }
226 See original L<Class::Accessor> documentation for more information.
233 confess "Wrong number of arguments received" unless scalar @_;
234 my $meta = $locate_metaclass->($self);
236 confess "No such attribute '$k'"
237 unless ( my $attr = $meta->find_attribute_by_name($k) );
238 my $writer = $attr->get_write_method;
239 $self->$writer(@_ > 1 ? [@_] : @_);
244 See original L<Class::Accessor> documentation for more information.
250 confess "Wrong number of arguments received" unless scalar @_;
251 my $meta = $locate_metaclass->($self);
255 confess "No such attribute '$_'"
256 unless ( my $attr = $meta->find_attribute_by_name($_) );
257 my $reader = $attr->get_read_method;
258 @_ > 1 ? push(@values, $self->$reader) : return $self->$reader;
265 my($class, $field) = @_;
266 my $meta = $locate_metaclass->($class);
267 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field,
268 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
270 my $reader = $attr->get_read_method_ref;
271 my $writer = $attr->get_write_method_ref;
274 return $reader->($self) unless @_;
275 return $writer->($self,(@_ > 1 ? [@_] : @_));
280 sub make_ro_accessor {
281 my($class, $field) = @_;
282 my $meta = $locate_metaclass->($class);
283 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field,
284 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
286 return $attr->get_read_method_ref;
290 sub make_wo_accessor {
291 my($class, $field) = @_;
292 my $meta = $locate_metaclass->($class);
293 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field,
294 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute']
296 return $attr->get_write_method_ref;
303 See L<Moose::Meta::Class>.
309 L<Moose>, L<Moose::Meta::Attribute>, L<Class::Accessor>, L<Class::Accessor::Fast>,
310 L<Class::MOP::Attribute>, L<MooseX::Adopt::Class::Accessor::Fast>
314 Guillermo Roditi (groditi) E<lt>groditi@cpan.orgE<gt>
316 With contributions from:
320 =item Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
322 =item Florian Ragwitz (rafl) E<lt>rafl@debian.orgE<gt>
328 You may distribute this code under the same terms as Perl itself.