poet::import(3pm) [debian man page]

Poet::Import(3pm)					User Contributed Perl Documentation					 Poet::Import(3pm)

NAME

       Poet::Import -- Import Poet quick vars and utilities

SYNOPSIS

	   # In a script...
	   use Poet::Script qw($conf $poet $log :file);

	   # In a module...
	   use Poet qw($conf $poet $log :file);

DESCRIPTION

       Poet makes it easy to import certain variables (known as "quick vars") and utility sets into any script or module in your environment.

       In a script:

	   use Poet::Script qw(...);

       and in a module:

	   use Poet qw(...);

       where "..." contains one or more quick var names (e.g. $conf, $poet) and/or utility tags (e.g. ":file", ":web").

       (Note that "use Poet::Script" is also necessary for initializing the environment, even if you don't care to import anything, whereas "use
       Poet" has no effect other than importing.)

QUICK VARS

       Here is the built-in list of quick vars you can import. Some of the variables are singletons, and some of them are specific to each package
       they are imported into.

       $poet
	   The global environment object, provided by Poet::Environment. This provides information such as the root directory and paths to
	   subdirectories.

	   For backward compatibility this is also available as $env.

       $conf
	   The global configuration object, provided by Poet::Conf.

       $cache
	   The cache for the current package, provided by Poet::Cache.

       $log
	   The logger for the current package, provided by Poet::Log.

UTILITIES

   Default utilities
       The utilities in Poet::Util::Debug are always imported, with no tag necessary.

   :file
       This tag imports all the utilities in Poet::Util::File.

   :web
       This tag imports all the utilities in Poet::Util::Web. It is automatically included in all Mason components.

MASON COMPONENTS

       Every Mason component automatically gets this on top:

	   use Poet qw($conf $poet :web);

       "$m->cache" and "$m->log" will get you the cache and log objects for a particular Mason component.

CUSTOMIZING

   Adding variables
       To add your own variable, define a method called provide_var_varname in "MyApp::Import". For example to add a variable $dbh:

	   package MyApp::Import;
	   use Poet::Moose;
	   extends 'Poet::Import';

	   method provide_var_dbh ($caller) {
	       # Generate and return a dbh.
	       # $caller is the package importing the variable.
	       # $poet is the current Poet environment.
	   }

       "provide_dbh" can return a single global value, or a dynamic value depending on $caller.

       Now your scripts and libraries can do

	   use Poet::Script qw($dbh);
	   use Poet qw($dbh);

   Adding utility tags
       To add your own utility tag, define a class "MyApp::Util::Mytagname" that exports a set of functions via the ':all' tag. For example:

	   package MyApp::Util::Hash;
	   use Hash::Util qw(hash_seed all_keys);
	   use Hash::MoreUtils qw(slice slice_def slice_exists);

	   our @EXPORT_OK = qw(hash_seed all_keys slice slice_def slice_exists);
	   our %EXPORT_TAGS = ( 'all' => @EXPORT_OK );

	   1;

       Now your scripts and libraries can do

	   use Poet::Script qw(:hash);
	   use Poet qw(:hash);

SEE ALSO

       Poet

AUTHOR

       Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Jonathan Swartz.

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

perl v5.14.2							    2012-06-05							 Poet::Import(3pm)

Poet::Log(3pm)						User Contributed Perl Documentation					    Poet::Log(3pm)

NAME

       Poet::Log -- Poet logging

SYNOPSIS

	   # In a conf file...
	   log:
	     defaults:
	       level: info
	       output: poet.log
	       layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c - %m - %F:%L - %P%n"
	     category:
	       CHI:
		 level: debug
		 output: chi.log
		 layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m - %P%n"
	       MyApp::Foo:
		 output: stdout

	   # In a script...
	   use Poet::Script qw($log);

	   # In a module...
	   use Poet qw($log);

	   # In a component...
	   my $log = $m->log;

	   # For an arbitrary category...
	   my $log = Poet::Log->get_logger(category => 'MyApp::Bar');

	   # then...
	   $log->error("an error occurred");

	   $log->debugf("arguments are: %s", @_)
	       if $log->is_debug();

DESCRIPTION

       Poet uses Log::Any and Log::Log4perl for logging, with simplified configuration for the common case.

       Log::Any is a logging abstraction that allows CPAN modules to log without knowing about which logging framework is in use. It supports
       standard logging methods ("$log->debug", "$log->is_debug") along with sprintf variants ("$log->debugf").

       Log4perl is a powerful logging package that provides just about any logging-related feature you'd want. One of its only drawbacks is its
       somewhat cumbersome configuration. So, we provide a way to configure Log4perl simply through Poet configuration if you just want common
       features.

       Note: Log4perl is not a strict dependency for Poet.  Log messages will simply not get logged until you install it or until you modify
       logging for your app.

CONFIGURATION

       The configurations below can go in any Poet conf file, e.g. "local.cfg" or "global/log.cfg".

       Here's a simple configuration that caches everything to "logs/poet.log" at "info" level. This is also the default if no configuration is
       present.

	   log:
	     defaults:
	       level: info
	       output: poet.log
	       layout: %d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c - %m - %F:%L - %P%n

       Here's a more involved configuration that maintains the same default, but adds several categories that are logged differently:

	   log:
	     defaults:
	       level: info
	       output: poet.log
	       layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c - %m - %F:%L - %P%n"
	     category:
	       CHI:
		 level: debug
		 output: chi.log
		 layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m - %P%n"
	       MyApp::Foo:
		 output: stdout

       For the default and for each category, you can specify three different settings:

       o   level - one of the valid log4perl levels (fatal, error, warn, info, debug, trace)

       o   output - can be a relative filename (which will be placed in the Poet log directory), an absolute filename, or the special names
	   "stdout" or "stderr"

       o   layout - a valid log4perl PatternLayout string.

       If a setting isn't defined for a specific category then it falls back to the default. In this example, "MyApp::Foo" will inherit the
       default level and layout.

       Notice that we use '::' instead of '.' to specify hierarchical category names, because '.' would interfere with Poet::Conf dot notation.

       Finally, if you must use a full Log4perl configuration file, you can specify it this way:

	   log:
	     log4perl_conf: /path/to/log4perl.conf

USAGE

   Obtaining log handle
       o   In a script (log category will be 'main'):

	       use Poet::Script qw($log);

       o   In a module "MyApp::Foo" (log category will be 'MyApp::Foo'):

	       use Poet qw($log);

       o   In a component "/foo/bar" (log category will be 'Mason::Component::foo::bar'):

	       my $log = $m->log;

       o   Manually for an arbitrary log category:

	       my $log = Poet::Log->get_logger(category => 'Some::Category');

	       # or

	       my $log = MyApp::Log->get_logger(category => 'Some::Category');

   Using log handle
	   $log->error("an error occurred");

	   $log->debugf("arguments are: %s", @_)
	       if $log->is_debug();

       See "Log::Any|Log::Any" for more details.

MODIFIABLE METHODS

       These methods are not intended to be called externally, but may be useful to override or modify with method modifiers in subclasses. Their
       APIs will be kept as stable as possible.

       initialize_logging
	   Called once when the Poet environment is initialized. By default, initializes log4perl with the results of "generate_log4perl_config"
	   and then calls "Log::Any::Adapter->set('Log4perl')".  You can modify this to initialize log4perl in your own way, or use a different
	   Log::Any adapter, or use a completely different logging system.

       generate_log4perl_config
	   Returns a log4perl config string based on Poet configuration. You can modify this to construct and return your own config.

SEE ALSO

       Poet

AUTHOR

       Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Jonathan Swartz.

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

perl v5.14.2							    2012-06-05							    Poet::Log(3pm)