# POD is generated automatically by calling _gen_pod from the
# Makefile.PL in $AUTHOR mode
-my $json_any = {
- 'JSON::Any' => '1.22',
+# 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',
+ 'MooseX::Types::LoadableClass' => '0.011',
};
my $replicated = {
%$moose_basic,
- 'Hash::Merge' => '0.12',
};
my $admin_basic = {
%$moose_basic,
- %$json_any,
+ %$min_json_any,
'MooseX::Types::Path::Class' => '0.05',
'MooseX::Types::JSON' => '0.02',
- 'namespace::autoclean' => '0.09',
+};
+
+my $admin_script = {
+ %$moose_basic,
+ %$admin_basic,
+ 'Getopt::Long::Descriptive' => '0.081',
+ 'Text::CSV' => '1.16',
};
my $datetime_basic = {
'DateTime::Format::Strptime' => '1.2',
};
-my $reqs = {
- dist => {
- #'Module::Install::Pod::Inherit' => '0.01',
- },
+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 => $replicated,
pod => {
admin_script => {
req => {
- %$moose_basic,
- %$admin_basic,
- 'Getopt::Long::Descriptive' => '0.081',
- 'Text::CSV' => '1.16',
+ %$admin_script,
},
pod => {
title => 'dbicadmin',
deploy => {
req => {
- 'SQL::Translator' => '0.11006',
+ '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.41',
+ 'Test::Pod' => '1.42',
},
},
},
},
- test_notabs => {
+ test_whitespace => {
req => {
+ 'Test::EOL' => '1.0',
'Test::NoTabs' => '0.9',
},
},
- test_eol => {
+ test_strictures => {
req => {
- 'Test::EOL' => '0.6',
+ 'Test::Strict' => '0.20',
},
},
test_prettydebug => {
- req => $json_any,
+ req => $min_json_any,
},
- test_leaks => {
+ test_admin_script => {
req => {
- 'Test::Memory::Cycle' => '0',
- 'Devel::Cycle' => '1.10',
+ %$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 => {
+ 'Class::MethodCache' => '0.02',
+ 'PadWalker' => '1.06',
},
},
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',
) : ()
},
req => {
$ENV{DBICTEST_MSSQL_ODBC_DSN}
? (
- 'DBD::ODBC' => '0',
+ %$rdbms_mssql_odbc,
+ ) : ()
+ },
+ },
+
+ test_rdbms_mssql_ado => {
+ req => {
+ $ENV{DBICTEST_MSSQL_ADO_DSN}
+ ? (
+ %$rdbms_mssql_ado,
) : ()
},
},
req => {
$ENV{DBICTEST_MSSQL_DSN}
? (
- 'DBD::Sybase' => '0',
+ %$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,
) : ()
},
},
req => {
$ENV{DBICTEST_MYSQL_DSN}
? (
- 'DBD::mysql' => '0',
+ %$rdbms_mysql,
) : ()
},
},
req => {
$ENV{DBICTEST_ORA_DSN}
? (
+ %$rdbms_oracle,
'DateTime::Format::Oracle' => '0',
'DBD::Oracle' => '1.24',
) : ()
req => {
$ENV{DBICTEST_SYBASE_DSN}
? (
- 'DateTime::Format::Sybase' => 0,
+ %$rdbms_ase,
) : ()
},
},
req => {
$ENV{DBICTEST_DB2_DSN}
? (
- 'DBD::DB2' => 0,
+ %$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,
+ ) : ()
+ },
+ },
+
+ test_rdbms_firebird_interbase => {
+ req => {
+ $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
+ ? (
+ %$rdbms_firebird_interbase,
+ ) : ()
+ },
+ },
+
+ test_rdbms_firebird_odbc => {
+ req => {
+ $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
+ ? (
+ %$rdbms_firebird_odbc,
) : ()
},
},
},
},
+ dist_dir => {
+ req => {
+ %$test_and_dist_json_any,
+ 'ExtUtils::MakeMaker' => '6.64',
+ 'Pod::Inherit' => '0.91',
+ },
+ },
+
+ dist_upload => {
+ req => {
+ 'CPAN::Uploader' => '0.103001',
+ },
+ },
+
};
+
+### 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) = @_;
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;
- return $class->_check_deps($group)->{errorlist};
+ $class->_check_deps($group)->{status}
+ or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
}
+
+
+### Private API
+
+our %req_availability_cache;
sub _check_deps {
my ($class, $group) = @_;
my $res;
if (keys %errors) {
- my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
- $missing .= " (see $class for details)" if $reqs->{$group}{pod};
+ 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,
};
}
-sub req_group_list {
- return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
-}
-
# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
- my ($class, $distver) = @_;
-
- my $modfn = __PACKAGE__ . '.pm';
- $modfn =~ s/\:\:/\//g;
+ my ($class, $distver, $pod_dir) = @_;
- my $podfn = __FILE__;
- $podfn =~ s/\.pm$/\.pod/;
+ die "No POD root dir supplied" unless $pod_dir;
$distver ||=
eval { require DBIx::Class; DBIx::Class->VERSION; }
"\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 = (
- <<'EOC',
+
+ my @chunks;
+
+#@@
+#@@ HEADER
+#@@
+ push @chunks, (
+ <<"EOC",
#########################################################################
##################### A U T O G E N E R A T E D ########################
#########################################################################
EOC
'=head1 NAME',
"$class - Optional module dependency specifications (for module authors)",
+ );
+
+
+#@@
+#@@ SYNOPSIS HEADING
+#@@
+ push @chunks, (
'=head1 SYNOPSIS',
<<"EOS",
Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
require $class;
- my \$deploy_deps = $class->req_list_for ('deploy');
+ my \$deploy_deps = $class->req_list_for('deploy');
for (keys %\$deploy_deps) {
requires \$_ => \$deploy_deps->{\$_};
Note that there are some caveats regarding C<configure_requires()>, more info
can be found at L<Module::Install/configure_requires>
EOS
+ );
+
+
+#@@
+#@@ DESCRIPTION HEADING
+#@@
+ push @chunks, (
'=head1 DESCRIPTION',
<<'EOD',
Some of the less-frequently used features of L<DBIx::Class> have external
of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
authors alike.
EOD
+ );
+
+
+#@@
+#@@ REQUIREMENT GROUPLIST HEADING
+#@@
+ push @chunks, (
'=head1 CURRENT REQUIREMENT GROUPS',
<<'EOD',
Dependencies are organized in C<groups> and each group can list one or more
);
}
+
+#@@
+#@@ API DOCUMENTATION HEADING
+#@@
push @chunks, (
'=head1 METHODS',
'=head2 req_group_list',
'=over',
'=item Arguments: none',
- '=item Returns: \%list_of_requirement_groups',
+ '=item Return Value: \%list_of_requirement_groups',
'=back',
<<'EOD',
This method should be used by DBIx::Class packagers, to get a hashref of all
'=head2 req_list_for',
'=over',
'=item Arguments: $group_name',
- '=item Returns: \%list_of_module_version_pairs',
+ '=item Return Value: \%list_of_module_version_pairs',
'=back',
<<'EOD',
This method should be used by DBIx::Class extension authors, to determine the
'=head2 req_ok_for',
'=over',
'=item Arguments: $group_name',
- '=item Returns: 1|0',
+ '=item Return Value: 1|0',
'=back',
<<'EOD',
Returns true or false depending on whether all modules required by
'=head2 req_missing_for',
'=over',
'=item Arguments: $group_name',
- '=item Returns: $error_message_string',
+ '=item Return Value: $error_message_string',
'=back',
<<"EOD",
Returns a single line string suitable for inclusion in larger error messages.
For example if some of the requirements for C<deploy> are not available,
the returned string could look like:
- SQL::Translator >= $sqltver (see $class for details)
+ "SQL::Translator~>=$sqltver" (see $class documentation for details)
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user.
EOD
+ '=head2 die_unless_req_ok_for',
+ '=over',
+ '=item Arguments: $group_name',
+ '=back',
+ <<'EOD',
+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>.
+EOD
+
'=head2 req_errorlist_for',
'=over',
'=item Arguments: $group_name',
- '=item Returns: \%list_of_loaderrors_per_module',
+ '=item Return Value: \%list_of_loaderrors_per_module',
'=back',
<<'EOD',
-Returns a hashref containing the actual errors that occured while attempting
+Returns a hashref containing the actual errors that occurred while attempting
to load each module in the requirement group.
EOD
- '=head1 AUTHOR',
- 'See L<DBIx::Class/CONTRIBUTORS>.',
- '=head1 LICENSE',
- 'You may distribute this code under the same terms as Perl itself',
);
- open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
- print $fh join ("\n\n", @chunks);
- close ($fh);
+
+#@@
+#@@ FOOTER
+#@@
+ push @chunks, (
+ '=head1 FURTHER QUESTIONS?',
+ 'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
+ '=head1 COPYRIGHT AND LICENSE',
+ <<'EOL',
+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>.
+EOL
+
+ );
+
+
+ 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