# POD is generated automatically by calling _gen_pod from the
# Makefile.PL in $AUTHOR mode
+# NOTE: the rationale for 2 JSON::Any versions is that
+# we need the newer only to work around JSON::XS, which
+# itself is an optional dep
+my $min_json_any = {
+ 'JSON::Any' => '1.23',
+};
+my $test_and_dist_json_any = {
+ 'JSON::Any' => '1.31',
+};
+
my $moose_basic = {
- 'Moose' => '0.98',
- 'MooseX::Types' => '0.21',
+ 'Moose' => '0.98',
+ 'MooseX::Types' => '0.21',
+ 'MooseX::Types::LoadableClass' => '0.011',
+};
+
+my $replicated = {
+ %$moose_basic,
};
my $admin_basic = {
%$moose_basic,
- 'MooseX::Types::Path::Class' => '0.05',
- 'MooseX::Types::JSON' => '0.02',
- 'namespace::autoclean' => '0.09',
- 'parent' => '0.223',
+ %$min_json_any,
+ 'MooseX::Types::Path::Class' => '0.05',
+ 'MooseX::Types::JSON' => '0.02',
};
-my $reqs = {
- dist => {
- #'Module::Install::Pod::Inherit' => '0.01',
- },
+my $admin_script = {
+ %$moose_basic,
+ %$admin_basic,
+ 'Getopt::Long::Descriptive' => '0.081',
+ 'Text::CSV' => '1.16',
+};
+
+my $datetime_basic = {
+ 'DateTime' => '0.55',
+ 'DateTime::Format::Strptime' => '1.2',
+};
+my $id_shortener = {
+ 'Math::BigInt' => '1.80',
+ 'Math::Base36' => '0.07',
+};
+
+my $rdbms_sqlite = {
+ 'DBD::SQLite' => '0',
+};
+my $rdbms_pg = {
+ 'DBD::Pg' => '0',
+};
+my $rdbms_mssql_odbc = {
+ 'DBD::ODBC' => '0',
+};
+my $rdbms_mssql_sybase = {
+ 'DBD::Sybase' => '0',
+};
+my $rdbms_mssql_ado = {
+ 'DBD::ADO' => '0',
+};
+my $rdbms_msaccess_odbc = {
+ 'DBD::ODBC' => '0',
+};
+my $rdbms_msaccess_ado = {
+ 'DBD::ADO' => '0',
+};
+my $rdbms_mysql = {
+ 'DBD::mysql' => '0',
+};
+my $rdbms_oracle = {
+ 'DBD::Oracle' => '0',
+ %$id_shortener,
+};
+my $rdbms_ase = {
+ 'DBD::Sybase' => '0',
+};
+my $rdbms_db2 = {
+ 'DBD::DB2' => '0',
+};
+my $rdbms_db2_400 = {
+ 'DBD::ODBC' => '0',
+};
+my $rdbms_informix = {
+ 'DBD::Informix' => '0',
+};
+my $rdbms_sqlanywhere = {
+ 'DBD::SQLAnywhere' => '0',
+};
+my $rdbms_sqlanywhere_odbc = {
+ 'DBD::ODBC' => '0',
+};
+my $rdbms_firebird = {
+ 'DBD::Firebird' => '0',
+};
+my $rdbms_firebird_interbase = {
+ 'DBD::InterBase' => '0',
+};
+my $rdbms_firebird_odbc = {
+ 'DBD::ODBC' => '0',
+};
+
+my $reqs = {
replicated => {
- req => {
- %$moose_basic,
- 'namespace::clean' => '0.11',
- 'Hash::Merge' => '0.11',
- },
+ req => $replicated,
pod => {
title => 'Storage::Replicated',
desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
},
},
+ test_replicated => {
+ req => {
+ %$replicated,
+ 'Test::Moose' => '0',
+ },
+ },
+
+
admin => {
req => {
%$admin_basic,
},
},
- dbicadmin => {
+ admin_script => {
req => {
- %$moose_basic,
- %$admin_basic,
- 'Getopt::Long::Descriptive' => '0.081',
- 'JSON::Any' => '1.22',
- 'Text::CSV' => '1.16',
+ %$admin_script,
},
pod => {
title => 'dbicadmin',
deploy => {
req => {
- 'SQL::Translator' => '0.11002',
+ 'SQL::Translator' => '0.11018',
},
pod => {
title => 'Storage::DBI::deploy()',
- desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>',
+ desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
+ },
+ },
+
+ id_shortener => {
+ req => $id_shortener,
+ },
+
+ test_component_accessor => {
+ req => {
+ 'Class::Unload' => '0.07',
+ },
+ },
+
+ test_pod => {
+ req => {
+ 'Test::Pod' => '1.42',
},
},
- author => {
+ test_podcoverage => {
req => {
- 'Test::Pod' => '1.26',
'Test::Pod::Coverage' => '1.08',
'Pod::Coverage' => '0.20',
- #'Test::NoTabs' => '0.9',
- #'Test::EOL' => '0.6',
},
},
- core => {
+ test_whitespace => {
+ req => {
+ 'Test::EOL' => '1.0',
+ 'Test::NoTabs' => '0.9',
+ },
+ },
+
+ test_strictures => {
+ req => {
+ 'Test::Strict' => '0.20',
+ },
+ },
+
+ test_prettydebug => {
+ req => $min_json_any,
+ },
+
+ test_admin_script => {
+ req => {
+ %$admin_script,
+ %$test_and_dist_json_any,
+ 'JSON' => 0,
+ 'JSON::PP' => 0,
+ 'Cpanel::JSON::XS' => 0,
+ 'JSON::XS' => 0,
+ $^O eq 'MSWin32'
+ # for t/admin/10script.t
+ ? ('Win32::ShellQuote' => 0)
+ # DWIW does not compile (./configure even) on win32
+ : ('JSON::DWIW' => 0 )
+ ,
+ }
+ },
+
+ test_leaks_heavy => {
req => {
- # t/52cycle.t
- 'Test::Memory::Cycle' => '0',
- 'Devel::Cycle' => '1.10',
+ 'Class::MethodCache' => '0.02',
+ 'PadWalker' => '1.06',
+ },
+ },
+ test_dt => {
+ req => $datetime_basic,
+ },
+
+ test_dt_sqlite => {
+ req => {
+ %$datetime_basic,
# t/36datetime.t
# t/60core.t
'DateTime::Format::SQLite' => '0',
+ },
+ },
+
+ test_dt_mysql => {
+ req => {
+ %$datetime_basic,
+ # t/inflate/datetime_mysql.t
+ # (doesn't need Mysql itself)
+ 'DateTime::Format::MySQL' => '0',
+ },
+ },
- # t/96_is_deteministic_value.t
- 'DateTime::Format::Strptime'=> '0',
+ test_dt_pg => {
+ req => {
+ %$datetime_basic,
+ # t/inflate/datetime_pg.t
+ # (doesn't need PG itself)
+ 'DateTime::Format::Pg' => '0.16004',
},
},
- cdbicompat => {
+ test_cdbicompat => {
req => {
- 'DBIx::ContextualFetch' => '0',
'Class::DBI::Plugin::DeepAbstractSearch' => '0',
- 'Class::Trigger' => '0',
+ %$datetime_basic,
'Time::Piece::MySQL' => '0',
- 'Clone' => '0',
'Date::Simple' => '3.03',
},
},
+ # this is just for completeness as SQLite
+ # is a core dep of DBIC for testing
+ rdbms_sqlite => {
+ req => {
+ %$rdbms_sqlite,
+ },
+ pod => {
+ title => 'SQLite support',
+ desc => 'Modules required to connect to SQLite',
+ },
+ },
+
rdbms_pg => {
req => {
+ # when changing this list make sure to adjust xt/optional_deps.t
+ %$rdbms_pg,
+ },
+ pod => {
+ title => 'PostgreSQL support',
+ desc => 'Modules required to connect to PostgreSQL',
+ },
+ },
+
+ rdbms_mssql_odbc => {
+ req => {
+ %$rdbms_mssql_odbc,
+ },
+ pod => {
+ title => 'MSSQL support via DBD::ODBC',
+ desc => 'Modules required to connect to MSSQL via DBD::ODBC',
+ },
+ },
+
+ rdbms_mssql_sybase => {
+ req => {
+ %$rdbms_mssql_sybase,
+ },
+ pod => {
+ title => 'MSSQL support via DBD::Sybase',
+ desc => 'Modules required to connect to MSSQL via DBD::Sybase',
+ },
+ },
+
+ rdbms_mssql_ado => {
+ req => {
+ %$rdbms_mssql_ado,
+ },
+ pod => {
+ title => 'MSSQL support via DBD::ADO (Windows only)',
+ desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
+ },
+ },
+
+ rdbms_msaccess_odbc => {
+ req => {
+ %$rdbms_msaccess_odbc,
+ },
+ pod => {
+ title => 'MS Access support via DBD::ODBC',
+ desc => 'Modules required to connect to MS Access via DBD::ODBC',
+ },
+ },
+
+ rdbms_msaccess_ado => {
+ req => {
+ %$rdbms_msaccess_ado,
+ },
+ pod => {
+ title => 'MS Access support via DBD::ADO (Windows only)',
+ desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
+ },
+ },
+
+ rdbms_mysql => {
+ req => {
+ %$rdbms_mysql,
+ },
+ pod => {
+ title => 'MySQL support',
+ desc => 'Modules required to connect to MySQL',
+ },
+ },
+
+ rdbms_oracle => {
+ req => {
+ %$rdbms_oracle,
+ },
+ pod => {
+ title => 'Oracle support',
+ desc => 'Modules required to connect to Oracle',
+ },
+ },
+
+ rdbms_ase => {
+ req => {
+ %$rdbms_ase,
+ },
+ pod => {
+ title => 'Sybase ASE support',
+ desc => 'Modules required to connect to Sybase ASE',
+ },
+ },
+
+ rdbms_db2 => {
+ req => {
+ %$rdbms_db2,
+ },
+ pod => {
+ title => 'DB2 support',
+ desc => 'Modules required to connect to DB2',
+ },
+ },
+
+ rdbms_db2_400 => {
+ req => {
+ %$rdbms_db2_400,
+ },
+ pod => {
+ title => 'DB2 on AS/400 support',
+ desc => 'Modules required to connect to DB2 on AS/400',
+ },
+ },
+
+ rdbms_informix => {
+ req => {
+ %$rdbms_informix,
+ },
+ pod => {
+ title => 'Informix support',
+ desc => 'Modules required to connect to Informix',
+ },
+ },
+
+ rdbms_sqlanywhere => {
+ req => {
+ %$rdbms_sqlanywhere,
+ },
+ pod => {
+ title => 'SQLAnywhere support',
+ desc => 'Modules required to connect to SQLAnywhere',
+ },
+ },
+
+ rdbms_sqlanywhere_odbc => {
+ req => {
+ %$rdbms_sqlanywhere_odbc,
+ },
+ pod => {
+ title => 'SQLAnywhere support via DBD::ODBC',
+ desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
+ },
+ },
+
+ rdbms_firebird => {
+ req => {
+ %$rdbms_firebird,
+ },
+ pod => {
+ title => 'Firebird support',
+ desc => 'Modules required to connect to Firebird',
+ },
+ },
+
+ rdbms_firebird_interbase => {
+ req => {
+ %$rdbms_firebird_interbase,
+ },
+ pod => {
+ title => 'Firebird support via DBD::InterBase',
+ desc => 'Modules required to connect to Firebird via DBD::InterBase',
+ },
+ },
+
+ rdbms_firebird_odbc => {
+ req => {
+ %$rdbms_firebird_odbc,
+ },
+ pod => {
+ title => 'Firebird support via DBD::ODBC',
+ desc => 'Modules required to connect to Firebird via DBD::ODBC',
+ },
+ },
+
+# the order does matter because the rdbms support group might require
+# a different version that the test group
+ test_rdbms_pg => {
+ req => {
$ENV{DBICTEST_PG_DSN}
? (
- 'Sys::SigAction' => '0',
+ # when changing this list make sure to adjust xt/optional_deps.t
+ %$rdbms_pg,
'DBD::Pg' => '2.009002',
- 'DateTime::Format::Pg' => '0',
) : ()
},
},
- rdbms_mysql => {
+ test_rdbms_mssql_odbc => {
+ req => {
+ $ENV{DBICTEST_MSSQL_ODBC_DSN}
+ ? (
+ %$rdbms_mssql_odbc,
+ ) : ()
+ },
+ },
+
+ test_rdbms_mssql_ado => {
+ req => {
+ $ENV{DBICTEST_MSSQL_ADO_DSN}
+ ? (
+ %$rdbms_mssql_ado,
+ ) : ()
+ },
+ },
+
+ test_rdbms_mssql_sybase => {
+ req => {
+ $ENV{DBICTEST_MSSQL_DSN}
+ ? (
+ %$rdbms_mssql_sybase,
+ ) : ()
+ },
+ },
+
+ test_rdbms_msaccess_odbc => {
+ req => {
+ $ENV{DBICTEST_MSACCESS_ODBC_DSN}
+ ? (
+ %$rdbms_msaccess_odbc,
+ %$datetime_basic,
+ 'Data::GUID' => '0',
+ ) : ()
+ },
+ },
+
+ test_rdbms_msaccess_ado => {
+ req => {
+ $ENV{DBICTEST_MSACCESS_ADO_DSN}
+ ? (
+ %$rdbms_msaccess_ado,
+ %$datetime_basic,
+ 'Data::GUID' => 0,
+ ) : ()
+ },
+ },
+
+ test_rdbms_mysql => {
req => {
$ENV{DBICTEST_MYSQL_DSN}
? (
- 'DateTime::Format::MySQL' => '0',
- 'DBD::mysql' => '0',
+ %$rdbms_mysql,
) : ()
},
},
- rdbms_oracle => {
+ test_rdbms_oracle => {
req => {
$ENV{DBICTEST_ORA_DSN}
? (
+ %$rdbms_oracle,
'DateTime::Format::Oracle' => '0',
+ 'DBD::Oracle' => '1.24',
) : ()
},
},
- rdbms_ase => {
+ test_rdbms_ase => {
req => {
$ENV{DBICTEST_SYBASE_DSN}
? (
- 'DateTime::Format::Sybase' => 0,
+ %$rdbms_ase,
+ ) : ()
+ },
+ },
+
+ test_rdbms_db2 => {
+ req => {
+ $ENV{DBICTEST_DB2_DSN}
+ ? (
+ %$rdbms_db2,
+ ) : ()
+ },
+ },
+
+ test_rdbms_db2_400 => {
+ req => {
+ $ENV{DBICTEST_DB2_400_DSN}
+ ? (
+ %$rdbms_db2_400,
+ ) : ()
+ },
+ },
+
+ test_rdbms_informix => {
+ req => {
+ $ENV{DBICTEST_INFORMIX_DSN}
+ ? (
+ %$rdbms_informix,
+ ) : ()
+ },
+ },
+
+ test_rdbms_sqlanywhere => {
+ req => {
+ $ENV{DBICTEST_SQLANYWHERE_DSN}
+ ? (
+ %$rdbms_sqlanywhere,
+ ) : ()
+ },
+ },
+
+ test_rdbms_sqlanywhere_odbc => {
+ req => {
+ $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
+ ? (
+ %$rdbms_sqlanywhere_odbc,
+ ) : ()
+ },
+ },
+
+ test_rdbms_firebird => {
+ req => {
+ $ENV{DBICTEST_FIREBIRD_DSN}
+ ? (
+ %$rdbms_firebird,
) : ()
},
},
- rdbms_asa => {
+ test_rdbms_firebird_interbase => {
req => {
- grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/}
+ $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
? (
- 'DateTime::Format::Strptime' => 0,
+ %$rdbms_firebird_interbase,
) : ()
},
},
+
+ test_rdbms_firebird_odbc => {
+ req => {
+ $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
+ ? (
+ %$rdbms_firebird_odbc,
+ ) : ()
+ },
+ },
+
+ test_memcached => {
+ req => {
+ $ENV{DBICTEST_MEMCACHED}
+ ? (
+ 'Cache::Memcached' => 0,
+ ) : ()
+ },
+ },
+
+ dist_dir => {
+ req => {
+ %$test_and_dist_json_any,
+ 'ExtUtils::MakeMaker' => '6.64',
+ 'Pod::Inherit' => '0.91',
+ },
+ },
+
+ dist_upload => {
+ req => {
+ 'CPAN::Uploader' => '0.103001',
+ },
+ },
+
};
-sub _all_optional_requirements {
- return { map { %{ $reqs->{$_}{req} || {} } } (keys %$reqs) };
-}
+### Public API
+
+# OO for (mistakenly considered) ease of extensibility, not due to any need to
+# carry state of any sort. This API is currently used outside, so leave as-is.
+# FIXME - make sure to not propagate this further if module is extracted as a
+# standalone library - keep the stupidity to a DBIC-secific shim!
+#
sub req_list_for {
my ($class, $group) = @_;
return { %$deps };
}
+sub req_group_list {
+ return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
+}
+
+sub req_errorlist_for {
+ my ($class, $group) = @_;
+
+ croak "req_errorlist_for() expects a requirement group name"
+ unless $group;
+
+ return $class->_check_deps($group)->{errorlist};
+}
-our %req_availability_cache;
sub req_ok_for {
my ($class, $group) = @_;
croak "req_ok_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{status};
+ return $class->_check_deps($group)->{status};
}
sub req_missing_for {
croak "req_missing_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{missing};
+ return $class->_check_deps($group)->{missing};
}
-sub req_errorlist_for {
+sub die_unless_req_ok_for {
my ($class, $group) = @_;
- croak "req_errorlist_for() expects a requirement group name"
+ croak "die_unless_req_ok_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{errorlist};
+ $class->_check_deps($group)->{status}
+ or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
}
+
+
+### Private OO API
+
+our %req_availability_cache;
sub _check_deps {
my ($class, $group) = @_;
- my $deps = $class->req_list_for ($group);
+ return $req_availability_cache{$group} ||= do {
+
+ my $deps = $class->req_list_for ($group);
+
+ my %errors;
+ for my $mod (keys %$deps) {
+ my $req_line = "require $mod;";
+ if (my $ver = $deps->{$mod}) {
+ $req_line .= "$mod->VERSION($ver);";
+ }
+
+ eval $req_line;
+
+ $errors{$mod} = $@ if $@;
+ }
+
+ my $res;
- my %errors;
- for my $mod (keys %$deps) {
- if (my $ver = $deps->{$mod}) {
- eval "use $mod $ver ()";
+ if (keys %errors) {
+ my $missing = join (', ', map { $deps->{$_} ? qq("${_}~>=$deps->{$_}") : $_ } (sort keys %errors) );
+ $missing .= " (see $class documentation for details)" if $reqs->{$group}{pod};
+ $res = {
+ status => 0,
+ errorlist => \%errors,
+ missing => $missing,
+ };
}
else {
- eval "require $mod";
+ $res = {
+ status => 1,
+ errorlist => {},
+ missing => '',
+ };
}
- $errors{$mod} = $@ if $@;
- }
-
- if (keys %errors) {
- my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
- $missing .= " (see $class for details)" if $reqs->{$group}{pod};
- $req_availability_cache{$group} = {
- status => 0,
- errorlist => { %errors },
- missing => $missing,
- };
- }
- else {
- $req_availability_cache{$group} = {
- status => 1,
- errorlist => {},
- missing => '',
- };
- }
+ $res;
+ };
}
+# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
- my $class = shift;
+ my ($class, $distver, $pod_dir) = @_;
+
+ die "No POD root dir supplied" unless $pod_dir;
+
+ $distver ||=
+ eval { require DBIx::Class; DBIx::Class->VERSION; }
+ ||
+ die
+"\n\n---------------------------------------------------------------------\n" .
+'Unable to load core DBIx::Class module to determine current version, '.
+'possibly due to missing dependencies. Author-mode autodocumentation ' .
+"halted\n\n" . $@ .
+"\n\n---------------------------------------------------------------------\n"
+ ;
+
+ # do not ask for a recent version, use 1.x API calls
+ # this *may* execute on a smoker with old perl or whatnot
+ require File::Path;
+
+ (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
+
+ (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
+ (my $dir = $podfn) =~ s|/[^/]+$||;
+
+ File::Path::mkpath([$dir]);
+
+ my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
+ or die "Hrmm? No sqlt dep?";
+
+
+ my @chunks;
+
+#@@
+#@@ HEADER
+#@@
+ push @chunks, <<"EOC";
+#########################################################################
+##################### A U T O G E N E R A T E D ########################
+#########################################################################
+#
+# The contents of this POD file are auto-generated. Any changes you make
+# will be lost. If you need to change the generated text edit _gen_pod()
+# at the end of $modfn
+#
+
+=head1 NAME
+
+$class - Optional module dependency specifications (for module authors)
+EOC
+
+
+#@@
+#@@ SYNOPSIS HEADING
+#@@
+ push @chunks, <<"EOC";
+=head1 SYNOPSIS
+
+Somewhere in your build-file (e.g. L<ExtUtils::MakeMaker>'s F<Makefile.PL>):
+
+ ...
+
+ \$EUMM_ARGS{CONFIGURE_REQUIRES} = {
+ \%{ \$EUMM_ARGS{CONFIGURE_REQUIRES} || {} },
+ 'DBIx::Class' => '$distver',
+ };
+
+ ...
+
+ my %DBIC_DEPLOY_DEPS = %{ eval {
+ require $class;
+ $class->req_list_for('deploy');
+ } || {} };
+
+ \$EUMM_ARGS{PREREQ_PM} = {
+ \%DBIC_DEPLOY_DEPS,
+ \%{ \$EUMM_ARGS{PREREQ_PM} || {} },
+ };
+
+ ...
+
+ ExtUtils::MakeMaker::WriteMakefile(\%EUMM_ARGS);
+
+B<Note>: The C<eval> protection within the example is due to support for
+requirements during L<the C<configure> build phase|CPAN::Meta::Spec/Phases>
+not being available on a sufficient portion of production installations of
+Perl. Robust support for such dependency requirements is available in the
+L<CPAN> installer only since version C<1.94_56> first made available for
+production with perl version C<5.12>. It is the belief of the current
+maintainer that support for requirements during the C<configure> build phase
+will not be sufficiently ubiquitous until the B<year 2020> at the earliest,
+hence the extra care demonstrated above. It should also be noted that some
+3rd party installers (e.g. L<cpanminus|App::cpanminus>) do the right thing
+with configure requirements independent from the versions of perl and CPAN
+available.
+EOC
+
+
+#@@
+#@@ DESCRIPTION HEADING
+#@@
+ push @chunks, <<'EOC';
+=head1 DESCRIPTION
- my @chunks = (
- '=head1 NAME',
- "$class - Optional module dependency specifications",
- '=head1 DESCRIPTION',
- <<'EOD',
Some of the less-frequently used features of L<DBIx::Class> 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
+with modules they 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.
-EOD
- '=head1 CURRENT REQUIREMENT GROUPS',
- <<'EOD',
-Dependencies are organized in C<groups> and each group can list one or more
-required modules, with an optional minimum version (or 0 for any version).
-The group name can be used in the
-EOD
- );
+thrown when a specific feature can't find one or several modules required for
+its operation. This module is the central holding place for the current list
+of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
+authors alike.
+
+Dependencies are organized in L<groups|/CURRENT REQUIREMENT GROUPS> where each
+group can list one or more required modules, with an optional minimum version
+(or 0 for any version). The group name can be used in the
+L<public methods|/METHODS> as described below.
+EOC
+
+
+#@@
+#@@ REQUIREMENT GROUPLIST HEADING
+#@@
+ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS';
for my $group (sort keys %$reqs) {
my $p = $reqs->{$group}{pod}
);
}
- push @chunks, (
- '=head1 METHODS',
- '=head2 req_list_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Returns: \%list_of_module_version_pairs',
- '=back',
- <<EOD,
+
+#@@
+#@@ API DOCUMENTATION HEADING
+#@@
+ push @chunks, <<'EOC';
+
+=head1 METHODS
+
+=head2 req_group_list
+
+=over
+
+=item Arguments: none
+
+=item Return Value: \%list_of_requirement_groups
+
+=back
+
+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.
+The B<values> of the returned hash are currently a set of options B<without a
+well defined structure>. If you have use for any of the contents - contact the
+maintainers, instead of treating this as public (left alone stable) API.
+
+=head2 req_list_for
+
+=over
+
+=item Arguments: $group_name
+
+=item Return Value: \%list_of_module_version_pairs
+
+=back
+
This method should be used by DBIx::Class extension authors, to determine the
-version of modules which a specific feature requires in the current version of
-DBIx::Class. For example if you write a module/extension that requires
-DBIx::Class and also requires the availability of
-L<DBIx::Class::Storage::DBI/deploy>, you can do the following in your
-C<Makefile.PL> or C<Build.PL>
-
- require $class;
- my \$dep_list = $class->req_list_for ('deploy');
-
-Which will give you a list of module/version pairs necessary for the particular
-feature to function with this version of DBIx::Class.
-EOD
-
- '=head2 req_ok_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Returns: 1|0',
- '=back',
- 'Returns true or false depending on whether all modules required by $group_name are present on the system and loadable',
-
- '=head2 req_missing_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Returns: $error_message_string',
- '=back',
- <<EOD,
-Returns a single line string suitable for inclusion in larger error messages.
-This method would normally be used by DBIx::Class core-module author, 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 the requirements for C<replicated> are not available, the
-returned string would look like:
-
- Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see $class for details)
+version of modules a specific feature requires in the B<current> version of
+DBIx::Class. See the L</SYNOPSIS> for a real-world example.
+
+=head2 req_ok_for
+=over
+
+=item Arguments: $group_name
+
+=item Return Value: 1|0
+
+=back
+
+Returns true or false depending on whether all modules required by
+C<$group_name> are present on the system and loadable.
+
+=head2 req_missing_for
+
+=over
+
+=item Arguments: $group_name
+
+=item Return Value: $error_message_string
+
+=back
+
+This method would normally be used by DBIx::Class core-modules, to indicate to
+the user that they need to install specific modules before being able to use a
+specific feature set.
+
+For example if some of the requirements for C<deploy> are not available,
+the returned string could look like:
+EOC
+
+ push @chunks, qq{ "SQL::Translator~>=$sqltver" (see $class documentation for details)};
+
+ push @chunks, <<'EOC';
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user.
-EOD
-
- '=head2 req_errorlist_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Returns: \%list_of_loaderrors_per_module',
- '=back',
- <<'EOD',
-Returns a hashref containing the actual errors that occured while attempting
-to load each module in the requirement group.
-EOD
- );
+=head2 die_unless_req_ok_for
+
+=over
+
+=item Arguments: $group_name
+
+=back
+
+Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
+in case of failure throws an exception including the information
+from L</req_missing_for>.
- my $fn = __FILE__;
- $fn =~ s/\.pm$/\.pod/;
+=head2 req_errorlist_for
- open (my $fh, '>', $fn) or croak "Unable to write to $fn: $!";
- print $fh join ("\n\n", @chunks);
- close ($fh);
+=over
+
+=item Arguments: $group_name
+
+=item Return Value: \%list_of_loaderrors_per_module
+
+=back
+
+Returns a hashref containing the actual errors that occurred while attempting
+to load each module in the requirement group.
+EOC
+
+#@@
+#@@ FOOTER
+#@@
+ push @chunks, <<'EOC';
+=head1 FURTHER QUESTIONS?
+
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
+
+=head1 COPYRIGHT AND LICENSE
+
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
+EOC
+
+ eval {
+ open (my $fh, '>', $podfn) or die;
+ print $fh join ("\n\n", @chunks) or die;
+ print $fh "\n" or die;
+ close ($fh) or die;
+ } or croak( "Unable to write $podfn: " . ( $! || $@ || 'unknown error') );
}
1;
projects / dbsrgits/DBIx-Class.git / blobdiff