Config::GitLike 1.04

This module handles interaction with configuration files of the style used by the version control system Git. It can both parse and modify these files, as well as create entirely new ones.<br /><br />You only need to know a few things about the configuration format in order to use this module. First, a configuration file is made up of key/value pairs. Every key must be contained in a section. Sections can have subsections, but they don't have to. For the purposes of setting and getting configuration variables, we join the section name, subsection name, and variable name together with dots to get a key name that looks like "section.subsection.variable". These are the strings that you'll be passing in to key arguments.<br /><br />Configuration files inherit from each other. By default, Config::GitLike loads data from a system-wide configuration file, a per-user configuration file, and a per-directory configuration file, but by subclassing and overriding methods you can obtain any combination of configuration files. By default, configuration files that don't exist are just skipped.<br /><br />See http://www.kernel.org/pub/software/scm/git/docs/git-config.html#_configuration_file for details on the syntax of git configuration files. We won't waste pixels on the nitty gritty here.<br /><br />While the behaviour of a couple of this module's methods differ slightly from the git config equivalents, this module can read any config file written by git. The converse is usually true, but only if you don't take advantage of this module's increased permissiveness when it comes to key names. (See "DIFFERENCES FROM GIT-CONFIG" for details.)<br /><br />This is an object-oriented module using Any::Moose. All subroutines are object method calls.<br /><br />A few methods have parameters that are always used for the same purpose:<br />Filenames<br /><br />All methods that change things in a configuration file require a filename to write to, via the filename parameter. Since a Config::GitLike object can be working with multiple config files that inherit from each other, we don't try to figure out which one to write to automatically and let you specify instead.<br />Casting<br /><br />All get and set methods can make sure the values they're returning or setting are valid values of a certain type: bool, int, num, or bool-or-int (or at least as close as Perl can get to having these types). Do this by passing one of these types in via the as parameter. The set method, if told to write bools, will always write "true" or "false" (not anything else that cast considers a valid bool).<br /><br />Methods that are told to cast values will throw exceptions if the values they're trying to cast aren't valid values of the given type.<br /><br />See the "cast" method documentation for more on what is considered valid for each type.<br />Filtering<br /><br />All get and set methods can filter what values they return via their filter parameter, which is expected to be a string that is a valid regex. If you want to filter items OUT instead of IN, you can prefix your regex with a ! and that'll do the trick.

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Config,  Configuration,  Don,  Filename,  Files,  Filter,  Inherit,  Method,  Methods,  Module,  Parameter,  Passing,  Setting,  Types,  Valid,  Values,  Write
Users rating:	0/10