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',
163 'DBD::Oracle' => '1.24',
170 $ENV{DBICTEST_SYBASE_DSN}
172 'DateTime::Format::Sybase' => 0,
179 (scalar grep { $ENV{$_} } (qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/) )
181 'DateTime::Format::Strptime' => 0,
188 $ENV{DBICTEST_DB2_DSN}
199 my ($class, $group) = @_;
201 croak "req_list_for() expects a requirement group name"
204 my $deps = $reqs->{$group}{req}
205 or croak "Requirement group '$group' does not exist";
211 our %req_availability_cache;
213 my ($class, $group) = @_;
215 croak "req_ok_for() expects a requirement group name"
218 return $class->_check_deps($group)->{status};
221 sub req_missing_for {
222 my ($class, $group) = @_;
224 croak "req_missing_for() expects a requirement group name"
227 return $class->_check_deps($group)->{missing};
230 sub req_errorlist_for {
231 my ($class, $group) = @_;
233 croak "req_errorlist_for() expects a requirement group name"
236 return $class->_check_deps($group)->{errorlist};
240 my ($class, $group) = @_;
242 return $req_availability_cache{$group} ||= do {
244 my $deps = $class->req_list_for ($group);
247 for my $mod (keys %$deps) {
248 my $req_line = "require $mod;";
249 if (my $ver = $deps->{$mod}) {
250 $req_line .= "$mod->VERSION($ver);";
255 $errors{$mod} = $@ if $@;
261 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
262 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
265 errorlist => \%errors,
282 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
285 # This is to be called by the author only (automatically in Makefile.PL)
289 my $modfn = __PACKAGE__ . '.pm';
290 $modfn =~ s/\:\:/\//g;
292 my $podfn = __FILE__;
293 $podfn =~ s/\.pm$/\.pod/;
296 eval { require DBIx::Class; DBIx::Class->VERSION; }
300 "\n\n---------------------------------------------------------------------\n" .
301 'Unable to load core DBIx::Class module to determine current version, '.
302 'possibly due to missing dependencies. Author-mode autodocumentation ' .
304 "\n\n---------------------------------------------------------------------\n"
310 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
311 or die "Hrmm? No sqlt dep?";
315 #########################################################################
316 ##################### A U T O G E N E R A T E D ########################
317 #########################################################################
319 # The contents of this POD file are auto-generated. Any changes you make
320 # will be lost. If you need to change the generated text edit _gen_pod()
321 # at the end of $modfn
325 "$class - Optional module dependency specifications (for module authors)",
328 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
332 configure_requires 'DBIx::Class' => '$distver';
336 my \$deploy_deps = $class->req_list_for ('deploy');
338 for (keys %\$deploy_deps) {
339 requires \$_ => \$deploy_deps->{\$_};
344 Note that there are some caveats regarding C<configure_requires()>, more info
345 can be found at L<Module::Install/configure_requires>
347 '=head1 DESCRIPTION',
349 Some of the less-frequently used features of L<DBIx::Class> have external
350 module dependencies on their own. In order not to burden the average user
351 with modules he will never use, these optional dependencies are not included
352 in the base Makefile.PL. Instead an exception with a descriptive message is
353 thrown when a specific feature is missing one or several modules required for
354 its operation. This module is the central holding place for the current list
355 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
358 '=head1 CURRENT REQUIREMENT GROUPS',
360 Dependencies are organized in C<groups> and each group can list one or more
361 required modules, with an optional minimum version (or 0 for any version).
362 The group name can be used in the
366 for my $group (sort keys %$reqs) {
367 my $p = $reqs->{$group}{pod}
370 my $modlist = $reqs->{$group}{req}
373 next unless keys %$modlist;
376 "=head2 $p->{title}",
379 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
381 "Requirement group: B<$group>",
387 '=head2 req_group_list',
389 '=item Arguments: none',
390 '=item Returns: \%list_of_requirement_groups',
393 This method should be used by DBIx::Class packagers, to get a hashref of all
394 dependencies keyed by dependency group. Each key (group name) can be supplied
395 to one of the group-specific methods below.
398 '=head2 req_list_for',
400 '=item Arguments: $group_name',
401 '=item Returns: \%list_of_module_version_pairs',
404 This method should be used by DBIx::Class extension authors, to determine the
405 version of modules a specific feature requires in the B<current> version of
406 DBIx::Class. See the L</SYNOPSIS> for a real-world
412 '=item Arguments: $group_name',
413 '=item Returns: 1|0',
416 Returns true or false depending on whether all modules required by
417 C<$group_name> are present on the system and loadable.
420 '=head2 req_missing_for',
422 '=item Arguments: $group_name',
423 '=item Returns: $error_message_string',
426 Returns a single line string suitable for inclusion in larger error messages.
427 This method would normally be used by DBIx::Class core-module author, to
428 indicate to the user that he needs to install specific modules before he will
429 be able to use a specific feature.
431 For example if some of the requirements for C<deploy> are not available,
432 the returned string could look like:
434 SQL::Translator >= $sqltver (see $class for details)
436 The author is expected to prepend the necessary text to this message before
437 returning the actual error seen by the user.
440 '=head2 req_errorlist_for',
442 '=item Arguments: $group_name',
443 '=item Returns: \%list_of_loaderrors_per_module',
446 Returns a hashref containing the actual errors that occured while attempting
447 to load each module in the requirement group.
450 'See L<DBIx::Class/CONTRIBUTORS>.',
452 'You may distribute this code under the same terms as Perl itself',
455 open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
456 print $fh join ("\n\n", @chunks);