lib/Moose/Manual/BestPractices.pod

   1 package Moose::Manual::BestPractices;
   2
   3 # ABSTRACT: Get the most out of Moose
   4
   5 __END__
   6
   7 =pod
   8
   9 =head1 RECOMMENDATIONS
  10
  11 Moose has a lot of features, and there's definitely more than one way
  12 to do it. However, we think that picking a subset of these features
  13 and using them consistently makes everyone's life easier.
  14
  15 Of course, as with any list of "best practices", these are really just
  16 opinions. Feel free to ignore us.
  17
  18 =head2 C<namespace::autoclean> and immutabilize
  19
  20 We recommend that you remove the Moose sugar and end your Moose class
  21 definitions by making your class immutable.
  22
  23   package Person;
  24
  25   use Moose;
  26   use namespace::autoclean;
  27
  28   # extends, roles, attributes, etc.
  29
  30   # methods
  31
  32   __PACKAGE__->meta->make_immutable;
  33
  34   1;
  35
  36 The C<use namespace::autoclean> bit is simply good code hygiene, as it removes
  37 imported symbols from your class's namespace at the end of your package's
  38 compile cycle, including Moose keywords.  Once the class has been built, these
  39 keywords are not needed. (This is preferred to placing C<no Moose> at the end
  40 of your package).
  41
  42 The C<make_immutable> call allows Moose to speed up a lot of things, most
  43 notably object construction. The trade-off is that you can no longer change
  44 the class definition.
  45
  46 =head2 Never override C<new>
  47
  48 Overriding C<new> is a very bad practice. Instead, you should use a
  49 C<BUILD> or C<BUILDARGS> methods to do the same thing. When you
  50 override C<new>, Moose can no longer inline a constructor when your
  51 class is immutabilized.
  52
  53 There are two good reasons to override C<new>. One, you are writing a
  54 MooseX extension that provides its own L<Moose::Object> subclass
  55 I<and> a subclass of L<Moose::Meta::Method::Constructor> to inline the
  56 constructor. Two, you are subclassing a non-Moose parent.
  57
  58 If you know how to do that, you know when to ignore this best practice
  59 ;)
  60
  61 =head2 Always call the original/parent C<BUILDARGS>
  62
  63 If you C<override> the C<BUILDARGS> method in your class, make sure to play
  64 nice and call C<super()> to handle cases you're not checking for explicitly.
  65
  66 The default C<BUILDARGS> method in L<Moose::Object> handles both a
  67 list and hashref of named parameters correctly, and also checks for a
  68 I<non-hashref> single argument.
  69
  70 =head2 Provide defaults whenever possible, otherwise use C<required>
  71
  72 When your class provides defaults, this makes constructing new objects
  73 simpler. If you cannot provide a default, consider making the
  74 attribute C<required>.
  75
  76 If you don't do either, an attribute can simply be left unset,
  77 increasing the complexity of your object, because it has more possible
  78 states that you or the user of your class must account for.
  79
  80 =head2 Use C<builder> instead of C<default> most of the time
  81
  82 Builders can be inherited, they have explicit names, and they're just
  83 plain cleaner.
  84
  85 However, I<do> use a default when the default is a non-reference,
  86 I<or> when the default is simply an empty reference of some sort.
  87
  88 Also, keep your builder methods private.
  89
  90 =head2 Be C<lazy>
  91
  92 Lazy is good, and often solves initialization ordering problems. It's also
  93 good for deferring work that may never have to be done. Make your attributes
  94 C<lazy> unless they're C<required> or have trivial defaults.
  95
  96 =head2 Consider keeping clearers and predicates private
  97
  98 Does everyone I<really> need to be able to clear an attribute?
  99 Probably not. Don't expose this functionality outside your class
 100 by default.
 101
 102 Predicates are less problematic, but there's no reason to make your
 103 public API bigger than it has to be.
 104
 105 =head2 Avoid C<lazy_build>
 106
 107 As described above, you rarely actually need a clearer or a predicate.
 108 C<lazy_build> adds both to your public API, which exposes you to use cases that
 109 you must now test for. It's much better to avoid adding them until you really
 110 need them - use explicit C<lazy> and C<builder> options instead.
 111
 112 =head2 Default to read-only, and consider keeping writers private
 113
 114 Making attributes mutable just means more complexity to account for in
 115 your program. The alternative to mutable state is to encourage users
 116 of your class to simply make new objects as needed.
 117
 118 If you I<must> make an attribute read-write, consider making the
 119 writer a separate private method. Narrower APIs are easy to maintain,
 120 and mutable state is trouble.
 121
 122 In order to declare such attributes, provide a private C<writer>
 123 parameter:
 124
 125     has pizza => (
 126         is     => 'ro',
 127         isa    => 'Pizza',
 128         writer => '_pizza',
 129     );
 130
 131 =head2 Think twice before changing an attribute's type in a subclass
 132
 133 Down this path lies great confusion. If the attribute is an object
 134 itself, at least make sure that it has the same interface as the type
 135 of object in the parent class.
 136
 137 =head2 Don't use the C<initializer> feature
 138
 139 Don't know what we're talking about? That's fine.
 140
 141 =head2 Use L<Moose::Meta::Attribute::Native> traits instead of C<auto_deref>
 142
 143 The C<auto_deref> feature is a bit troublesome. Directly exposing a complex
 144 attribute is ugly. Instead, consider using L<Moose::Meta::Attribute::Native>
 145 traits to define an API that only exposes the necessary pieces of
 146 functionality.
 147
 148 =head2 Always call C<inner> in the most specific subclass
 149
 150 When using C<augment> and C<inner>, we recommend that you call
 151 C<inner> in the most specific subclass of your hierarchy. This makes
 152 it possible to subclass further and extend the hierarchy without
 153 changing the parents.
 154
 155 =head2 Namespace your types
 156
 157 Use some sort of namespacing convention for type names. We recommend something
 158 like "MyApp::Type::Foo". We also recommend considering L<MooseX::Types>.
 159
 160 =head2 Do not coerce Moose built-ins directly
 161
 162 If you define a coercion for a Moose built-in like C<ArrayRef>, this
 163 will affect every application in the Perl interpreter that uses this
 164 type.
 165
 166     # very naughty!
 167     coerce 'ArrayRef'
 168         => from Str
 169         => via { [ split /,/ ] };
 170
 171 Instead, create a subtype and coerce that:
 172
 173     subtype 'My::ArrayRef' => as 'ArrayRef';
 174
 175     coerce 'My::ArrayRef'
 176         => from 'Str'
 177         => via { [ split /,/ ] };
 178
 179 =head2 Do not coerce class names directly
 180
 181 Just as with Moose built-in types, a class type is global for the
 182 entire interpreter. If you add a coercion for that class name, it can
 183 have magical side effects elsewhere:
 184
 185     # also very naughty!
 186     coerce 'HTTP::Headers'
 187         => from 'HashRef'
 188         => via { HTTP::Headers->new( %{$_} ) };
 189
 190 Instead, we can create an "empty" subtype for the coercion:
 191
 192     subtype 'My::HTTP::Headers' => as class_type('HTTP::Headers');
 193
 194     coerce 'My::HTTP::Headers'
 195         => from 'HashRef'
 196         => via { HTTP::Headers->new( %{$_} ) };
 197
 198 =head2 Use coercion instead of unions
 199
 200 Consider using a type coercion instead of a type union. This was
 201 covered in L<Moose::Manual::Types>.
 202
 203 =head2 Define all your types in one module
 204
 205 Define all your types and coercions in one module. This was also
 206 covered in L<Moose::Manual::Types>.
 207
 208 =head1 BENEFITS OF BEST PRACTICES
 209
 210 Following these practices has a number of benefits.
 211
 212 It helps ensure that your code will play nice with others, making it
 213 more reusable and easier to extend.
 214
 215 Following an accepted set of idioms will make maintenance easier,
 216 especially when someone else has to maintain your code. It will also
 217 make it easier to get support from other Moose users, since your code
 218 will be easier to digest quickly.
 219
 220 Some of these practices are designed to help Moose do the right thing,
 221 especially when it comes to immutabilization. This means your code
 222 will be faster when immutabilized.
 223
 224 Many of these practices also help get the most out of meta
 225 programming. If you used an overridden C<new> to do type coercion by
 226 hand, rather than defining a real coercion, there is no introspectable
 227 metadata. This sort of thing is particularly problematic for MooseX
 228 extensions which rely on introspection to do the right thing.
 229
 230 =cut