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',
194 'Test::Strict' => '0.16',
198 test_prettydebug => {
202 test_admin_script => {
208 # for t/admin/10script.t
209 ? ('Win32::ShellQuote' => 0)
210 # DWIW does not compile (./configure even) on win32
211 : ('JSON::DWIW' => 0 )
218 'Test::Memory::Cycle' => '0',
219 'Devel::Cycle' => '1.10',
224 req => $datetime_basic,
232 'DateTime::Format::SQLite' => '0',
239 # t/inflate/datetime_mysql.t
240 # (doesn't need Mysql itself)
241 'DateTime::Format::MySQL' => '0',
248 # t/inflate/datetime_pg.t
249 # (doesn't need PG itself)
250 'DateTime::Format::Pg' => '0.16004',
257 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
259 'Time::Piece::MySQL' => '0',
260 'Date::Simple' => '3.03',
264 # this is just for completeness as SQLite
265 # is a core dep of DBIC for testing
271 title => 'SQLite support',
272 desc => 'Modules required to connect to SQLite',
278 # when changing this list make sure to adjust xt/optional_deps.t
282 title => 'PostgreSQL support',
283 desc => 'Modules required to connect to PostgreSQL',
287 rdbms_mssql_odbc => {
292 title => 'MSSQL support via DBD::ODBC',
293 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
297 rdbms_mssql_sybase => {
299 %$rdbms_mssql_sybase,
302 title => 'MSSQL support via DBD::Sybase',
303 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
312 title => 'MSSQL support via DBD::ADO (Windows only)',
313 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
317 rdbms_msaccess_odbc => {
319 %$rdbms_msaccess_odbc,
322 title => 'MS Access support via DBD::ODBC',
323 desc => 'Modules required to connect to MS Access via DBD::ODBC',
327 rdbms_msaccess_ado => {
329 %$rdbms_msaccess_ado,
332 title => 'MS Access support via DBD::ADO (Windows only)',
333 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
342 title => 'MySQL support',
343 desc => 'Modules required to connect to MySQL',
352 title => 'Oracle support',
353 desc => 'Modules required to connect to Oracle',
362 title => 'Sybase ASE support',
363 desc => 'Modules required to connect to Sybase ASE',
372 title => 'DB2 support',
373 desc => 'Modules required to connect to DB2',
382 title => 'DB2 on AS/400 support',
383 desc => 'Modules required to connect to DB2 on AS/400',
392 title => 'Informix support',
393 desc => 'Modules required to connect to Informix',
397 rdbms_sqlanywhere => {
402 title => 'SQLAnywhere support',
403 desc => 'Modules required to connect to SQLAnywhere',
407 rdbms_sqlanywhere_odbc => {
409 %$rdbms_sqlanywhere_odbc,
412 title => 'SQLAnywhere support via DBD::ODBC',
413 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
422 title => 'Firebird support',
423 desc => 'Modules required to connect to Firebird',
427 rdbms_firebird_interbase => {
429 %$rdbms_firebird_interbase,
432 title => 'Firebird support via DBD::InterBase',
433 desc => 'Modules required to connect to Firebird via DBD::InterBase',
437 rdbms_firebird_odbc => {
439 %$rdbms_firebird_odbc,
442 title => 'Firebird support via DBD::ODBC',
443 desc => 'Modules required to connect to Firebird via DBD::ODBC',
447 # the order does matter because the rdbms support group might require
448 # a different version that the test group
451 $ENV{DBICTEST_PG_DSN}
453 # when changing this list make sure to adjust xt/optional_deps.t
455 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
456 'DBD::Pg' => '2.009002',
461 test_rdbms_mssql_odbc => {
463 $ENV{DBICTEST_MSSQL_ODBC_DSN}
470 test_rdbms_mssql_ado => {
472 $ENV{DBICTEST_MSSQL_ADO_DSN}
479 test_rdbms_mssql_sybase => {
481 $ENV{DBICTEST_MSSQL_DSN}
483 %$rdbms_mssql_sybase,
488 test_rdbms_msaccess_odbc => {
490 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
492 %$rdbms_msaccess_odbc,
499 test_rdbms_msaccess_ado => {
501 $ENV{DBICTEST_MSACCESS_ADO_DSN}
503 %$rdbms_msaccess_ado,
510 test_rdbms_mysql => {
512 $ENV{DBICTEST_MYSQL_DSN}
519 test_rdbms_oracle => {
521 $ENV{DBICTEST_ORA_DSN}
524 'DateTime::Format::Oracle' => '0',
525 'DBD::Oracle' => '1.24',
532 $ENV{DBICTEST_SYBASE_DSN}
541 $ENV{DBICTEST_DB2_DSN}
548 test_rdbms_db2_400 => {
550 $ENV{DBICTEST_DB2_400_DSN}
557 test_rdbms_informix => {
559 $ENV{DBICTEST_INFORMIX_DSN}
566 test_rdbms_sqlanywhere => {
568 $ENV{DBICTEST_SQLANYWHERE_DSN}
575 test_rdbms_sqlanywhere_odbc => {
577 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
579 %$rdbms_sqlanywhere_odbc,
584 test_rdbms_firebird => {
586 $ENV{DBICTEST_FIREBIRD_DSN}
593 test_rdbms_firebird_interbase => {
595 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
597 %$rdbms_firebird_interbase,
602 test_rdbms_firebird_odbc => {
604 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
606 %$rdbms_firebird_odbc,
613 $ENV{DBICTEST_MEMCACHED}
615 'Cache::Memcached' => 0,
624 my ($class, $group) = @_;
626 Carp::croak "req_list_for() expects a requirement group name"
629 my $deps = $reqs->{$group}{req}
630 or Carp::croak "Requirement group '$group' does not exist";
636 our %req_availability_cache;
638 my ($class, $group) = @_;
640 Carp::croak "req_ok_for() expects a requirement group name"
643 return $class->_check_deps($group)->{status};
646 sub req_missing_for {
647 my ($class, $group) = @_;
649 Carp::croak "req_missing_for() expects a requirement group name"
652 return $class->_check_deps($group)->{missing};
655 sub req_errorlist_for {
656 my ($class, $group) = @_;
658 Carp::croak "req_errorlist_for() expects a requirement group name"
661 return $class->_check_deps($group)->{errorlist};
665 my ($class, $group) = @_;
667 return $req_availability_cache{$group} ||= do {
669 my $deps = $class->req_list_for ($group);
672 for my $mod (keys %$deps) {
673 my $req_line = "require $mod;";
674 if (my $ver = $deps->{$mod}) {
675 $req_line .= "$mod->VERSION($ver);";
680 $errors{$mod} = $@ if $@;
686 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
687 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
690 errorlist => \%errors,
707 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
710 # This is to be called by the author only (automatically in Makefile.PL)
712 my ($class, $distver, $pod_dir) = @_;
714 die "No POD root dir supplied" unless $pod_dir;
717 eval { require DBIx::Class; DBIx::Class->VERSION; }
720 "\n\n---------------------------------------------------------------------\n" .
721 'Unable to load core DBIx::Class module to determine current version, '.
722 'possibly due to missing dependencies. Author-mode autodocumentation ' .
724 "\n\n---------------------------------------------------------------------\n"
727 # do not ask for a recent version, use 1.x API calls
728 # this *may* execute on a smoker with old perl or whatnot
731 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
733 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
734 (my $dir = $podfn) =~ s|/[^/]+$||;
736 File::Path::mkpath([$dir]);
738 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
739 or die "Hrmm? No sqlt dep?";
743 #########################################################################
744 ##################### A U T O G E N E R A T E D ########################
745 #########################################################################
747 # The contents of this POD file are auto-generated. Any changes you make
748 # will be lost. If you need to change the generated text edit _gen_pod()
749 # at the end of $modfn
753 "$class - Optional module dependency specifications (for module authors)",
756 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
760 configure_requires 'DBIx::Class' => '$distver';
764 my \$deploy_deps = $class->req_list_for('deploy');
766 for (keys %\$deploy_deps) {
767 requires \$_ => \$deploy_deps->{\$_};
772 Note that there are some caveats regarding C<configure_requires()>, more info
773 can be found at L<Module::Install/configure_requires>
775 '=head1 DESCRIPTION',
777 Some of the less-frequently used features of L<DBIx::Class> have external
778 module dependencies on their own. In order not to burden the average user
779 with modules he will never use, these optional dependencies are not included
780 in the base Makefile.PL. Instead an exception with a descriptive message is
781 thrown when a specific feature is missing one or several modules required for
782 its operation. This module is the central holding place for the current list
783 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
786 '=head1 CURRENT REQUIREMENT GROUPS',
788 Dependencies are organized in C<groups> and each group can list one or more
789 required modules, with an optional minimum version (or 0 for any version).
790 The group name can be used in the
794 for my $group (sort keys %$reqs) {
795 my $p = $reqs->{$group}{pod}
798 my $modlist = $reqs->{$group}{req}
801 next unless keys %$modlist;
804 "=head2 $p->{title}",
807 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
809 "Requirement group: B<$group>",
815 '=head2 req_group_list',
817 '=item Arguments: none',
818 '=item Return Value: \%list_of_requirement_groups',
821 This method should be used by DBIx::Class packagers, to get a hashref of all
822 dependencies keyed by dependency group. Each key (group name) can be supplied
823 to one of the group-specific methods below.
826 '=head2 req_list_for',
828 '=item Arguments: $group_name',
829 '=item Return Value: \%list_of_module_version_pairs',
832 This method should be used by DBIx::Class extension authors, to determine the
833 version of modules a specific feature requires in the B<current> version of
834 DBIx::Class. See the L</SYNOPSIS> for a real-world
840 '=item Arguments: $group_name',
841 '=item Return Value: 1|0',
844 Returns true or false depending on whether all modules required by
845 C<$group_name> are present on the system and loadable.
848 '=head2 req_missing_for',
850 '=item Arguments: $group_name',
851 '=item Return Value: $error_message_string',
854 Returns a single line string suitable for inclusion in larger error messages.
855 This method would normally be used by DBIx::Class core-module author, to
856 indicate to the user that he needs to install specific modules before he will
857 be able to use a specific feature.
859 For example if some of the requirements for C<deploy> are not available,
860 the returned string could look like:
862 SQL::Translator >= $sqltver (see $class for details)
864 The author is expected to prepend the necessary text to this message before
865 returning the actual error seen by the user.
868 '=head2 req_errorlist_for',
870 '=item Arguments: $group_name',
871 '=item Return Value: \%list_of_loaderrors_per_module',
874 Returns a hashref containing the actual errors that occured while attempting
875 to load each module in the requirement group.
878 'See L<DBIx::Class/CONTRIBUTORS>.',
880 'You may distribute this code under the same terms as Perl itself',
883 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
884 print $fh join ("\n\n", @chunks);