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',
25 'Hash::Merge' => '0.12',
31 'MooseX::Types::Path::Class' => '0.05',
32 'MooseX::Types::JSON' => '0.02',
33 'namespace::autoclean' => '0.09',
36 my $datetime_basic = {
38 'DateTime::Format::Strptime' => '1.2',
42 'Math::BigInt' => '1.89',
43 'Math::Base36' => '0.07',
52 my $rdbms_mssql_odbc = {
55 my $rdbms_mssql_sybase = {
74 #'Module::Install::Pod::Inherit' => '0.01',
80 title => 'Storage::Replicated',
81 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
98 title => 'DBIx::Class::Admin',
99 desc => 'Modules required for the DBIx::Class administrative library',
107 'Getopt::Long::Descriptive' => '0.081',
108 'Text::CSV' => '1.16',
111 title => 'dbicadmin',
112 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
118 'SQL::Translator' => '0.11006',
121 title => 'Storage::DBI::deploy()',
122 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
127 req => $id_shortener,
132 'Test::Pod' => '1.41',
136 test_podcoverage => {
138 'Test::Pod::Coverage' => '1.08',
139 'Pod::Coverage' => '0.20',
145 'Test::NoTabs' => '0.9',
151 'Test::EOL' => '0.6',
155 test_prettydebug => {
161 'Test::Memory::Cycle' => '0',
162 'Devel::Cycle' => '1.10',
167 req => $datetime_basic,
175 'DateTime::Format::SQLite' => '0',
182 # t/inflate/datetime_mysql.t
183 # (doesn't need Mysql itself)
184 'DateTime::Format::MySQL' => '0',
191 # t/inflate/datetime_pg.t
192 # (doesn't need PG itself)
193 'DateTime::Format::Pg' => '0.16004',
199 'DBIx::ContextualFetch' => '0',
200 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
201 'Class::Trigger' => '0',
202 'Time::Piece::MySQL' => '0',
204 'Date::Simple' => '3.03',
208 # this is just for completeness as SQLite
209 # is a core dep of DBIC for testing
215 title => 'SQLite support',
216 desc => 'Modules required to connect to SQLite',
225 title => 'PostgreSQL support',
226 desc => 'Modules required to connect to PostgreSQL',
230 rdbms_mssql_odbc => {
235 title => 'MSSQL support via DBD::ODBC',
236 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
240 rdbms_mssql_sybase => {
242 %$rdbms_mssql_sybase,
245 title => 'MSSQL support via DBD::Sybase',
246 desc => 'Modules required to connect to MSSQL support via DBD::Sybase',
255 title => 'MySQL support',
256 desc => 'Modules required to connect to MySQL',
265 title => 'Oracle support',
266 desc => 'Modules required to connect to Oracle',
275 title => 'Sybase ASE support',
276 desc => 'Modules required to connect to Sybase ASE',
285 title => 'DB2 support',
286 desc => 'Modules required to connect to DB2',
290 # the order does matter because the rdbms support group might require
291 # a different version that the test group
294 $ENV{DBICTEST_PG_DSN}
297 'Sys::SigAction' => '0',
298 'DBD::Pg' => '2.009002',
303 test_rdbms_mssql_odbc => {
305 $ENV{DBICTEST_MSSQL_ODBC_DSN}
312 test_rdbms_mssql_sybase => {
314 $ENV{DBICTEST_MSSQL_DSN}
316 %$rdbms_mssql_sybase,
321 test_rdbms_mysql => {
323 $ENV{DBICTEST_MYSQL_DSN}
330 test_rdbms_oracle => {
332 $ENV{DBICTEST_ORA_DSN}
335 'DateTime::Format::Oracle' => '0',
336 'DBD::Oracle' => '1.24',
343 $ENV{DBICTEST_SYBASE_DSN}
346 'DateTime::Format::Sybase' => '0',
353 $ENV{DBICTEST_DB2_DSN}
362 $ENV{DBICTEST_MEMCACHED}
364 'Cache::Memcached' => 0,
373 my ($class, $group) = @_;
375 croak "req_list_for() expects a requirement group name"
378 my $deps = $reqs->{$group}{req}
379 or croak "Requirement group '$group' does not exist";
385 our %req_availability_cache;
387 my ($class, $group) = @_;
389 croak "req_ok_for() expects a requirement group name"
392 return $class->_check_deps($group)->{status};
395 sub req_missing_for {
396 my ($class, $group) = @_;
398 croak "req_missing_for() expects a requirement group name"
401 return $class->_check_deps($group)->{missing};
404 sub req_errorlist_for {
405 my ($class, $group) = @_;
407 croak "req_errorlist_for() expects a requirement group name"
410 return $class->_check_deps($group)->{errorlist};
414 my ($class, $group) = @_;
416 return $req_availability_cache{$group} ||= do {
418 my $deps = $class->req_list_for ($group);
421 for my $mod (keys %$deps) {
422 my $req_line = "require $mod;";
423 if (my $ver = $deps->{$mod}) {
424 $req_line .= "$mod->VERSION($ver);";
429 $errors{$mod} = $@ if $@;
435 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
436 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
439 errorlist => \%errors,
456 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
459 # This is to be called by the author only (automatically in Makefile.PL)
461 my ($class, $distver) = @_;
463 my $modfn = __PACKAGE__ . '.pm';
464 $modfn =~ s/\:\:/\//g;
466 my $podfn = __FILE__;
467 $podfn =~ s/\.pm$/\.pod/;
470 eval { require DBIx::Class; DBIx::Class->VERSION; }
473 "\n\n---------------------------------------------------------------------\n" .
474 'Unable to load core DBIx::Class module to determine current version, '.
475 'possibly due to missing dependencies. Author-mode autodocumentation ' .
477 "\n\n---------------------------------------------------------------------\n"
480 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
481 or die "Hrmm? No sqlt dep?";
485 #########################################################################
486 ##################### A U T O G E N E R A T E D ########################
487 #########################################################################
489 # The contents of this POD file are auto-generated. Any changes you make
490 # will be lost. If you need to change the generated text edit _gen_pod()
491 # at the end of $modfn
495 "$class - Optional module dependency specifications (for module authors)",
498 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
502 configure_requires 'DBIx::Class' => '$distver';
506 my \$deploy_deps = $class->req_list_for('deploy');
508 for (keys %\$deploy_deps) {
509 requires \$_ => \$deploy_deps->{\$_};
514 Note that there are some caveats regarding C<configure_requires()>, more info
515 can be found at L<Module::Install/configure_requires>
517 '=head1 DESCRIPTION',
519 Some of the less-frequently used features of L<DBIx::Class> have external
520 module dependencies on their own. In order not to burden the average user
521 with modules he will never use, these optional dependencies are not included
522 in the base Makefile.PL. Instead an exception with a descriptive message is
523 thrown when a specific feature is missing one or several modules required for
524 its operation. This module is the central holding place for the current list
525 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
528 '=head1 CURRENT REQUIREMENT GROUPS',
530 Dependencies are organized in C<groups> and each group can list one or more
531 required modules, with an optional minimum version (or 0 for any version).
532 The group name can be used in the
536 for my $group (sort keys %$reqs) {
537 my $p = $reqs->{$group}{pod}
540 my $modlist = $reqs->{$group}{req}
543 next unless keys %$modlist;
546 "=head2 $p->{title}",
549 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
551 "Requirement group: B<$group>",
557 '=head2 req_group_list',
559 '=item Arguments: none',
560 '=item Returns: \%list_of_requirement_groups',
563 This method should be used by DBIx::Class packagers, to get a hashref of all
564 dependencies keyed by dependency group. Each key (group name) can be supplied
565 to one of the group-specific methods below.
568 '=head2 req_list_for',
570 '=item Arguments: $group_name',
571 '=item Returns: \%list_of_module_version_pairs',
574 This method should be used by DBIx::Class extension authors, to determine the
575 version of modules a specific feature requires in the B<current> version of
576 DBIx::Class. See the L</SYNOPSIS> for a real-world
582 '=item Arguments: $group_name',
583 '=item Returns: 1|0',
586 Returns true or false depending on whether all modules required by
587 C<$group_name> are present on the system and loadable.
590 '=head2 req_missing_for',
592 '=item Arguments: $group_name',
593 '=item Returns: $error_message_string',
596 Returns a single line string suitable for inclusion in larger error messages.
597 This method would normally be used by DBIx::Class core-module author, to
598 indicate to the user that he needs to install specific modules before he will
599 be able to use a specific feature.
601 For example if some of the requirements for C<deploy> are not available,
602 the returned string could look like:
604 SQL::Translator >= $sqltver (see $class for details)
606 The author is expected to prepend the necessary text to this message before
607 returning the actual error seen by the user.
610 '=head2 req_errorlist_for',
612 '=item Arguments: $group_name',
613 '=item Returns: \%list_of_loaderrors_per_module',
616 Returns a hashref containing the actual errors that occured while attempting
617 to load each module in the requirement group.
620 'See L<DBIx::Class/CONTRIBUTORS>.',
622 'You may distribute this code under the same terms as Perl itself',
625 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
626 print $fh join ("\n\n", @chunks);