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
15 'JSON::Any' => '1.22',
20 'MooseX::Types' => '0.21',
30 'MooseX::Types::Path::Class' => '0.05',
31 'MooseX::Types::JSON' => '0.02',
32 'namespace::autoclean' => '0.09',
35 my $datetime_basic = {
37 'DateTime::Format::Strptime' => '1.2',
41 'Math::BigInt' => '1.80',
42 'Math::Base36' => '0.07',
51 my $rdbms_mssql_odbc = {
54 my $rdbms_mssql_sybase = {
57 my $rdbms_mssql_ado = {
60 my $rdbms_msaccess_odbc = {
63 my $rdbms_msaccess_ado = {
82 my $rdbms_informix = {
83 'DBD::Informix' => '0',
85 my $rdbms_sqlanywhere = {
86 'DBD::SQLAnywhere' => '0',
88 my $rdbms_sqlanywhere_odbc = {
91 my $rdbms_firebird = {
92 'DBD::Firebird' => '0',
94 my $rdbms_firebird_interbase = {
95 'DBD::InterBase' => '0',
97 my $rdbms_firebird_odbc = {
103 #'Module::Install::Pod::Inherit' => '0.01',
109 title => 'Storage::Replicated',
110 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
117 'Test::Moose' => '0',
127 title => 'DBIx::Class::Admin',
128 desc => 'Modules required for the DBIx::Class administrative library',
136 'Getopt::Long::Descriptive' => '0.081',
137 'Text::CSV' => '1.16',
140 title => 'dbicadmin',
141 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
147 'SQL::Translator' => '0.11006',
150 title => 'Storage::DBI::deploy()',
151 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
156 req => $id_shortener,
159 test_component_accessor => {
161 'Class::Unload' => '0.07',
167 'Test::Pod' => '1.41',
171 test_podcoverage => {
173 'Test::Pod::Coverage' => '1.08',
174 'Pod::Coverage' => '0.20',
180 'Test::NoTabs' => '0.9',
186 'Test::EOL' => '1.0',
190 test_prettydebug => {
196 'Test::Memory::Cycle' => '0',
197 'Devel::Cycle' => '1.10',
202 req => $datetime_basic,
210 'DateTime::Format::SQLite' => '0',
217 # t/inflate/datetime_mysql.t
218 # (doesn't need Mysql itself)
219 'DateTime::Format::MySQL' => '0',
226 # t/inflate/datetime_pg.t
227 # (doesn't need PG itself)
228 'DateTime::Format::Pg' => '0.16004',
235 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
237 'Time::Piece::MySQL' => '0',
238 'Date::Simple' => '3.03',
242 # this is just for completeness as SQLite
243 # is a core dep of DBIC for testing
249 title => 'SQLite support',
250 desc => 'Modules required to connect to SQLite',
256 # when changing this list make sure to adjust xt/optional_deps.t
260 title => 'PostgreSQL support',
261 desc => 'Modules required to connect to PostgreSQL',
265 rdbms_mssql_odbc => {
270 title => 'MSSQL support via DBD::ODBC',
271 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
275 rdbms_mssql_sybase => {
277 %$rdbms_mssql_sybase,
280 title => 'MSSQL support via DBD::Sybase',
281 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
290 title => 'MSSQL support via DBD::ADO (Windows only)',
291 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
295 rdbms_msaccess_odbc => {
297 %$rdbms_msaccess_odbc,
300 title => 'MS Access support via DBD::ODBC',
301 desc => 'Modules required to connect to MS Access via DBD::ODBC',
305 rdbms_msaccess_ado => {
307 %$rdbms_msaccess_ado,
310 title => 'MS Access support via DBD::ADO (Windows only)',
311 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
320 title => 'MySQL support',
321 desc => 'Modules required to connect to MySQL',
330 title => 'Oracle support',
331 desc => 'Modules required to connect to Oracle',
340 title => 'Sybase ASE support',
341 desc => 'Modules required to connect to Sybase ASE',
350 title => 'DB2 support',
351 desc => 'Modules required to connect to DB2',
360 title => 'DB2 on AS/400 support',
361 desc => 'Modules required to connect to DB2 on AS/400',
370 title => 'Informix support',
371 desc => 'Modules required to connect to Informix',
375 rdbms_sqlanywhere => {
380 title => 'SQLAnywhere support',
381 desc => 'Modules required to connect to SQLAnywhere',
385 rdbms_sqlanywhere_odbc => {
387 %$rdbms_sqlanywhere_odbc,
390 title => 'SQLAnywhere support via DBD::ODBC',
391 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
400 title => 'Firebird support',
401 desc => 'Modules required to connect to Firebird',
405 rdbms_firebird_interbase => {
407 %$rdbms_firebird_interbase,
410 title => 'Firebird support via DBD::InterBase',
411 desc => 'Modules required to connect to Firebird via DBD::InterBase',
415 rdbms_firebird_odbc => {
417 %$rdbms_firebird_odbc,
420 title => 'Firebird support via DBD::ODBC',
421 desc => 'Modules required to connect to Firebird via DBD::ODBC',
425 # the order does matter because the rdbms support group might require
426 # a different version that the test group
429 $ENV{DBICTEST_PG_DSN}
431 # when changing this list make sure to adjust xt/optional_deps.t
433 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
434 'DBD::Pg' => '2.009002',
439 test_rdbms_mssql_odbc => {
441 $ENV{DBICTEST_MSSQL_ODBC_DSN}
448 test_rdbms_mssql_ado => {
450 $ENV{DBICTEST_MSSQL_ADO_DSN}
457 test_rdbms_mssql_sybase => {
459 $ENV{DBICTEST_MSSQL_DSN}
461 %$rdbms_mssql_sybase,
466 test_rdbms_msaccess_odbc => {
468 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
470 %$rdbms_msaccess_odbc,
477 test_rdbms_msaccess_ado => {
479 $ENV{DBICTEST_MSACCESS_ADO_DSN}
481 %$rdbms_msaccess_ado,
488 test_rdbms_mysql => {
490 $ENV{DBICTEST_MYSQL_DSN}
497 test_rdbms_oracle => {
499 $ENV{DBICTEST_ORA_DSN}
502 'DateTime::Format::Oracle' => '0',
503 'DBD::Oracle' => '1.24',
510 $ENV{DBICTEST_SYBASE_DSN}
519 $ENV{DBICTEST_DB2_DSN}
526 test_rdbms_db2_400 => {
528 $ENV{DBICTEST_DB2_400_DSN}
535 test_rdbms_informix => {
537 $ENV{DBICTEST_INFORMIX_DSN}
544 test_rdbms_sqlanywhere => {
546 $ENV{DBICTEST_SQLANYWHERE_DSN}
553 test_rdbms_sqlanywhere_odbc => {
555 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
557 %$rdbms_sqlanywhere_odbc,
562 test_rdbms_firebird => {
564 $ENV{DBICTEST_FIREBIRD_DSN}
571 test_rdbms_firebird_interbase => {
573 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
575 %$rdbms_firebird_interbase,
580 test_rdbms_firebird_odbc => {
582 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
584 %$rdbms_firebird_odbc,
591 $ENV{DBICTEST_MEMCACHED}
593 'Cache::Memcached' => 0,
602 my ($class, $group) = @_;
604 Carp::croak "req_list_for() expects a requirement group name"
607 my $deps = $reqs->{$group}{req}
608 or Carp::croak "Requirement group '$group' does not exist";
614 our %req_availability_cache;
616 my ($class, $group) = @_;
618 Carp::croak "req_ok_for() expects a requirement group name"
621 return $class->_check_deps($group)->{status};
624 sub req_missing_for {
625 my ($class, $group) = @_;
627 Carp::croak "req_missing_for() expects a requirement group name"
630 return $class->_check_deps($group)->{missing};
633 sub req_errorlist_for {
634 my ($class, $group) = @_;
636 Carp::croak "req_errorlist_for() expects a requirement group name"
639 return $class->_check_deps($group)->{errorlist};
643 my ($class, $group) = @_;
645 return $req_availability_cache{$group} ||= do {
647 my $deps = $class->req_list_for ($group);
650 for my $mod (keys %$deps) {
651 my $req_line = "require $mod;";
652 if (my $ver = $deps->{$mod}) {
653 $req_line .= "$mod->VERSION($ver);";
658 $errors{$mod} = $@ if $@;
664 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
665 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
668 errorlist => \%errors,
685 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
688 # This is to be called by the author only (automatically in Makefile.PL)
690 my ($class, $distver) = @_;
692 my $modfn = __PACKAGE__ . '.pm';
693 $modfn =~ s/\:\:/\//g;
695 my $podfn = __FILE__;
696 $podfn =~ s/\.pm$/\.pod/;
699 eval { require DBIx::Class; DBIx::Class->VERSION; }
702 "\n\n---------------------------------------------------------------------\n" .
703 'Unable to load core DBIx::Class module to determine current version, '.
704 'possibly due to missing dependencies. Author-mode autodocumentation ' .
706 "\n\n---------------------------------------------------------------------\n"
709 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
710 or die "Hrmm? No sqlt dep?";
714 #########################################################################
715 ##################### A U T O G E N E R A T E D ########################
716 #########################################################################
718 # The contents of this POD file are auto-generated. Any changes you make
719 # will be lost. If you need to change the generated text edit _gen_pod()
720 # at the end of $modfn
724 "$class - Optional module dependency specifications (for module authors)",
727 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
731 configure_requires 'DBIx::Class' => '$distver';
735 my \$deploy_deps = $class->req_list_for('deploy');
737 for (keys %\$deploy_deps) {
738 requires \$_ => \$deploy_deps->{\$_};
743 Note that there are some caveats regarding C<configure_requires()>, more info
744 can be found at L<Module::Install/configure_requires>
746 '=head1 DESCRIPTION',
748 Some of the less-frequently used features of L<DBIx::Class> have external
749 module dependencies on their own. In order not to burden the average user
750 with modules he will never use, these optional dependencies are not included
751 in the base Makefile.PL. Instead an exception with a descriptive message is
752 thrown when a specific feature is missing one or several modules required for
753 its operation. This module is the central holding place for the current list
754 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
757 '=head1 CURRENT REQUIREMENT GROUPS',
759 Dependencies are organized in C<groups> and each group can list one or more
760 required modules, with an optional minimum version (or 0 for any version).
761 The group name can be used in the
765 for my $group (sort keys %$reqs) {
766 my $p = $reqs->{$group}{pod}
769 my $modlist = $reqs->{$group}{req}
772 next unless keys %$modlist;
775 "=head2 $p->{title}",
778 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
780 "Requirement group: B<$group>",
786 '=head2 req_group_list',
788 '=item Arguments: none',
789 '=item Returns: \%list_of_requirement_groups',
792 This method should be used by DBIx::Class packagers, to get a hashref of all
793 dependencies keyed by dependency group. Each key (group name) can be supplied
794 to one of the group-specific methods below.
797 '=head2 req_list_for',
799 '=item Arguments: $group_name',
800 '=item Returns: \%list_of_module_version_pairs',
803 This method should be used by DBIx::Class extension authors, to determine the
804 version of modules a specific feature requires in the B<current> version of
805 DBIx::Class. See the L</SYNOPSIS> for a real-world
811 '=item Arguments: $group_name',
812 '=item Returns: 1|0',
815 Returns true or false depending on whether all modules required by
816 C<$group_name> are present on the system and loadable.
819 '=head2 req_missing_for',
821 '=item Arguments: $group_name',
822 '=item Returns: $error_message_string',
825 Returns a single line string suitable for inclusion in larger error messages.
826 This method would normally be used by DBIx::Class core-module author, to
827 indicate to the user that he needs to install specific modules before he will
828 be able to use a specific feature.
830 For example if some of the requirements for C<deploy> are not available,
831 the returned string could look like:
833 SQL::Translator >= $sqltver (see $class for details)
835 The author is expected to prepend the necessary text to this message before
836 returning the actual error seen by the user.
839 '=head2 req_errorlist_for',
841 '=item Arguments: $group_name',
842 '=item Returns: \%list_of_loaderrors_per_module',
845 Returns a hashref containing the actual errors that occured while attempting
846 to load each module in the requirement group.
849 'See L<DBIx::Class/CONTRIBUTORS>.',
851 'You may distribute this code under the same terms as Perl itself',
854 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
855 print $fh join ("\n\n", @chunks);