1 package DBIx::Class::Optional::Dependencies;
8 # NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G)
9 # This module is to be loaded by Makefile.PM on a pristine system
11 # POD is generated automatically by calling _gen_pod from the
12 # Makefile.PL in $AUTHOR mode
14 # NOTE: the rationale for 2 JSON::Any versions is that
15 # we need the newer only to work around JSON::XS, which
16 # itself is an optional dep
18 'JSON::Any' => '1.23',
20 my $test_and_dist_json_any = {
21 'JSON::Any' => '1.31',
26 'MooseX::Types' => '0.21',
27 'MooseX::Types::LoadableClass' => '0.011',
37 'MooseX::Types::Path::Class' => '0.05',
38 'MooseX::Types::JSON' => '0.02',
39 'namespace::autoclean' => '0.09',
45 'Getopt::Long::Descriptive' => '0.081',
46 'Text::CSV' => '1.16',
49 my $datetime_basic = {
51 'DateTime::Format::Strptime' => '1.2',
55 'Math::BigInt' => '1.80',
56 'Math::Base36' => '0.07',
65 my $rdbms_mssql_odbc = {
68 my $rdbms_mssql_sybase = {
71 my $rdbms_mssql_ado = {
74 my $rdbms_msaccess_odbc = {
77 my $rdbms_msaccess_ado = {
96 my $rdbms_informix = {
97 'DBD::Informix' => '0',
99 my $rdbms_sqlanywhere = {
100 'DBD::SQLAnywhere' => '0',
102 my $rdbms_sqlanywhere_odbc = {
105 my $rdbms_firebird = {
106 'DBD::Firebird' => '0',
108 my $rdbms_firebird_interbase = {
109 'DBD::InterBase' => '0',
111 my $rdbms_firebird_odbc = {
119 title => 'Storage::Replicated',
120 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
127 'Test::Moose' => '0',
137 title => 'DBIx::Class::Admin',
138 desc => 'Modules required for the DBIx::Class administrative library',
147 title => 'dbicadmin',
148 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
154 'SQL::Translator' => '0.11016',
157 title => 'Storage::DBI::deploy()',
158 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
163 req => $id_shortener,
166 test_component_accessor => {
168 'Class::Unload' => '0.07',
174 'Test::Pod' => '1.42',
178 test_podcoverage => {
180 'Test::Pod::Coverage' => '1.08',
181 'Pod::Coverage' => '0.20',
187 'Test::EOL' => '1.0',
188 'Test::NoTabs' => '0.9',
194 'Test::Strict' => '0.20',
198 test_prettydebug => {
199 req => $min_json_any,
202 test_admin_script => {
205 %$test_and_dist_json_any,
208 'Cpanel::JSON::XS' => 0,
211 # for t/admin/10script.t
212 ? ('Win32::ShellQuote' => 0)
213 # DWIW does not compile (./configure even) on win32
214 : ('JSON::DWIW' => 0 )
221 'Test::Memory::Cycle' => '0',
222 'Devel::Cycle' => '1.10',
227 req => $datetime_basic,
235 'DateTime::Format::SQLite' => '0',
242 # t/inflate/datetime_mysql.t
243 # (doesn't need Mysql itself)
244 'DateTime::Format::MySQL' => '0',
251 # t/inflate/datetime_pg.t
252 # (doesn't need PG itself)
253 'DateTime::Format::Pg' => '0.16004',
259 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
261 'Time::Piece::MySQL' => '0',
262 'Date::Simple' => '3.03',
266 # this is just for completeness as SQLite
267 # is a core dep of DBIC for testing
273 title => 'SQLite support',
274 desc => 'Modules required to connect to SQLite',
280 # when changing this list make sure to adjust xt/optional_deps.t
284 title => 'PostgreSQL support',
285 desc => 'Modules required to connect to PostgreSQL',
289 rdbms_mssql_odbc => {
294 title => 'MSSQL support via DBD::ODBC',
295 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
299 rdbms_mssql_sybase => {
301 %$rdbms_mssql_sybase,
304 title => 'MSSQL support via DBD::Sybase',
305 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
314 title => 'MSSQL support via DBD::ADO (Windows only)',
315 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
319 rdbms_msaccess_odbc => {
321 %$rdbms_msaccess_odbc,
324 title => 'MS Access support via DBD::ODBC',
325 desc => 'Modules required to connect to MS Access via DBD::ODBC',
329 rdbms_msaccess_ado => {
331 %$rdbms_msaccess_ado,
334 title => 'MS Access support via DBD::ADO (Windows only)',
335 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
344 title => 'MySQL support',
345 desc => 'Modules required to connect to MySQL',
354 title => 'Oracle support',
355 desc => 'Modules required to connect to Oracle',
364 title => 'Sybase ASE support',
365 desc => 'Modules required to connect to Sybase ASE',
374 title => 'DB2 support',
375 desc => 'Modules required to connect to DB2',
384 title => 'DB2 on AS/400 support',
385 desc => 'Modules required to connect to DB2 on AS/400',
394 title => 'Informix support',
395 desc => 'Modules required to connect to Informix',
399 rdbms_sqlanywhere => {
404 title => 'SQLAnywhere support',
405 desc => 'Modules required to connect to SQLAnywhere',
409 rdbms_sqlanywhere_odbc => {
411 %$rdbms_sqlanywhere_odbc,
414 title => 'SQLAnywhere support via DBD::ODBC',
415 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
424 title => 'Firebird support',
425 desc => 'Modules required to connect to Firebird',
429 rdbms_firebird_interbase => {
431 %$rdbms_firebird_interbase,
434 title => 'Firebird support via DBD::InterBase',
435 desc => 'Modules required to connect to Firebird via DBD::InterBase',
439 rdbms_firebird_odbc => {
441 %$rdbms_firebird_odbc,
444 title => 'Firebird support via DBD::ODBC',
445 desc => 'Modules required to connect to Firebird via DBD::ODBC',
449 # the order does matter because the rdbms support group might require
450 # a different version that the test group
453 $ENV{DBICTEST_PG_DSN}
455 # when changing this list make sure to adjust xt/optional_deps.t
457 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
458 'DBD::Pg' => '2.009002',
463 test_rdbms_mssql_odbc => {
465 $ENV{DBICTEST_MSSQL_ODBC_DSN}
472 test_rdbms_mssql_ado => {
474 $ENV{DBICTEST_MSSQL_ADO_DSN}
481 test_rdbms_mssql_sybase => {
483 $ENV{DBICTEST_MSSQL_DSN}
485 %$rdbms_mssql_sybase,
490 test_rdbms_msaccess_odbc => {
492 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
494 %$rdbms_msaccess_odbc,
501 test_rdbms_msaccess_ado => {
503 $ENV{DBICTEST_MSACCESS_ADO_DSN}
505 %$rdbms_msaccess_ado,
512 test_rdbms_mysql => {
514 $ENV{DBICTEST_MYSQL_DSN}
521 test_rdbms_oracle => {
523 $ENV{DBICTEST_ORA_DSN}
526 'DateTime::Format::Oracle' => '0',
527 'DBD::Oracle' => '1.24',
534 $ENV{DBICTEST_SYBASE_DSN}
543 $ENV{DBICTEST_DB2_DSN}
550 test_rdbms_db2_400 => {
552 $ENV{DBICTEST_DB2_400_DSN}
559 test_rdbms_informix => {
561 $ENV{DBICTEST_INFORMIX_DSN}
568 test_rdbms_sqlanywhere => {
570 $ENV{DBICTEST_SQLANYWHERE_DSN}
577 test_rdbms_sqlanywhere_odbc => {
579 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
581 %$rdbms_sqlanywhere_odbc,
586 test_rdbms_firebird => {
588 $ENV{DBICTEST_FIREBIRD_DSN}
595 test_rdbms_firebird_interbase => {
597 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
599 %$rdbms_firebird_interbase,
604 test_rdbms_firebird_odbc => {
606 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
608 %$rdbms_firebird_odbc,
615 $ENV{DBICTEST_MEMCACHED}
617 'Cache::Memcached' => 0,
624 %$test_and_dist_json_any,
625 'ExtUtils::MakeMaker' => '6.64',
626 'Pod::Inherit' => '0.90',
633 'CPAN::Uploader' => '0.103001',
639 our %req_availability_cache;
642 my ($class, $group) = @_;
644 Carp::croak "req_list_for() expects a requirement group name"
647 my $deps = $reqs->{$group}{req}
648 or Carp::croak "Requirement group '$group' does not exist";
654 sub die_unless_req_ok_for {
655 my ($class, $group) = @_;
657 Carp::croak "die_unless_req_ok_for() expects a requirement group name"
660 $class->_check_deps($group)->{status}
661 or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
665 my ($class, $group) = @_;
667 Carp::croak "req_ok_for() expects a requirement group name"
670 return $class->_check_deps($group)->{status};
673 sub req_missing_for {
674 my ($class, $group) = @_;
676 Carp::croak "req_missing_for() expects a requirement group name"
679 return $class->_check_deps($group)->{missing};
682 sub req_errorlist_for {
683 my ($class, $group) = @_;
685 Carp::croak "req_errorlist_for() expects a requirement group name"
688 return $class->_check_deps($group)->{errorlist};
692 my ($class, $group) = @_;
694 return $req_availability_cache{$group} ||= do {
696 my $deps = $class->req_list_for ($group);
699 for my $mod (keys %$deps) {
700 my $req_line = "require $mod;";
701 if (my $ver = $deps->{$mod}) {
702 $req_line .= "$mod->VERSION($ver);";
707 $errors{$mod} = $@ if $@;
713 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
714 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
717 errorlist => \%errors,
734 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
737 # This is to be called by the author only (automatically in Makefile.PL)
739 my ($class, $distver, $pod_dir) = @_;
741 die "No POD root dir supplied" unless $pod_dir;
744 eval { require DBIx::Class; DBIx::Class->VERSION; }
747 "\n\n---------------------------------------------------------------------\n" .
748 'Unable to load core DBIx::Class module to determine current version, '.
749 'possibly due to missing dependencies. Author-mode autodocumentation ' .
751 "\n\n---------------------------------------------------------------------\n"
754 # do not ask for a recent version, use 1.x API calls
755 # this *may* execute on a smoker with old perl or whatnot
758 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
760 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
761 (my $dir = $podfn) =~ s|/[^/]+$||;
763 File::Path::mkpath([$dir]);
765 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
766 or die "Hrmm? No sqlt dep?";
770 #########################################################################
771 ##################### A U T O G E N E R A T E D ########################
772 #########################################################################
774 # The contents of this POD file are auto-generated. Any changes you make
775 # will be lost. If you need to change the generated text edit _gen_pod()
776 # at the end of $modfn
780 "$class - Optional module dependency specifications (for module authors)",
783 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
787 configure_requires 'DBIx::Class' => '$distver';
791 my \$deploy_deps = $class->req_list_for('deploy');
793 for (keys %\$deploy_deps) {
794 requires \$_ => \$deploy_deps->{\$_};
799 Note that there are some caveats regarding C<configure_requires()>, more info
800 can be found at L<Module::Install/configure_requires>
802 '=head1 DESCRIPTION',
804 Some of the less-frequently used features of L<DBIx::Class> have external
805 module dependencies on their own. In order not to burden the average user
806 with modules he will never use, these optional dependencies are not included
807 in the base Makefile.PL. Instead an exception with a descriptive message is
808 thrown when a specific feature is missing one or several modules required for
809 its operation. This module is the central holding place for the current list
810 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
813 '=head1 CURRENT REQUIREMENT GROUPS',
815 Dependencies are organized in C<groups> and each group can list one or more
816 required modules, with an optional minimum version (or 0 for any version).
817 The group name can be used in the
821 for my $group (sort keys %$reqs) {
822 my $p = $reqs->{$group}{pod}
825 my $modlist = $reqs->{$group}{req}
828 next unless keys %$modlist;
831 "=head2 $p->{title}",
834 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
836 "Requirement group: B<$group>",
842 '=head2 req_group_list',
844 '=item Arguments: none',
845 '=item Return Value: \%list_of_requirement_groups',
848 This method should be used by DBIx::Class packagers, to get a hashref of all
849 dependencies keyed by dependency group. Each key (group name) can be supplied
850 to one of the group-specific methods below.
853 '=head2 req_list_for',
855 '=item Arguments: $group_name',
856 '=item Return Value: \%list_of_module_version_pairs',
859 This method should be used by DBIx::Class extension authors, to determine the
860 version of modules a specific feature requires in the B<current> version of
861 DBIx::Class. See the L</SYNOPSIS> for a real-world
867 '=item Arguments: $group_name',
868 '=item Return Value: 1|0',
871 Returns true or false depending on whether all modules required by
872 C<$group_name> are present on the system and loadable.
875 '=head2 req_missing_for',
877 '=item Arguments: $group_name',
878 '=item Return Value: $error_message_string',
881 Returns a single line string suitable for inclusion in larger error messages.
882 This method would normally be used by DBIx::Class core-module author, to
883 indicate to the user that he needs to install specific modules before he will
884 be able to use a specific feature.
886 For example if some of the requirements for C<deploy> are not available,
887 the returned string could look like:
889 SQL::Translator >= $sqltver (see $class for details)
891 The author is expected to prepend the necessary text to this message before
892 returning the actual error seen by the user.
895 '=head2 die_unless_req_ok_for',
897 '=item Arguments: $group_name',
900 Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
901 in case of failure throws an exception including the information
902 from L</req_missing_for>.
905 '=head2 req_errorlist_for',
907 '=item Arguments: $group_name',
908 '=item Return Value: \%list_of_loaderrors_per_module',
911 Returns a hashref containing the actual errors that occurred while attempting
912 to load each module in the requirement group.
915 'See L<DBIx::Class/CONTRIBUTORS>.',
917 'You may distribute this code under the same terms as Perl itself',
920 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
921 print $fh join ("\n\n", @chunks);