{ "content": [ { "type": "text", "text": "# Moose (man)\n\n## NAME\n\nMoose - A postmodern object system for Perl 5\n\n## SYNOPSIS\n\npackage Point;\nuse Moose; # automatically turns on strict and warnings\nhas 'x' => (is => 'rw', isa => 'Int');\nhas 'y' => (is => 'rw', isa => 'Int');\nsub clear {\nmy $self = shift;\n$self->x(0);\n$self->y(0);\n}\npackage Point3D;\nuse Moose;\nextends 'Point';\nhas 'z' => (is => 'rw', isa => 'Int');\nafter 'clear' => sub {\nmy $self = shift;\n$self->z(0);\n};\n\n## DESCRIPTION\n\nMoose is an extension of the Perl 5 object system.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION** (2 subsections)\n- **TRANSLATIONS**\n- **BUILDING CLASSES WITH MOOSE**\n- **PROVIDED METHODS**\n- **EXPORTED FUNCTIONS** (13 subsections)\n- **METACLASS** (1 subsections)\n- **UNIMPORTING FUNCTIONS** (1 subsections)\n- **EXTENDING AND EMBEDDING MOOSE** (1 subsections)\n- **METACLASS COMPATIBILITY AND MOOSE**\n- **CAVEATS**\n- **GETTING HELP** (1 subsections)\n- **ACKNOWLEDGEMENTS**\n- **SEE ALSO** (2 subsections)\n- **BUGS**\n- **FEATURE REQUESTS**\n- **CABAL**\n- **CONTRIBUTORS**\n- **AUTHORS**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Moose", "section": "", "mode": "man", "summary": "Moose - A postmodern object system for Perl 5", "synopsis": "package Point;\nuse Moose; # automatically turns on strict and warnings\nhas 'x' => (is => 'rw', isa => 'Int');\nhas 'y' => (is => 'rw', isa => 'Int');\nsub clear {\nmy $self = shift;\n$self->x(0);\n$self->y(0);\n}\npackage Point3D;\nuse Moose;\nextends 'Point';\nhas 'z' => (is => 'rw', isa => 'Int');\nafter 'clear' => sub {\nmy $self = shift;\n$self->z(0);\n};", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 24, "subsections": [] }, { "name": "DESCRIPTION", "lines": 10, "subsections": [ { "name": "New to Moose?", "lines": 7 }, { "name": "Moose Extensions", "lines": 5 } ] }, { "name": "TRANSLATIONS", "lines": 7, "subsections": [] }, { "name": "BUILDING CLASSES WITH MOOSE", "lines": 13, "subsections": [] }, { "name": "PROVIDED METHODS", "lines": 21, "subsections": [] }, { "name": "EXPORTED FUNCTIONS", "lines": 3, "subsections": [ { "name": "extends (@superclasses)", "lines": 15 }, { "name": "with (@roles)", "lines": 17 }, { "name": "has $name|@$names => %options", "lines": 207 }, { "name": "has +$name => %options", "lines": 62 }, { "name": "before $name|@names|\\@names|qr/.../ => sub { ... }", "lines": 1 }, { "name": "after $name|@names|\\@names|qr/.../ => sub { ... }", "lines": 1 }, { "name": "around $name|@names|\\@names|qr/.../ => sub { ... }", "lines": 4 }, { "name": "override ($name, &sub)", "lines": 5 }, { "name": "super", "lines": 4 }, { "name": "augment ($name, &sub)", "lines": 4 }, { "name": "inner", "lines": 5 }, { "name": "blessed", "lines": 3 }, { "name": "confess", "lines": 2 } ] }, { "name": "METACLASS", "lines": 7, "subsections": [ { "name": "Metaclass and Trait Name Resolution", "lines": 16 } ] }, { "name": "UNIMPORTING FUNCTIONS", "lines": 1, "subsections": [ { "name": "unimport", "lines": 17 } ] }, { "name": "EXTENDING AND EMBEDDING MOOSE", "lines": 6, "subsections": [ { "name": "The MooseX:: namespace", "lines": 6 } ] }, { "name": "METACLASS COMPATIBILITY AND MOOSE", "lines": 20, "subsections": [] }, { "name": "CAVEATS", "lines": 12, "subsections": [] }, { "name": "GETTING HELP", "lines": 8, "subsections": [ { "name": "WHAT DOES MOOSE STAND FOR?", "lines": 23 } ] }, { "name": "ACKNOWLEDGEMENTS", "lines": 9, "subsections": [] }, { "name": "SEE ALSO", "lines": 21, "subsections": [ { "name": "Books", "lines": 4 }, { "name": "Papers", "lines": 5 } ] }, { "name": "BUGS", "lines": 9, "subsections": [] }, { "name": "FEATURE REQUESTS", "lines": 9, "subsections": [] }, { "name": "CABAL", "lines": 4, "subsections": [] }, { "name": "CONTRIBUTORS", "lines": 98, "subsections": [] }, { "name": "AUTHORS", "lines": 20, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 8, "subsections": [] } ], "sections": { "NAME": { "content": "Moose - A postmodern object system for Perl 5\n", "subsections": [] }, "VERSION": { "content": "version 2.2200\n", "subsections": [] }, "SYNOPSIS": { "content": "package Point;\nuse Moose; # automatically turns on strict and warnings\n\nhas 'x' => (is => 'rw', isa => 'Int');\nhas 'y' => (is => 'rw', isa => 'Int');\n\nsub clear {\nmy $self = shift;\n$self->x(0);\n$self->y(0);\n}\n\npackage Point3D;\nuse Moose;\n\nextends 'Point';\n\nhas 'z' => (is => 'rw', isa => 'Int');\n\nafter 'clear' => sub {\nmy $self = shift;\n$self->z(0);\n};\n", "subsections": [] }, "DESCRIPTION": { "content": "Moose is an extension of the Perl 5 object system.\n\nThe main goal of Moose is to make Perl 5 Object Oriented programming easier, more consistent,\nand less tedious. With Moose you can think more about what you want to do and less about the\nmechanics of OOP.\n\nAdditionally, Moose is built on top of Class::MOP, which is a metaclass system for Perl 5.\nThis means that Moose not only makes building normal Perl 5 objects better, but it provides\nthe power of metaclass programming as well.\n", "subsections": [ { "name": "New to Moose?", "content": "If you're new to Moose, the best place to start is the Moose::Manual docs, followed by the\nMoose::Cookbook. The intro will show you what Moose is, and how it makes Perl 5 OO better.\n\nThe cookbook recipes on Moose basics will get you up to speed with many of Moose's features\nquickly. Once you have an idea of what Moose can do, you can use the API documentation to get\nmore detail on features which interest you.\n" }, { "name": "Moose Extensions", "content": "The \"MooseX::\" namespace is the official place to find Moose extensions. These extensions\ncan be found on the CPAN. The easiest way to find them is to search for them\n(), or to examine Task::Moose which aims to keep an\nup-to-date, easily installable list of Moose extensions.\n" } ] }, "TRANSLATIONS": { "content": "Much of the Moose documentation has been translated into other languages.\n\nJapanese\nJapanese docs can be found at\n. The source POD files\ncan be found in GitHub: \n", "subsections": [] }, "BUILDING CLASSES WITH MOOSE": { "content": "Moose makes every attempt to provide as much convenience as possible during class\nconstruction/definition, but still stay out of your way if you want it to. Here are a few\nitems to note when building classes with Moose.\n\nWhen you \"use Moose\", Moose will set the class's parent class to Moose::Object, unless the\nclass using Moose already has a parent class. In addition, specifying a parent with \"extends\"\nwill change the parent class.\n\nMoose will also manage all attributes (including inherited ones) that are defined with \"has\".\nAnd (assuming you call \"new\", which is inherited from Moose::Object) this includes properly\ninitializing all instance slots, setting defaults where appropriate, and performing any type\nconstraint checking or coercion.\n", "subsections": [] }, "PROVIDED METHODS": { "content": "Moose provides a number of methods to all your classes, mostly through the inheritance of\nMoose::Object. There is however, one exception. By default, Moose will install a method named\n\"meta\" in any class which uses \"Moose\". This method returns the current class's metaclass.\n\nIf you'd like to rename this method, you can do so by passing the \"-metaname\" option when\nusing Moose:\n\nuse Moose -metaname => 'mymeta';\n\nHowever, the Moose::Object class also provides a method named \"meta\" which does the same\nthing. If your class inherits from Moose::Object (which is the default), then you will still\nhave a \"meta\" method. However, if your class inherits from a parent which provides a \"meta\"\nmethod of its own, your class will inherit that instead.\n\nIf you'd like for Moose to not install a meta method at all, you can pass \"undef\" as the\n\"-metaname\" option:\n\nuse Moose -metaname => undef;\n\nAgain, you will still inherit \"meta\" from Moose::Object in this case.\n", "subsections": [] }, "EXPORTED FUNCTIONS": { "content": "Moose will export a number of functions into the class's namespace which may then be used to\nset up the class. These functions all work directly on the current class.\n", "subsections": [ { "name": "extends (@superclasses)", "content": "This function will set the superclass(es) for the current class. If the parent classes are\nnot yet loaded, then \"extends\" tries to load them.\n\nThis approach is recommended instead of \"use base\"/\"use parent\", because \"use base\" actually\n\"push\"es onto the class's @ISA, whereas \"extends\" will replace it. This is important to\nensure that classes which do not have superclasses still properly inherit from Moose::Object.\n\nEach superclass can be followed by a hash reference with options. Currently, only -version is\nrecognized:\n\nextends 'My::Parent' => { -version => 0.01 },\n'My::OtherParent' => { -version => 0.03 };\n\nAn exception will be thrown if the version requirements are not satisfied.\n" }, { "name": "with (@roles)", "content": "This will apply a given set of @roles to the local class.\n\nLike with \"extends\", each specified role can be followed by a hash reference with a -version\noption:\n\nwith 'My::Role' => { -version => 0.32 },\n'My::Otherrole' => { -version => 0.23 };\n\nThe specified version requirements must be satisfied, otherwise an exception will be thrown.\n\nIf your role takes options or arguments, they can be passed along in the hash reference as\nwell.\n\nYou should only use one \"with\", even if you are consuming multiple roles. If you consume\nroles using multiple \"with\" statements Moose cannot detect method conflicts between those\nroles.\n" }, { "name": "has $name|@$names => %options", "content": "This will install an attribute of a given $name into the current class. If the first\nparameter is an array reference, it will create an attribute for every $name in the list. The\n%options will be passed to the constructor for Moose::Meta::Attribute (which inherits from\nClass::MOP::Attribute), so the full documentation for the valid options can be found there.\nThese are the most commonly used options:\n\nis => 'rw'|'ro'\nThe is option accepts either rw (for read/write) or ro (for read only). These will create\neither a read/write accessor or a read-only accessor respectively, using the same name as\nthe $name of the attribute.\n\nIf you need more control over how your accessors are named, you can use the reader,\nwriter and accessor options inherited from Class::MOP::Attribute, however if you use\nthose, you won't need the is option.\n\nisa => $typename\nThe isa option uses Moose's type constraint facilities to set up runtime type checking\nfor this attribute. Moose will perform the checks during class construction, and within\nany accessors. The $typename argument must be a string. The string may be either a class\nname or a type defined using Moose's type definition features. (Refer to\nMoose::Util::TypeConstraints for information on how to define a new type, and how to\nretrieve type meta-data).\n\ncoerce => (1|0)\nThis will attempt to use coercion with the supplied type constraint to change the value\npassed into any accessors or constructors. You must supply a type constraint, and that\ntype constraint must define a coercion. See\nMoose::Cookbook::Basics::HTTPSubtypesAndCoercion for an example.\n\ndoes => $rolename\nThis will accept the name of a role which the value stored in this attribute is expected\nto have consumed.\n\nrequired => (1|0)\nThis marks the attribute as being required. This means a value must be supplied during\nclass construction, or the attribute must be lazy and have either a default or a builder.\nNote that \"required\" does not say anything about the attribute's value, which can be\n\"undef\".\n\nweakref => (1|0)\nThis will tell the class to store the value of this attribute as a weakened reference. If\nan attribute is a weakened reference, it cannot also be coerced. Note that when a weak\nref expires, the attribute's value becomes undefined, and is still considered to be set\nfor purposes of predicate, default, etc.\n\nlazy => (1|0)\nThis will tell the class to not create this slot until absolutely necessary. If an\nattribute is marked as lazy it must have a default or builder supplied.\n\ntrigger => $code\nThe trigger option is a CODE reference which will be called after the value of the\nattribute is set. The CODE ref is passed the instance itself, the updated value, and the\noriginal value if the attribute was already set.\n\nYou can have a trigger on a read-only attribute.\n\nNOTE: Triggers will only fire when you assign to the attribute, either in the\nconstructor, or using the writer. Default and built values will not cause the trigger to\nbe fired.\n\nhandles => ARRAY | HASH | REGEXP | ROLE | ROLETYPE | DUCKTYPE | CODE\nThe handles option provides Moose classes with automated delegation features. This is a\npretty complex and powerful option. It accepts many different option formats, each with\nits own benefits and drawbacks.\n\nNOTE: The class being delegated to does not need to be a Moose based class, which is why\nthis feature is especially useful when wrapping non-Moose classes.\n\nAll handles option formats share the following traits:\n\nYou cannot override a locally defined method with a delegated method; an exception will\nbe thrown if you try. That is to say, if you define \"foo\" in your class, you cannot\noverride it with a delegated \"foo\". This is almost never something you would want to do,\nand if it is, you should do it by hand and not use Moose.\n\nYou cannot override any of the methods found in Moose::Object, or the \"BUILD\" and\n\"DEMOLISH\" methods. These will not throw an exception, but will silently move on to the\nnext method in the list. My reasoning for this is that you would almost never want to do\nthis, since it usually breaks your class. As with overriding locally defined methods, if\nyou do want to do this, you should do it manually, not with Moose.\n\nYou do not need to have a reader (or accessor) for the attribute in order to delegate to\nit. Moose will create a means of accessing the value for you, however this will be\nseveral times less efficient then if you had given the attribute a reader (or accessor)\nto use.\n\nBelow is the documentation for each option format:\n\n\"ARRAY\"\nThis is the most common usage for handles. You basically pass a list of method names\nto be delegated, and Moose will install a delegation method for each one.\n\n\"HASH\"\nThis is the second most common usage for handles. Instead of a list of method names,\nyou pass a HASH ref where each key is the method name you want installed locally, and\nits value is the name of the original method in the class being delegated to.\n\nThis can be very useful for recursive classes like trees. Here is a quick example\n(soon to be expanded into a Moose::Cookbook recipe):\n\npackage Tree;\nuse Moose;\n\nhas 'node' => (is => 'rw', isa => 'Any');\n\nhas 'children' => (\nis => 'ro',\nisa => 'ArrayRef',\ndefault => sub { [] }\n);\n\nhas 'parent' => (\nis => 'rw',\nisa => 'Tree',\nweakref => 1,\nhandles => {\nparentnode => 'node',\nsiblings => 'children',\n}\n);\n\nIn this example, the Tree package gets \"parentnode\" and \"siblings\" methods, which\ndelegate to the \"node\" and \"children\" methods (respectively) of the Tree instance\nstored in the \"parent\" slot.\n\nYou may also use an array reference to curry arguments to the original method.\n\nhas 'thing' => (\n...\nhandles => { setfoo => [ set => 'foo' ] },\n);\n\n# $self->setfoo(...) calls $self->thing->set('foo', ...)\n\nThe first element of the array reference is the original method name, and the rest is\na list of curried arguments.\n\n\"REGEXP\"\nThe regexp option works very similar to the ARRAY option, except that it builds the\nlist of methods for you. It starts by collecting all possible methods of the class\nbeing delegated to, then filters that list using the regexp supplied here.\n\nNOTE: An isa option is required when using the regexp option format. This is so that\nwe can determine (at compile time) the method list from the class. Without an isa\nthis is just not possible.\n\n\"ROLE\" or \"ROLETYPE\"\nWith the role option, you specify the name of a role or a role type whose \"interface\"\nthen becomes the list of methods to handle. The \"interface\" can be defined as; the\nmethods of the role and any required methods of the role. It should be noted that\nthis does not include any method modifiers or generated attribute methods (which is\nconsistent with role composition).\n\n\"DUCKTYPE\"\nWith the duck type option, you pass a duck type object whose \"interface\" then becomes\nthe list of methods to handle. The \"interface\" can be defined as the list of methods\npassed to \"ducktype\" to create a duck type object. For more information on\n\"ducktype\" please check Moose::Util::TypeConstraints.\n\n\"CODE\"\nThis is the option to use when you really want to do something funky. You should only\nuse it if you really know what you are doing, as it involves manual metaclass\ntwiddling.\n\nThis takes a code reference, which should expect two arguments. The first is the\nattribute meta-object this handles is attached to. The second is the metaclass of the\nclass being delegated to. It expects you to return a hash (not a HASH ref) of the\nmethods you want mapped.\n\ntraits => [ @rolenames ]\nThis tells Moose to take the list of @rolenames and apply them to the attribute meta-\nobject. Custom attribute metaclass traits are useful for extending the capabilities of\nthe has keyword: they are the simplest way to extend the MOP, but they are still a fairly\nadvanced topic and too much to cover here.\n\nSee \"Metaclass and Trait Name Resolution\" for details on how a trait name is resolved to\na role name.\n\nAlso see Moose::Cookbook::Meta::LabeledAttributeTrait for a metaclass trait example.\n\nbuilder => Str\nThe value of this key is the name of the method that will be called to obtain the value\nused to initialize the attribute. See the builder option docs in Class::MOP::Attribute\nand/or Moose::Cookbook::Basics::BinaryTreeBuilderAndLazyBuild for more information.\n\ndefault => SCALAR | CODE\nThe value of this key is the default value which will initialize the attribute.\n\nNOTE: If the value is a simple scalar (string or number), then it can be just passed as\nis. However, if you wish to initialize it with a HASH or ARRAY ref, then you need to\nwrap that inside a CODE reference. See the default option docs in Class::MOP::Attribute\nfor more information.\n\nclearer => Str\nCreates a method allowing you to clear the value. See the clearer option docs in\nClass::MOP::Attribute for more information.\n\npredicate => Str\nCreates a method to perform a basic test to see if a value has been set in the attribute.\nSee the predicate option docs in Class::MOP::Attribute for more information.\n\nNote that the predicate will return true even for a \"weakref\" attribute whose value has\nexpired.\n\ndocumentation => $string\nAn arbitrary string that can be retrieved later by calling \"$attr->documentation\".\n" }, { "name": "has +$name => %options", "content": "This is variation on the normal attribute creator \"has\" which allows you to clone and extend\nan attribute from a superclass or from a role. Here is an example of the superclass usage:\n\npackage Foo;\nuse Moose;\n\nhas 'message' => (\nis => 'rw',\nisa => 'Str',\ndefault => 'Hello, I am a Foo'\n);\n\npackage My::Foo;\nuse Moose;\n\nextends 'Foo';\n\nhas '+message' => (default => 'Hello I am My::Foo');\n\nWhat is happening here is that My::Foo is cloning the \"message\" attribute from its parent\nclass Foo, retaining the \"is => 'rw'\" and \"isa => 'Str'\" characteristics, but changing the\nvalue in \"default\".\n\nHere is another example, but within the context of a role:\n\npackage Foo::Role;\nuse Moose::Role;\n\nhas 'message' => (\nis => 'rw',\nisa => 'Str',\ndefault => 'Hello, I am a Foo'\n);\n\npackage My::Foo;\nuse Moose;\n\nwith 'Foo::Role';\n\nhas '+message' => (default => 'Hello I am My::Foo');\n\nIn this case, we are basically taking the attribute which the role supplied and altering it\nwithin the bounds of this feature.\n\nNote that you can only extend an attribute from either a superclass or a role, you cannot\nextend an attribute in a role that composes over an attribute from another role.\n\nAside from where the attributes come from (one from superclass, the other from a role), this\nfeature works exactly the same. This feature is restricted somewhat, so as to try and force\nat least some sanity into it. Most options work the same, but there are some exceptions:\n\nreader\nwriter\naccessor\nclearer\npredicate\nThese options can be added, but cannot override a superclass definition.\n\ntraits\nYou are allowed to add additional traits to the \"traits\" definition. These traits will\nbe composed into the attribute, but preexisting traits are not overridden, or removed.\n" }, { "name": "before $name|@names|\\@names|qr/.../ => sub { ... }", "content": "" }, { "name": "after $name|@names|\\@names|qr/.../ => sub { ... }", "content": "" }, { "name": "around $name|@names|\\@names|qr/.../ => sub { ... }", "content": "These three items are syntactic sugar for the before, after, and around method modifier\nfeatures that Class::MOP provides. More information on these may be found in\nMoose::Manual::MethodModifiers and the Class::MOP::Class documentation.\n" }, { "name": "override ($name, &sub)", "content": "An \"override\" method is a way of explicitly saying \"I am overriding this method from my\nsuperclass\". You can call \"super\" within this method, and it will work as expected. The same\nthing can be accomplished with a normal method call and the \"SUPER::\" pseudo-package; it is\nreally your choice.\n" }, { "name": "super", "content": "The keyword \"super\" is a no-op when called outside of an \"override\" method. In the context of\nan \"override\" method, it will call the next most appropriate superclass method with the same\narguments as the original method.\n" }, { "name": "augment ($name, &sub)", "content": "An \"augment\" method, is a way of explicitly saying \"I am augmenting this method from my\nsuperclass\". Once again, the details of how \"inner\" and \"augment\" work is best described in\nthe Moose::Cookbook::Basics::DocumentAugmentAndInner.\n" }, { "name": "inner", "content": "The keyword \"inner\", much like \"super\", is a no-op outside of the context of an \"augment\"\nmethod. You can think of \"inner\" as being the inverse of \"super\"; the details of how \"inner\"\nand \"augment\" work is best described in the\nMoose::Cookbook::Basics::DocumentAugmentAndInner.\n" }, { "name": "blessed", "content": "This is the \"Scalar::Util::blessed\" function. It is highly recommended that this is used\ninstead of \"ref\" anywhere you need to test for an object's class name.\n" }, { "name": "confess", "content": "This is the \"Carp::confess\" function, and exported here for historical reasons.\n" } ] }, "METACLASS": { "content": "When you use Moose, you can specify traits which will be applied to your metaclass:\n\nuse Moose -traits => 'My::Trait';\n\nThis is very similar to the attribute traits feature. When you do this, your class's \"meta\"\nobject will have the specified traits applied to it.\n", "subsections": [ { "name": "Metaclass and Trait Name Resolution", "content": "By default, when given a trait name, Moose simply tries to load a class of the same name. If\nsuch a class does not exist, it then looks for a class matching\nMoose::Meta::$type::Custom::Trait::$traitname. The $type variable here will be one of\nAttribute or Class, depending on what the trait is being applied to.\n\nIf a class with this long name exists, Moose checks to see if it has the method\n\"registerimplementation\". This method is expected to return the real class name of the\ntrait. If there is no \"registerimplementation\" method, it will fall back to using\nMoose::Meta::$type::Custom::Trait::$trait as the trait name.\n\nThe lookup method for metaclasses is the same, except that it looks for a class matching\nMoose::Meta::$type::Custom::$metaclassname.\n\nIf all this is confusing, take a look at Moose::Cookbook::Meta::LabeledAttributeTrait, which\ndemonstrates how to create an attribute trait.\n" } ] }, "UNIMPORTING FUNCTIONS": { "content": "", "subsections": [ { "name": "unimport", "content": "Moose offers a way to remove the keywords it exports, through the \"unimport\" method. You\nsimply have to say \"no Moose\" at the bottom of your code for this to work. Here is an\nexample:\n\npackage Person;\nuse Moose;\n\nhas 'firstname' => (is => 'rw', isa => 'Str');\nhas 'lastname' => (is => 'rw', isa => 'Str');\n\nsub fullname {\nmy $self = shift;\n$self->firstname . ' ' . $self->lastname\n}\n\nno Moose; # keywords are removed from the Person package\n" } ] }, "EXTENDING AND EMBEDDING MOOSE": { "content": "To learn more about extending Moose, we recommend checking out the \"Extending\" recipes in the\nMoose::Cookbook, starting with Moose::Cookbook::Extending::ExtensionOverview, which provides\nan overview of all the different ways you might extend Moose. Moose::Exporter and\nMoose::Util::MetaRole are the modules which provide the majority of the extension\nfunctionality, so reading their documentation should also be helpful.\n", "subsections": [ { "name": "The MooseX:: namespace", "content": "Generally if you're writing an extension for Moose itself you'll want to put your extension\nin the \"MooseX::\" namespace. This namespace is specifically for extensions that make Moose\nbetter or different in some fundamental way. It is traditionally not for a package that just\nhappens to use Moose. This namespace follows from the examples of the \"LWPx::\" and \"DBIx::\"\nnamespaces that perform the same function for \"LWP\" and \"DBI\" respectively.\n" } ] }, "METACLASS COMPATIBILITY AND MOOSE": { "content": "Metaclass compatibility is a thorny subject. You should start by reading the \"About Metaclass\ncompatibility\" section in the Class::MOP docs.\n\nMoose will attempt to resolve a few cases of metaclass incompatibility when you set the\nsuperclasses for a class, in addition to the cases that Class::MOP handles.\n\nMoose tries to determine if the metaclasses only \"differ by roles\". This means that the\nparent and child's metaclass share a common ancestor in their respective hierarchies, and\nthat the subclasses under the common ancestor are only different because of role\napplications. This case is actually fairly common when you mix and match various \"MooseX::*\"\nmodules, many of which apply roles to the metaclass.\n\nIf the parent and child do differ by roles, Moose replaces the metaclass in the child with a\nnewly created metaclass. This metaclass is a subclass of the parent's metaclass which does\nall of the roles that the child's metaclass did before being replaced. Effectively, this\nmeans the new metaclass does all of the roles done by both the parent's and child's original\nmetaclasses.\n\nUltimately, this is all transparent to you except in the case of an unresolvable conflict.\n", "subsections": [] }, "CAVEATS": { "content": "It should be noted that \"super\" and \"inner\" cannot be used in the same method. However, they\nmay be combined within the same class hierarchy; see t/basics/overrideaugmentinnersuper.t\nfor an example.\n\nThe reason for this is that \"super\" is only valid within a method with the \"override\"\nmodifier, and \"inner\" will never be valid within an \"override\" method. In fact, \"augment\"\nwill skip over any \"override\" methods when searching for its appropriate \"inner\".\n\nThis might seem like a restriction, but I am of the opinion that keeping these two features\nseparate (yet interoperable) actually makes them easy to use, since their behavior is then\neasier to predict. Time will tell whether I am right or not (UPDATE: so far so good).\n", "subsections": [] }, "GETTING HELP": { "content": "We offer both a mailing list and a very active IRC channel.\n\nThe mailing list is . You must be subscribed to send a message. To\nsubscribe, send an empty message to \n\nYou can also visit us at \"#moose\" on This channel is quite\nactive, and questions at all levels (on Moose-related topics ;) are welcome.\n", "subsections": [ { "name": "WHAT DOES MOOSE STAND FOR?", "content": "Moose doesn't stand for one thing in particular, however, if you want, here are a few of our\nfavorites. Feel free to contribute more!\n\n• Make Other Object Systems Envious\n\n• Makes Object Orientation So Easy\n\n• Makes Object Orientation Spiffy- Er (sorry ingy)\n\n• Most Other Object Systems Emasculate\n\n• Moose Often Ovulate Sorta Early\n\n• Moose Offers Often Super Extensions\n\n• Meta Object Obligates Salivary Excitation\n\n• Meta Object Orientation Syntax Extensions\n\n• Moo, Only Overengineered, Slow, and Execrable (blame rjbs!)\n\n• Massive Object-Oriented Stacktrace Emitter\n" } ] }, "ACKNOWLEDGEMENTS": { "content": "I blame Sam Vilain for introducing me to the insanity that is meta-models.\nI blame Audrey Tang for then encouraging my meta-model habit in #perl6.\nWithout Yuval \"nothingmuch\" Kogman this module would not be possible, and it certainly\nwouldn't have this name ;P\nThe basis of the TypeContraints module was Rob Kinyon's idea originally, I just ran with it.\nThanks to mst & chansen and the whole #moose posse for all the early\nideas/feature-requests/encouragement/bug-finding.\nThanks to David \"Theory\" Wheeler for meta-discussions and spelling fixes.\n", "subsections": [] }, "SEE ALSO": { "content": "\nThis is the official web home of Moose. It contains links to our public git repository,\nas well as links to a number of talks and articles on Moose and Moose related\ntechnologies.\n\nthe Moose manual\nThis is an introduction to Moose which covers most of the basics.\n\nModern Perl, by chromatic\nThis is an introduction to modern Perl programming, which includes a section on Moose. It\nis available in print and as a free download from\n.\n\nThe Moose is flying, a tutorial by Randal Schwartz\nPart 1 - \n\nPart 2 - \n\nSeveral Moose extension modules in the \"MooseX::\" namespace.\nSee for extensions.\n", "subsections": [ { "name": "Books", "content": "The Art of the MetaObject Protocol\nI mention this in the Class::MOP docs too, as this book was critical in the development\nof both modules and is highly recommended.\n" }, { "name": "Papers", "content": "\nThis paper (suggested by lbr on #moose) was what lead to the implementation of the\n\"super\"/\"override\" and \"inner\"/\"augment\" features. If you really want to understand them,\nI suggest you read this.\n" } ] }, "BUGS": { "content": "All complex software has bugs lurking in it, and this module is no exception.\n\nPlease report any bugs to \"bug-moose@rt.cpan.org\", or through the web interface at\n. You can also submit a \"TODO\" test as a pull request at\n.\n\nYou can also discuss feature requests or possible bugs on the Moose mailing list\n(moose@perl.org) or on IRC at .\n", "subsections": [] }, "FEATURE REQUESTS": { "content": "We are very strict about what features we add to the Moose core, especially the user-visible\nfeatures. Instead we have made sure that the underlying meta-system of Moose is as extensible\nas possible so that you can add your own features easily.\n\nThat said, occasionally there is a feature needed in the meta-system to support your planned\nextension, in which case you should either email the mailing list (moose@perl.org) or join us\non IRC at to discuss. The Moose::Manual::Contributing has more\ndetail about how and when you can contribute.\n", "subsections": [] }, "CABAL": { "content": "There are only a few people with the rights to release a new version of Moose. The Moose\nCabal are the people to go to with questions regarding the wider purview of Moose. They help\nmaintain not just the code but the community as well. See the list below under \"AUTHORS\".\n", "subsections": [] }, "CONTRIBUTORS": { "content": "Moose is a community project, and as such, involves the work of many, many members of the\ncommunity beyond just the members in the cabal. In particular:\n\nDave (autarch) Rolsky wrote most of the documentation in Moose::Manual.\n\nJohn (jgoulah) Goulah wrote Moose::Cookbook::Snack::Keywords.\n\nJess (castaway) Robinson wrote Moose::Cookbook::Snack::Types.\n\nAran (bluefeet) Clary Deltac wrote\nMoose::Cookbook::Basics::GenomeOverloadingSubtypesAndCoercion.\n\nAnders (Debolaz) Nor Berle contributed Test::Moose and Moose::Util.\n\nAlso, the code in Moose::Meta::Attribute::Native is based on code from the\nMooseX::AttributeHelpers distribution, which had contributions from:\n\nChris (perigrin) Prather\n\nCory (gphat) Watson\n\nEvan Carroll\n\nFlorian (rafl) Ragwitz\n\nJason May\n\nJay Hannah\n\nJesse (doy) Luehrs\n\nPaul (frodwith) Driver\n\nRobert (rlb3) Boone\n\nRobert Buels\n\nRobert (phaylon) Sedlacek\n\nShawn (Sartak) Moore\n\nStevan Little\n\nTom (dec) Lanyon\n\nYuval Kogman\n\nFinally, these people also contributed various tests, bug fixes, documentation, and features\nto the Moose codebase:\n\nAankhen\n\nAdam (Alias) Kennedy\n\nChristian (chansen) Hansen\n\nCory (gphat) Watson\n\nDylan Hardison (doc fixes)\n\nEric (ewilhelm) Wilhelm\n\nEvan Carroll\n\nGuillermo (groditi) Roditi\n\nJason May\n\nJay Hannah\n\nJonathan (jrockway) Rockway\n\nMatt (mst) Trout\n\nNathan (kolibrie) Gray\n\nPaul (frodwith) Driver\n\nPiotr (dexter) Roszatycki\n\nRobert Buels\n\nRobert (phaylon) Sedlacek\n\nRobert (rlb3) Boone\n\nSam (mugwump) Vilain\n\nScott (konobi) McWhirter\n\nShlomi (rindolf) Fish\n\nTom (dec) Lanyon\n\nWallace (wreis) Reis\n\n... and many other #moose folks\n", "subsections": [] }, "AUTHORS": { "content": "• Stevan Little \n\n• Dave Rolsky \n\n• Jesse Luehrs \n\n• Shawn M Moore \n\n• יובל קוג'מן (Yuval Kogman) \n\n• Karen Etheridge \n\n• Florian Ragwitz \n\n• Hans Dieter Pearcey \n\n• Chris Prather \n\n• Matt S Trout \n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "This software is copyright (c) 2006 by Infinity Interactive, Inc.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the\nPerl 5 programming language system itself.\n\n\n\nperl v5.34.0 2022-02-06 Moose(3pm)", "subsections": [] } } } }