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',
38 'Getopt::Long::Descriptive' => '0.081',
39 'Text::CSV' => '1.16',
42 my $datetime_basic = {
44 'DateTime::Format::Strptime' => '1.2',
48 'Math::BigInt' => '1.80',
49 'Math::Base36' => '0.07',
58 my $rdbms_mssql_odbc = {
61 my $rdbms_mssql_sybase = {
64 my $rdbms_mssql_ado = {
67 my $rdbms_msaccess_odbc = {
70 my $rdbms_msaccess_ado = {
89 my $rdbms_informix = {
90 'DBD::Informix' => '0',
92 my $rdbms_sqlanywhere = {
93 'DBD::SQLAnywhere' => '0',
95 my $rdbms_sqlanywhere_odbc = {
98 my $rdbms_firebird = {
99 'DBD::Firebird' => '0',
101 my $rdbms_firebird_interbase = {
102 'DBD::InterBase' => '0',
104 my $rdbms_firebird_odbc = {
110 #'Module::Install::Pod::Inherit' => '0.01',
116 title => 'Storage::Replicated',
117 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
124 'Test::Moose' => '0',
134 title => 'DBIx::Class::Admin',
135 desc => 'Modules required for the DBIx::Class administrative library',
144 title => 'dbicadmin',
145 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
149 test_admin_script => {
152 ($^O eq 'MSWin32' ? ('Win32::ShellQuote' => 0) : ()),
158 'SQL::Translator' => '0.11006',
161 title => 'Storage::DBI::deploy()',
162 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
167 req => $id_shortener,
170 test_component_accessor => {
172 'Class::Unload' => '0.07',
178 'Test::Pod' => '1.41',
182 test_podcoverage => {
184 'Test::Pod::Coverage' => '1.08',
185 'Pod::Coverage' => '0.20',
191 'Test::NoTabs' => '0.9',
197 'Test::EOL' => '1.0',
201 test_prettydebug => {
207 'Test::Memory::Cycle' => '0',
208 'Devel::Cycle' => '1.10',
213 req => $datetime_basic,
221 'DateTime::Format::SQLite' => '0',
228 # t/inflate/datetime_mysql.t
229 # (doesn't need Mysql itself)
230 'DateTime::Format::MySQL' => '0',
237 # t/inflate/datetime_pg.t
238 # (doesn't need PG itself)
239 'DateTime::Format::Pg' => '0.16004',
246 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
248 'Time::Piece::MySQL' => '0',
249 'Date::Simple' => '3.03',
253 # this is just for completeness as SQLite
254 # is a core dep of DBIC for testing
260 title => 'SQLite support',
261 desc => 'Modules required to connect to SQLite',
267 # when changing this list make sure to adjust xt/optional_deps.t
271 title => 'PostgreSQL support',
272 desc => 'Modules required to connect to PostgreSQL',
276 rdbms_mssql_odbc => {
281 title => 'MSSQL support via DBD::ODBC',
282 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
286 rdbms_mssql_sybase => {
288 %$rdbms_mssql_sybase,
291 title => 'MSSQL support via DBD::Sybase',
292 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
301 title => 'MSSQL support via DBD::ADO (Windows only)',
302 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
306 rdbms_msaccess_odbc => {
308 %$rdbms_msaccess_odbc,
311 title => 'MS Access support via DBD::ODBC',
312 desc => 'Modules required to connect to MS Access via DBD::ODBC',
316 rdbms_msaccess_ado => {
318 %$rdbms_msaccess_ado,
321 title => 'MS Access support via DBD::ADO (Windows only)',
322 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
331 title => 'MySQL support',
332 desc => 'Modules required to connect to MySQL',
341 title => 'Oracle support',
342 desc => 'Modules required to connect to Oracle',
351 title => 'Sybase ASE support',
352 desc => 'Modules required to connect to Sybase ASE',
361 title => 'DB2 support',
362 desc => 'Modules required to connect to DB2',
371 title => 'DB2 on AS/400 support',
372 desc => 'Modules required to connect to DB2 on AS/400',
381 title => 'Informix support',
382 desc => 'Modules required to connect to Informix',
386 rdbms_sqlanywhere => {
391 title => 'SQLAnywhere support',
392 desc => 'Modules required to connect to SQLAnywhere',
396 rdbms_sqlanywhere_odbc => {
398 %$rdbms_sqlanywhere_odbc,
401 title => 'SQLAnywhere support via DBD::ODBC',
402 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
411 title => 'Firebird support',
412 desc => 'Modules required to connect to Firebird',
416 rdbms_firebird_interbase => {
418 %$rdbms_firebird_interbase,
421 title => 'Firebird support via DBD::InterBase',
422 desc => 'Modules required to connect to Firebird via DBD::InterBase',
426 rdbms_firebird_odbc => {
428 %$rdbms_firebird_odbc,
431 title => 'Firebird support via DBD::ODBC',
432 desc => 'Modules required to connect to Firebird via DBD::ODBC',
436 # the order does matter because the rdbms support group might require
437 # a different version that the test group
440 $ENV{DBICTEST_PG_DSN}
442 # when changing this list make sure to adjust xt/optional_deps.t
444 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
445 'DBD::Pg' => '2.009002',
450 test_rdbms_mssql_odbc => {
452 $ENV{DBICTEST_MSSQL_ODBC_DSN}
459 test_rdbms_mssql_ado => {
461 $ENV{DBICTEST_MSSQL_ADO_DSN}
468 test_rdbms_mssql_sybase => {
470 $ENV{DBICTEST_MSSQL_DSN}
472 %$rdbms_mssql_sybase,
477 test_rdbms_msaccess_odbc => {
479 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
481 %$rdbms_msaccess_odbc,
488 test_rdbms_msaccess_ado => {
490 $ENV{DBICTEST_MSACCESS_ADO_DSN}
492 %$rdbms_msaccess_ado,
499 test_rdbms_mysql => {
501 $ENV{DBICTEST_MYSQL_DSN}
508 test_rdbms_oracle => {
510 $ENV{DBICTEST_ORA_DSN}
513 'DateTime::Format::Oracle' => '0',
514 'DBD::Oracle' => '1.24',
521 $ENV{DBICTEST_SYBASE_DSN}
530 $ENV{DBICTEST_DB2_DSN}
537 test_rdbms_db2_400 => {
539 $ENV{DBICTEST_DB2_400_DSN}
546 test_rdbms_informix => {
548 $ENV{DBICTEST_INFORMIX_DSN}
555 test_rdbms_sqlanywhere => {
557 $ENV{DBICTEST_SQLANYWHERE_DSN}
564 test_rdbms_sqlanywhere_odbc => {
566 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
568 %$rdbms_sqlanywhere_odbc,
573 test_rdbms_firebird => {
575 $ENV{DBICTEST_FIREBIRD_DSN}
582 test_rdbms_firebird_interbase => {
584 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
586 %$rdbms_firebird_interbase,
591 test_rdbms_firebird_odbc => {
593 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
595 %$rdbms_firebird_odbc,
602 $ENV{DBICTEST_MEMCACHED}
604 'Cache::Memcached' => 0,
613 my ($class, $group) = @_;
615 Carp::croak "req_list_for() expects a requirement group name"
618 my $deps = $reqs->{$group}{req}
619 or Carp::croak "Requirement group '$group' does not exist";
625 our %req_availability_cache;
627 my ($class, $group) = @_;
629 Carp::croak "req_ok_for() expects a requirement group name"
632 return $class->_check_deps($group)->{status};
635 sub req_missing_for {
636 my ($class, $group) = @_;
638 Carp::croak "req_missing_for() expects a requirement group name"
641 return $class->_check_deps($group)->{missing};
644 sub req_errorlist_for {
645 my ($class, $group) = @_;
647 Carp::croak "req_errorlist_for() expects a requirement group name"
650 return $class->_check_deps($group)->{errorlist};
654 my ($class, $group) = @_;
656 return $req_availability_cache{$group} ||= do {
658 my $deps = $class->req_list_for ($group);
661 for my $mod (keys %$deps) {
662 my $req_line = "require $mod;";
663 if (my $ver = $deps->{$mod}) {
664 $req_line .= "$mod->VERSION($ver);";
669 $errors{$mod} = $@ if $@;
675 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
676 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
679 errorlist => \%errors,
696 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
699 # This is to be called by the author only (automatically in Makefile.PL)
701 my ($class, $distver, $pod_dir) = @_;
703 die "No POD root dir supplied" unless $pod_dir;
706 eval { require DBIx::Class; DBIx::Class->VERSION; }
709 "\n\n---------------------------------------------------------------------\n" .
710 'Unable to load core DBIx::Class module to determine current version, '.
711 'possibly due to missing dependencies. Author-mode autodocumentation ' .
713 "\n\n---------------------------------------------------------------------\n"
716 # do not ask for a recet version, use 1.x API calls
717 # this *may* execute on a smoker with old perl or whatnot
720 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
722 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
723 (my $dir = $podfn) =~ s|/[^/]+$||;
725 File::Path::mkpath([$dir]);
727 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
728 or die "Hrmm? No sqlt dep?";
732 #########################################################################
733 ##################### A U T O G E N E R A T E D ########################
734 #########################################################################
736 # The contents of this POD file are auto-generated. Any changes you make
737 # will be lost. If you need to change the generated text edit _gen_pod()
738 # at the end of $modfn
742 "$class - Optional module dependency specifications (for module authors)",
745 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
749 configure_requires 'DBIx::Class' => '$distver';
753 my \$deploy_deps = $class->req_list_for('deploy');
755 for (keys %\$deploy_deps) {
756 requires \$_ => \$deploy_deps->{\$_};
761 Note that there are some caveats regarding C<configure_requires()>, more info
762 can be found at L<Module::Install/configure_requires>
764 '=head1 DESCRIPTION',
766 Some of the less-frequently used features of L<DBIx::Class> have external
767 module dependencies on their own. In order not to burden the average user
768 with modules he will never use, these optional dependencies are not included
769 in the base Makefile.PL. Instead an exception with a descriptive message is
770 thrown when a specific feature is missing one or several modules required for
771 its operation. This module is the central holding place for the current list
772 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
775 '=head1 CURRENT REQUIREMENT GROUPS',
777 Dependencies are organized in C<groups> and each group can list one or more
778 required modules, with an optional minimum version (or 0 for any version).
779 The group name can be used in the
783 for my $group (sort keys %$reqs) {
784 my $p = $reqs->{$group}{pod}
787 my $modlist = $reqs->{$group}{req}
790 next unless keys %$modlist;
793 "=head2 $p->{title}",
796 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
798 "Requirement group: B<$group>",
804 '=head2 req_group_list',
806 '=item Arguments: none',
807 '=item Returns: \%list_of_requirement_groups',
810 This method should be used by DBIx::Class packagers, to get a hashref of all
811 dependencies keyed by dependency group. Each key (group name) can be supplied
812 to one of the group-specific methods below.
815 '=head2 req_list_for',
817 '=item Arguments: $group_name',
818 '=item Returns: \%list_of_module_version_pairs',
821 This method should be used by DBIx::Class extension authors, to determine the
822 version of modules a specific feature requires in the B<current> version of
823 DBIx::Class. See the L</SYNOPSIS> for a real-world
829 '=item Arguments: $group_name',
830 '=item Returns: 1|0',
833 Returns true or false depending on whether all modules required by
834 C<$group_name> are present on the system and loadable.
837 '=head2 req_missing_for',
839 '=item Arguments: $group_name',
840 '=item Returns: $error_message_string',
843 Returns a single line string suitable for inclusion in larger error messages.
844 This method would normally be used by DBIx::Class core-module author, to
845 indicate to the user that he needs to install specific modules before he will
846 be able to use a specific feature.
848 For example if some of the requirements for C<deploy> are not available,
849 the returned string could look like:
851 SQL::Translator >= $sqltver (see $class for details)
853 The author is expected to prepend the necessary text to this message before
854 returning the actual error seen by the user.
857 '=head2 req_errorlist_for',
859 '=item Arguments: $group_name',
860 '=item Returns: \%list_of_loaderrors_per_module',
863 Returns a hashref containing the actual errors that occured while attempting
864 to load each module in the requirement group.
867 'See L<DBIx::Class/CONTRIBUTORS>.',
869 'You may distribute this code under the same terms as Perl itself',
872 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
873 print $fh join ("\n\n", @chunks);