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 'namespace::clean' => '0.11',
36 'Hash::Merge' => '0.12',
39 title => 'Storage::Replicated',
40 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
49 title => 'DBIx::Class::Admin',
50 desc => 'Modules required for the DBIx::Class administrative library',
58 'Getopt::Long::Descriptive' => '0.081',
59 'Text::CSV' => '1.16',
63 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
69 'SQL::Translator' => '0.11002',
72 title => 'Storage::DBI::deploy()',
73 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>',
80 'Test::Pod' => '1.41',
86 'Test::Pod::Coverage' => '1.08',
87 'Pod::Coverage' => '0.20',
93 #'Test::NoTabs' => '0.9',
99 #'Test::EOL' => '0.6',
105 'Test::Memory::Cycle' => '0',
106 'Devel::Cycle' => '1.10',
114 'DateTime::Format::SQLite' => '0',
116 # t/96_is_deteministic_value.t
117 'DateTime::Format::Strptime'=> '0',
123 'DBIx::ContextualFetch' => '0',
124 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
125 'Class::Trigger' => '0',
126 'Time::Piece::MySQL' => '0',
128 'Date::Simple' => '3.03',
134 $ENV{DBICTEST_PG_DSN}
136 'Sys::SigAction' => '0',
137 'DBD::Pg' => '2.009002',
138 'DateTime::Format::Pg' => '0',
145 $ENV{DBICTEST_MYSQL_DSN}
147 'DateTime::Format::MySQL' => '0',
155 $ENV{DBICTEST_ORA_DSN}
157 'DateTime::Format::Oracle' => '0',
164 $ENV{DBICTEST_SYBASE_DSN}
166 'DateTime::Format::Sybase' => 0,
173 (scalar grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/})
175 'DateTime::Format::Strptime' => 0,
182 sub _all_optional_requirements {
183 return { map { %{ $reqs->{$_}{req} || {} } } (keys %$reqs) };
187 my ($class, $group) = @_;
189 croak "req_list_for() expects a requirement group name"
192 my $deps = $reqs->{$group}{req}
193 or croak "Requirement group '$group' does not exist";
199 our %req_availability_cache;
201 my ($class, $group) = @_;
203 croak "req_ok_for() expects a requirement group name"
206 $class->_check_deps ($group) unless $req_availability_cache{$group};
208 return $req_availability_cache{$group}{status};
211 sub req_missing_for {
212 my ($class, $group) = @_;
214 croak "req_missing_for() expects a requirement group name"
217 $class->_check_deps ($group) unless $req_availability_cache{$group};
219 return $req_availability_cache{$group}{missing};
222 sub req_errorlist_for {
223 my ($class, $group) = @_;
225 croak "req_errorlist_for() expects a requirement group name"
228 $class->_check_deps ($group) unless $req_availability_cache{$group};
230 return $req_availability_cache{$group}{errorlist};
234 my ($class, $group) = @_;
236 my $deps = $class->req_list_for ($group);
239 for my $mod (keys %$deps) {
240 if (my $ver = $deps->{$mod}) {
241 eval "use $mod $ver ()";
247 $errors{$mod} = $@ if $@;
251 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
252 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
253 $req_availability_cache{$group} = {
255 errorlist => { %errors },
260 $req_availability_cache{$group} = {
268 # This is to be called by the author onbly (automatically in Makefile.PL)
271 my $modfn = __PACKAGE__ . '.pm';
272 $modfn =~ s/\:\:/\//g;
275 my $distver = DBIx::Class->VERSION;
279 #########################################################################
280 ##################### A U T O G E N E R A T E D ########################
281 #########################################################################
283 # The contents of this POD file are auto-generated. Any changes you make
284 # will be lost. If you need to change the generated text edit _gen_pod()
285 # at the end of $modfn
289 "$class - Optional module dependency specifications (for module authors)",
290 '=head1 SYNOPSIS (EXPERIMENTAL)',
292 B<THE USAGE SHOWN HERE IS EXPERIMENTAL>
294 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
298 configure_requires 'DBIx::Class' => '$distver';
302 my \$deploy_deps = $class->req_list_for ('deploy');
304 for (keys %\$deploy_deps) {
305 requires \$_ => \$deploy_deps->{\$_};
310 Note that there are some caveats regarding C<configure_requires()>, more info
311 can be found at L<Module::Install/configure_requires>
313 '=head1 DESCRIPTION',
315 Some of the less-frequently used features of L<DBIx::Class> have external
316 module dependencies on their own. In order not to burden the average user
317 with modules he will never use, these optional dependencies are not included
318 in the base Makefile.PL. Instead an exception with a descriptive message is
319 thrown when a specific feature is missing one or several modules required for
320 its operation. This module is the central holding place for the current list
321 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
324 '=head1 CURRENT REQUIREMENT GROUPS',
326 Dependencies are organized in C<groups> and each group can list one or more
327 required modules, with an optional minimum version (or 0 for any version).
328 The group name can be used in the
332 for my $group (sort keys %$reqs) {
333 my $p = $reqs->{$group}{pod}
336 my $modlist = $reqs->{$group}{req}
339 next unless keys %$modlist;
342 "=head2 $p->{title}",
345 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
347 "Requirement group: B<$group>",
353 '=head2 req_list_for',
355 '=item Arguments: $group_name',
356 '=item Returns: \%list_of_module_version_pairs',
359 This method should be used by DBIx::Class extension authors, to determine the
360 version of modules a specific feature requires in the B<current> version of
361 DBIx::Class. See the L<SYNOPSIS|/SYNOPSIS (EXPERIMENTAL)> for a real-world
367 '=item Arguments: $group_name',
368 '=item Returns: 1|0',
370 'Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable',
372 '=head2 req_missing_for',
374 '=item Arguments: $group_name',
375 '=item Returns: $error_message_string',
378 Returns a single line string suitable for inclusion in larger error messages.
379 This method would normally be used by DBIx::Class core-module author, to
380 indicate to the user that he needs to install specific modules before he will
381 be able to use a specific feature.
383 For example if the requirements for C<replicated> are not available, the
384 returned string would look like:
386 Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see $class for details)
388 The author is expected to prepend the necessary text to this message before
389 returning the actual error seen by the user.
392 '=head2 req_errorlist_for',
394 '=item Arguments: $group_name',
395 '=item Returns: \%list_of_loaderrors_per_module',
398 Returns a hashref containing the actual errors that occured while attempting
399 to load each module in the requirement group.
402 'See L<DBIx::Class/CONTRIBUTORS>.',
404 'You may distribute this code under the same terms as Perl itself',
408 $fn =~ s/\.pm$/\.pod/;
410 open (my $fh, '>', $fn) or croak "Unable to write to $fn: $!";
411 print $fh join ("\n\n", @chunks);