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',
29 'MooseX::Types::Path::Class' => '0.05',
30 'MooseX::Types::JSON' => '0.02',
31 'namespace::autoclean' => '0.09',
34 my $datetime_basic = {
36 'DateTime::Format::Strptime' => '1.2',
40 'Math::BigInt' => '1.89',
41 'Math::Base36' => '0.07',
50 my $rdbms_mssql_odbc = {
53 my $rdbms_mssql_sybase = {
72 #'Module::Install::Pod::Inherit' => '0.01',
78 title => 'Storage::Replicated',
79 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
92 title => 'DBIx::Class::Admin',
93 desc => 'Modules required for the DBIx::Class administrative library',
101 'Getopt::Long::Descriptive' => '0.081',
102 'Text::CSV' => '1.16',
105 title => 'dbicadmin',
106 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
112 'SQL::Translator' => '0.11006',
115 title => 'Storage::DBI::deploy()',
116 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
121 req => $id_shortener,
126 'Test::Pod' => '1.41',
130 test_podcoverage => {
132 'Test::Pod::Coverage' => '1.08',
133 'Pod::Coverage' => '0.20',
139 'Test::NoTabs' => '0.9',
145 'Test::EOL' => '0.6',
149 test_prettydebug => {
155 'Test::Memory::Cycle' => '0',
156 'Devel::Cycle' => '1.10',
161 req => $datetime_basic,
169 'DateTime::Format::SQLite' => '0',
176 # t/inflate/datetime_mysql.t
177 # (doesn't need Mysql itself)
178 'DateTime::Format::MySQL' => '0',
185 # t/inflate/datetime_pg.t
186 # (doesn't need PG itself)
187 'DateTime::Format::Pg' => '0.16004',
193 'DBIx::ContextualFetch' => '0',
194 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
195 'Class::Trigger' => '0',
196 'Time::Piece::MySQL' => '0',
198 'Date::Simple' => '3.03',
202 # this is just for completeness as SQLite
203 # is a core dep of DBIC for testing
209 title => 'SQLite support',
210 desc => 'Modules required to connect to SQLite',
219 title => 'PostgreSQL support',
220 desc => 'Modules required to connect to PostgreSQL',
224 rdbms_mssql_odbc => {
229 title => 'MSSQL support via DBD::ODBC',
230 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
234 rdbms_mssql_sybase => {
236 %$rdbms_mssql_sybase,
239 title => 'MSSQL support via DBD::Sybase',
240 desc => 'Modules required to connect to MSSQL support via DBD::Sybase',
249 title => 'MySQL support',
250 desc => 'Modules required to connect to MySQL',
259 title => 'Oracle support',
260 desc => 'Modules required to connect to Oracle',
269 title => 'Sybase ASE support',
270 desc => 'Modules required to connect to Sybase ASE',
279 title => 'DB2 support',
280 desc => 'Modules required to connect to DB2',
284 # the order does matter because the rdbms support group might require
285 # a different version that the test group
288 $ENV{DBICTEST_PG_DSN}
291 'Sys::SigAction' => '0',
292 'DBD::Pg' => '2.009002',
297 test_rdbms_mssql_odbc => {
299 $ENV{DBICTEST_MSSQL_ODBC_DSN}
306 test_rdbms_mssql_sybase => {
308 $ENV{DBICTEST_MSSQL_DSN}
310 %$rdbms_mssql_sybase,
315 test_rdbms_mysql => {
317 $ENV{DBICTEST_MYSQL_DSN}
324 test_rdbms_oracle => {
326 $ENV{DBICTEST_ORA_DSN}
329 'DateTime::Format::Oracle' => '0',
330 'DBD::Oracle' => '1.24',
337 $ENV{DBICTEST_SYBASE_DSN}
340 'DateTime::Format::Sybase' => '0',
347 $ENV{DBICTEST_DB2_DSN}
356 $ENV{DBICTEST_MEMCACHED}
358 'Cache::Memcached' => 0,
367 my ($class, $group) = @_;
369 croak "req_list_for() expects a requirement group name"
372 my $deps = $reqs->{$group}{req}
373 or croak "Requirement group '$group' does not exist";
379 our %req_availability_cache;
381 my ($class, $group) = @_;
383 croak "req_ok_for() expects a requirement group name"
386 return $class->_check_deps($group)->{status};
389 sub req_missing_for {
390 my ($class, $group) = @_;
392 croak "req_missing_for() expects a requirement group name"
395 return $class->_check_deps($group)->{missing};
398 sub req_errorlist_for {
399 my ($class, $group) = @_;
401 croak "req_errorlist_for() expects a requirement group name"
404 return $class->_check_deps($group)->{errorlist};
408 my ($class, $group) = @_;
410 return $req_availability_cache{$group} ||= do {
412 my $deps = $class->req_list_for ($group);
415 for my $mod (keys %$deps) {
416 my $req_line = "require $mod;";
417 if (my $ver = $deps->{$mod}) {
418 $req_line .= "$mod->VERSION($ver);";
423 $errors{$mod} = $@ if $@;
429 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
430 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
433 errorlist => \%errors,
450 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
453 # This is to be called by the author only (automatically in Makefile.PL)
455 my ($class, $distver) = @_;
457 my $modfn = __PACKAGE__ . '.pm';
458 $modfn =~ s/\:\:/\//g;
460 my $podfn = __FILE__;
461 $podfn =~ s/\.pm$/\.pod/;
464 eval { require DBIx::Class; DBIx::Class->VERSION; }
467 "\n\n---------------------------------------------------------------------\n" .
468 'Unable to load core DBIx::Class module to determine current version, '.
469 'possibly due to missing dependencies. Author-mode autodocumentation ' .
471 "\n\n---------------------------------------------------------------------\n"
474 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
475 or die "Hrmm? No sqlt dep?";
479 #########################################################################
480 ##################### A U T O G E N E R A T E D ########################
481 #########################################################################
483 # The contents of this POD file are auto-generated. Any changes you make
484 # will be lost. If you need to change the generated text edit _gen_pod()
485 # at the end of $modfn
489 "$class - Optional module dependency specifications (for module authors)",
492 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
496 configure_requires 'DBIx::Class' => '$distver';
500 my \$deploy_deps = $class->req_list_for('deploy');
502 for (keys %\$deploy_deps) {
503 requires \$_ => \$deploy_deps->{\$_};
508 Note that there are some caveats regarding C<configure_requires()>, more info
509 can be found at L<Module::Install/configure_requires>
511 '=head1 DESCRIPTION',
513 Some of the less-frequently used features of L<DBIx::Class> have external
514 module dependencies on their own. In order not to burden the average user
515 with modules he will never use, these optional dependencies are not included
516 in the base Makefile.PL. Instead an exception with a descriptive message is
517 thrown when a specific feature is missing one or several modules required for
518 its operation. This module is the central holding place for the current list
519 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
522 '=head1 CURRENT REQUIREMENT GROUPS',
524 Dependencies are organized in C<groups> and each group can list one or more
525 required modules, with an optional minimum version (or 0 for any version).
526 The group name can be used in the
530 for my $group (sort keys %$reqs) {
531 my $p = $reqs->{$group}{pod}
534 my $modlist = $reqs->{$group}{req}
537 next unless keys %$modlist;
540 "=head2 $p->{title}",
543 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
545 "Requirement group: B<$group>",
551 '=head2 req_group_list',
553 '=item Arguments: none',
554 '=item Returns: \%list_of_requirement_groups',
557 This method should be used by DBIx::Class packagers, to get a hashref of all
558 dependencies keyed by dependency group. Each key (group name) can be supplied
559 to one of the group-specific methods below.
562 '=head2 req_list_for',
564 '=item Arguments: $group_name',
565 '=item Returns: \%list_of_module_version_pairs',
568 This method should be used by DBIx::Class extension authors, to determine the
569 version of modules a specific feature requires in the B<current> version of
570 DBIx::Class. See the L</SYNOPSIS> for a real-world
576 '=item Arguments: $group_name',
577 '=item Returns: 1|0',
580 Returns true or false depending on whether all modules required by
581 C<$group_name> are present on the system and loadable.
584 '=head2 req_missing_for',
586 '=item Arguments: $group_name',
587 '=item Returns: $error_message_string',
590 Returns a single line string suitable for inclusion in larger error messages.
591 This method would normally be used by DBIx::Class core-module author, to
592 indicate to the user that he needs to install specific modules before he will
593 be able to use a specific feature.
595 For example if some of the requirements for C<deploy> are not available,
596 the returned string could look like:
598 SQL::Translator >= $sqltver (see $class for details)
600 The author is expected to prepend the necessary text to this message before
601 returning the actual error seen by the user.
604 '=head2 req_errorlist_for',
606 '=item Arguments: $group_name',
607 '=item Returns: \%list_of_loaderrors_per_module',
610 Returns a hashref containing the actual errors that occured while attempting
611 to load each module in the requirement group.
614 'See L<DBIx::Class/CONTRIBUTORS>.',
616 'You may distribute this code under the same terms as Perl itself',
619 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
620 print $fh join ("\n\n", @chunks);