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',
234 'DBIx::ContextualFetch' => '0',
235 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
236 'Class::Trigger' => '0',
237 'Time::Piece::MySQL' => '0',
239 'Date::Simple' => '3.03',
243 # this is just for completeness as SQLite
244 # is a core dep of DBIC for testing
250 title => 'SQLite support',
251 desc => 'Modules required to connect to SQLite',
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}
432 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
433 'DBD::Pg' => '2.009002',
438 test_rdbms_mssql_odbc => {
440 $ENV{DBICTEST_MSSQL_ODBC_DSN}
447 test_rdbms_mssql_ado => {
449 $ENV{DBICTEST_MSSQL_ADO_DSN}
456 test_rdbms_mssql_sybase => {
458 $ENV{DBICTEST_MSSQL_DSN}
460 %$rdbms_mssql_sybase,
465 test_rdbms_msaccess_odbc => {
467 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
469 %$rdbms_msaccess_odbc,
476 test_rdbms_msaccess_ado => {
478 $ENV{DBICTEST_MSACCESS_ADO_DSN}
480 %$rdbms_msaccess_ado,
487 test_rdbms_mysql => {
489 $ENV{DBICTEST_MYSQL_DSN}
496 test_rdbms_oracle => {
498 $ENV{DBICTEST_ORA_DSN}
501 'DateTime::Format::Oracle' => '0',
502 'DBD::Oracle' => '1.24',
509 $ENV{DBICTEST_SYBASE_DSN}
518 $ENV{DBICTEST_DB2_DSN}
525 test_rdbms_db2_400 => {
527 $ENV{DBICTEST_DB2_400_DSN}
534 test_rdbms_informix => {
536 $ENV{DBICTEST_INFORMIX_DSN}
543 test_rdbms_sqlanywhere => {
545 $ENV{DBICTEST_SQLANYWHERE_DSN}
552 test_rdbms_sqlanywhere_odbc => {
554 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
556 %$rdbms_sqlanywhere_odbc,
561 test_rdbms_firebird => {
563 $ENV{DBICTEST_FIREBIRD_DSN}
570 test_rdbms_firebird_interbase => {
572 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
574 %$rdbms_firebird_interbase,
579 test_rdbms_firebird_odbc => {
581 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
583 %$rdbms_firebird_odbc,
590 $ENV{DBICTEST_MEMCACHED}
592 'Cache::Memcached' => 0,
601 my ($class, $group) = @_;
603 Carp::croak "req_list_for() expects a requirement group name"
606 my $deps = $reqs->{$group}{req}
607 or Carp::croak "Requirement group '$group' does not exist";
613 our %req_availability_cache;
615 my ($class, $group) = @_;
617 Carp::croak "req_ok_for() expects a requirement group name"
620 return $class->_check_deps($group)->{status};
623 sub req_missing_for {
624 my ($class, $group) = @_;
626 Carp::croak "req_missing_for() expects a requirement group name"
629 return $class->_check_deps($group)->{missing};
632 sub req_errorlist_for {
633 my ($class, $group) = @_;
635 Carp::croak "req_errorlist_for() expects a requirement group name"
638 return $class->_check_deps($group)->{errorlist};
642 my ($class, $group) = @_;
644 return $req_availability_cache{$group} ||= do {
646 my $deps = $class->req_list_for ($group);
649 for my $mod (keys %$deps) {
650 my $req_line = "require $mod;";
651 if (my $ver = $deps->{$mod}) {
652 $req_line .= "$mod->VERSION($ver);";
657 $errors{$mod} = $@ if $@;
663 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
664 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
667 errorlist => \%errors,
684 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
687 # This is to be called by the author only (automatically in Makefile.PL)
689 my ($class, $distver) = @_;
691 my $modfn = __PACKAGE__ . '.pm';
692 $modfn =~ s/\:\:/\//g;
694 my $podfn = __FILE__;
695 $podfn =~ s/\.pm$/\.pod/;
698 eval { require DBIx::Class; DBIx::Class->VERSION; }
701 "\n\n---------------------------------------------------------------------\n" .
702 'Unable to load core DBIx::Class module to determine current version, '.
703 'possibly due to missing dependencies. Author-mode autodocumentation ' .
705 "\n\n---------------------------------------------------------------------\n"
708 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
709 or die "Hrmm? No sqlt dep?";
713 #########################################################################
714 ##################### A U T O G E N E R A T E D ########################
715 #########################################################################
717 # The contents of this POD file are auto-generated. Any changes you make
718 # will be lost. If you need to change the generated text edit _gen_pod()
719 # at the end of $modfn
723 "$class - Optional module dependency specifications (for module authors)",
726 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
730 configure_requires 'DBIx::Class' => '$distver';
734 my \$deploy_deps = $class->req_list_for('deploy');
736 for (keys %\$deploy_deps) {
737 requires \$_ => \$deploy_deps->{\$_};
742 Note that there are some caveats regarding C<configure_requires()>, more info
743 can be found at L<Module::Install/configure_requires>
745 '=head1 DESCRIPTION',
747 Some of the less-frequently used features of L<DBIx::Class> have external
748 module dependencies on their own. In order not to burden the average user
749 with modules he will never use, these optional dependencies are not included
750 in the base Makefile.PL. Instead an exception with a descriptive message is
751 thrown when a specific feature is missing one or several modules required for
752 its operation. This module is the central holding place for the current list
753 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
756 '=head1 CURRENT REQUIREMENT GROUPS',
758 Dependencies are organized in C<groups> and each group can list one or more
759 required modules, with an optional minimum version (or 0 for any version).
760 The group name can be used in the
764 for my $group (sort keys %$reqs) {
765 my $p = $reqs->{$group}{pod}
768 my $modlist = $reqs->{$group}{req}
771 next unless keys %$modlist;
774 "=head2 $p->{title}",
777 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
779 "Requirement group: B<$group>",
785 '=head2 req_group_list',
787 '=item Arguments: none',
788 '=item Returns: \%list_of_requirement_groups',
791 This method should be used by DBIx::Class packagers, to get a hashref of all
792 dependencies keyed by dependency group. Each key (group name) can be supplied
793 to one of the group-specific methods below.
796 '=head2 req_list_for',
798 '=item Arguments: $group_name',
799 '=item Returns: \%list_of_module_version_pairs',
802 This method should be used by DBIx::Class extension authors, to determine the
803 version of modules a specific feature requires in the B<current> version of
804 DBIx::Class. See the L</SYNOPSIS> for a real-world
810 '=item Arguments: $group_name',
811 '=item Returns: 1|0',
814 Returns true or false depending on whether all modules required by
815 C<$group_name> are present on the system and loadable.
818 '=head2 req_missing_for',
820 '=item Arguments: $group_name',
821 '=item Returns: $error_message_string',
824 Returns a single line string suitable for inclusion in larger error messages.
825 This method would normally be used by DBIx::Class core-module author, to
826 indicate to the user that he needs to install specific modules before he will
827 be able to use a specific feature.
829 For example if some of the requirements for C<deploy> are not available,
830 the returned string could look like:
832 SQL::Translator >= $sqltver (see $class for details)
834 The author is expected to prepend the necessary text to this message before
835 returning the actual error seen by the user.
838 '=head2 req_errorlist_for',
840 '=item Arguments: $group_name',
841 '=item Returns: \%list_of_loaderrors_per_module',
844 Returns a hashref containing the actual errors that occured while attempting
845 to load each module in the requirement group.
848 'See L<DBIx::Class/CONTRIBUTORS>.',
850 'You may distribute this code under the same terms as Perl itself',
853 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
854 print $fh join ("\n\n", @chunks);