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 'MooseX::Types::Path::Class' => '0.05',
22 'MooseX::Types::JSON' => '0.02',
23 'JSON::Any' => '1.22',
24 'namespace::autoclean' => '0.09',
29 #'Module::Install::Pod::Inherit' => '0.01',
35 'Hash::Merge' => '0.12',
38 title => 'Storage::Replicated',
39 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
48 title => 'DBIx::Class::Admin',
49 desc => 'Modules required for the DBIx::Class administrative library',
57 'Getopt::Long::Descriptive' => '0.081',
58 'Text::CSV' => '1.16',
62 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
68 'SQL::Translator' => '0.11006',
71 title => 'Storage::DBI::deploy()',
72 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>',
79 'Test::Pod' => '1.41',
85 'Test::Pod::Coverage' => '1.08',
86 'Pod::Coverage' => '0.20',
92 'Test::NoTabs' => '0.9',
104 'Test::Memory::Cycle' => '0',
105 'Devel::Cycle' => '1.10',
113 'DateTime::Format::SQLite' => '0',
115 # t/96_is_deteministic_value.t
116 'DateTime::Format::Strptime'=> '0',
118 # t/inflate/datetime_mysql.t
119 # (doesn't need Mysql itself)
120 'DateTime::Format::MySQL' => '0',
122 # t/inflate/datetime_pg.t
123 # (doesn't need PG itself)
124 'DateTime::Format::Pg' => '0',
130 'DBIx::ContextualFetch' => '0',
131 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
132 'Class::Trigger' => '0',
133 'Time::Piece::MySQL' => '0',
135 'Date::Simple' => '3.03',
141 $ENV{DBICTEST_PG_DSN}
143 'Sys::SigAction' => '0',
144 'DBD::Pg' => '2.009002',
151 $ENV{DBICTEST_MYSQL_DSN}
160 $ENV{DBICTEST_ORA_DSN}
162 'DateTime::Format::Oracle' => '0',
169 $ENV{DBICTEST_SYBASE_DSN}
171 'DateTime::Format::Sybase' => 0,
178 (scalar grep { $ENV{$_} } (qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/) )
180 'DateTime::Format::Strptime' => 0,
187 $ENV{DBICTEST_DB2_DSN}
198 my ($class, $group) = @_;
200 croak "req_list_for() expects a requirement group name"
203 my $deps = $reqs->{$group}{req}
204 or croak "Requirement group '$group' does not exist";
210 our %req_availability_cache;
212 my ($class, $group) = @_;
214 croak "req_ok_for() expects a requirement group name"
217 $class->_check_deps ($group) unless $req_availability_cache{$group};
219 return $req_availability_cache{$group}{status};
222 sub req_missing_for {
223 my ($class, $group) = @_;
225 croak "req_missing_for() expects a requirement group name"
228 $class->_check_deps ($group) unless $req_availability_cache{$group};
230 return $req_availability_cache{$group}{missing};
233 sub req_errorlist_for {
234 my ($class, $group) = @_;
236 croak "req_errorlist_for() expects a requirement group name"
239 $class->_check_deps ($group) unless $req_availability_cache{$group};
241 return $req_availability_cache{$group}{errorlist};
245 my ($class, $group) = @_;
247 my $deps = $class->req_list_for ($group);
250 for my $mod (keys %$deps) {
251 if (my $ver = $deps->{$mod}) {
252 eval "use $mod $ver ()";
258 $errors{$mod} = $@ if $@;
262 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
263 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
264 $req_availability_cache{$group} = {
266 errorlist => { %errors },
271 $req_availability_cache{$group} = {
280 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
283 # This is to be called by the author only (automatically in Makefile.PL)
287 my $modfn = __PACKAGE__ . '.pm';
288 $modfn =~ s/\:\:/\//g;
290 my $podfn = __FILE__;
291 $podfn =~ s/\.pm$/\.pod/;
294 eval { require DBIx::Class; DBIx::Class->VERSION; }
298 "\n\n---------------------------------------------------------------------\n" .
299 'Unable to load core DBIx::Class module to determine current version, '.
300 'possibly due to missing dependencies. Author-mode autodocumentation ' .
302 "\n\n---------------------------------------------------------------------\n"
308 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
309 or die "Hrmm? No sqlt dep?";
313 #########################################################################
314 ##################### A U T O G E N E R A T E D ########################
315 #########################################################################
317 # The contents of this POD file are auto-generated. Any changes you make
318 # will be lost. If you need to change the generated text edit _gen_pod()
319 # at the end of $modfn
323 "$class - Optional module dependency specifications (for module authors)",
326 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
330 configure_requires 'DBIx::Class' => '$distver';
334 my \$deploy_deps = $class->req_list_for ('deploy');
336 for (keys %\$deploy_deps) {
337 requires \$_ => \$deploy_deps->{\$_};
342 Note that there are some caveats regarding C<configure_requires()>, more info
343 can be found at L<Module::Install/configure_requires>
345 '=head1 DESCRIPTION',
347 Some of the less-frequently used features of L<DBIx::Class> have external
348 module dependencies on their own. In order not to burden the average user
349 with modules he will never use, these optional dependencies are not included
350 in the base Makefile.PL. Instead an exception with a descriptive message is
351 thrown when a specific feature is missing one or several modules required for
352 its operation. This module is the central holding place for the current list
353 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
356 '=head1 CURRENT REQUIREMENT GROUPS',
358 Dependencies are organized in C<groups> and each group can list one or more
359 required modules, with an optional minimum version (or 0 for any version).
360 The group name can be used in the
364 for my $group (sort keys %$reqs) {
365 my $p = $reqs->{$group}{pod}
368 my $modlist = $reqs->{$group}{req}
371 next unless keys %$modlist;
374 "=head2 $p->{title}",
377 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
379 "Requirement group: B<$group>",
385 '=head2 req_group_list',
387 '=item Arguments: $none',
388 '=item Returns: \%list_of_requirement_groups',
391 This method should be used by DBIx::Class packagers, to get a hashref of all
392 dependencies keyed by dependency group. Each key (group name) can be supplied
393 to one of the group-specific methods below.
396 '=head2 req_list_for',
398 '=item Arguments: $group_name',
399 '=item Returns: \%list_of_module_version_pairs',
402 This method should be used by DBIx::Class extension authors, to determine the
403 version of modules a specific feature requires in the B<current> version of
404 DBIx::Class. See the L</SYNOPSIS> for a real-world
410 '=item Arguments: $group_name',
411 '=item Returns: 1|0',
413 'Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable',
415 '=head2 req_missing_for',
417 '=item Arguments: $group_name',
418 '=item Returns: $error_message_string',
421 Returns a single line string suitable for inclusion in larger error messages.
422 This method would normally be used by DBIx::Class core-module author, to
423 indicate to the user that he needs to install specific modules before he will
424 be able to use a specific feature.
426 For example if some of the requirements for C<deploy> are not available,
427 the returned string could look like:
429 SQL::Translator >= $sqltver (see $class for details)
431 The author is expected to prepend the necessary text to this message before
432 returning the actual error seen by the user.
435 '=head2 req_errorlist_for',
437 '=item Arguments: $group_name',
438 '=item Returns: \%list_of_loaderrors_per_module',
441 Returns a hashref containing the actual errors that occured while attempting
442 to load each module in the requirement group.
445 'See L<DBIx::Class/CONTRIBUTORS>.',
447 'You may distribute this code under the same terms as Perl itself',
450 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
451 print $fh join ("\n\n", @chunks);