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',
44 'Getopt::Long::Descriptive' => '0.081',
45 'Text::CSV' => '1.16',
48 my $datetime_basic = {
50 'DateTime::Format::Strptime' => '1.2',
54 'Math::BigInt' => '1.80',
55 'Math::Base36' => '0.07',
64 my $rdbms_mssql_odbc = {
67 my $rdbms_mssql_sybase = {
70 my $rdbms_mssql_ado = {
73 my $rdbms_msaccess_odbc = {
76 my $rdbms_msaccess_ado = {
95 my $rdbms_informix = {
96 'DBD::Informix' => '0',
98 my $rdbms_sqlanywhere = {
99 'DBD::SQLAnywhere' => '0',
101 my $rdbms_sqlanywhere_odbc = {
104 my $rdbms_firebird = {
105 'DBD::Firebird' => '0',
107 my $rdbms_firebird_interbase = {
108 'DBD::InterBase' => '0',
110 my $rdbms_firebird_odbc = {
118 title => 'Storage::Replicated',
119 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
126 'Test::Moose' => '0',
136 title => 'DBIx::Class::Admin',
137 desc => 'Modules required for the DBIx::Class administrative library',
146 title => 'dbicadmin',
147 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
153 'SQL::Translator' => '0.11018',
156 title => 'Storage::DBI::deploy()',
157 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
162 req => $id_shortener,
165 test_component_accessor => {
167 'Class::Unload' => '0.07',
173 'Test::Pod' => '1.42',
177 test_podcoverage => {
179 'Test::Pod::Coverage' => '1.08',
180 'Pod::Coverage' => '0.20',
186 'Test::EOL' => '1.0',
187 'Test::NoTabs' => '0.9',
193 'Test::Strict' => '0.20',
197 test_prettydebug => {
198 req => $min_json_any,
201 test_admin_script => {
204 %$test_and_dist_json_any,
207 'Cpanel::JSON::XS' => 0,
210 # for t/admin/10script.t
211 ? ('Win32::ShellQuote' => 0)
212 # DWIW does not compile (./configure even) on win32
213 : ('JSON::DWIW' => 0 )
218 test_leaks_heavy => {
220 'Class::MethodCache' => '0.02',
221 'PadWalker' => '1.06',
226 req => $datetime_basic,
234 'DateTime::Format::SQLite' => '0',
241 # t/inflate/datetime_mysql.t
242 # (doesn't need Mysql itself)
243 'DateTime::Format::MySQL' => '0',
250 # t/inflate/datetime_pg.t
251 # (doesn't need PG itself)
252 'DateTime::Format::Pg' => '0.16004',
259 'Time::Piece::MySQL' => '0',
260 'Date::Simple' => '3.03',
264 test_cdbicompat_deepabstractsearch => {
266 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
272 'Class::Trigger' => '0',
273 'DBIx::ContextualFetch' => '0',
280 'Class::Trigger' => '0',
281 'DBIx::ContextualFetch' => '0',
286 # this is just for completeness as SQLite
287 # is a core dep of DBIC for testing
293 title => 'SQLite support',
294 desc => 'Modules required to connect to SQLite',
300 # when changing this list make sure to adjust xt/optional_deps.t
304 title => 'PostgreSQL support',
305 desc => 'Modules required to connect to PostgreSQL',
309 rdbms_mssql_odbc => {
314 title => 'MSSQL support via DBD::ODBC',
315 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
319 rdbms_mssql_sybase => {
321 %$rdbms_mssql_sybase,
324 title => 'MSSQL support via DBD::Sybase',
325 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
334 title => 'MSSQL support via DBD::ADO (Windows only)',
335 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
339 rdbms_msaccess_odbc => {
341 %$rdbms_msaccess_odbc,
344 title => 'MS Access support via DBD::ODBC',
345 desc => 'Modules required to connect to MS Access via DBD::ODBC',
349 rdbms_msaccess_ado => {
351 %$rdbms_msaccess_ado,
354 title => 'MS Access support via DBD::ADO (Windows only)',
355 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
364 title => 'MySQL support',
365 desc => 'Modules required to connect to MySQL',
374 title => 'Oracle support',
375 desc => 'Modules required to connect to Oracle',
384 title => 'Sybase ASE support',
385 desc => 'Modules required to connect to Sybase ASE',
394 title => 'DB2 support',
395 desc => 'Modules required to connect to DB2',
404 title => 'DB2 on AS/400 support',
405 desc => 'Modules required to connect to DB2 on AS/400',
414 title => 'Informix support',
415 desc => 'Modules required to connect to Informix',
419 rdbms_sqlanywhere => {
424 title => 'SQLAnywhere support',
425 desc => 'Modules required to connect to SQLAnywhere',
429 rdbms_sqlanywhere_odbc => {
431 %$rdbms_sqlanywhere_odbc,
434 title => 'SQLAnywhere support via DBD::ODBC',
435 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
444 title => 'Firebird support',
445 desc => 'Modules required to connect to Firebird',
449 rdbms_firebird_interbase => {
451 %$rdbms_firebird_interbase,
454 title => 'Firebird support via DBD::InterBase',
455 desc => 'Modules required to connect to Firebird via DBD::InterBase',
459 rdbms_firebird_odbc => {
461 %$rdbms_firebird_odbc,
464 title => 'Firebird support via DBD::ODBC',
465 desc => 'Modules required to connect to Firebird via DBD::ODBC',
469 # the order does matter because the rdbms support group might require
470 # a different version that the test group
473 $ENV{DBICTEST_PG_DSN}
475 # when changing this list make sure to adjust xt/optional_deps.t
477 'DBD::Pg' => '2.009002',
482 test_rdbms_mssql_odbc => {
484 $ENV{DBICTEST_MSSQL_ODBC_DSN}
491 test_rdbms_mssql_ado => {
493 $ENV{DBICTEST_MSSQL_ADO_DSN}
500 test_rdbms_mssql_sybase => {
502 $ENV{DBICTEST_MSSQL_DSN}
504 %$rdbms_mssql_sybase,
509 test_rdbms_msaccess_odbc => {
511 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
513 %$rdbms_msaccess_odbc,
520 test_rdbms_msaccess_ado => {
522 $ENV{DBICTEST_MSACCESS_ADO_DSN}
524 %$rdbms_msaccess_ado,
531 test_rdbms_mysql => {
533 $ENV{DBICTEST_MYSQL_DSN}
540 test_rdbms_oracle => {
542 $ENV{DBICTEST_ORA_DSN}
545 'DateTime::Format::Oracle' => '0',
546 'DBD::Oracle' => '1.24',
553 $ENV{DBICTEST_SYBASE_DSN}
562 $ENV{DBICTEST_DB2_DSN}
569 test_rdbms_db2_400 => {
571 $ENV{DBICTEST_DB2_400_DSN}
578 test_rdbms_informix => {
580 $ENV{DBICTEST_INFORMIX_DSN}
587 test_rdbms_sqlanywhere => {
589 $ENV{DBICTEST_SQLANYWHERE_DSN}
596 test_rdbms_sqlanywhere_odbc => {
598 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
600 %$rdbms_sqlanywhere_odbc,
605 test_rdbms_firebird => {
607 $ENV{DBICTEST_FIREBIRD_DSN}
614 test_rdbms_firebird_interbase => {
616 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
618 %$rdbms_firebird_interbase,
623 test_rdbms_firebird_odbc => {
625 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
627 %$rdbms_firebird_odbc,
634 $ENV{DBICTEST_MEMCACHED}
636 'Cache::Memcached' => 0,
643 %$test_and_dist_json_any,
644 'ExtUtils::MakeMaker' => '6.64',
645 'Pod::Inherit' => '0.91',
651 'CPAN::Uploader' => '0.103001',
657 our %req_availability_cache;
660 my ($class, $group) = @_;
662 Carp::croak "req_list_for() expects a requirement group name"
665 my $deps = $reqs->{$group}{req}
666 or Carp::croak "Requirement group '$group' does not exist";
672 sub die_unless_req_ok_for {
673 my ($class, $group) = @_;
675 Carp::croak "die_unless_req_ok_for() expects a requirement group name"
678 $class->_check_deps($group)->{status}
679 or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
683 my ($class, $group) = @_;
685 Carp::croak "req_ok_for() expects a requirement group name"
688 return $class->_check_deps($group)->{status};
691 sub req_missing_for {
692 my ($class, $group) = @_;
694 Carp::croak "req_missing_for() expects a requirement group name"
697 return $class->_check_deps($group)->{missing};
700 sub req_errorlist_for {
701 my ($class, $group) = @_;
703 Carp::croak "req_errorlist_for() expects a requirement group name"
706 return $class->_check_deps($group)->{errorlist};
710 my ($class, $group) = @_;
712 return $req_availability_cache{$group} ||= do {
714 my $deps = $class->req_list_for ($group);
717 for my $mod (keys %$deps) {
718 my $req_line = "require $mod;";
719 if (my $ver = $deps->{$mod}) {
720 $req_line .= "$mod->VERSION($ver);";
725 $errors{$mod} = $@ if $@;
731 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
732 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
735 errorlist => \%errors,
752 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
755 # This is to be called by the author only (automatically in Makefile.PL)
757 my ($class, $distver, $pod_dir) = @_;
759 die "No POD root dir supplied" unless $pod_dir;
762 eval { require DBIx::Class; DBIx::Class->VERSION; }
765 "\n\n---------------------------------------------------------------------\n" .
766 'Unable to load core DBIx::Class module to determine current version, '.
767 'possibly due to missing dependencies. Author-mode autodocumentation ' .
769 "\n\n---------------------------------------------------------------------\n"
772 # do not ask for a recent version, use 1.x API calls
773 # this *may* execute on a smoker with old perl or whatnot
776 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
778 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
779 (my $dir = $podfn) =~ s|/[^/]+$||;
781 File::Path::mkpath([$dir]);
783 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
784 or die "Hrmm? No sqlt dep?";
788 #########################################################################
789 ##################### A U T O G E N E R A T E D ########################
790 #########################################################################
792 # The contents of this POD file are auto-generated. Any changes you make
793 # will be lost. If you need to change the generated text edit _gen_pod()
794 # at the end of $modfn
798 "$class - Optional module dependency specifications (for module authors)",
801 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
805 configure_requires 'DBIx::Class' => '$distver';
809 my \$deploy_deps = $class->req_list_for('deploy');
811 for (keys %\$deploy_deps) {
812 requires \$_ => \$deploy_deps->{\$_};
817 Note that there are some caveats regarding C<configure_requires()>, more info
818 can be found at L<Module::Install/configure_requires>
820 '=head1 DESCRIPTION',
822 Some of the less-frequently used features of L<DBIx::Class> have external
823 module dependencies on their own. In order not to burden the average user
824 with modules he will never use, these optional dependencies are not included
825 in the base Makefile.PL. Instead an exception with a descriptive message is
826 thrown when a specific feature is missing one or several modules required for
827 its operation. This module is the central holding place for the current list
828 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
831 '=head1 CURRENT REQUIREMENT GROUPS',
833 Dependencies are organized in C<groups> and each group can list one or more
834 required modules, with an optional minimum version (or 0 for any version).
835 The group name can be used in the
839 for my $group (sort keys %$reqs) {
840 my $p = $reqs->{$group}{pod}
843 my $modlist = $reqs->{$group}{req}
846 next unless keys %$modlist;
849 "=head2 $p->{title}",
852 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
854 "Requirement group: B<$group>",
860 '=head2 req_group_list',
862 '=item Arguments: none',
863 '=item Return Value: \%list_of_requirement_groups',
866 This method should be used by DBIx::Class packagers, to get a hashref of all
867 dependencies keyed by dependency group. Each key (group name) can be supplied
868 to one of the group-specific methods below.
871 '=head2 req_list_for',
873 '=item Arguments: $group_name',
874 '=item Return Value: \%list_of_module_version_pairs',
877 This method should be used by DBIx::Class extension authors, to determine the
878 version of modules a specific feature requires in the B<current> version of
879 DBIx::Class. See the L</SYNOPSIS> for a real-world
885 '=item Arguments: $group_name',
886 '=item Return Value: 1|0',
889 Returns true or false depending on whether all modules required by
890 C<$group_name> are present on the system and loadable.
893 '=head2 req_missing_for',
895 '=item Arguments: $group_name',
896 '=item Return Value: $error_message_string',
899 Returns a single line string suitable for inclusion in larger error messages.
900 This method would normally be used by DBIx::Class core-module author, to
901 indicate to the user that he needs to install specific modules before he will
902 be able to use a specific feature.
904 For example if some of the requirements for C<deploy> are not available,
905 the returned string could look like:
907 SQL::Translator >= $sqltver (see $class for details)
909 The author is expected to prepend the necessary text to this message before
910 returning the actual error seen by the user.
913 '=head2 die_unless_req_ok_for',
915 '=item Arguments: $group_name',
918 Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
919 in case of failure throws an exception including the information
920 from L</req_missing_for>.
923 '=head2 req_errorlist_for',
925 '=item Arguments: $group_name',
926 '=item Return Value: \%list_of_loaderrors_per_module',
929 Returns a hashref containing the actual errors that occurred while attempting
930 to load each module in the requirement group.
932 '=head1 FURTHER QUESTIONS?',
933 'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
934 '=head1 COPYRIGHT AND LICENSE',
936 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
937 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
938 redistribute it and/or modify it under the same terms as the
939 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
944 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
945 print $fh join ("\n\n", @chunks);