MooseX::Getopt 0.20

MooseX::Getopt is a role which provides an alternate constructor for creating objects using parameters passed in from the command line.<br /><br />This module attempts to DWIM as much as possible with the command line params by introspecting your class's attributes. It will use the name of your attribute as the command line option, and if there is a type constraint defined, it will configure Getopt::Long to handle the option accordingly.<br /><br />You can use the trait MooseX::Getopt::Meta::Attribute::Trait or the attribute metaclass MooseX::Getopt::Meta::Attribute to get non-default commandline option names and aliases.<br /><br />You can use the trait MooseX::Getopt::Meta::Attribute::Trait::NoGetopt or the attribute metaclass MooseX::Getopt::Meta::Attribute::NoGetopt to have MooseX::Getopt ignore your attribute in the commandline options.<br /><br />By default, attributes which start with an underscore are not given commandline argument support, unless the attribute's metaclass is set to MooseX::Getopt::Meta::Attribute. If you don't want you accessors to have the leading underscore in thier name, you can do this:<br /><br /> # for read/write attributes<br /> has '_foo' => (accessor => 'foo', ...);<br /><br /> # or for read-only attributes<br /> has '_bar' => (reader => 'bar', ...);<br /><br />This will mean that Getopt will not handle a --foo param, but your code can still call the foo method.<br /><br />If your class also uses a configfile-loading role based on MooseX::ConfigFromFile, such as MooseX::SimpleConfig, MooseX::Getopt's new_with_options will load the configfile specified by the --configfile option (or the default you've given for the configfile attribute) for you.<br /><br />Options specified in multiple places follow the following precendence order: commandline overrides configfile, which overrides explicit new_with_options parameters.<br /><br />SYNOPSIS<br /><br /> ## In your class<br /> package My::App;<br /> use Moose;<br /><br /> with 'MooseX::Getopt';<br /><br /> has 'out' => (is => 'rw', isa => 'Str', required => 1);<br /> has 'in' => (is => 'rw', isa => 'Str', required => 1);<br /><br /> # ... rest of the class here<br /><br /> ## in your script<br /> #!/usr/bin/perl<br /><br /> use My::App;<br /><br /> my $app = My::App->new_with_options();<br /> # ... rest of the script here<br /><br /> ## on the command line<br /> % perl my_app_script.pl -in file.input -out file.dump<br />

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Attribute,  Attributes,  Class,  Command,  Commandline,  Configfile,  Default,  Handle,  Metaclass,  Moosexgetopt,  Moosexgetopt 0 20,  Myapp,  Option,  Overrides,  Trait
Users rating:	0/10