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
16 'MooseX::Types' => '0.21',
21 'Hash::Merge' => '0.12',
26 'MooseX::Types::Path::Class' => '0.05',
27 'MooseX::Types::JSON' => '0.02',
28 'JSON::Any' => '1.22',
29 'namespace::autoclean' => '0.09',
32 my $datetime_basic = {
34 'DateTime::Format::Strptime' => '1.2',
39 #'Module::Install::Pod::Inherit' => '0.01',
45 title => 'Storage::Replicated',
46 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
63 title => 'DBIx::Class::Admin',
64 desc => 'Modules required for the DBIx::Class administrative library',
72 'Getopt::Long::Descriptive' => '0.081',
73 'Text::CSV' => '1.16',
77 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
83 'SQL::Translator' => '0.11006',
86 title => 'Storage::DBI::deploy()',
87 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>',
94 'Test::Pod' => '1.41',
100 'Test::Pod::Coverage' => '1.08',
101 'Pod::Coverage' => '0.20',
107 'Test::NoTabs' => '0.9',
113 'Test::EOL' => '0.6',
119 'Test::Memory::Cycle' => '0',
120 'Devel::Cycle' => '1.10',
125 req => $datetime_basic,
133 'DateTime::Format::SQLite' => '0',
140 # t/inflate/datetime_mysql.t
141 # (doesn't need Mysql itself)
142 'DateTime::Format::MySQL' => '0',
149 # t/inflate/datetime_pg.t
150 # (doesn't need PG itself)
151 'DateTime::Format::Pg' => '0.16004',
157 'DBIx::ContextualFetch' => '0',
158 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
159 'Class::Trigger' => '0',
160 'Time::Piece::MySQL' => '0',
162 'Date::Simple' => '3.03',
168 $ENV{DBICTEST_PG_DSN}
170 'Sys::SigAction' => '0',
171 'DBD::Pg' => '2.009002',
176 test_rdbms_mssql_odbc => {
178 $ENV{DBICTEST_MSSQL_ODBC_DSN}
185 test_rdbms_mssql_sybase => {
187 $ENV{DBICTEST_MSSQL_DSN}
189 'DBD::Sybase' => '0',
194 test_rdbms_mysql => {
196 $ENV{DBICTEST_MYSQL_DSN}
203 test_rdbms_oracle => {
205 $ENV{DBICTEST_ORA_DSN}
207 'DateTime::Format::Oracle' => '0',
208 'DBD::Oracle' => '1.24',
215 $ENV{DBICTEST_SYBASE_DSN}
217 'DateTime::Format::Sybase' => 0,
224 $ENV{DBICTEST_DB2_DSN}
235 my ($class, $group) = @_;
237 croak "req_list_for() expects a requirement group name"
240 my $deps = $reqs->{$group}{req}
241 or croak "Requirement group '$group' does not exist";
247 our %req_availability_cache;
249 my ($class, $group) = @_;
251 croak "req_ok_for() expects a requirement group name"
254 return $class->_check_deps($group)->{status};
257 sub req_missing_for {
258 my ($class, $group) = @_;
260 croak "req_missing_for() expects a requirement group name"
263 return $class->_check_deps($group)->{missing};
266 sub req_errorlist_for {
267 my ($class, $group) = @_;
269 croak "req_errorlist_for() expects a requirement group name"
272 return $class->_check_deps($group)->{errorlist};
276 my ($class, $group) = @_;
278 return $req_availability_cache{$group} ||= do {
280 my $deps = $class->req_list_for ($group);
283 for my $mod (keys %$deps) {
284 my $req_line = "require $mod;";
285 if (my $ver = $deps->{$mod}) {
286 $req_line .= "$mod->VERSION($ver);";
291 $errors{$mod} = $@ if $@;
297 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
298 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
301 errorlist => \%errors,
318 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
321 # This is to be called by the author only (automatically in Makefile.PL)
323 my ($class, $distver) = @_;
325 my $modfn = __PACKAGE__ . '.pm';
326 $modfn =~ s/\:\:/\//g;
328 my $podfn = __FILE__;
329 $podfn =~ s/\.pm$/\.pod/;
332 eval { require DBIx::Class; DBIx::Class->VERSION; }
335 "\n\n---------------------------------------------------------------------\n" .
336 'Unable to load core DBIx::Class module to determine current version, '.
337 'possibly due to missing dependencies. Author-mode autodocumentation ' .
339 "\n\n---------------------------------------------------------------------\n"
342 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
343 or die "Hrmm? No sqlt dep?";
347 #########################################################################
348 ##################### A U T O G E N E R A T E D ########################
349 #########################################################################
351 # The contents of this POD file are auto-generated. Any changes you make
352 # will be lost. If you need to change the generated text edit _gen_pod()
353 # at the end of $modfn
357 "$class - Optional module dependency specifications (for module authors)",
360 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
364 configure_requires 'DBIx::Class' => '$distver';
368 my \$deploy_deps = $class->req_list_for ('deploy');
370 for (keys %\$deploy_deps) {
371 requires \$_ => \$deploy_deps->{\$_};
376 Note that there are some caveats regarding C<configure_requires()>, more info
377 can be found at L<Module::Install/configure_requires>
379 '=head1 DESCRIPTION',
381 Some of the less-frequently used features of L<DBIx::Class> have external
382 module dependencies on their own. In order not to burden the average user
383 with modules he will never use, these optional dependencies are not included
384 in the base Makefile.PL. Instead an exception with a descriptive message is
385 thrown when a specific feature is missing one or several modules required for
386 its operation. This module is the central holding place for the current list
387 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
390 '=head1 CURRENT REQUIREMENT GROUPS',
392 Dependencies are organized in C<groups> and each group can list one or more
393 required modules, with an optional minimum version (or 0 for any version).
394 The group name can be used in the
398 for my $group (sort keys %$reqs) {
399 my $p = $reqs->{$group}{pod}
402 my $modlist = $reqs->{$group}{req}
405 next unless keys %$modlist;
408 "=head2 $p->{title}",
411 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
413 "Requirement group: B<$group>",
419 '=head2 req_group_list',
421 '=item Arguments: none',
422 '=item Returns: \%list_of_requirement_groups',
425 This method should be used by DBIx::Class packagers, to get a hashref of all
426 dependencies keyed by dependency group. Each key (group name) can be supplied
427 to one of the group-specific methods below.
430 '=head2 req_list_for',
432 '=item Arguments: $group_name',
433 '=item Returns: \%list_of_module_version_pairs',
436 This method should be used by DBIx::Class extension authors, to determine the
437 version of modules a specific feature requires in the B<current> version of
438 DBIx::Class. See the L</SYNOPSIS> for a real-world
444 '=item Arguments: $group_name',
445 '=item Returns: 1|0',
448 Returns true or false depending on whether all modules required by
449 C<$group_name> are present on the system and loadable.
452 '=head2 req_missing_for',
454 '=item Arguments: $group_name',
455 '=item Returns: $error_message_string',
458 Returns a single line string suitable for inclusion in larger error messages.
459 This method would normally be used by DBIx::Class core-module author, to
460 indicate to the user that he needs to install specific modules before he will
461 be able to use a specific feature.
463 For example if some of the requirements for C<deploy> are not available,
464 the returned string could look like:
466 SQL::Translator >= $sqltver (see $class for details)
468 The author is expected to prepend the necessary text to this message before
469 returning the actual error seen by the user.
472 '=head2 req_errorlist_for',
474 '=item Arguments: $group_name',
475 '=item Returns: \%list_of_loaderrors_per_module',
478 Returns a hashref containing the actual errors that occured while attempting
479 to load each module in the requirement group.
482 'See L<DBIx::Class/CONTRIBUTORS>.',
484 'You may distribute this code under the same terms as Perl itself',
487 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
488 print $fh join ("\n\n", @chunks);