moosex::simpleconfig(3pm) [debian man page]

MooseX::SimpleConfig(3pm)				User Contributed Perl Documentation				 MooseX::SimpleConfig(3pm)

NAME

       MooseX::SimpleConfig - A Moose role for setting attributes from a simple configfile

SYNOPSIS

	 ## A YAML configfile named /etc/my_app.yaml:
	 foo: bar
	 baz: 123

	 ## In your class
	 package My::App;
	 use Moose;

	 with 'MooseX::SimpleConfig';

	 has 'foo' => (is => 'ro', isa => 'Str', required => 1);
	 has 'baz'  => (is => 'rw', isa => 'Int', required => 1);

	 # ... rest of the class here

	 ## in your script
	 #!/usr/bin/perl

	 use My::App;

	 my $app = My::App->new_with_config(configfile => '/etc/my_app.yaml');
	 # ... rest of the script here

	 ####################
	 ###### combined with MooseX::Getopt:

	 ## In your class
	 package My::App;
	 use Moose;

	 with 'MooseX::SimpleConfig';
	 with 'MooseX::Getopt';

	 has 'foo' => (is => 'ro', isa => 'Str', required => 1);
	 has 'baz'  => (is => 'rw', isa => 'Int', required => 1);

	 # ... rest of the class here

	 ## in your script
	 #!/usr/bin/perl

	 use My::App;

	 my $app = My::App->new_with_options();
	 # ... rest of the script here

	 ## on the command line
	 % perl my_app_script.pl -configfile /etc/my_app.yaml -otherthing 123

DESCRIPTION

       This role loads simple configfiles to set object attributes.  It is based on the abstract role MooseX::ConfigFromFile, and uses Config::Any
       to load your configfile.  Config::Any will in turn support any of a variety of different config formats, detected by the file extension.
       See Config::Any for more details about supported formats.

       Like all MooseX::ConfigFromFile -derived configfile loaders, this module is automatically supported by the MooseX::Getopt role as well,
       which allows specifying "-configfile" on the commandline.

ATTRIBUTES

   configfile
       Provided by the base role MooseX::ConfigFromFile.  You can provide a default configfile pathname like so:

	 has '+configfile' => ( default => '/etc/myapp.yaml' );

       You can pass an array of filenames if you want, but as usual the array has to be wrapped in a sub ref.

	 has '+configfile' => ( default => sub { [ '/etc/myapp.yaml', '/etc/myapp_local.yml' ] } );

       Config files are trivially merged at the top level, with the right-hand files taking precedence.

CLASS METHODS

   new_with_config
       Provided by the base role MooseX::ConfigFromFile.  Acts just like regular "new()", but also accepts an argument "configfile" to specify the
       configfile from which to load other attributes.	Explicit arguments to "new_with_config" will override anything loaded from the configfile.

   get_config_from_file
       Called internally by either "new_with_config" or MooseX::Getopt's "new_with_options".  Invokes Config::Any to parse "configfile".

AUTHOR

       Brandon L. Black, <blblack@gmail.com>

LICENSE

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-06-19						 MooseX::SimpleConfig(3pm)

MooseX::ConfigFromFile(3pm)				User Contributed Perl Documentation			       MooseX::ConfigFromFile(3pm)

NAME

       MooseX::ConfigFromFile - An abstract Moose role for setting attributes from a configfile

SYNOPSIS

	 ########
	 ## A real role based on this abstract role:
	 ########

	 package MooseX::SomeSpecificConfigRole;
	 use Moose::Role;

	 with 'MooseX::ConfigFromFile';

	 use Some::ConfigFile::Loader ();

	 sub get_config_from_file {
	   my ($class, $file) = @_;

	   my $options_hashref = Some::ConfigFile::Loader->load($file);

	   return $options_hashref;
	 }

	 ########
	 ## A class that uses it:
	 ########
	 package Foo;
	 use Moose;
	 with 'MooseX::SomeSpecificConfigRole';

	 # optionally, default the configfile:
	 sub configfile { '/tmp/foo.yaml' }

	 # ... insert your stuff here ...

	 ########
	 ## A script that uses the class with a configfile
	 ########

	 my $obj = Foo->new_with_config(configfile => '/etc/foo.yaml', other_opt => 'foo');

DESCRIPTION

       This is an abstract role which provides an alternate constructor for creating objects using parameters passed in from a configuration file.
       The actual implementation of reading the configuration file is left to concrete subroles.

       It declares an attribute "configfile" and a class method "new_with_config", and requires that concrete roles derived from it implement the
       class method "get_config_from_file".

       Attributes specified directly as arguments to "new_with_config" supercede those in the configfile.

       MooseX::Getopt knows about this abstract role, and will use it if available to load attributes from the file specified by the commandline
       flag "--configfile" during its normal "new_with_options".

Attributes
   configfile
       This is a Path::Class::File object which can be coerced from a regular pathname string.	This is the file your attributes are loaded from.
       You can add a default configfile in the class using the role and it will be honored at the appropriate time:

	 has +configfile ( default => '/etc/myapp.yaml' );

       Note that you can alternately just provide a "configfile" method which returns the config file when called - this will be used in
       preference to the default of the attribute.

Class Methods
   new_with_config
       This is an alternate constructor, which knows to look for the "configfile" option in its arguments and use that to set attributes.  It is
       much like MooseX::Getopts's "new_with_options".	Example:

	 my $foo = SomeClass->new_with_config(configfile => '/etc/foo.yaml');

       Explicit arguments will overide anything set by the configfile.

   get_config_from_file
       This class method is not implemented in this role, but it is required of all subroles.  Its two arguments are the classname and the
       configfile, and it is expected to return a hashref of arguments to pass to "new()" which are sourced from the configfile.

COPYRIGHT

       Copyright (c) 2007 - 2009 the MooseX::ConfigFromFile "AUTHOR" and "CONTRIBUTORS" as listed below.

AUTHOR

       Brandon L. Black, <blblack@gmail.com>

CONTRIBUTORS

       Tomas Doran "<bobtfish@bobtfish.net>" (current maintainer).
       Karen Etheridge
       Chris Prather
       Zbigniew Lukasiak

LICENSE

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-17					       MooseX::ConfigFromFile(3pm)