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',
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_mysql => {
178 $ENV{DBICTEST_MYSQL_DSN}
185 test_rdbms_oracle => {
187 $ENV{DBICTEST_ORA_DSN}
189 'DateTime::Format::Oracle' => '0',
190 'DBD::Oracle' => '1.24',
197 $ENV{DBICTEST_SYBASE_DSN}
199 'DateTime::Format::Sybase' => 0,
206 $ENV{DBICTEST_DB2_DSN}
217 my ($class, $group) = @_;
219 croak "req_list_for() expects a requirement group name"
222 my $deps = $reqs->{$group}{req}
223 or croak "Requirement group '$group' does not exist";
229 our %req_availability_cache;
231 my ($class, $group) = @_;
233 croak "req_ok_for() expects a requirement group name"
236 return $class->_check_deps($group)->{status};
239 sub req_missing_for {
240 my ($class, $group) = @_;
242 croak "req_missing_for() expects a requirement group name"
245 return $class->_check_deps($group)->{missing};
248 sub req_errorlist_for {
249 my ($class, $group) = @_;
251 croak "req_errorlist_for() expects a requirement group name"
254 return $class->_check_deps($group)->{errorlist};
258 my ($class, $group) = @_;
260 return $req_availability_cache{$group} ||= do {
262 my $deps = $class->req_list_for ($group);
265 for my $mod (keys %$deps) {
266 my $req_line = "require $mod;";
267 if (my $ver = $deps->{$mod}) {
268 $req_line .= "$mod->VERSION($ver);";
273 $errors{$mod} = $@ if $@;
279 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
280 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
283 errorlist => \%errors,
300 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
303 # This is to be called by the author only (automatically in Makefile.PL)
307 my $modfn = __PACKAGE__ . '.pm';
308 $modfn =~ s/\:\:/\//g;
310 my $podfn = __FILE__;
311 $podfn =~ s/\.pm$/\.pod/;
314 eval { require DBIx::Class; DBIx::Class->VERSION; }
318 "\n\n---------------------------------------------------------------------\n" .
319 'Unable to load core DBIx::Class module to determine current version, '.
320 'possibly due to missing dependencies. Author-mode autodocumentation ' .
322 "\n\n---------------------------------------------------------------------\n"
328 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
329 or die "Hrmm? No sqlt dep?";
333 #########################################################################
334 ##################### A U T O G E N E R A T E D ########################
335 #########################################################################
337 # The contents of this POD file are auto-generated. Any changes you make
338 # will be lost. If you need to change the generated text edit _gen_pod()
339 # at the end of $modfn
343 "$class - Optional module dependency specifications (for module authors)",
346 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
350 configure_requires 'DBIx::Class' => '$distver';
354 my \$deploy_deps = $class->req_list_for ('deploy');
356 for (keys %\$deploy_deps) {
357 requires \$_ => \$deploy_deps->{\$_};
362 Note that there are some caveats regarding C<configure_requires()>, more info
363 can be found at L<Module::Install/configure_requires>
365 '=head1 DESCRIPTION',
367 Some of the less-frequently used features of L<DBIx::Class> have external
368 module dependencies on their own. In order not to burden the average user
369 with modules he will never use, these optional dependencies are not included
370 in the base Makefile.PL. Instead an exception with a descriptive message is
371 thrown when a specific feature is missing one or several modules required for
372 its operation. This module is the central holding place for the current list
373 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
376 '=head1 CURRENT REQUIREMENT GROUPS',
378 Dependencies are organized in C<groups> and each group can list one or more
379 required modules, with an optional minimum version (or 0 for any version).
380 The group name can be used in the
384 for my $group (sort keys %$reqs) {
385 my $p = $reqs->{$group}{pod}
388 my $modlist = $reqs->{$group}{req}
391 next unless keys %$modlist;
394 "=head2 $p->{title}",
397 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
399 "Requirement group: B<$group>",
405 '=head2 req_group_list',
407 '=item Arguments: none',
408 '=item Returns: \%list_of_requirement_groups',
411 This method should be used by DBIx::Class packagers, to get a hashref of all
412 dependencies keyed by dependency group. Each key (group name) can be supplied
413 to one of the group-specific methods below.
416 '=head2 req_list_for',
418 '=item Arguments: $group_name',
419 '=item Returns: \%list_of_module_version_pairs',
422 This method should be used by DBIx::Class extension authors, to determine the
423 version of modules a specific feature requires in the B<current> version of
424 DBIx::Class. See the L</SYNOPSIS> for a real-world
430 '=item Arguments: $group_name',
431 '=item Returns: 1|0',
434 Returns true or false depending on whether all modules required by
435 C<$group_name> are present on the system and loadable.
438 '=head2 req_missing_for',
440 '=item Arguments: $group_name',
441 '=item Returns: $error_message_string',
444 Returns a single line string suitable for inclusion in larger error messages.
445 This method would normally be used by DBIx::Class core-module author, to
446 indicate to the user that he needs to install specific modules before he will
447 be able to use a specific feature.
449 For example if some of the requirements for C<deploy> are not available,
450 the returned string could look like:
452 SQL::Translator >= $sqltver (see $class for details)
454 The author is expected to prepend the necessary text to this message before
455 returning the actual error seen by the user.
458 '=head2 req_errorlist_for',
460 '=item Arguments: $group_name',
461 '=item Returns: \%list_of_loaderrors_per_module',
464 Returns a hashref containing the actual errors that occured while attempting
465 to load each module in the requirement group.
468 'See L<DBIx::Class/CONTRIBUTORS>.',
470 'You may distribute this code under the same terms as Perl itself',
473 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
474 print $fh join ("\n\n", @chunks);