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 = {
111 'Pod::Inherit' => '0.90',
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.41',
178 test_podcoverage => {
180 'Test::Pod::Coverage' => '1.08',
181 'Pod::Coverage' => '0.20',
187 'Test::EOL' => '1.0',
188 'Test::NoTabs' => '0.9',
192 test_prettydebug => {
196 test_admin_script => {
202 # for t/admin/10script.t
203 ? ('Win32::ShellQuote' => 0)
204 # DWIW does not compile (./configure even) on win32
205 : ('JSON::DWIW' => 0 )
212 'Test::Memory::Cycle' => '0',
213 'Devel::Cycle' => '1.10',
218 req => $datetime_basic,
226 'DateTime::Format::SQLite' => '0',
233 # t/inflate/datetime_mysql.t
234 # (doesn't need Mysql itself)
235 'DateTime::Format::MySQL' => '0',
242 # t/inflate/datetime_pg.t
243 # (doesn't need PG itself)
244 'DateTime::Format::Pg' => '0.16004',
251 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
253 'Time::Piece::MySQL' => '0',
254 'Date::Simple' => '3.03',
258 # this is just for completeness as SQLite
259 # is a core dep of DBIC for testing
265 title => 'SQLite support',
266 desc => 'Modules required to connect to SQLite',
272 # when changing this list make sure to adjust xt/optional_deps.t
276 title => 'PostgreSQL support',
277 desc => 'Modules required to connect to PostgreSQL',
281 rdbms_mssql_odbc => {
286 title => 'MSSQL support via DBD::ODBC',
287 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
291 rdbms_mssql_sybase => {
293 %$rdbms_mssql_sybase,
296 title => 'MSSQL support via DBD::Sybase',
297 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
306 title => 'MSSQL support via DBD::ADO (Windows only)',
307 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
311 rdbms_msaccess_odbc => {
313 %$rdbms_msaccess_odbc,
316 title => 'MS Access support via DBD::ODBC',
317 desc => 'Modules required to connect to MS Access via DBD::ODBC',
321 rdbms_msaccess_ado => {
323 %$rdbms_msaccess_ado,
326 title => 'MS Access support via DBD::ADO (Windows only)',
327 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
336 title => 'MySQL support',
337 desc => 'Modules required to connect to MySQL',
346 title => 'Oracle support',
347 desc => 'Modules required to connect to Oracle',
356 title => 'Sybase ASE support',
357 desc => 'Modules required to connect to Sybase ASE',
366 title => 'DB2 support',
367 desc => 'Modules required to connect to DB2',
376 title => 'DB2 on AS/400 support',
377 desc => 'Modules required to connect to DB2 on AS/400',
386 title => 'Informix support',
387 desc => 'Modules required to connect to Informix',
391 rdbms_sqlanywhere => {
396 title => 'SQLAnywhere support',
397 desc => 'Modules required to connect to SQLAnywhere',
401 rdbms_sqlanywhere_odbc => {
403 %$rdbms_sqlanywhere_odbc,
406 title => 'SQLAnywhere support via DBD::ODBC',
407 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
416 title => 'Firebird support',
417 desc => 'Modules required to connect to Firebird',
421 rdbms_firebird_interbase => {
423 %$rdbms_firebird_interbase,
426 title => 'Firebird support via DBD::InterBase',
427 desc => 'Modules required to connect to Firebird via DBD::InterBase',
431 rdbms_firebird_odbc => {
433 %$rdbms_firebird_odbc,
436 title => 'Firebird support via DBD::ODBC',
437 desc => 'Modules required to connect to Firebird via DBD::ODBC',
441 # the order does matter because the rdbms support group might require
442 # a different version that the test group
445 $ENV{DBICTEST_PG_DSN}
447 # when changing this list make sure to adjust xt/optional_deps.t
449 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
450 'DBD::Pg' => '2.009002',
455 test_rdbms_mssql_odbc => {
457 $ENV{DBICTEST_MSSQL_ODBC_DSN}
464 test_rdbms_mssql_ado => {
466 $ENV{DBICTEST_MSSQL_ADO_DSN}
473 test_rdbms_mssql_sybase => {
475 $ENV{DBICTEST_MSSQL_DSN}
477 %$rdbms_mssql_sybase,
482 test_rdbms_msaccess_odbc => {
484 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
486 %$rdbms_msaccess_odbc,
493 test_rdbms_msaccess_ado => {
495 $ENV{DBICTEST_MSACCESS_ADO_DSN}
497 %$rdbms_msaccess_ado,
504 test_rdbms_mysql => {
506 $ENV{DBICTEST_MYSQL_DSN}
513 test_rdbms_oracle => {
515 $ENV{DBICTEST_ORA_DSN}
518 'DateTime::Format::Oracle' => '0',
519 'DBD::Oracle' => '1.24',
526 $ENV{DBICTEST_SYBASE_DSN}
535 $ENV{DBICTEST_DB2_DSN}
542 test_rdbms_db2_400 => {
544 $ENV{DBICTEST_DB2_400_DSN}
551 test_rdbms_informix => {
553 $ENV{DBICTEST_INFORMIX_DSN}
560 test_rdbms_sqlanywhere => {
562 $ENV{DBICTEST_SQLANYWHERE_DSN}
569 test_rdbms_sqlanywhere_odbc => {
571 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
573 %$rdbms_sqlanywhere_odbc,
578 test_rdbms_firebird => {
580 $ENV{DBICTEST_FIREBIRD_DSN}
587 test_rdbms_firebird_interbase => {
589 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
591 %$rdbms_firebird_interbase,
596 test_rdbms_firebird_odbc => {
598 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
600 %$rdbms_firebird_odbc,
607 $ENV{DBICTEST_MEMCACHED}
609 'Cache::Memcached' => 0,
618 my ($class, $group) = @_;
620 Carp::croak "req_list_for() expects a requirement group name"
623 my $deps = $reqs->{$group}{req}
624 or Carp::croak "Requirement group '$group' does not exist";
630 our %req_availability_cache;
632 my ($class, $group) = @_;
634 Carp::croak "req_ok_for() expects a requirement group name"
637 return $class->_check_deps($group)->{status};
640 sub req_missing_for {
641 my ($class, $group) = @_;
643 Carp::croak "req_missing_for() expects a requirement group name"
646 return $class->_check_deps($group)->{missing};
649 sub req_errorlist_for {
650 my ($class, $group) = @_;
652 Carp::croak "req_errorlist_for() expects a requirement group name"
655 return $class->_check_deps($group)->{errorlist};
659 my ($class, $group) = @_;
661 return $req_availability_cache{$group} ||= do {
663 my $deps = $class->req_list_for ($group);
666 for my $mod (keys %$deps) {
667 my $req_line = "require $mod;";
668 if (my $ver = $deps->{$mod}) {
669 $req_line .= "$mod->VERSION($ver);";
674 $errors{$mod} = $@ if $@;
680 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
681 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
684 errorlist => \%errors,
701 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
704 # This is to be called by the author only (automatically in Makefile.PL)
706 my ($class, $distver, $pod_dir) = @_;
708 die "No POD root dir supplied" unless $pod_dir;
711 eval { require DBIx::Class; DBIx::Class->VERSION; }
714 "\n\n---------------------------------------------------------------------\n" .
715 'Unable to load core DBIx::Class module to determine current version, '.
716 'possibly due to missing dependencies. Author-mode autodocumentation ' .
718 "\n\n---------------------------------------------------------------------\n"
721 # do not ask for a recent version, use 1.x API calls
722 # this *may* execute on a smoker with old perl or whatnot
725 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
727 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
728 (my $dir = $podfn) =~ s|/[^/]+$||;
730 File::Path::mkpath([$dir]);
732 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
733 or die "Hrmm? No sqlt dep?";
737 #########################################################################
738 ##################### A U T O G E N E R A T E D ########################
739 #########################################################################
741 # The contents of this POD file are auto-generated. Any changes you make
742 # will be lost. If you need to change the generated text edit _gen_pod()
743 # at the end of $modfn
747 "$class - Optional module dependency specifications (for module authors)",
750 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
754 configure_requires 'DBIx::Class' => '$distver';
758 my \$deploy_deps = $class->req_list_for('deploy');
760 for (keys %\$deploy_deps) {
761 requires \$_ => \$deploy_deps->{\$_};
766 Note that there are some caveats regarding C<configure_requires()>, more info
767 can be found at L<Module::Install/configure_requires>
769 '=head1 DESCRIPTION',
771 Some of the less-frequently used features of L<DBIx::Class> have external
772 module dependencies on their own. In order not to burden the average user
773 with modules he will never use, these optional dependencies are not included
774 in the base Makefile.PL. Instead an exception with a descriptive message is
775 thrown when a specific feature is missing one or several modules required for
776 its operation. This module is the central holding place for the current list
777 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
780 '=head1 CURRENT REQUIREMENT GROUPS',
782 Dependencies are organized in C<groups> and each group can list one or more
783 required modules, with an optional minimum version (or 0 for any version).
784 The group name can be used in the
788 for my $group (sort keys %$reqs) {
789 my $p = $reqs->{$group}{pod}
792 my $modlist = $reqs->{$group}{req}
795 next unless keys %$modlist;
798 "=head2 $p->{title}",
801 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
803 "Requirement group: B<$group>",
809 '=head2 req_group_list',
811 '=item Arguments: none',
812 '=item Return Value: \%list_of_requirement_groups',
815 This method should be used by DBIx::Class packagers, to get a hashref of all
816 dependencies keyed by dependency group. Each key (group name) can be supplied
817 to one of the group-specific methods below.
820 '=head2 req_list_for',
822 '=item Arguments: $group_name',
823 '=item Return Value: \%list_of_module_version_pairs',
826 This method should be used by DBIx::Class extension authors, to determine the
827 version of modules a specific feature requires in the B<current> version of
828 DBIx::Class. See the L</SYNOPSIS> for a real-world
834 '=item Arguments: $group_name',
835 '=item Return Value: 1|0',
838 Returns true or false depending on whether all modules required by
839 C<$group_name> are present on the system and loadable.
842 '=head2 req_missing_for',
844 '=item Arguments: $group_name',
845 '=item Return Value: $error_message_string',
848 Returns a single line string suitable for inclusion in larger error messages.
849 This method would normally be used by DBIx::Class core-module author, to
850 indicate to the user that he needs to install specific modules before he will
851 be able to use a specific feature.
853 For example if some of the requirements for C<deploy> are not available,
854 the returned string could look like:
856 SQL::Translator >= $sqltver (see $class for details)
858 The author is expected to prepend the necessary text to this message before
859 returning the actual error seen by the user.
862 '=head2 req_errorlist_for',
864 '=item Arguments: $group_name',
865 '=item Return Value: \%list_of_loaderrors_per_module',
868 Returns a hashref containing the actual errors that occured while attempting
869 to load each module in the requirement group.
872 'See L<DBIx::Class/CONTRIBUTORS>.',
874 'You may distribute this code under the same terms as Perl itself',
877 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
878 print $fh join ("\n\n", @chunks);