lib/Moose/Manual.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Moose::Manual - What is Moose, and how do I use it?
   6
   7 =head1 WHAT IS MOOSE?
   8
   9 Moose is a I<complete> object system for Perl 5. If you've used a
  10 modern object-oriented language (which Perl 5 definitely isn't), you
  11 know they provide keywords for attribute declaration, object
  12 construction, and inheritance. These keywords are part of the
  13 language, and you don't care how they are implemented.
  14
  15 Moose aims to do the same thing for Perl 5 OO. We can't actually
  16 create new keywords, but we do offer "sugar" that looks a lot like
  17 them. More importantly, with Moose, you I<declaratively define> your
  18 class, without needing to know about blessed hashrefs, accessor
  19 methods, and so on.
  20
  21 Moose helps you define the I<logical> structure of your classes, so
  22 you can focus on "what" rather than "how". With Moose, a class
  23 definition reads like a list of very concise English sentences.
  24
  25 Moose is built in top of C<Class::MOP>, a meta-object protocol (aka
  26 MOP). Using the MOP, Moose provides complete introspection for all
  27 Moose-using classes. This means you can ask classes about their
  28 attributes, parents, children, methods, etc., all using a well-defined
  29 API. The MOP abstracts away tedious digging about in the Perl symbol
  30 table, looking at C<@ISA> vars, and all the other crufty Perl tricks
  31 we know and love(?).
  32
  33 Moose is based in large part on the Perl 6 object system, as well as
  34 drawing on the best ideas from CLOS, Smalltalk, and many other
  35 languages.
  36
  37 =head1 WHY MOOSE?
  38
  39 Moose makes Perl 5 OO both simpler and more powerful. It encapsulates
  40 all the tricks of Perl 5 power users in high-level declarative APIs
  41 which are easy to use, and doesn't require any special knowledge of
  42 how Perl works under the hood.
  43
  44 If you want to dig about in the guts, Moose lets you do that too, by
  45 using and extending its powerful introspection API.
  46
  47 =head1 AN EXAMPLE
  48
  49   package Person;
  50
  51   use Moose;
  52
  53   has 'first_name' => (
  54       is  => 'rw',
  55       isa => 'Str',
  56   );
  57
  58   has 'last_name' => (
  59       is  => 'rw',
  60       isa => 'Str',
  61   );
  62
  63 This is a I<complete and usable> class definition!
  64
  65   package User;
  66
  67   use DateTime;
  68   use Moose;
  69
  70   extends 'Person';
  71
  72   has 'password' => (
  73       is  => 'rw',
  74       isa => 'Str',
  75   );
  76
  77   has 'last_login' => (
  78       is      => 'rw',
  79       isa     => 'DateTime',
  80       handles => { 'date_of_last_login' => 'date' },
  81   );
  82
  83   sub login {
  84       my $self = shift;
  85       my $pw   = shift;
  86
  87       return 0 if $pw ne $self->password;
  88
  89       $self->last_login( DateTime->now() );
  90
  91       return 1;
  92   }
  93
  94 We'll leave the line-by-line explanation of this code to other
  95 documentation, but you can see how Moose reduces common OO idioms to
  96 simple declarative constructs.
  97
  98 =head2 TABLE OF CONTENTS
  99
 100 This manual consists of a number of documents.
 101
 102 =over 4
 103
 104 =item L<Moose::Manual::Concepts>
 105
 106 Introduces Moose concepts, and contrasts them against "old school"
 107 Perl 5 OO.
 108
 109 =item L<Moose::Manual::Classes>
 110
 111 How do you make use of Moose in your classes? Now that I'm a Moose,
 112 how do I subclass something?
 113
 114 =item L<Moose::Manual::Attributes>
 115
 116 Attributes are a core part of the Moose OO system. An attribute is a
 117 piece of data that an object has. Moose has a lot of attribute-related
 118 features!
 119
 120 =item L<Moose::Manual::Construction>
 121
 122 Learn how objects are built in Moose, and in particular about the
 123 C<BUILD>, C<BUILDARGS> methods. Also covers object destruction
 124 with C<DEMOLISH>.
 125
 126 =item L<Moose::Manual::MethodModifiers>
 127
 128 A method modifier lets you say "before calling method X, do this
 129 first", or "wrap method X in this code". Method modifiers are
 130 particularly handy in roles and with attribute accessors.
 131
 132 =item L<Moose::Manual::Roles>
 133
 134 A role is something a class does (like "Debuggable" or
 135 "Printable"). Roles provide a way of adding behavior to classes that
 136 is orthogonal to inheritance.
 137
 138 =item L<Moose::Manual::Types>
 139
 140 Moose's type system lets you strictly define what values an attribute
 141 can contain.
 142
 143 =item L<Moose::Manual::Introspection>
 144
 145 Moose's introspection system (primarily from C<Class::MOP>) lets you
 146 ask classes about their parents, children, methods, attributes, etc.
 147
 148 =item L<Moose::Manual::MooseX>
 149
 150 This document shows a few of the most useful Moose extensions on CPAN.
 151
 152 =back
 153
 154 =head1 JUSTIFICATION
 155
 156 If you're still still asking yourself "Why do I need this?", then this
 157 section is for you.
 158
 159 =over 4
 160
 161 =item Another object system!?!?
 162
 163 Yes, I know there has been an explosion recently of new ways to
 164 build objects in Perl 5, most of them based on inside-out objects
 165 and other such things. Moose is different because it is not a new
 166 object system for Perl 5, but instead an extension of the existing
 167 object system.
 168
 169 Moose is built on top of L<Class::MOP>, which is a metaclass system
 170 for Perl 5. This means that Moose not only makes building normal
 171 Perl 5 objects better, but it also provides the power of metaclass
 172 programming.
 173
 174 =item Is this for real? Or is this just an experiment?
 175
 176 Moose is I<based> on the prototypes and experiments Stevan did for the
 177 Perl 6 meta-model. However, Moose is B<NOT> an experiment or
 178 prototype; it is for B<real>.
 179
 180 =item Is this ready for use in production?
 181
 182 Yes.
 183
 184 Moose has been used successfully in production environments by several
 185 people and companies. There are Moose applications which have been in
 186 production with little or no issue now for well over two years. We
 187 consider it highly stable and we are commited to keeping it stable.
 188
 189 Of course, in the end, you need to make this call yourself. If you
 190 have any questions or concerns, please feel free to email Stevan, the
 191 moose@perl.org list, or just stop by irc.perl.org#moose and ask away.
 192
 193 =item Is Moose just Perl 6 in Perl 5?
 194
 195 No. While Moose is very much inspired by Perl 6, it is not itself Perl
 196 6.  Instead, it is an OO system for Perl 5. Stevan built Moose because
 197 he was tired of writing the same old boring Perl 5 OO code, and
 198 drooling over Perl 6 OO. So instead of switching to Ruby, he wrote
 199 Moose :)
 200
 201 =item Wait, I<post> modern, I thought it was just I<modern>?
 202
 203 Stevan read Larry Wall's talk from the 1999 Linux World entitled
 204 "Perl, the first postmodern computer language" in which he talks about
 205 how he picked the features for Perl because he thought they were cool
 206 and he threw out the ones that he thought sucked. This got him
 207 thinking about how we have done the same thing in Moose. For Moose, we
 208 have "borrowed" features from Perl 6, CLOS (LISP), Smalltalk, Java,
 209 BETA, OCaml, Ruby and more, and the bits we didn't like (cause they
 210 sucked) we tossed aside. So for this reason (and a few others) Stevan
 211 has re-dubbed Moose a I<postmodern> object system.
 212
 213 Nuff Said.
 214
 215 =back
 216
 217 =head1 AUTHOR
 218
 219 Dave Rolsky E<lt>autarch@urth.orgE<gt> and Stevan Little
 220 E<lt>stevan@iinteractive.comE<gt>
 221
 222 =head1 COPYRIGHT AND LICENSE
 223
 224 Copyright 2008 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