1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
6 <title>Introduction to Moose</title>
7 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
9 <meta name="generator" content="S5" />
10 <meta name="version" content="S5 1.2a2" />
11 <meta name="author" content="Eric A. Meyer" />
12 <meta name="company" content="Complex Spiral Consulting" />
13 <!-- configuration parameters -->
14 <meta name="defaultView" content="slideshow" />
15 <meta name="controlVis" content="hidden" />
16 <!-- style sheet links -->
17 <link rel="stylesheet" href="ui/default/slides.css" type="text/css" media="projection" id="slideProj" />
18 <link rel="stylesheet" href="ui/default/outline.css" type="text/css" media="screen" id="outlineStyle" />
19 <link rel="stylesheet" href="ui/default/print.css" type="text/css" media="print" id="slidePrint" />
20 <link rel="stylesheet" href="ui/default/opera.css" type="text/css" media="projection" id="operaFix" />
21 <!-- embedded styles -->
22 <style type="text/css" media="all">
23 .imgcon {width: 525px; margin: 0 auto; padding: 0; text-align: center;}
24 #anim {width: 270px; height: 320px; position: relative; margin-top: 0.5em;}
25 #anim img {position: absolute; top: 42px; left: 24px;}
26 img#me01 {top: 0; left: 0;}
27 img#me02 {left: 23px;}
29 img#me05 {top: 43px;left: 36px;}
32 <script src="ui/default/slides.js" type="text/javascript"></script>
33 <link rel="stylesheet" href="ui/custom.css" type="text/css" />
38 <div id="controls"><!-- DO NOT EDIT --></div>
39 <div id="currentSlide"><!-- DO NOT EDIT --></div>
40 <div id="header"></div>
43 <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/"><img alt="Creative Commons License" style="border-width:0" src="ui/creative-commons.png" /></a>
44 <br /><span xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://purl.org/dc/dcmitype/Text" property="dc:title" rel="dc:type">Introduction to Moose</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">David Rolsky</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.
47 <h2>Introduction to Moose</h2>
51 <div class="presentation">
54 <h1>Introduction to Moose</h1>
59 <h1>Introduce Yourselves</h1>
63 <li>What you do with Perl</li>
64 <li>Why you're here today (optional)</li>
69 <h1>Moose Summed Up</h1>
72 <li><strong>Declarative</strong> OO sugar</li>
73 <li>Introspectable</li>
74 <li>Extensible (MooseX::* on CPAN)</li>
79 <h1>Moose Background</h1>
82 <li>Created by Stevan Little, first released in 2006</li>
83 <li>Moose builds on Perl 5's native OO</li>
84 <li>Borrows ideas from other languages, notably Perl 6</li>
85 <li>Provides semantics for common operations</li>
89 <div class="slide fake-slide0">
90 <h1>Part 0: Moose Concepts</h1>
102 <li>Superclasses</li>
103 <li>Method modifiers</li>
104 <li>Constructor and destructor</li>
105 <li>One metaclass object</li>
108 <li>Classes do roles</li>
113 <h1>Class Example</h1>
115 <pre><code>package Person;
116 <span class="highlight">use Moose;</span></code></pre>
119 <li>Poof, a Moose-based class!</li>
127 <li>Aka property, slot, field, member variable</li>
128 <li>A piece of data owned by an object</li>
139 <li>Mutability (read-only vs read-write)</li>
140 <li>An optional type</li>
141 <li>Accessor methods</li>
142 <li>Delegation methods</li>
143 <li>Optional default value</li>
144 <li>Many more features</li>
147 <li>Stored in the object, but don't worry about that</li>
152 <h1>Attribute Example</h1>
154 <pre><code>package Person;
157 <span class="highlight">has first_name => ( is => 'rw' );</span></code></pre>
165 <li>Nothing fancy here, just Perl subroutines</li>
168 <pre><code>package Person;
171 <span class="highlight">sub greet { ... }</span></code></pre>
178 <li>Classes <strong>do</strong> (or consume) roles</li>
179 <li>Similar to mixins and Java interfaces</li>
187 <li>Like classes, can have attributes, methods, do roles</li>
188 <li>Roles can require methods</li>
189 <li>Roles are composed (flattened) into classes</li>
194 <h1>Role Example</h1>
196 <pre><code>package HasPermissions;
197 <span class="highlight">use Moose::Role;</span>
199 has is_admin => ( is => 'rw' );</code></pre>
203 <h1>Role Example</h1>
209 <pre><code>package Person;
212 <span class="highlight">with 'HasPermissions';</span></code></pre>
216 <h1>Method Modifiers</h1>
220 <li>"<strong>Before</strong> foo(), do this first"</li>
221 <li>"Do this <strong>after</strong> foo()"</li>
222 <li>"Put this code <strong>around</strong> foo()"</li>
227 <h1>Before and After</h1>
229 <pre><code>before 'foo'
230 => sub { warn 'About to call foo()' };
233 => sub { warn 'Leaving foo()' };</code></pre>
240 <pre><code>around 'foo' => sub {
241 my $real_foo = shift;
244 warn 'Just before foo()';
246 $self->$real_foo( @_, bar => 42 );
250 'modify return values'
256 <h1>Type Constraints</h1>
259 <li>NOT A FULL-BLOWN TYPE SYSTEM!</li>
260 <li>But still darn useful</li>
261 <li>Constrain attribute values</li>
262 <li>Coerce from other types</li>
267 <h1>Type Constraint Example</h1>
269 <pre><code>package Person;
274 <span class="highlight">isa => 'Int'</span>,
278 Person->new( weight => 'heavy' );</code></pre>
285 <li>Attributes can define delegations</li>
286 <li>Lets you hide some implementation details</li>
287 <li>Fewer objects to chase around</li>
294 <pre><code>package Person;
300 <span class="highlight">handles => { 'blog_host' => 'host' },</span>
303 <span class="highlight">$person->blog_host;</span>
304 # really calls $person->blog_uri->host</code></pre>
308 <h1>Constructors</h1>
311 <li>Moose creates <code>new()</code> for you</li>
312 <li>Provide an optional <code>BUILDARGS()</code> and <code>BUILD()</code></li>
320 <li>Provide an optional <code>DEMOLISH()</code></li>
325 <h1>Moose Meta-API</h1>
328 <li>Answers questions like ...
330 <li>What methods does this class have?</li>
331 <li>What are its parents?</li>
332 <li>What attributes does it have (including inherited attributes)?</li>
333 <li>What roles does it do?</li>
334 <li>Much, much, more</li>
341 <h1>Moose Meta-API</h1>
344 <li>Not just for introspection ...
346 <li>Add methods, attributes, roles, etc</li>
347 <li>Extend and alter core features</li>
357 <li>A quick bit of propaganda ...</li>
364 <pre><code>package Person;
367 has last_name => (
374 <h1>Without Moose</h1>
376 <pre class="small"><code>package Person;
386 if (exists $args{last_name}) {
387 confess "Attribute (last_name) does not pass the type constraint because: "
388 . "Validation failed for 'Str' with value $args{last_name}"
389 if ref($args{last_name});
390 $self->{last_nane} = $args{last_name};
393 return bless $self, $class;
401 confess "Attribute (last_name) does not pass the type constraint because: "
402 . "Validation failed for 'Str' with value $value"
404 $self->{last_name} = $value;
407 return $self->{last_name};
413 <h1>Side by side</h1>
415 <table class="side-by-side">
418 <pre><code>package Person;
421 has last_name => (
427 <pre class="small"><code>package Person;
437 if (exists $args{last_name}) {
438 confess "Attribute (last_name) does not pass the type constraint because: "
439 . "Validation failed for 'Str' with value $args{last_name}"
440 if ref($args{last_name});
441 $self->{last_nane} = $args{last_name};
444 return bless $self, $class;
452 confess "Attribute (last_name) does not pass the type constraint because: "
453 . "Validation failed for 'Str' with value $value"
455 $self->{last_name} = $value;
458 return $self->{last_name};
467 <h1>Side by side</h1>
469 <table class="side-by-side">
472 <pre><code><span class="match-moose">package Person;</span>
475 has last_name => (
481 <pre class="small"><code><span class="match-unsweet">package Person;</span>
491 if (exists $args{last_name}) {
492 confess "Attribute (last_name) does not pass the type constraint because: "
493 . "Validation failed for 'Str' with value $args{last_name}"
494 if ref($args{last_name});
495 $self->{last_nane} = $args{last_name};
498 return bless $self, $class;
506 confess "Attribute (last_name) does not pass the type constraint because: "
507 . "Validation failed for 'Str' with value $value"
509 $self->{last_name} = $value;
512 return $self->{last_name};
520 <h1>Side by side</h1>
522 <table class="side-by-side">
525 <pre><code>package Person;
526 <span class="match-moose">use Moose;</span>
528 has last_name => (
534 <pre class="small"><code>package Person;
535 <span class="match-unsweet">use strict;
542 my $self = {};</span>
544 if (exists $args{last_name}) {
545 confess "Attribute (last_name) does not pass the type constraint because: "
546 . "Validation failed for 'Str' with value $args{last_name}"
547 if ref($args{last_name});
548 $self->{last_nane} = $args{last_name};
551 <span class="match-unsweet">return bless $self, $class;
559 confess "Attribute (last_name) does not pass the type constraint because: "
560 . "Validation failed for 'Str' with value $value"
562 $self->{last_name} = $value;
565 return $self->{last_name};
573 <h1>Side by side</h1>
575 <table class="side-by-side">
578 <pre><code>package Person;
581 <span class="match-moose">has last_name => (</span>
584 <span class="match-moose">);</span></code></pre>
587 <pre class="small"><code>package Person;
597 <span class="match-unsweet">if (exists $args{last_name}) {</span>
598 confess "Attribute (last_name) does not pass the type constraint because: "
599 . "Validation failed for 'Str' with value $args{last_name}"
600 if ref($args{last_name});
601 <span class="match-unsweet">$self->{last_nane} = $args{last_name};
604 return bless $self, $class;
612 confess "Attribute (last_name) does not pass the type constraint because: "
613 . "Validation failed for 'Str' with value $value"
615 $self->{last_name} = $value;
618 return $self->{last_name};
626 <h1>Side by side</h1>
628 <table class="side-by-side">
631 <pre><code>package Person;
634 has last_name => (
635 <span class="match-moose">is => 'rw',</span>
640 <pre class="small"><code>package Person;
650 if (exists $args{last_name}) {
651 confess "Attribute (last_name) does not pass the type constraint because: "
652 . "Validation failed for 'Str' with value $args{last_name}"
653 if ref($args{last_name});
654 $self->{last_nane} = $args{last_name};
657 return bless $self, $class;
660 <span class="match-unsweet">sub last_name {
664 my $value = shift;</span>
665 confess "Attribute (last_name) does not pass the type constraint because: "
666 . "Validation failed for 'Str' with value $value"
668 <span class="match-unsweet">$self->{last_name} = $value;
671 return $self->{last_name};
672 }</span></code></pre>
679 <h1>Side by side</h1>
681 <table class="side-by-side">
684 <pre><code>package Person;
687 has last_name => (
689 <span class="match-moose">isa => 'Str',</span>
693 <pre class="small"><code>package Person;
703 if (exists $args{last_name}) {
704 <span class="match-unsweet">confess "Attribute (last_name) does not pass the type constraint because: "
705 . "Validation failed for 'Str' with value $args{last_name}"
706 if ref($args{last_name});</span>
707 $self->{last_nane} = $args{last_name};
710 return bless $self, $class;
718 <span class="match-unsweet">confess "Attribute (last_name) does not pass the type constraint because: "
719 . "Validation failed for 'Str' with value $value"
720 if ref($value);</span>
721 $self->{last_name} = $value;
724 return $self->{last_name};
732 <h1>Side by side</h1>
734 <table class="side-by-side">
735 <tr class="incremental">
739 <tr class="incremental">
740 <td>92 characters</td>
741 <td>741 characters</td>
745 <pre><code>package Person;
748 has last_name => (
754 <pre class="small"><code>package Person;
764 if (exists $args{last_name}) {
765 confess "Attribute (last_name) does not pass the type constraint because: "
766 . "Validation failed for 'Str' with value $args{last_name}"
767 if ref($args{last_name});
768 $self->{last_nane} = $args{last_name};
771 return bless $self, $class;
779 confess "Attribute (last_name) does not pass the type constraint because: "
780 . "Validation failed for 'Str' with value $value"
782 $self->{last_name} = $value;
785 return $self->{last_name};
795 <pre class="small"><code>sub new {
800 if (exists $args{last_name}) {
801 confess "Attribute (last_name) does not pass the type constraint because: "
802 . "Validation failed for 'Str' with value $args{last_name}"
803 if ref($args{last_name});
804 $self->{last_nane} = $args{last_name};
807 return bless $self, $class;
814 <pre class="small"><code>if (exists $args{last_name}) {
815 confess "Attribute (last_name) does not pass the type constraint because: "
816 . "Validation failed for 'Str' with value $args{last_name}"
817 if ref($args{last_name});
818 $self->{last_nane} = $args{last_name};
825 <code>$self->{last_nane} = $args{last_name};</code>
830 <code>$self->{last_na<span class="wrong">n</span>e}</code>
836 <pre><code>package Person;
839 has last_name => (
846 <h1>More Why Moose?</h1>
849 <li>Less code == fewer bugs</li>
850 <li>Moose is well-tested, test your own code, not Moose</li>
851 <li>Focus on <strong>what</strong>, not <strong>how</strong></li>
855 <div class="slide fake-slide0">
856 <h1>Part 1: Moose Classes</h1>
860 <h1>Moose Classes</h1>
863 <li>Moose classes are Perl packages which <code>use Moose</code></li>
868 <h1>Moose.pm and Your Class</h1>
870 <pre><code>package Person;
871 use Moose;</code></pre>
874 <li><code>Moose.pm</code> provides declarative sugar</li>
875 <li>Turns on <code>strict</code> and <code>warnings</code></li>
876 <li>Creates metaclasses for your class: <code>Person->meta</code></li>
877 <li>Moose classes automatically inherit from <code>Moose::Object</code></li>
882 <h1>What <code>Moose::Object</code> Provides</h1>
885 <li>Constructor - <code>new()</code></li>
886 <li>Calls your <code>BUILDARGS()</code> and/or <code>BUILD()</code></li>
887 <li>Calls your <code>DEMOLISH</code> during object destruction</li>
895 <li>Takes <code>@_</code>, returns a hash reference of attribute name/value pairs</li>
896 <li>Accepts a hash or hashref; throws otherwise</li>
897 <li>Provide your own for other cases</li>
898 <li><strong>Always</strong> call <code>$class->SUPER::BUILDARGS(@_)</code> as a fallback!</li>
903 <h1>BUILDARGS Example</h1>
905 <pre><code>package Person;
911 if ( @_ == 1 && ! ref $_[0] ) {
912 <span class="highlight">return { ssn => $_[0] };</span>
914 <span class="highlight">return $class->SUPER::BUILDARGS(@_)</span>;
917 <span class="highlight">Person->new('123-45-6789')</span></code></pre>
924 <li>Called after object is created, before <code>new</code> returns</li>
925 <li>Chance to do more complex validation, set complex attributes</li>
926 <li>Called in reverse inheritance order, parents to children</li>
927 <li>Return value is ignored</li>
932 <h1>BUILD Example</h1>
934 <pre><code>package Person;
940 if ( $self->country_of_residence
942 die 'All US residents'
943 . ' must have an SSN'
944 unless $self->has_ssn;
950 <h1>Object Construction a la Moose</h1>
952 <pre><code>Person->new(@_)</code></pre>
954 <ol style="margin-top: 0">
955 <li>Calls <code>Person->BUILDARGS(@_)</code> to turn <code>@_</code> into a hashref</li>
956 <li>Blesses a reference</li>
957 <li>Populates attributes based on the hashref from #1</li>
958 <li>Calls <code>$new_object->BUILDALL($constructor_args)</code>
959 <br />... which calls all <code>BUILD</code> methods</li>
960 <li>Returns the object</li>
965 <h1>The Object is Opaque</h1>
968 <li>Technically it's a hash reference</li>
969 <li><span class="wrong">If you <em>ever</em> treat it as one <strong>you are doing it wrong!</strong></span></li>
977 <li>Like <code>DESTROY</code>, but Moose makes sure all <code>DEMOLISH</code> methods in a hierarchy are called</li>
978 <li>Called in normal inheritance order, children to parents</li>
986 <li><code>extends</code> is sugar for declaring parent classes</li>
987 <li>Also ensures metaclass compatibility between parent and child</li>
988 <li>Do not <code>use base</code></li>
991 <pre><code>package Employee;
993 <span class="highlight">extends 'Person';</span></code></pre>
1000 <li>Each call to <code>extends</code> <strong>resets</strong> your parents</li>
1003 <h2 class="wrong">Wrong</h2>
1005 <pre><code>package EvilEmployee;
1008 extends 'Thief';</code></pre>
1010 <h2 class="right">Right</h2>
1012 <pre><code>package EvilEmployee;
1014 extends 'Person', 'Thief';</code></pre>
1018 <h1>Extending un-Moose-y Parents</h1>
1020 <pre><code>package My::LWP;
1022 extends 'LWP';</code></pre>
1025 <li>No <code>Moose::Object</code>, so ...
1027 <li>No attribute-handling <code>new()</code></li>
1028 <li>No <code>BUILDARGS()</code> or <code>BUILD()</code></li>
1029 <li>No <code>DEMOLISH()</code></li>
1032 <li>But see <code>MooseX::NonMoose</code> for a workaround</li>
1037 <h1><code>override</code> and <code>super</code></h1>
1040 <li><code>override</code> is another method modifier</li>
1041 <li>An alternative to Perl's <code>SUPER::</code></li>
1042 <li><em>Declares</em> your intent to override a method</li>
1047 <h1><code>override</code> and <code>super</code></h1>
1049 <pre><code>package Employee;
1052 <span class="current incremental">extends 'Person';</span>
1054 <span class="incremental">override</span> work => sub {
1058 unless $self->got_paid;
1059 <span class="incremental">super();</span>
1060 }<span class="incremental">;</span></code></pre>
1064 <h1>Caveat <code>super</code></h1>
1067 <li>Mostly like <code>$self->SUPER::work(@_)</code></li>
1068 <li><strong>But</strong> cannot change <code>@_</code>!</li>
1069 <li>Binds the parent's method at compile time</li>
1070 <li>Parent determined by checking <code>Child->meta()->superclasses()</code></li>
1075 <h1>Minimal Attributes</h1>
1078 <li><code>has 'foo'</code></li>
1079 <li>Use <code>is => 'ro'</code> or <code>is => 'rw'</code></li>
1080 <li>Attributes without "is" have no accessors</li>
1085 <h1>Read-write attributes</h1>
1087 <pre><code>package Person;
1090 has first_name => ( <span class="highlight">is => 'rw'</span> );
1093 Person->new( first_name => 'Dave' );
1095 $person->first_name('Stevan');
1096 print $person->first_name; # Stevan</code></pre>
1101 <h1>Read-only attributes</h1>
1103 <pre><code>package Person;
1106 has first_name => ( <span class="highlight">is => 'ro'</span> );
1109 Person->new( first_name => 'Dave' );
1111 $person->first_name('Stevan'); # dies</code></pre>
1116 <h1>There is More to Come</h1>
1119 <li>Attributes have a <em>lot</em> of features</li>
1124 <h1>Cleaning Up Moose Droppings</h1>
1126 <pre><code>package Person;
1130 Person->can('extends');</code></pre>
1133 <li>Not very hygienic</li>
1138 <h1>Cleaning Up Moose Droppings</h1>
1140 <pre><code>package Person;
1145 <span class="highlight">no Moose;</span>
1148 Person->can('extends');</code></pre>
1152 <h1>Cleaning Up Moose Droppings</h1>
1154 <pre><code>package Person;
1155 <span class="highlight">use namespace::autoclean;</span>
1161 Person->can('extends');</code></pre>
1168 <li>Cleaning up is a best practice</li>
1169 <li>Say <code>no Moose</code> at the end of a package</li>
1170 <li>Or <code>use namespace::autoclean</code> at the top</li>
1176 <h1>Immutability</h1>
1179 <li><span style="font-family: URW Chancery L; font-size: 120%">Stevan's Incantation of Fleet-Footedness</span></li>
1182 <pre><code>package Person;
1185 <span class="highlight">__PACKAGE__->meta->make_immutable;</span></code></pre>
1189 <h1>What <code>make_immutable</code> does</h1>
1193 <li>Uses <code>eval</code> to "inline" a constructor</li>
1194 <li>Memoizes a lot of meta-information</li>
1195 <li>Makes loading your class slower</li>
1196 <li>Makes object creation <em>much</em> faster</li>
1201 <h1>When to Immutabilize?</h1>
1204 <li><em>Almost</em> always</li>
1205 <li>Startup time vs execution time</li>
1210 <h1>Classes Summary</h1>
1213 <li><code>use Moose</code></li>
1214 <li><code>Class->meta</code></li>
1215 <li><code>Moose::Object</code> base class</li>
1216 <li><code>extends</code>, <code>override</code>, and <code>super</code></li>
1217 <li>Simple attributes: <code>has</code>, <code>is => 'ro'</code>, & <code>is => 'rw'</code></li>
1218 <li><code>no Moose</code></li>
1219 <li><code>__PACKAGE__->meta->make_immutable</code></li>
1232 # perl bin/prove -lv t/00-prereq.t
1234 # perl install-moose (if needed)
1236 # perl bin/prove -lv t/01-classes.t
1238 # edit lib/Person.pm and lib/Employee.pm
1240 Iterate til this passes all its tests</pre>
1243 <div class="slide fake-slide0">
1244 <h1>Part 2: Roles</h1>
1248 <h1>Just What Is a Role?</h1>
1251 <li>Mixin? Interface? Trait?</li>
1252 <li>Yes ... and more!</li>
1257 <h1>Roles - State <strong>and</strong> Behavior</h1>
1259 <pre><code>package HasPermissions;
1261 <span class="current incremental"># state
1262 has access_level => ( is => 'rw' );</span>
1264 <span class="incremental"># behavior
1267 my $required = shift;
1269 return $self->access_level
1271 }</span></code></pre>
1276 <h1>Roles Can Define Interfaces</h1>
1278 <pre><code>package Printable;
1281 requires 'as_string';</code></pre>
1285 <h1>Roles Can Do All Three</h1>
1287 <pre><code>package Printable;
1290 requires 'as_string';
1292 has has_been_printed => ( is => 'rw' );
1296 print $self->as_string;
1297 $self->has_been_printed(1);
1302 <h1>Classes Consume Roles</h1>
1304 <pre><code>package Person;
1307 with 'HasPermissions';</code></pre>
1311 <h1>Classes Consume Roles</h1>
1313 <pre><code>my $person = Person->new(
1314 first_name => 'Kenichi',
1315 last_name => 'Asai',
1316 access_level => 42,
1319 print $person->full_name
1321 . $person->can_access(42)
1323 : 'little power';</code></pre>
1327 <h1>Roles in Practice</h1>
1330 <li>Consuming a role =~ inlining the role</li>
1335 <h1>In Other Words ...</h1>
1337 <pre><code>package Person;
1340 <span class="highlight">with 'Printable';</span></code></pre>
1344 <h1>In Other Words ...</h1>
1346 <pre><code>package Person;
1349 <span class="delete">with 'Printable';</span>
1351 <span class="highlight">has has_been_printed => ( is => 'rw' );
1355 print $self->as_string;
1356 $self->has_been_printed(1);
1357 }</span></code></pre>
1364 <li>Role consumption is introspectable</li>
1367 <pre><code>if ( Person->does('Printable') ) { ... }
1371 Person->meta->does_role('Printable')</code></pre>
1376 <h1>These Names Are the Same</h1>
1379 <li>What if a role and class define the same method?</li>
1380 <li>A class's <em>local</em> methods win over the role's</li>
1381 <li>The role's methods win over the class's <em>inherited</em> methods</li>
1386 <h1>Conflicts Between Roles</h1>
1389 <li>Two roles with a method of the same name</li>
1390 <li>Generates a compile-time error when consumed by a class</li>
1395 <h1>Conflict Example</h1>
1397 <pre><code>package IsFragile;
1402 package CanBreakdance;
1405 sub break { ... }</code></pre>
1409 <h1>Conflict Example</h1>
1411 <pre><code>package FragileDancer;
1414 <span class="highlight">with 'IsFragile', 'CanBreakdance';</span></code></pre>
1417 <li>Only one <code>with</code>!</li>
1422 <h1>Conflict Resolution</h1>
1425 <li>The consuming class must resolve the conflict by implementing the method</li>
1426 <li>Can use some combination of method exclusion and aliasing</li>
1431 <h1>Conflicts Are a Smell</h1>
1434 <li>Roles are about semantics!</li>
1435 <li>Roles have a <em>meaning</em></li>
1436 <li>Method name conflicts smell like bad design</li>
1441 <h1>Roles With Roles</h1>
1443 <pre><code>package Comparable;
1446 requires 'compare';</code></pre>
1450 <h1>Roles With Roles</h1>
1452 <pre><code>package TestsEquality;
1459 return $self->compare(@_) == 0;
1464 <h1>And then ...</h1>
1466 <pre><code>package Integer;
1469 with 'TestsEquality';
1471 # Satisfies the Comparable role
1474 Integer->does('TestsEquality'); # true
1475 Integer->does('Comparable'); # also true!</code></pre>
1479 <h1>Name Conflicts Between Roles</h1>
1481 <pre><code>package HasSubProcess;
1484 <span class="highlight">sub execute { ... }</span>
1489 with 'HasSubProcess';
1491 <span class="highlight">sub execute { ... }</span></code></pre>
1495 <h1>Delayed Conflict</h1>
1497 <pre><code>package SysadminAssassin;
1498 with 'Killer';</code></pre>
1501 <li><code>SysadminAssassin</code> must implement its own <code>execute</code></li>
1502 <li>But loading the <code>Killer</code> role by itself does not cause an error</li>
1507 <h1>Roles as Interfaces</h1>
1510 <li>Roles can <code>require</code> methods of their consumers</li>
1511 <li>Compile-time checks</li>
1512 <li>Method must exist when the role is consumed</li>
1517 <h1>The Attribute Gotcha</h1>
1519 <pre><code>package HasSize;
1522 <span class="current incremental">requires 'size';</span>
1527 <span class="incremental">with 'HasSize';
1529 has size => ( is => 'ro' );</span></code></pre>
1533 <h1>The Attribute Gotcha Workaround</h1>
1535 <pre><code>package HasSize;
1543 has size => ( is => 'ro' );
1545 with 'HasSize';</code></pre>
1549 <h1>Compile-time Is a Lie</h1>
1552 <li>Really, it's <em>package load</em> time</li>
1553 <li>That's run-time, but before the "real" run-time</li>
1554 <li>Moose does not rewire Perl, it's just sugar!</li>
1555 <li>(but <code>MooseX::Declare</code> <em>does</em> rewire Perl)</li>
1560 <h1>Enforcing Roles</h1>
1562 <pre><code>package Comparison;
1565 has [ 'left', 'right' ] => (
1567 <span class="highlight">does => 'Comparable',</span>
1572 <li>A sneak peek at type constraints</li>
1578 <h1>Roles Can Be Applied to Objects</h1>
1580 <pre><code>use Moose::Util qw( apply_all_roles );
1582 my $fragile_person = Person->new( ... );
1583 apply_all_roles( $fragile_person,
1584 'IsFragile' );</code></pre>
1587 <li>Does not change the <code>Person</code> class</li>
1588 <li>Works with non-Moose classes, great for monkey-patching!</li>
1593 <h1>Roles Are Dirty Too</h1>
1596 <li>Once again, clean up those Moose droppings</li>
1599 <pre><code>package Comparable;
1604 <span class="highlight">no Moose::Role;</span></code></pre>
1607 <li>But roles cannot be made immutable</li>
1612 <h1>The Zen of Roles</h1>
1615 <li>Roles represent discrete units of ...
1622 <li>Roles are shareable between unrelated classes</li>
1623 <li>Roles are what a class <em>does</em>, not what it <em>is</em></li>
1624 <li>Roles <em>add</em> functionality, inheritance <em>specializes</em></li>
1629 <h1>Abstract Examples</h1>
1632 <li>Human <em>@ISA</em> Animal</li>
1633 <li>Human <em>does</em> Toolmaker (as <em>does</em> Chimpanzee)</li>
1634 <li>Car <em>@ISA</em> Vehicle</li>
1635 <li>Car <em>does</em> HasEngine</li>
1640 <h1>Real Examples</h1>
1643 <li>Objects representing SQL database components and queries
1645 <li>Schema, Table, Column, ColumnAlias</li>
1646 <li>Select, Insert, Update, Delete</li>
1653 <h1>Real Examples</h1>
1656 <li>Column and ColumnAlias both <em>do</em> ColumnLike</li>
1657 <li>ColumnLike things can be used in certain parts of queries</li>
1658 <li>All queries <em>do</em> HasWhereClause</li>
1659 <li>Select <em>does</em> Comparable and Selectable (for subselects)</li>
1660 <li>A where clause requires its components to <em>do</em> Comparable</li>
1665 <h1>Roles Summary</h1>
1668 <li>Roles can define an interface with <code>requires</code></li>
1669 <li>Roles can have state (attributes) and behavior (methods)</li>
1670 <li>Roles can mix interface, state, & behavior</li>
1671 <li>Roles are composed (flattened) into classes</li>
1672 <li>Roles can do other roles</li>
1673 <li>Roles can be used as a type in APIs (must do Comparable)</li>
1685 # perl bin/prove -lv t/02-roles.t
1687 Iterate til this passes all its tests</pre>
1690 <div class="slide fake-slide0">
1691 <h1>Part 3: Basic Attributes</h1>
1695 <h1>Attributes Are Huge</h1>
1698 <li>Moose's biggest feature</li>
1699 <li>The target of <em>many</em> MooseX modules</li>
1704 <h1>Quick Review</h1>
1707 <li>Declared with <code>has</code></li>
1708 <li>Read-only or read-write</li>
1711 <pre><code>package Shirt;
1714 has 'color' => ( is => 'ro' );
1715 has 'is_ripped' => ( is => 'rw' );</code></pre>
1719 <h1>Required-ness</h1>
1722 <li>Required means "must be passed to the constructor"</li>
1723 <li>But can be <code>undef</code></li>
1728 <h1>Required-ness</h1>
1730 <pre><code>package Person;
1733 has first_name => (
1735 <span class="current incremental">required => 1,</span>
1738 <span class="incremental">Person->new( first_name => undef ); # ok
1739 Person->new(); # kaboom</span></code></pre>
1743 <h1>Default and Builder</h1>
1746 <li>Attributes can have defaults</li>
1747 <li>Simple non-reference scalars (number, string)</li>
1748 <li>Subroutine reference</li>
1749 <li>A builder method</li>
1757 <li>Can be a non-reference scalar (including <code>undef</code>)</li>
1760 <pre><code>package Person;
1765 default => 'Spire FCU',
1773 <li>Can be a subroutine reference</li>
1776 <pre><code>package Person;
1783 name => 'Spire FCU' ) },
1788 <h1>Subroutine Reference Default</h1>
1791 <li>Called as a method on the object</li>
1792 <li>Called anew for each object</li>
1797 <h1>Why No Other Reference Types?</h1>
1799 <pre><code>package Person;
1804 <span class="wrong">default => Bank->new(
1805 name => 'Spire FCU' ),</span>
1809 <li>Now <strong>every</strong> person shares the <strong>same</strong> Bank object!</li>
1814 <h1>Defaulting to an Empty Reference</h1>
1816 <pre><code>package Person;
1819 has packages => (
1821 default => <span class="highlight">sub { [] }</span>,
1826 <h1>What if I Want to Share?</h1>
1828 <pre><code>package Person;
1831 my $highlander_bank =
1833 name => 'Clan MacLeod Trust' );
1837 default => sub { $highlander_bank },
1845 <li>A method <em>name</em></li>
1846 <li>When called, this method returns the default value</li>
1853 <pre><code>package Person;
1858 builder => '_build_bank',
1863 return Bank->new(
1864 name => 'Spire FCU' );
1869 <h1>Default vs Builder</h1>
1872 <li>Use default for simple scalars</li>
1873 <li>Use default to return empty references</li>
1874 <li>Use default for <em>very</em> trivial subroutine references</li>
1875 <li>Use builder for everything else</li>
1880 <h1>Builder Bonuses</h1>
1883 <li>Can be overridden and method modified, because it's called by <em>name</em></li>
1884 <li>Roles can require a builder</li>
1889 <h1>Role Requires Builder</h1>
1891 <pre><code>package HasBank;
1894 requires '_build_bank';
1898 builder => '_build_bank',
1903 <h1>Lazy, Good for Nothin' Attributes</h1>
1906 <li>Normally, defaults are generated during object construction</li>
1907 <li>This can be expensive</li>
1908 <li>We want to default to <code>$self->size * 2</code>, but attribute initialization order is unpredictable</li>
1909 <li>Use lazy attributes!</li>
1914 <h1>The Power of Dynamic Defaults</h1>
1916 <pre><code>package Person;
1919 has shoe_size => (
1926 <h1>The Power of Dynamic Defaults</h1>
1928 <pre><code>has shoes => (
1930 <span class="highlight">lazy => 1,</span>
1931 builder => '_build_shoes',
1937 return Shoes->new(
1938 size => <span class="highlight">$self->shoe_size</span> );
1943 <h1>Lazy is Good</h1>
1946 <li>Lazy defaults are executed when the attribute is read</li>
1947 <li>Can see other object attributes</li>
1948 <li>Still need to watch out for circular laziness</li>
1953 <h1>Clearer and Predicate</h1>
1956 <li>Attributes can have a value, including <code>undef</code>, or not</li>
1957 <li>Can clear the value with a clearer method</li>
1958 <li>Can check for the existence of a value with a predicate method</li>
1959 <li>By default, these methods are not created</li>
1964 <h1>Clearer and Predicate</h1>
1966 <pre><code>package Person;
1972 builder => '_build_account',
1973 <span class="highlight">clearer => '_clear_account',
1974 predicate => 'has_account',</span>
1979 <h1>Clearer and Lazy Defaults</h1>
1982 <li>Lazy defaults are good for computed attributes</li>
1983 <li>Clear the attribute when the source data changes</li>
1984 <li>Recalculated at next access</li>
1989 <h1>Renaming constructor arguments</h1>
1992 <li>By default, constructor names = attribute names</li>
1993 <li>Use <code>init_arg</code> to change this</li>
1994 <li>Set <code>init_arg => undef</code> to make it unconstructable</li>
1999 <h1>Some <code>init_arg</code> examples</h1>
2001 <pre><code>package Person;
2006 <span class="highlight">init_arg => 'foot_size',</span>
2009 Person->new( <span class="wrong">shoe_size => 13</span> );
2012 Person->new( <span class="right">foot_size => 13</span> );
2013 print $person->shoe_size;</code></pre>
2017 <h1>Some <code>init_arg</code> examples</h1>
2019 <pre><code>package Person;
2024 <span class="highlight">init_arg => undef,</span>
2027 Person->new( <span class="wrong">shoes => Shoes->new</span> );</code></pre>
2031 <h1>Why Set <code>init_arg => undef</code>?</h1>
2034 <li>Use this with a lazy default for attributes-as-cache</li>
2035 <li>Compute the value as needed</li>
2036 <li>Ensure that it is always generated correctly (not set by constructor)</li>
2037 <li>Use triggers or method modifiers (coming soon) to clear the value</li>
2042 <h1>Attribute Inheritance</h1>
2045 <li>By default, subclasses inherit attribute as-is</li>
2046 <li>Can change some attribute parameters in subclasses
2052 <li>others we've not yet covered</li>
2059 <h1>Attribute Inheritance Example</h1>
2061 <pre><code>package Employee;
2066 has '<span class="highlight">+first_name</span>' => (
2067 default => 'Joe',
2072 <h1>Attribute Inheritance Warning</h1>
2075 <li>An attribute is a contract about a class's API</li>
2076 <li>Don't break that contract in a subclass</li>
2077 <li>Especially important in the context of types</li>
2082 <h1>Changing Accessor Names</h1>
2084 <pre><code>package Person;
2087 has first_name => (
2088 <span class="highlight">accessor</span> => 'first_name',
2092 <li>The long-hand version of <code>is => 'rw'</code></li>
2097 <h1>Changing Accessor Names</h1>
2099 <pre><code>package Person;
2102 has first_name => (
2103 <span class="highlight">reader</span> => 'first_name',
2104 <span class="highlight">writer</span> => undef,
2108 <li>The long-hand version of <code>is => 'ro'</code></li>
2114 <h1>Changing Accessor Names</h1>
2116 <pre><code>package Person;
2119 has first_name => (
2120 <span class="highlight">reader</span> => 'get_first_name',
2121 <span class="highlight">writer</span> => 'set_first_name',
2126 <h1>Changing Accessor Names</h1>
2128 <pre><code>package Person;
2131 has first_name => (
2132 <span class="highlight">is</span> => 'rw',
2133 <span class="highlight">writer</span> => '_first_name',
2137 <li>Can also mix-and-match <code>is</code> and explicit names</li>
2142 <h1>ETOOMUCHTYPING</h1>
2145 <li><code>MooseX::FollowPBP</code><br /><code>get_foo</code> and <code>set_foo</code></li>
2146 <li><code>MooseX::SemiAffordanceAccessor</code><br /><code>foo</code> and <code>set_foo</code></li>
2151 <h1>ETOOMUCHTYPING</h1>
2153 <pre><code>package Person;
2155 <span class="highlight">use MooseX::SemiAffordanceAccessor;</span>
2157 has first_name => (
2162 <li>Creates <code>first_name</code> and <code>set_first_name</code></li>
2167 <h1>Basic Attributes Summary</h1>
2170 <li>Attributes can be <code>required</code></li>
2171 <li>Attributes can have a <code>default</code> or <code>builder</code></li>
2172 <li>Attributes with a default or builder can be <code>lazy</code></li>
2173 <li>Attributes can have a <code>clearer</code> and/or <code>predicate</code></li>
2178 <h1>Basic Attributes Summary</h1>
2181 <li>An attribute's constructor name can be changed with <code>init_arg</code></li>
2182 <li>A subclass can alter its parents' attributes</li>
2183 <li>Attribute accessor names can be changed</li>
2195 # perl bin/prove -lv \
2196 t/03-basic-attributes.t
2198 Iterate til this passes all its tests</pre>
2201 <div class="slide fake-slide0">
2202 <h1>Part 4: Method Modifiers</h1>
2206 <h1>What is a Method Modifier</h1>
2209 <li>Apply to an existing method</li>
2210 <li>... that comes from a parent class, the current class, or a role</li>
2211 <li>Roles can provide modifiers that are applied at composition time</li>
2216 <h1>What Are Method Modifiers For?</h1>
2219 <li>"Inject" behavior</li>
2220 <li>Add behavior to generated methods (accessors, delegations)</li>
2221 <li>Added from a role, can modify existing behavior</li>
2226 <h1>Before and After</h1>
2229 <li>Simplest modifiers - <code>before</code> and <code>after</code></li>
2230 <li>Guess when they run!</li>
2235 <h1>Uses for <code>before</code></h1>
2238 <li>As a pre-call check</li>
2241 <pre><code>package Person;
2244 before work => sub {
2246 die 'I have no job!'
2247 unless $self->has_title;
2252 <h1>Uses for <code>before</code></h1>
2255 <li>Logging/Debugging</li>
2258 <pre><code>package Person;
2261 before work => sub {
2263 return unless $DEBUG;
2265 warn "Called work on ",
2266 $self->full_name,
2267 "with the arguments: [@_]\n";
2272 <h1>Uses for <code>after</code></h1>
2275 <li>Also works for logging/debugging</li>
2276 <li>Post-X side-effects (recording audit info)</li>
2279 <pre><code>package Person;
2282 after work => sub {
2284 $self->work_count(
2285 $self->work_count + 1 );
2293 <li>Modifiers are useful for adding behavior to generated methods</li>
2298 <h1>More Modifier Examples</h1>
2300 <pre><code>has password => (
2302 clearer => 'clear_password',
2304 has hashed_password => (
2306 builder => '_build_hashed_password',
2307 clearer => '_clear_hashed_password',
2309 after clear_password => sub {
2311 $self->_clear_hashed_password;
2316 <h1><code>before</code> and <code>after</code> Limitations</h1>
2319 <li>Cannot alter method parameters</li>
2320 <li>Cannot alter return value</li>
2321 <li>But <strong>can</strong> throw an exception</li>
2326 <h1>The <code>around</code> Modifier</h1>
2329 <li>The big gun</li>
2330 <li>Can alter parameters <strong>and/or</strong> return values</li>
2331 <li>Can skip calling the wrapped method entirely</li>
2336 <h1>The power of <code>around</code></h1>
2338 <pre><code>around insert => sub {
2342 $self->_validate_insert(@_);
2346 $self->_munge_insert(@_) );
2348 $new_user->_assign_uri;
2354 <h1>Modifier Order</h1>
2357 <li>Before runs in order from last to first</li>
2358 <li>After runs in order from first to last</li>
2359 <li>Around runs in order from last to first</li>
2364 <h1>Modifier Order Illustrated</h1>
2367 <span class="current incremental">before 2
2369 <span class="incremental">around 2
2371 <span class="incremental">wrapped method</span>
2372 <span class="incremental">around 1
2374 <span class="incremental">after 1
2380 <h1>Modifiers in Roles</h1>
2383 <li>Roles can use these modifiers</li>
2384 <li>Very powerful!</li>
2389 <h1>Modifiers in Roles</h1>
2391 <pre><code>package IsUnreliable;
2394 <span class="highlight">requires 'run';
2396 around run</span> => sub {
2400 return if rand(1) < 0.5;
2402 return $self->$orig(@_);
2407 <h1>Augment and Inner</h1>
2410 <li>Inverted <code>super</code></li>
2411 <li>From least- to most-specific</li>
2412 <li>Like Mason's autohandler feature</li>
2413 <li>Grandparent to parent to child</li>
2414 <li>Not allowed in roles</li>
2419 <h1>Augment and Inner</h1>
2421 <pre class="medium"><code>package Document;
2423 sub xml { '<doc>' . <span class="highlight">inner()</span> . '</doc>' }
2427 <span class="highlight">augment xml</span> =>
2428 sub { my $self = shift;
2429 $self->title() . <span class="highlight">inner()</span> . $self->summary() };
2433 <span class="highlight">augment xml</span> =>
2434 sub { my $self = shift;
2435 $self->tps_xml() . <span class="highlight">inner()</span> };</code></pre>
2439 <h1>Augment and Inner</h1>
2442 <li>When we call <code>$tps->xml</code> ...
2444 <li><code>Document->xml</code></li>
2445 <li><code>Report->xml</code></li>
2446 <li><code>TPSReport->xml</code></li>
2453 <h1>Augment and Inner Usage</h1>
2456 <li>Call <code>inner()</code> to "fill in the blank"</li>
2457 <li>Requires designing for subclassing</li>
2458 <li>Call <code>inner()</code> in the terminal class, just in case</li>
2463 <h1>Method Modifiers Summary</h1>
2466 <li>Use <code>before</code> and <code>after</code> for ...
2469 <li>pre- or post-validation</li>
2470 <li>to add behavior to generated methods</li>
2473 <li>These two modifiers cannot change parameters or return values</li>
2478 <h1>Method Modifiers Summary</h1>
2481 <li>Use <code>around</code> to ...
2483 <li>alter parameters passed to the original method</li>
2484 <li>alter the return value of the original method</li>
2485 <li>not call the original method at all (or call a <em>different</em> method)</li>
2492 <h1>Method Modifiers Summary</h1>
2495 <li>When using modifiers in a role, require the modified method</li>
2496 <li>Use <code>augment</code> and <code>inner</code> to invert the normal subclassing flow ...
2498 <li>Least- to most-specific (parents to children)</li>
2499 <li>Build in "insertability" (stick more stuff in the "middle")</li>
2502 <li>Always call <code>inner</code> in the most specific subclass to allow for future extension</li>
2514 # perl bin/prove -lv \
2515 t/04-method-modifiers.t
2517 Iterate til this passes all its tests</pre>
2520 <div class="slide fake-slide0">
2521 <h1>Part 5: Types</h1>
2525 <h1>A Type System for Perl</h1>
2528 <li>Sort of ...</li>
2529 <li><em>Variables</em> are not typed</li>
2530 <li>Attributes can have types</li>
2531 <li>MooseX modules let you define method signatures</li>
2536 <h1>Components of a Moose Type</h1>
2539 <li>A type is a name and a constraint</li>
2540 <li>Types have a hierarchy</li>
2541 <li>Constraints are cumulative from parents</li>
2542 <li>Types can have associated coercions</li>
2547 <h1>Built-in Type Hierarchy</h1>
2566 <h1>Built-in Type Hierarchy</h1>
2600 <li>Like Perl's <code>if ($foo)</code></li>
2605 <h1>Value (and subtypes)</h1>
2608 <li><code>Value</code> is true when <code>! ref $thing</code></li>
2609 <li><code>Value</code> and <code>Str</code> are effectively the same, but <code>Str</code> is more expressive</li>
2610 <li><code>Num</code> is true when a <code>$scalar</code> looks like a number</li>
2611 <li>An overloaded object which numifies does not pass the <code>Num</code> constraint!</li>
2612 <li>Perl 5's overloading is hopelessly broken</li>
2617 <h1>ClassName and RoleName</h1>
2620 <li>A string with a package name</li>
2621 <li>The package <strong>must already be loaded</strong></li>
2626 <h1>Parameterizable Types</h1>
2629 <li>What does <code>ArrayRef[`a]</code> mean?</li>
2630 <li><code>s/`a/Int/</code> (or <code>Str</code> or ...)</li>
2631 <li>When you use it you can write ...
2633 <li><code>ArrayRef</code> (== <code>ArrayRef[Item]</code>)</li>
2634 <li><code>ArrayRef[Str]</code></li>
2635 <li><code>ArrayRef[MyTypeName]</code></li>
2636 <li><code>ArrayRef[HashRef[Maybe[Int]]]</code></li>
2646 <li>Maybe means either the named type or <code>undef</code></li>
2647 <li><code>Maybe[Int]</code> accepts integers or <code>undef</code></li>
2655 <li>This or that (or that or ...)</li>
2656 <li><code>Int | ArrayRef[Int]</code></li>
2657 <li>But use a coercion instead when possible</li>
2658 <li>Or use a <code>role_type</code>, <code>duck_type</code>, or anything not a union</li>
2659 <li>A union is often a code smell</li>
2664 <h1>Making Your Own Types</h1>
2666 <pre><code>use Moose::Util::TypeConstraints;
2668 <span class="incremental current">subtype 'PositiveInt',</span>
2669 <span class="incremental">as 'Int',</span>
2670 <span class="incremental">where { $_ > 0 },</span>
2671 <span class="incremental">message
2672 { "The value you provided ($_)"
2673 . " was not a positive int." };</span>
2677 <span class="incremental">isa => 'PositiveInt',</span>
2682 <h1>Automatic Types</h1>
2685 <li>Moose creates a type for every Moose class and role</li>
2686 <li>Unknown names are assumed to be classes</li>
2691 <h1>Automatic Types</h1>
2693 <pre><code>package Employee;
2698 <span class="highlight">isa => 'Employee',</span>
2701 has start_date => (
2703 <span class="highlight">isa => 'DateTime',</span>
2708 <h1>Subtype Shortcuts - <code>class_type</code></h1>
2710 <pre><code>use Moose::Util::TypeConstraints;
2711 class_type 'DateTime';</code></pre>
2715 <pre><code>subtype 'DateTime',
2717 where { $_->isa('DateTime') },
2718 message { ... };</code></pre>
2722 <h1>Subtype Shortcuts - <code>role_type</code></h1>
2724 <pre><code>use Moose::Util::TypeConstraints;
2725 role_type 'Printable';</coe></pre>
2729 <pre><code>subtype 'Printable',
2732 { Moose::Util::does_role(
2733 $_, 'Printable' ) },
2734 message { ... };</code></pre>
2738 <h1>Subtype Shortcuts - <code>duck_type</code></h1>
2740 <pre><code>use Moose::Util::TypeConstraints;
2741 duck_type Car => qw( run break_down );</code></pre>
2745 <pre><code>subtype 'Car',
2747 where { all { $_->can($_) }
2748 qw( run break_down ) },
2749 message { ... };</code></pre>
2753 <h1>Subtype Shortcuts - <code>enum</code></h1>
2755 <pre><code>use Moose::Util::TypeConstraints;
2756 enum Color => qw( red blue green );</code></pre>
2760 <pre><code>my %ok = map { $_ => 1 }
2761 qw( red blue green );
2766 message { ... };</code></pre>
2770 <h1>Anonymous Subtypes</h1>
2772 <pre><code>package Person;
2774 <span class="highlight">my $posint =
2775 subtype as 'Int', where { $_ > 0 };</span>
2779 <span class="highlight">isa => $posint,</span>
2783 <li>Shortcuts have anonymous forms as well</li>
2790 <pre><code>use Moose::Util::TypeConstraints;
2794 where { ! /[a-z]/ };</code></pre>
2800 <pre><code><span class="incremental current">coerce 'UCStr',</span>
2801 <span class="incremental">from 'Str',</span>
2802 <span class="incremental">via { uc };</span>
2804 has shouty_name => (
2807 <span class="incremental">coerce => 1,</span>
2812 <h1>Coercion Examples</h1>
2814 <pre><code>subtype 'My::DateTime',
2815 as class_type 'DateTime';
2817 coerce 'My::DateTime',
2819 via { DateTime->new( %{$_} ) };
2821 coerce 'My::DateTime',
2823 via { DateTime->from_epoch(
2824 epoch => $_ ) };</code></pre>
2827 <li>Use coercion to inflate a value</li>
2832 <h1>Coercion Examples</h1>
2834 <pre><code>coerce 'ArrayRef[Int]',
2836 via { [ $_ ] };</code></pre>
2839 <li>Instead of union - <code style="white-space: nowrap">Int | ArrayRef[Int]</code></li>
2844 <h1>Using Types with Attributes</h1>
2846 <pre><code>package Person;
2850 <span class="highlight">isa => 'Num',</span>
2853 has favorite_numbers => (
2855 <span class="highlight">isa => 'ArrayRef[Int]',
2856 coerce => 1,</span>
2861 <h1>More Droppings</h1>
2864 <li><code>Moose::Util::TypeConstraints</code> also needs cleanup</li>
2867 <pre><code>package Person;
2870 use Moose::Util::TypeConstraints;
2875 <span class="highlight">no Moose::Util::TypeConstraints;</span></code></pre>
2879 <h1>Questions So Far?</h1>
2886 # perl bin/prove -lv t/05-types.t
2888 Iterate til this passes all its tests</pre>
2892 <h1>Typed Methods (Low-tech)</h1>
2894 <pre class="medium"><code>package Person;
2895 <span class="highlight">use MooseX::Params::Validate qw( validated_list );</span>
2899 <span class="highlight">my ( $tasks, $can_rest ) =
2903 { isa => 'ArrayRef[Task]',
2914 <h1>Typed Methods (High-tech)</h1>
2916 <pre class="medium"><code>package Person;
2918 <span class="highlight">use MooseX::Method::Signatures;</span>
2920 <span class="highlight">method work ( ArrayRef[Task] :$tasks,
2921 Bool :$can_rest = 0 )</span> {
2929 <h1>Digression: The Type Registry</h1>
2932 <li>Types are actually <code>Moose::Meta::TypeConstraints</code> <em>objects</em></li>
2933 <li>Stored in an interpreter-global registry mapping names to objects</li>
2941 <li>Coercions are attached to type objects</li>
2942 <li>Therefore also global</li>
2943 <li>Name conflicts between modules!</li>
2944 <li>Coercion conflicts between modules!</li>
2949 <h1>Namespace Fix</h1>
2952 <li>Use some sort of pseudo-namespacing scheme</li>
2953 <li>Never coerce directly to a class name, or <em>to</em> built-in types</li>
2958 <h1>Namespace Fix</h1>
2960 <pre><code>use Moose::Util::TypeConstraints;
2961 subtype <span class="highlight">'MyApp::Type::DateTime',</span>
2964 <span class="highlight">coerce 'MyApp::Type::DateTime',</span>
2966 via { DateTime->new( %{$_} ) }
2968 has creation_date => (
2970 <span class="highlight">isa => 'MyApp::Type::DateTime',</span>
2976 <h1>Namespace Fix</h1>
2978 <pre><code>subtype 'MyApp::Type::ArrayOfInt',
2981 coerce 'MyApp::Type::ArrayOfInt',
2983 via { [ $_ ] };</code></pre>
2987 <h1>Namespace Fix Pros and Cons</h1>
2990 <li><span class="right">Relatively simple</span></li>
2991 <li><span class="right">Already built into Moose</span></li>
2992 <li><span class="wrong">Conflates type and module namespaces</span></li>
2993 <li><span class="wrong">Type names are strings, so typos are easy to make and may be hard to find</span></li>
2998 <h1>MooseX::Types</h1>
3000 <pre><code>package MyApp::Types;
3003 <span class="highlight">-declare => [ qw( ArrayOfInt ) ]</span>;
3004 use MooseX::Types::Moose
3007 subtype <span class="highlight">ArrayOfInt</span>,
3010 coerce <span class="highlight">ArrayOfInt</span>
3012 via { [ $_ ] };</code></pre>
3016 <h1>MooseX::Types</h1>
3018 <pre><code>package MyApp::Account;
3020 use MyApp::Types qw( ArrayOfInt );
3022 has transaction_history => (
3029 <h1>MooseX::Types</h1>
3032 <li>Type names are exported functions, catches typos early</li>
3033 <li>Types must be pre-declared</li>
3034 <li>Types are stored with namespaces internally, but you use short names</li>
3035 <li>Import existing Moose types as functions from <code>MooseX::Types::Moose</code></li>
3036 <li>Still need string names for things like <code>ArrayRef['Email::Address']</code></li>
3041 <h1>MooseX::Types Pros and Cons</h1>
3044 <li><span class="right">Catches typos at compile time</span></li>
3045 <li><span class="right">Automatic namespacing</span></li>
3046 <li><span class="wrong">One more thing to install and learn</span></li>
3047 <li><span class="wrong">Every name is typed twice (declared and then defined)</span></li>
3048 <li><span class="wrong">Still stuck with strings when referring to class or role names</span></li>
3049 <li><span class="wrong">Coercion gotcha from earlier still applies to types exported from <code>MooseX::Types::Moose</code></span></li>
3054 <h1>Recommendation</h1>
3057 <li>Use <code>MooseX::Types</code></li>
3058 <li>Compile time error catching and automatic namespacing are huge wins</li>
3059 <li>Docs from <code>Moose::Util::TypeConstraints</code> are 98% compatible with <code>MooseX::Types</code> anyway</li>
3060 <li>A function exported by a type library works wherever a type name would</li>
3068 <div class="slide fake-slide0">
3069 <h1>Part 6: Advanced Attributes</h1>
3073 <h1>Weak References</h1>
3076 <li>A weak reference lets you avoid circular references</li>
3077 <li>Weak references do not increase the reference count</li>
3082 <h1>Circular Reference Illustrated</h1>
3084 <pre><code>my $foo = {};
3085 my $bar = { foo => $foo };
3086 $foo->{bar} = $bar;</code></pre>
3089 <li>Neither <code>$foo</code> nor <code>$bar</code> go out of scope<br />
3090 (until the program exits)</li>
3095 <h1>Weakening Circular References</h1>
3097 <pre><code>use Scalar::Util qw( weaken );
3100 my $bar = { foo => $foo };
3101 $foo->{bar} = $bar;
3102 weaken $foo->{bar}</code></pre>
3105 <li>When <code>$bar</code> goes out of scope, <code>$foo->{bar}</code> becomes <code>undef</code></li>
3110 <h1>Circular References in Attributes</h1>
3112 <pre><code>package Person;
3115 has name => ( is => 'ro' );
3116 has friend => ( is => 'rw' );
3118 my $alice = Person->new( name => 'Alice' );
3119 my $bob = Person->new( name => 'Bob' );
3120 $bob->friend($alice);
3121 $alice->friend($bob);</code></pre>
3127 <pre><code>package Person;
3130 has name => ( is => 'ro' );
3131 has friend => ( is => 'rw',
3132 <span class="highlight">weak_ref => 1</span> );
3134 my $alice = Person->new( name => 'Alice' );
3135 my $bob = Person->new( name => 'Bob' );
3136 $bob->friend($alice);
3137 $alice->friend($bob);</code></pre>
3141 <h1>Under the Hood</h1>
3144 <li>A <code>weak_ref</code> attribute calls <code>weaken</code> ...
3146 <li>during object construction</li>
3147 <li>when the attribute is set via a writer</li>
3157 <li>A code reference run after an attribute is <em>set</em></li>
3158 <li>Like an <code>after</code> modifier, but makes intentions clearer</li>
3161 <h2 class="wrong">Gross</h2>
3163 <pre><code>after salary_level => {
3165 <span class="highlight">return unless @_;</span>
3166 $self->clear_salary;
3171 <h1>Use a Trigger Instead</h1>
3173 <h2 class="right">Cleaner</h2>
3175 <pre><code>has salary_level => (
3178 sub { $_[0]->clear_salary },
3183 <h1>Trigger Arguments</h1>
3186 <li><code>$self</code></li>
3187 <li><code>$new_value</code></li>
3188 <li><code>$old_value</code> - if one exists</li>
3196 <li>Attributes can be objects</li>
3197 <li>Delegation transparently calls methods on those objects</li>
3202 <h1>Delegation Examples</h1>
3204 <pre><code>package Person;
3209 <span class="highlight">handles => [ 'inhale', 'exhale' ],</span>
3213 <li>Creates <code>$person->inhale</code> and <code>->exhale</code> methods</li>
3214 <li>Internally calls <code>$person->lungs->inhale</code></li>
3219 <h1>Why Delegation?</h1>
3222 <li>Reduce the number of classes exposed</li>
3223 <li>Re-arrange class internals -<br />
3224 turn a method into an attribute with delegation</li>
3225 <li>Provide convenenience methods</li>
3230 <h1>Moose's <code>handles</code> Parameter</h1>
3233 <li>Accepts many arguments ...
3235 <li>Array reference - list of methods to delegate as-is</li>
3236 <li>Hash reference - map of method names</li>
3237 <li>Regex - delegates all matching methods</li>
3238 <li>Role name - delegates all methods in the role</li>
3239 <li>Sub reference - does something complicated ;)</li>
3246 <h1>Array Reference</h1>
3249 <li>1-to-1 mapping</li>
3250 <li>Takes each method name and creates a simple delegation from the delegating class to the delegatee attribute</li>
3255 <h1>Hash Reference</h1>
3258 <li>Mapping of names in the delegating class to the delegatee class</li>
3261 <pre><code>package Person;
3265 isa => 'BankAccount',
3266 <span class="highlight">handles => {
3267 receive_money => 'deposit',
3268 give_money => 'withdraw',
3274 <h1>Hash Reference Detailed</h1>
3276 <pre><code> handles => {
3277 receive_money => 'deposit',
3278 give_money => 'withdraw',
3282 <li><code>$person->receive_money</code> = <code>$person->account->deposit</code></li>
3283 <li><code>$person->give_money</code> = <code>$person->account->withdraw</code></li>
3290 <pre><code>package Person;
3296 handles => qr/.*/,
3300 <li>Creates a delegation for every method in the Name class</li>
3301 <li>Excludes <code>meta</code> and methods inherited from <code>Moose::Object</code></li>
3308 <pre><code>package Auditor;
3310 sub record_change { ... }
3311 sub change_history { ... }
3318 does => 'Auditor',
3319 <span class="highlight">handles => 'Auditor',</span>
3324 <h1>Role Name Detailed</h1>
3327 <li>Account gets delegate methods for each method in the <code>Auditor</code> role
3329 <li>record_history</li>
3330 <li>change_history</li>
3337 <h1>Native Delegation</h1>
3340 <li>Delegate to <em>unblessed</em> Perl types</li>
3341 <li>Scalar, array or hash ref, etc</li>
3342 <li>Treat Perl types as objects</li>
3343 <li>Still uses <code>handles</code></li>
3344 <li>Pretend that native Perl types have methods</li>
3349 <h1>Native Delegation - Array(Ref)</h1>
3352 <li>Methods include:
3354 <li><code>push</code></li>
3355 <li><code>shift</code></li>
3356 <li><code>elements</code> - returns all elements</li>
3357 <li><code>count</code></li>
3358 <li><code>is_empty</code></li>
3359 <li>quite a few more</li>
3366 <h1>Native Delegation - Array(Ref)</h1>
3368 <pre><code>package Person;
3370 has _favorite_numbers => (
3371 traits => [ 'Array' ],
3373 isa => 'ArrayRef[Int]',
3374 default => sub { [] },
3375 init_arg => undef,
3376 <span class="highlight">handles =>
3377 { favorite_numbers => 'elements',
3378 add_favorite_number => 'push',
3384 <h1>Native Delegation - Array(Ref)</h1>
3386 <pre><code>my $person = Person->new();
3388 $person->add_favorite_number(7);
3389 $person->add_favorite_number(42);
3392 for $person->favorite_numbers;
3399 <h1>Native Delegation</h1>
3402 <li>Native types are ...
3404 <li>Number - <code>add</code>, <code>mul</code>, ...</li>
3405 <li>String - <code>append</code>, <code>chop</code>, ...</li>
3406 <li>Counter - <code>inc</code>, <code>dec</code>, ...</li>
3407 <li>Bool - <code>set</code>, <code>toggle</code>, ...</li>
3408 <li>Hash - <code>get</code>, <code>set</code>, ...</li>
3409 <li>Array - already saw it</li>
3410 <li>Code - <code>execute</code> and <code>execute_method</code></li>
3417 <h1>Curried Delegation</h1>
3420 <li>A delegation with some preset arguments</li>
3421 <li>Works with object or Native delegation</li>
3426 <h1>Curried Delegation</h1>
3428 <pre><code>package Person;
3432 isa => 'BankAccount',
3435 <span class="highlight">[ 'deposit', 100 ]</span>
3437 <span class="highlight">[ 'withdraw', 100 ]</span>
3443 <h1>Curried Delegation</h1>
3445 <pre><code>$person->receive_100;
3447 $person->account->deposit(100);</code></pre>
3451 <h1>Traits and Metaclasses</h1>
3454 <li>The ultimate in customization</li>
3455 <li>Per attribute metaclasses</li>
3456 <li>Per attribute roles applied to the attribute metaclass</li>
3457 <li>Change the meta-level behavior</li>
3462 <h1>Traits and Metaclasses</h1>
3465 <li>The default metaclass is <code>Moose::Meta::Attribute</code></li>
3466 <li>Controls accessor generation, defaults, delegation, etc.</li>
3467 <li>Adding a role to this metaclass (or replacing it) allows for infinite customization</li>
3472 <h1>Traits and Metaclasses</h1>
3475 <li>Can add/alter/remove an attribute parameter (from <code>has</code>)</li>
3476 <li>Can change behavior of created attribute</li>
3481 <h1>Simple Trait Example</h1>
3483 <pre><code>package Person;
3485 use MooseX::LabeledAttributes;
3488 <span class="highlight">traits => [ 'Labeled' ],</span>
3491 <span class="highlight">label => 'Social Security Number',</span>
3493 print <span class="highlight">Person->meta
3494 ->get_attribute('ssn')->label;</span></code></pre>
3498 <h1>Simple Metaclass Example</h1>
3500 <pre><code>package Person;
3502 use MooseX::LabeledAttributes;
3505 <span class="highlight">metaclass =>
3506 'MooseX::Meta::Attribute::Labeled',</span>
3509 <span class="highlight">label => 'Social Security Number',</span>
3511 print <span class="highlight">Person->meta
3512 ->get_attribute('ssn')->label;</span></code></pre>
3516 <h1>Traits vs Metaclass</h1>
3519 <li>Can apply any mix of traits to an attribute</li>
3520 <li>But just one metaclass</li>
3521 <li>Traits (aka roles) can cooperate</li>
3522 <li>Metaclasses require you to pick just one</li>
3527 <h1>Advanced Attributes Summary</h1>
3530 <li>Use <code>weak_ref</code> to avoid circular references</li>
3531 <li>Use trigger to do an action post-attribute write</li>
3532 <li>Use delegations to hide "internal" objects</li>
3533 <li>Use native delegations to treat Perl types as objects</li>
3534 <li>Traits and metaclasses let you extend Moose's core attribute features</li>
3542 # perl bin/prove -lv \
3543 t/06-advanced-attributes.t
3545 Iterate til this passes all its tests</pre>
3552 If there is time, keep going ...
3556 Otherwise, jump to slide 269 ...
3560 <div class="slide fake-slide0">
3561 <h1>Bonus: A Brief Tour of MooseX</h1>
3565 <h1>Notable MX Modules on CPAN</h1>
3568 <li><strong>Not comprehensive</strong></li>
3569 <li>152 MooseX distributions on CPAN as of 02/02/2010</li>
3570 <li>Some of them are crap</li>
3575 <h1>Already Mentioned Several</h1>
3578 <li><code>MooseX::NonMoose</code> - best solution for subclassing non-Moose parents</li>
3579 <li><code>MooseX::Declare</code> - <em>real</em> Perl 5 OO</li>
3580 <li><code>MooseX::FollowPBP</code> and <code>MooseX::SemiAffordanceAccessor</code></li>
3581 <li><code>MooseX::Params::Validate</code> and <code>MooseX::Method::Signatures</code></li>
3582 <li><code>MooseX::Types</code></li>
3587 <h1>MooseX::Declare</h1>
3589 <pre><code>use MooseX::Declare;
3590 use 5.10.0; # for say
3594 ( is => 'ro', isa => 'Str' );
3597 say $self->greeting;
3603 <h1>MooseX::Declare</h1>
3606 <li>Still experimental-ish, but seeing more and more use</li>
3607 <li><strong>Not</strong> a source filter!</li>
3608 <li>Hooks into the Perl parser rather than filtering all your code</li>
3609 <li>But not supported by <code>PPI</code>, <code>perltidy</code>, etc.</li> (yet?)
3614 <h1>MooseX::StrictConstructor</h1>
3617 <li>By default, unknown constructor arguments are ignored</li>
3618 <li>MX::StrictConstructor turns these into an error</li>
3623 <h1>MooseX::StrictConstructor</h1>
3625 <pre><code>package Person;
3628 <span class="highlight">use MooseX::StrictConstructor;</span>
3630 has name => ( is => 'ro' );
3633 ( na<span class="wrong">n</span>e => 'Ringo Shiina' ); # kaboom</code></pre>
3637 <h1>MooseX::Traits</h1>
3640 <li>Combines object construction and role application</li>
3641 <li>Makes it easy to create one-off customized objects</li>
3646 <h1>MooseX::Traits</h1>
3648 <pre><code>package MyApp::Thingy;
3651 <span class="highlight">with 'MooseX::Traits';</span>
3654 MyApp::Thingy-><span class="highlight">new_with_traits</span>
3655 ( <span class="highlight">traits => [ 'Foo', 'Bar' ],</span>
3656 size => 42 );</code></pre>
3660 <h1>MooseX::Getopt</h1>
3663 <li>Makes command-line interface programs easy!</li>
3664 <li>Construct an object from CLI arguments</li>
3669 <h1>MooseX::Getopt</h1>
3671 <pre><code>package App::CLI;
3674 <span class="highlight">with 'MooseX::Getopt';</span>
3677 ( is => 'ro', required => 1 );
3679 ( is => 'ro', isa => 'ArrayRef[Str]' );
3681 sub run { ... }</code></pre>
3685 <h1>MooseX::Getopt</h1>
3688 <li>Then call it like this:</li>
3691 <pre><code>#!/usr/bin/perl
3695 <span class="highlight">App::CLI->new_with_options()</span>->run();</code></pre>
3699 --filters compress \
3700 --filters sanitize</pre>
3704 <h1>MooseX::Clone</h1>
3706 <pre><code>package Person;
3709 <span class="highlight">with 'MooseX::Clone';</span>
3711 my $person = Person->new;
3712 my $clone = <span class="highlight">$person->clone;</span></code></pre>
3716 <h1>MooseX::NonMoose</h1>
3719 <li>Highly recommended for subclassing non-Moose parents</li>
3720 <li>Gets all the little annoying details right</li>
3725 <h1>MooseX::Role::Parameterized</h1>
3727 <pre><code>package HasCollection;
3728 <span class="current incremental">use MooseX::Role::Parameterized;</span>
3729 <span class="incremental">parameter type => ( isa => 'Str',
3730 default => 'Item' );</span>
3731 <span class="incremental">role {
3735 'ArrayRef[' . $p->type() . ']';
3736 has collection =>
3739 };</span></code></pre>
3743 <h1>MooseX::Role::Parameterized</h1>
3745 <pre><code>package Person;
3748 with HasCollection => { type => 'Int' };</code></pre>
3756 <h1>Moose-using Modules</h1>
3759 For further reading, a few modules which use Moose ...
3763 <li><a href="http://search.cpan.org/dist/Catalyst-Runtime">Catalyst</a></li>
3764 <li><a href="http://search.cpan.org/dist/CHI">CHI</a></li>
3765 <li><a href="http://search.cpan.org/dist/Devel-REPL">Devel::REPL</a></li>
3766 <li><a href="http://search.cpan.org/dist/Email-Sender">Email::Sender</a></li>
3767 <li><a href="http://search.cpan.org/dist/Fey">Fey</a></li>
3768 <li><a href="http://search.cpan.org/dist/Net-Twitter">Net::Twitter</a></li>
3773 <h1>More Information</h1>
3776 <li><a href="http://moose.perl.org/">http://moose.perl.org/</a></li>
3777 <li><a href="http://search.cpan.org/dist/Moose/lib/Moose/Manual.pod">Moose::Manual</a> and <a href="http://search.cpan.org/dist/Moose/lib/Moose/Cookbook.pod">Moose::Cookbook</a></li>
3778 <li><a href="irc://irc.perl.org/#moose">irc://irc.perl.org/#moose</a></li>
3779 <li>mailing list - <a href="mailto:moose@perl.org">moose@perl.org</a></li>
3780 <li>Slides and exercises are in Moose's git repo:
3782 <span style="font-size:80%; white-space: nowrap">git://jules.scsys.co.uk/gitmo/moose-presentations</span></li>
3786 <div class="slide fake-slide0">
3796 Copyright 2009 David Rolsky. All Rights Reserved.
3798 This work is licensed under a Creative Commons Attribution-Share Alike
3799 3.0 United States License See
3800 http://creativecommons.org/licenses/by-sa/3.0/us/ for details.