From: Graham Knop Date: Fri, 24 Jul 2020 00:07:10 +0000 (+0200) Subject: clean up pod X-Git-Tag: v0.35~6 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-ConfigLoader.git;a=commitdiff_plain;h=ff1f7cb02e1a69b26f90939388e6a76523de8200 clean up pod use C<< > >> rather than C>. Use F<> for file names. Remove trailing whitespace. Normalize indentation. Correct some section links. --- diff --git a/lib/Catalyst/Plugin/ConfigLoader.pm b/lib/Catalyst/Plugin/ConfigLoader.pm index 753b76f..ac1f4f3 100644 --- a/lib/Catalyst/Plugin/ConfigLoader.pm +++ b/lib/Catalyst/Plugin/ConfigLoader.pm @@ -26,21 +26,21 @@ Catalyst::Plugin::ConfigLoader - Load config files of various types # you can specify a file if you'd like __PACKAGE__->config( 'Plugin::ConfigLoader' => { file => 'config.yaml' } ); - In the file, assuming it's in YAML format: +In the file, assuming it's in YAML format: foo: bar - Accessible through the context object, or the class itself +Accessible through the context object, or the class itself - $c->config->{foo} # bar - MyApp->config->{foo} # bar + $c->config->{foo} # bar + MyApp->config->{foo} # bar =head1 DESCRIPTION This module will attempt to load find and load a configuration file of various types. Currently it supports YAML, JSON, XML, INI and Perl formats. Special configuration for a particular driver format can -be stored in Cconfig-E{ 'Plugin::ConfigLoader' }-E{ driver }>. +be stored in C<< MyApp->config->{ 'Plugin::ConfigLoader' }->{ driver } >>. For example, to pass arguments to L, use the following: __PACKAGE__->config( 'Plugin::ConfigLoader' => { @@ -52,9 +52,9 @@ For example, to pass arguments to L, use the following: See L's C parameter for more information. To support the distinction between development and production environments, -this module will also attemp to load a local config (e.g. myapp_local.yaml) +this module will also attemp to load a local config (e.g. F) which will override any duplicate settings. See -L +L for details on how this is configured. =head1 METHODS @@ -125,7 +125,7 @@ sub load_config { This method determines the potential file paths to be used for config loading. It returns an array of paths (up to the filename less the extension) to pass to -L for loading. +L for loading. =cut @@ -162,9 +162,9 @@ The order of preference is specified as: =item * C<$ENV{ CATALYST_CONFIG }> -=item * C<$c-Econfig-E{ 'Plugin::ConfigLoader' }-E{ file }> +=item * C<< $c->config->{ 'Plugin::ConfigLoader' }->{ file } >> -=item * C<$c-Epath_to( $application_prefix )> +=item * C<< $c->path_to( $application_prefix ) >> =back @@ -206,7 +206,7 @@ be specified in the following order of preference: =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }> -=item * C<$c-Econfig-E{ 'Plugin::ConfigLoader' }-E{ config_local_suffix }> +=item * C<< $c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix } >> =back @@ -214,8 +214,8 @@ The first one of these values found replaces the default of C in the name of the local config file to be loaded. For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C, -ConfigLoader will try and load C instead of -C. +ConfigLoader will try and load F instead of +F. =cut @@ -255,9 +255,9 @@ This method is called after the config file is loaded. It can be used to implement tuning of config values that can only be done at runtime. If you need to do this to properly configure any plugins, it's important to load ConfigLoader before them. -ConfigLoader provides a default finalize_config method which -walks through the loaded config hash and calls the C -sub on any string. +ConfigLoader provides a default C method which +walks through the loaded config hash and calls the +L method on any string. =cut @@ -292,7 +292,7 @@ C<__DATA__> as a config value, for example) The parameter list is split on comma (C<,>). You can override this method to do your own string munging, or you can define your own macros in -Cconfig-E{ 'Plugin::ConfigLoader' }-E{ substitutions }>. +C<< MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } >>. Example: MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { @@ -330,7 +330,7 @@ sub config_substitutions { =head1 AUTHOR -Brian Cassidy Ebricas@cpan.orgE +Brian Cassidy =head1 CONTRIBUTORS @@ -339,9 +339,9 @@ development of this module: =over 4 -=item * Joel Bernstein Erataxis@cpan.orgE - Rewrite to use L +=item * Joel Bernstein - Rewrite to use L -=item * David Kamholz Edkamholz@cpan.orgE - L integration +=item * David Kamholz - L integration =item * Stuart Watt - Addition of ENV macro. diff --git a/lib/Catalyst/Plugin/ConfigLoader/Manual.pod b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod index d0a13dd..1e528ed 100644 --- a/lib/Catalyst/Plugin/ConfigLoader/Manual.pod +++ b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod @@ -1,4 +1,3 @@ - =head1 NAME Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin @@ -6,7 +5,7 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin =head1 BASIC USAGE package MyApp; - + use Catalyst qw( ConfigLoader ... ); =head1 ENVIRONMENT VARIABLES @@ -58,10 +57,10 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin =head3 Example Config name=TestApp - + [Controller::Foo] foo=bar - + [Model::Baz] qux=xyzzy @@ -125,25 +124,24 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin =head3 Example Config - + MyApp::CMS - /var/www/docs/myapp-cms/uploads + /var/www/docs/myapp-cms/uploads - dbi:mysql:cmsdb - user - password + dbi:mysql:cmsdb + user + password - __path_to(root,templates)__ - UTF-8 - 1 - 2 - 2 + __path_to(root,templates)__ + UTF-8 + 1 + 2 + 2 - - + Note that the name attribute for the C tag should be the relative namespace of the Catalyst model, not the absolute one. That is for @@ -175,12 +173,12 @@ C the C attribute should be C. =head2 Configuring a Catalyst::Model::DBIC::Schema model from a YAML config Model::MyModel: - schema_class: MyApp::MySchema - connect_info: - - dbi:SQLite:myapp.db - - '' - - '' - - AutoCommit: 1 + schema_class: MyApp::MySchema + connect_info: + - dbi:SQLite:myapp.db + - '' + - '' + - AutoCommit: 1 =head2 Converting your existing config to Config::General format @@ -205,16 +203,16 @@ should add the following config information to MyApp.pm: When ConfigLoader reads configurations, it starts by reading the configuration file for C with one of the supported extensions as listed -L. +L. -For example, A L config file is C. +For example, A L config file is F. If a configuration file called C exists with one of the supported file extensions, it will also be read, and values from that file will override values from the main config file. A L local configuration file would be called -C. +F. The C suffix can be changed. See L for the details of @@ -223,17 +221,16 @@ how. This is useful because it allows different people or environments to have different configuration files. A project with three developers, I, I, and I as well as a production environment can have -a C, a C, a C, and a -C. +a F, a F, a F, and a +F. Each developer, and the web server, would set the environment variable to load their proper configuration file. All of the configurations can be stored properly in source control. -If there is no C (where .ext is a supported extension), and +If there is no F (where C<.ext> is a supported extension), and the individual configuration files contain something required to start the application, such as the Model's data source definition, the applicaton won't start unless the environment variable is set properly. =cut -