trusty (3) DBIx::Class::Schema::Loader::Optional::Dependencies.3pm.gz

NAME

       DBIx::Class::Schema::Loader::Optional::Dependencies - Optional module dependency specifications (for
       module authors)

SYNOPSIS

       Somewhere in your build-file (e.g. Module::Install's Makefile.PL):

         ...

         configure_requires 'DBIx::Class::Schema::Loader' => '0.07039';

         require DBIx::Class::Schema::Loader::Optional::Dependencies;

         my $use_moose_deps = DBIx::Class::Schema::Loader::Optional::Dependencies->req_list_for ('use_moose');

         for (keys %$use_moose_deps) {
           requires $_ => $use_moose_deps->{$_};
         }

         ...

       Note that there are some caveats regarding "configure_requires()", more info can be found at
       "configure_requires" in Module::Install

DESCRIPTION

       Some of the features of DBIx::Class::Schema::Loader have external module dependencies on their own. In
       order not to burden the average user with modules he will never use, these optional dependencies are not
       included in the base Makefile.PL. Instead an exception with a descriptive message is thrown when a
       specific feature is missing one or several modules required for its operation. This module is the central
       holding place for  the current list of such dependencies.

CURRENT REQUIREMENT GROUPS

       Dependencies are organized in "groups" and each group can list one or more required modules, with an
       optional minimum version (or 0 for any version).

   dbicdump config file
       Modules required for using a config file with dbicdump

       •   Config::Any

       Requirement group: dbicdump_config

   dbicdump config file testing
       Modules required for using testing using a config file with dbicdump

       •   Config::Any

       •   Config::General

       Requirement group: test_dbicdump_config

   POD testing
       Modules required for testing POD in this distribution

       •   Pod::Simple >= 3.22

       •   Test::Pod >= 1.14

       Requirement group: test_pod

   use_moose
       Modules required for the use_moose option

       •   Moose >= 1.12

       •   MooseX::MarkAsMethods >= 0.13

       •   MooseX::NonMoose >= 0.16

       •   namespace::autoclean >= 0.09

       Requirement group: use_moose

METHODS

   req_group_list
       Arguments: $none
       Returns: \%list_of_requirement_groups

       This method should be used by DBIx::Class packagers, to get a hashref of all dependencies keyed by
       dependency group. Each key (group name) can be supplied to one of the group-specific methods below.

   req_list_for
       Arguments: $group_name
       Returns: \%list_of_module_version_pairs

       This method should be used by DBIx::Class extension authors, to determine the version of modules a
       specific feature requires in the current version of DBIx::Class::Schema::Loader. See the "SYNOPSIS" for a
       real-world example.

   req_ok_for
       Arguments: $group_name
       Returns: 1|0

       Returns true or false depending on whether all modules required by $group_name are present on the system
       and loadable

   req_missing_for
       Arguments: $group_name
       Returns: $error_message_string

       Returns a single line string suitable for inclusion in larger error messages.  This method would normally
       be used by DBIx::Class::Schema::Loader maintainers, to indicate to the user that he needs to install
       specific modules before he will be able to use a specific feature.

       For example if some of the requirements for "use_moose" are not available, the returned string could look
       like:

        Moose >= 0 (see use_moose for details)

       The author is expected to prepend the necessary text to this message before returning the actual error
       seen by the user.

   req_errorlist_for
       Arguments: $group_name
       Returns: \%list_of_loaderrors_per_module

       Returns a hashref containing the actual errors that occurred while attempting to load each module in the
       requirement group.

AUTHOR

       See "CONTRIBUTORS" in DBIx::Class.

LICENSE

       You may distribute this code under the same terms as Perl itself

perl v5.18.1                                       2014-DBIx::Class::Schema::Loader::Optional::Dependencies(3pm)