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 req => { $] < '5.010001' ? () : (
111 'Pod::Inherit' => '0.16',
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.11006',
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::NoTabs' => '0.9',
193 'Test::EOL' => '1.0',
197 test_prettydebug => {
201 test_admin_script => {
207 # for t/admin/10script.t
208 ? ('Win32::ShellQuote' => 0)
209 # DWIW does not compile (./configure even) on win32
210 : ('JSON::DWIW' => 0 )
217 'Test::Memory::Cycle' => '0',
218 'Devel::Cycle' => '1.10',
223 req => $datetime_basic,
231 'DateTime::Format::SQLite' => '0',
238 # t/inflate/datetime_mysql.t
239 # (doesn't need Mysql itself)
240 'DateTime::Format::MySQL' => '0',
247 # t/inflate/datetime_pg.t
248 # (doesn't need PG itself)
249 'DateTime::Format::Pg' => '0.16004',
256 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
258 'Time::Piece::MySQL' => '0',
259 'Date::Simple' => '3.03',
263 # this is just for completeness as SQLite
264 # is a core dep of DBIC for testing
270 title => 'SQLite support',
271 desc => 'Modules required to connect to SQLite',
277 # when changing this list make sure to adjust xt/optional_deps.t
281 title => 'PostgreSQL support',
282 desc => 'Modules required to connect to PostgreSQL',
286 rdbms_mssql_odbc => {
291 title => 'MSSQL support via DBD::ODBC',
292 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
296 rdbms_mssql_sybase => {
298 %$rdbms_mssql_sybase,
301 title => 'MSSQL support via DBD::Sybase',
302 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
311 title => 'MSSQL support via DBD::ADO (Windows only)',
312 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
316 rdbms_msaccess_odbc => {
318 %$rdbms_msaccess_odbc,
321 title => 'MS Access support via DBD::ODBC',
322 desc => 'Modules required to connect to MS Access via DBD::ODBC',
326 rdbms_msaccess_ado => {
328 %$rdbms_msaccess_ado,
331 title => 'MS Access support via DBD::ADO (Windows only)',
332 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
341 title => 'MySQL support',
342 desc => 'Modules required to connect to MySQL',
351 title => 'Oracle support',
352 desc => 'Modules required to connect to Oracle',
361 title => 'Sybase ASE support',
362 desc => 'Modules required to connect to Sybase ASE',
371 title => 'DB2 support',
372 desc => 'Modules required to connect to DB2',
381 title => 'DB2 on AS/400 support',
382 desc => 'Modules required to connect to DB2 on AS/400',
391 title => 'Informix support',
392 desc => 'Modules required to connect to Informix',
396 rdbms_sqlanywhere => {
401 title => 'SQLAnywhere support',
402 desc => 'Modules required to connect to SQLAnywhere',
406 rdbms_sqlanywhere_odbc => {
408 %$rdbms_sqlanywhere_odbc,
411 title => 'SQLAnywhere support via DBD::ODBC',
412 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
421 title => 'Firebird support',
422 desc => 'Modules required to connect to Firebird',
426 rdbms_firebird_interbase => {
428 %$rdbms_firebird_interbase,
431 title => 'Firebird support via DBD::InterBase',
432 desc => 'Modules required to connect to Firebird via DBD::InterBase',
436 rdbms_firebird_odbc => {
438 %$rdbms_firebird_odbc,
441 title => 'Firebird support via DBD::ODBC',
442 desc => 'Modules required to connect to Firebird via DBD::ODBC',
446 # the order does matter because the rdbms support group might require
447 # a different version that the test group
450 $ENV{DBICTEST_PG_DSN}
452 # when changing this list make sure to adjust xt/optional_deps.t
454 ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
455 'DBD::Pg' => '2.009002',
460 test_rdbms_mssql_odbc => {
462 $ENV{DBICTEST_MSSQL_ODBC_DSN}
469 test_rdbms_mssql_ado => {
471 $ENV{DBICTEST_MSSQL_ADO_DSN}
478 test_rdbms_mssql_sybase => {
480 $ENV{DBICTEST_MSSQL_DSN}
482 %$rdbms_mssql_sybase,
487 test_rdbms_msaccess_odbc => {
489 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
491 %$rdbms_msaccess_odbc,
498 test_rdbms_msaccess_ado => {
500 $ENV{DBICTEST_MSACCESS_ADO_DSN}
502 %$rdbms_msaccess_ado,
509 test_rdbms_mysql => {
511 $ENV{DBICTEST_MYSQL_DSN}
518 test_rdbms_oracle => {
520 $ENV{DBICTEST_ORA_DSN}
523 'DateTime::Format::Oracle' => '0',
524 'DBD::Oracle' => '1.24',
531 $ENV{DBICTEST_SYBASE_DSN}
540 $ENV{DBICTEST_DB2_DSN}
547 test_rdbms_db2_400 => {
549 $ENV{DBICTEST_DB2_400_DSN}
556 test_rdbms_informix => {
558 $ENV{DBICTEST_INFORMIX_DSN}
565 test_rdbms_sqlanywhere => {
567 $ENV{DBICTEST_SQLANYWHERE_DSN}
574 test_rdbms_sqlanywhere_odbc => {
576 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
578 %$rdbms_sqlanywhere_odbc,
583 test_rdbms_firebird => {
585 $ENV{DBICTEST_FIREBIRD_DSN}
592 test_rdbms_firebird_interbase => {
594 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
596 %$rdbms_firebird_interbase,
601 test_rdbms_firebird_odbc => {
603 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
605 %$rdbms_firebird_odbc,
612 $ENV{DBICTEST_MEMCACHED}
614 'Cache::Memcached' => 0,
623 my ($class, $group) = @_;
625 Carp::croak "req_list_for() expects a requirement group name"
628 my $deps = $reqs->{$group}{req}
629 or Carp::croak "Requirement group '$group' does not exist";
635 our %req_availability_cache;
637 my ($class, $group) = @_;
639 Carp::croak "req_ok_for() expects a requirement group name"
642 return $class->_check_deps($group)->{status};
645 sub req_missing_for {
646 my ($class, $group) = @_;
648 Carp::croak "req_missing_for() expects a requirement group name"
651 return $class->_check_deps($group)->{missing};
654 sub req_errorlist_for {
655 my ($class, $group) = @_;
657 Carp::croak "req_errorlist_for() expects a requirement group name"
660 return $class->_check_deps($group)->{errorlist};
664 my ($class, $group) = @_;
666 return $req_availability_cache{$group} ||= do {
668 my $deps = $class->req_list_for ($group);
671 for my $mod (keys %$deps) {
672 my $req_line = "require $mod;";
673 if (my $ver = $deps->{$mod}) {
674 $req_line .= "$mod->VERSION($ver);";
679 $errors{$mod} = $@ if $@;
685 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
686 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
689 errorlist => \%errors,
706 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
709 # This is to be called by the author only (automatically in Makefile.PL)
711 my ($class, $distver, $pod_dir) = @_;
713 die "No POD root dir supplied" unless $pod_dir;
716 eval { require DBIx::Class; DBIx::Class->VERSION; }
719 "\n\n---------------------------------------------------------------------\n" .
720 'Unable to load core DBIx::Class module to determine current version, '.
721 'possibly due to missing dependencies. Author-mode autodocumentation ' .
723 "\n\n---------------------------------------------------------------------\n"
726 # do not ask for a recent version, use 1.x API calls
727 # this *may* execute on a smoker with old perl or whatnot
730 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
732 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
733 (my $dir = $podfn) =~ s|/[^/]+$||;
735 File::Path::mkpath([$dir]);
737 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
738 or die "Hrmm? No sqlt dep?";
742 #########################################################################
743 ##################### A U T O G E N E R A T E D ########################
744 #########################################################################
746 # The contents of this POD file are auto-generated. Any changes you make
747 # will be lost. If you need to change the generated text edit _gen_pod()
748 # at the end of $modfn
752 "$class - Optional module dependency specifications (for module authors)",
755 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
759 configure_requires 'DBIx::Class' => '$distver';
763 my \$deploy_deps = $class->req_list_for('deploy');
765 for (keys %\$deploy_deps) {
766 requires \$_ => \$deploy_deps->{\$_};
771 Note that there are some caveats regarding C<configure_requires()>, more info
772 can be found at L<Module::Install/configure_requires>
774 '=head1 DESCRIPTION',
776 Some of the less-frequently used features of L<DBIx::Class> have external
777 module dependencies on their own. In order not to burden the average user
778 with modules he will never use, these optional dependencies are not included
779 in the base Makefile.PL. Instead an exception with a descriptive message is
780 thrown when a specific feature is missing one or several modules required for
781 its operation. This module is the central holding place for the current list
782 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
785 '=head1 CURRENT REQUIREMENT GROUPS',
787 Dependencies are organized in C<groups> and each group can list one or more
788 required modules, with an optional minimum version (or 0 for any version).
789 The group name can be used in the
793 for my $group (sort keys %$reqs) {
794 my $p = $reqs->{$group}{pod}
797 my $modlist = $reqs->{$group}{req}
800 next unless keys %$modlist;
803 "=head2 $p->{title}",
806 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
808 "Requirement group: B<$group>",
814 '=head2 req_group_list',
816 '=item Arguments: none',
817 '=item Return Value: \%list_of_requirement_groups',
820 This method should be used by DBIx::Class packagers, to get a hashref of all
821 dependencies keyed by dependency group. Each key (group name) can be supplied
822 to one of the group-specific methods below.
825 '=head2 req_list_for',
827 '=item Arguments: $group_name',
828 '=item Return Value: \%list_of_module_version_pairs',
831 This method should be used by DBIx::Class extension authors, to determine the
832 version of modules a specific feature requires in the B<current> version of
833 DBIx::Class. See the L</SYNOPSIS> for a real-world
839 '=item Arguments: $group_name',
840 '=item Return Value: 1|0',
843 Returns true or false depending on whether all modules required by
844 C<$group_name> are present on the system and loadable.
847 '=head2 req_missing_for',
849 '=item Arguments: $group_name',
850 '=item Return Value: $error_message_string',
853 Returns a single line string suitable for inclusion in larger error messages.
854 This method would normally be used by DBIx::Class core-module author, to
855 indicate to the user that he needs to install specific modules before he will
856 be able to use a specific feature.
858 For example if some of the requirements for C<deploy> are not available,
859 the returned string could look like:
861 SQL::Translator >= $sqltver (see $class for details)
863 The author is expected to prepend the necessary text to this message before
864 returning the actual error seen by the user.
867 '=head2 req_errorlist_for',
869 '=item Arguments: $group_name',
870 '=item Return Value: \%list_of_loaderrors_per_module',
873 Returns a hashref containing the actual errors that occured while attempting
874 to load each module in the requirement group.
877 'See L<DBIx::Class/CONTRIBUTORS>.',
879 'You may distribute this code under the same terms as Perl itself',
882 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
883 print $fh join ("\n\n", @chunks);