Ron Savage > Config-Plugin-TinyManifold > Config::Plugin::TinyManifold

Download:
Config-Plugin-TinyManifold-1.01.tgz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.01   Source  

NAME ^

Config::Plugin::TinyManifold - A plugin which uses Config::Tiny with 1 of N sections

Synopsis ^

        package My::App;

        use strict;
        use warnings;

        use Config::Plugin::TinyManifold; # For config_manifold().

        use File::Spec;

        # ------------------------------------------------

        sub marine
        {
                my($self)   = @_;
                my($config) = $self -> config_manifold(File::Spec -> catfile('some', 'dir', 'config.tiny.manifold.ini') );

        } # End of marine.

        # --------------------------------------------------

        1;

t/config.tiny.manifold.ini ships with the Config::Plugin::TinyManifold distro, and is used in the test file t/test.t.

Description ^

When you 'use' this module (as in the Synopsis), it automatically imports into your class the method "config_maifold($file_name)" to give you access to config data stored in an *.ini file.

But more than that, it uses a value from the config file to select 1 of N sections within that file as the whole config. See "config_manifold($file_name)" for details.

Distributions ^

This module is available as a Unix-style distro (*.tgz).

See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing distros.

Installation ^

Install Config::Plugin::TinyManifold as you would for any Perl module:

Run:

        cpanm Config::Plugin::TinyManifold

or run:

        sudo cpan Config::Plugin::TinyManifold

or unpack the distro, and then either:

        perl Build.PL
        ./Build
        ./Build test
        sudo ./Build install

or:

        perl Makefile.PL
        make (or dmake or nmake)
        make test
        make install

Constructor and Initialization ^

This module does not have, and does not need, a constructor.

Methods ^

config_manifold($file_name)

Returns a *.ini-style config file as a hashref.

Here, the [] indicate an optional parameter.

The $file_name is passed to Config::Tiny's read($file_name) method.

It uses a value from the config file to select 1 of N sections within that file as the whole config.

Specifically, the name of the global section is hard-coded as '[global]', and the name of the key within that is hard-coded as 'section'.

So, a sample config file, which ships as t/config.tiny.manifold.ini is:

        [global]

        # The 'section' key:
        # o Specifies which section to use after the [global] section ends.
        # o Case-sensitive options are /^(localhost|webhost)$/.

        section = localhost

        [localhost]

        template_path = /home/ron/assets/templates/CGI/Snapp

        [website]

        template_path = /dev/shm/html/assets/templates/CGI/Snapp

Alternately, you could use sections called [global], [testing] and [production], and so on.

FAQ ^

When would I use this module?

In your sub-class of CGI::Snapp for example, or anywhere else you want effortless access to a *.ini file which contains N alternate sections, and you wish to auto-select 1 of these sections.

For example, if you wish to load a config for use by a module such as Log::Handler::Plugin::DBI, try Config::Plugin::Tiny or Config::Plugin::TinyManifold.

Why didn't you call the exported method config()?

Because "config_manifold($file_name)" allows both Config::Plugin::Tiny and Config::Plugin::TinyManifold to be used in the same code.

Why don't you 'use Exporter;'?

It is not needed; it would be for documentation only.

For the record, Exporter V 5.567 ships with Perl 5.8.0. That's what I had in Build.PL and Makefile.PL until I tested the fact I can omit it.

What's the error message format?

Every message passed to croak matches /^Error/ and ends with "\n".

What does 'manifold' mean, exactly?

My paper dictionary lists 8 meanings. The first 2 are:

1: of many kinds; numerous and varied: manifold duties
2: having many different parts, elements, features, forms, etc.

So, rather like sections in a *.ini file...

See Also ^

CGI::Application

The following are all part of this set of distros:

CGI::Snapp - A almost back-compat fork of CGI::Application

CGI::Snapp::Demo::One - A template-free demo of CGI::Snapp using just 1 run mode

CGI::Snapp::Demo::Two - A template-free demo of CGI::Snapp using N run modes

CGI::Snapp::Demo::Three - A template-free demo of CGI::Snapp using CGI::Snapp::Plugin::Forward

CGI::Snapp::Demo::Four - A template-free demo of CGI::Snapp using Log::Handler::Plugin::DBI

CGI::Snapp::Demo::Four::Wrapper - A wrapper around CGI::Snapp::Demo::Four, to simplify using Log::Handler::Plugin::DBI

Config::Plugin::Tiny - A plugin which uses Config::Tiny

Config::Plugin::TinyManifold - A plugin which uses Config::Tiny with 1 of N sections

Data::Session - Persistent session data management

Log::Handler::Plugin::DBI - A plugin for Log::Handler using Log::Hander::Output::DBI

Log::Handler::Plugin::DBI::CreateTable - A helper for Log::Hander::Output::DBI to create your 'log' table

Machine-Readable Change Log ^

The file CHANGES was converted into Changelog.ini by Module::Metadata::Changes.

Version Numbers ^

Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.

Credits ^

Please read https://metacpan.org/module/CGI::Application::Plugin::Config::Simple#AUTHOR, since a lot of the ideas for this module were copied from CGI::Application::Plugin::Config::Simple.

Support ^

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=Config::Plugin::TinyManifold.

Author ^

Config::Plugin::TinyManifold was written by Ron Savage <ron@savage.net.au> in 2012.

Home page: http://savage.net.au/index.html.

Copyright ^

Australian copyright (c) 2012, Ron Savage.

        All Programs of mine are 'OSI Certified Open Source Software';
        you can redistribute them and/or modify them under the terms of
        The Artistic License, a copy of which is available at:
        http://www.opensource.org/licenses/index.html
syntax highlighting: