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',
21 'MooseX::Types::LoadableClass' => '0.011',
31 'MooseX::Types::Path::Class' => '0.05',
32 'MooseX::Types::JSON' => '0.02',
33 'namespace::autoclean' => '0.09',
39 'Getopt::Long::Descriptive' => '0.081',
40 'Text::CSV' => '1.16',
43 my $datetime_basic = {
45 'DateTime::Format::Strptime' => '1.2',
49 'Math::BigInt' => '1.80',
50 'Math::Base36' => '0.07',
59 my $rdbms_mssql_odbc = {
62 my $rdbms_mssql_sybase = {
65 my $rdbms_mssql_ado = {
68 my $rdbms_msaccess_odbc = {
71 my $rdbms_msaccess_ado = {
90 my $rdbms_informix = {
91 'DBD::Informix' => '0',
93 my $rdbms_sqlanywhere = {
94 'DBD::SQLAnywhere' => '0',
96 my $rdbms_sqlanywhere_odbc = {
99 my $rdbms_firebird = {
100 'DBD::Firebird' => '0',
102 my $rdbms_firebird_interbase = {
103 'DBD::InterBase' => '0',
105 my $rdbms_firebird_odbc = {
113 title => 'Storage::Replicated',
114 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
121 'Test::Moose' => '0',
131 title => 'DBIx::Class::Admin',
132 desc => 'Modules required for the DBIx::Class administrative library',
141 title => 'dbicadmin',
142 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
148 'SQL::Translator' => '0.11016',
151 title => 'Storage::DBI::deploy()',
152 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
157 req => $id_shortener,
160 test_component_accessor => {
162 'Class::Unload' => '0.07',
168 'Test::Pod' => '1.42',
172 test_podcoverage => {
174 'Test::Pod::Coverage' => '1.08',
175 'Pod::Coverage' => '0.20',
181 'Test::EOL' => '1.0',
182 'Test::NoTabs' => '0.9',
188 'Test::Strict' => '0.20',
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',
250 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
252 'Time::Piece::MySQL' => '0',
253 'Date::Simple' => '3.03',
257 # this is just for completeness as SQLite
258 # is a core dep of DBIC for testing
264 title => 'SQLite support',
265 desc => 'Modules required to connect to SQLite',
271 # when changing this list make sure to adjust xt/optional_deps.t
275 title => 'PostgreSQL support',
276 desc => 'Modules required to connect to PostgreSQL',
280 rdbms_mssql_odbc => {
285 title => 'MSSQL support via DBD::ODBC',
286 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
290 rdbms_mssql_sybase => {
292 %$rdbms_mssql_sybase,
295 title => 'MSSQL support via DBD::Sybase',
296 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
305 title => 'MSSQL support via DBD::ADO (Windows only)',
306 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
310 rdbms_msaccess_odbc => {
312 %$rdbms_msaccess_odbc,
315 title => 'MS Access support via DBD::ODBC',
316 desc => 'Modules required to connect to MS Access via DBD::ODBC',
320 rdbms_msaccess_ado => {
322 %$rdbms_msaccess_ado,
325 title => 'MS Access support via DBD::ADO (Windows only)',
326 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
335 title => 'MySQL support',
336 desc => 'Modules required to connect to MySQL',
345 title => 'Oracle support',
346 desc => 'Modules required to connect to Oracle',
355 title => 'Sybase ASE support',
356 desc => 'Modules required to connect to Sybase ASE',
365 title => 'DB2 support',
366 desc => 'Modules required to connect to DB2',
375 title => 'DB2 on AS/400 support',
376 desc => 'Modules required to connect to DB2 on AS/400',
385 title => 'Informix support',
386 desc => 'Modules required to connect to Informix',
390 rdbms_sqlanywhere => {
395 title => 'SQLAnywhere support',
396 desc => 'Modules required to connect to SQLAnywhere',
400 rdbms_sqlanywhere_odbc => {
402 %$rdbms_sqlanywhere_odbc,
405 title => 'SQLAnywhere support via DBD::ODBC',
406 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
415 title => 'Firebird support',
416 desc => 'Modules required to connect to Firebird',
420 rdbms_firebird_interbase => {
422 %$rdbms_firebird_interbase,
425 title => 'Firebird support via DBD::InterBase',
426 desc => 'Modules required to connect to Firebird via DBD::InterBase',
430 rdbms_firebird_odbc => {
432 %$rdbms_firebird_odbc,
435 title => 'Firebird support via DBD::ODBC',
436 desc => 'Modules required to connect to Firebird via DBD::ODBC',
440 # the order does matter because the rdbms support group might require
441 # a different version that the test group
444 $ENV{DBICTEST_PG_DSN}
446 # when changing this list make sure to adjust xt/optional_deps.t
448 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
449 'DBD::Pg' => '2.009002',
454 test_rdbms_mssql_odbc => {
456 $ENV{DBICTEST_MSSQL_ODBC_DSN}
463 test_rdbms_mssql_ado => {
465 $ENV{DBICTEST_MSSQL_ADO_DSN}
472 test_rdbms_mssql_sybase => {
474 $ENV{DBICTEST_MSSQL_DSN}
476 %$rdbms_mssql_sybase,
481 test_rdbms_msaccess_odbc => {
483 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
485 %$rdbms_msaccess_odbc,
492 test_rdbms_msaccess_ado => {
494 $ENV{DBICTEST_MSACCESS_ADO_DSN}
496 %$rdbms_msaccess_ado,
503 test_rdbms_mysql => {
505 $ENV{DBICTEST_MYSQL_DSN}
512 test_rdbms_oracle => {
514 $ENV{DBICTEST_ORA_DSN}
517 'DateTime::Format::Oracle' => '0',
518 'DBD::Oracle' => '1.24',
525 $ENV{DBICTEST_SYBASE_DSN}
534 $ENV{DBICTEST_DB2_DSN}
541 test_rdbms_db2_400 => {
543 $ENV{DBICTEST_DB2_400_DSN}
550 test_rdbms_informix => {
552 $ENV{DBICTEST_INFORMIX_DSN}
559 test_rdbms_sqlanywhere => {
561 $ENV{DBICTEST_SQLANYWHERE_DSN}
568 test_rdbms_sqlanywhere_odbc => {
570 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
572 %$rdbms_sqlanywhere_odbc,
577 test_rdbms_firebird => {
579 $ENV{DBICTEST_FIREBIRD_DSN}
586 test_rdbms_firebird_interbase => {
588 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
590 %$rdbms_firebird_interbase,
595 test_rdbms_firebird_odbc => {
597 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
599 %$rdbms_firebird_odbc,
606 $ENV{DBICTEST_MEMCACHED}
608 'Cache::Memcached' => 0,
615 'ExtUtils::MakeMaker' => '6.64',
616 'Pod::Inherit' => '0.90',
623 'CPAN::Uploader' => '0.103001',
629 our %req_availability_cache;
632 my ($class, $group) = @_;
634 Carp::croak "req_list_for() expects a requirement group name"
637 my $deps = $reqs->{$group}{req}
638 or Carp::croak "Requirement group '$group' does not exist";
644 sub die_unless_req_ok_for {
645 my ($class, $group) = @_;
647 Carp::croak "die_unless_req_ok_for() expects a requirement group name"
650 $class->_check_deps($group)->{status}
651 or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
655 my ($class, $group) = @_;
657 Carp::croak "req_ok_for() expects a requirement group name"
660 return $class->_check_deps($group)->{status};
663 sub req_missing_for {
664 my ($class, $group) = @_;
666 Carp::croak "req_missing_for() expects a requirement group name"
669 return $class->_check_deps($group)->{missing};
672 sub req_errorlist_for {
673 my ($class, $group) = @_;
675 Carp::croak "req_errorlist_for() expects a requirement group name"
678 return $class->_check_deps($group)->{errorlist};
682 my ($class, $group) = @_;
684 return $req_availability_cache{$group} ||= do {
686 my $deps = $class->req_list_for ($group);
689 for my $mod (keys %$deps) {
690 my $req_line = "require $mod;";
691 if (my $ver = $deps->{$mod}) {
692 $req_line .= "$mod->VERSION($ver);";
697 $errors{$mod} = $@ if $@;
703 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
704 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
707 errorlist => \%errors,
724 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
727 # This is to be called by the author only (automatically in Makefile.PL)
729 my ($class, $distver, $pod_dir) = @_;
731 die "No POD root dir supplied" unless $pod_dir;
734 eval { require DBIx::Class; DBIx::Class->VERSION; }
737 "\n\n---------------------------------------------------------------------\n" .
738 'Unable to load core DBIx::Class module to determine current version, '.
739 'possibly due to missing dependencies. Author-mode autodocumentation ' .
741 "\n\n---------------------------------------------------------------------\n"
744 # do not ask for a recent version, use 1.x API calls
745 # this *may* execute on a smoker with old perl or whatnot
748 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
750 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
751 (my $dir = $podfn) =~ s|/[^/]+$||;
753 File::Path::mkpath([$dir]);
755 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
756 or die "Hrmm? No sqlt dep?";
760 #########################################################################
761 ##################### A U T O G E N E R A T E D ########################
762 #########################################################################
764 # The contents of this POD file are auto-generated. Any changes you make
765 # will be lost. If you need to change the generated text edit _gen_pod()
766 # at the end of $modfn
770 "$class - Optional module dependency specifications (for module authors)",
773 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
777 configure_requires 'DBIx::Class' => '$distver';
781 my \$deploy_deps = $class->req_list_for('deploy');
783 for (keys %\$deploy_deps) {
784 requires \$_ => \$deploy_deps->{\$_};
789 Note that there are some caveats regarding C<configure_requires()>, more info
790 can be found at L<Module::Install/configure_requires>
792 '=head1 DESCRIPTION',
794 Some of the less-frequently used features of L<DBIx::Class> have external
795 module dependencies on their own. In order not to burden the average user
796 with modules he will never use, these optional dependencies are not included
797 in the base Makefile.PL. Instead an exception with a descriptive message is
798 thrown when a specific feature is missing one or several modules required for
799 its operation. This module is the central holding place for the current list
800 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
803 '=head1 CURRENT REQUIREMENT GROUPS',
805 Dependencies are organized in C<groups> and each group can list one or more
806 required modules, with an optional minimum version (or 0 for any version).
807 The group name can be used in the
811 for my $group (sort keys %$reqs) {
812 my $p = $reqs->{$group}{pod}
815 my $modlist = $reqs->{$group}{req}
818 next unless keys %$modlist;
821 "=head2 $p->{title}",
824 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
826 "Requirement group: B<$group>",
832 '=head2 req_group_list',
834 '=item Arguments: none',
835 '=item Return Value: \%list_of_requirement_groups',
838 This method should be used by DBIx::Class packagers, to get a hashref of all
839 dependencies keyed by dependency group. Each key (group name) can be supplied
840 to one of the group-specific methods below.
843 '=head2 req_list_for',
845 '=item Arguments: $group_name',
846 '=item Return Value: \%list_of_module_version_pairs',
849 This method should be used by DBIx::Class extension authors, to determine the
850 version of modules a specific feature requires in the B<current> version of
851 DBIx::Class. See the L</SYNOPSIS> for a real-world
857 '=item Arguments: $group_name',
858 '=item Return Value: 1|0',
861 Returns true or false depending on whether all modules required by
862 C<$group_name> are present on the system and loadable.
865 '=head2 req_missing_for',
867 '=item Arguments: $group_name',
868 '=item Return Value: $error_message_string',
871 Returns a single line string suitable for inclusion in larger error messages.
872 This method would normally be used by DBIx::Class core-module author, to
873 indicate to the user that he needs to install specific modules before he will
874 be able to use a specific feature.
876 For example if some of the requirements for C<deploy> are not available,
877 the returned string could look like:
879 SQL::Translator >= $sqltver (see $class for details)
881 The author is expected to prepend the necessary text to this message before
882 returning the actual error seen by the user.
885 '=head2 die_unless_req_ok_for',
887 '=item Arguments: $group_name',
890 Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
891 in case of failure throws an exception including the information
892 from L</req_missing_for>.
895 '=head2 req_errorlist_for',
897 '=item Arguments: $group_name',
898 '=item Return Value: \%list_of_loaderrors_per_module',
901 Returns a hashref containing the actual errors that occurred while attempting
902 to load each module in the requirement group.
905 'See L<DBIx::Class/CONTRIBUTORS>.',
907 'You may distribute this code under the same terms as Perl itself',
910 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
911 print $fh join ("\n\n", @chunks);