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>',
79 'Test::Pod' => '1.26',
80 'Test::Pod::Coverage' => '1.08',
81 'Pod::Coverage' => '0.20',
82 #'Test::NoTabs' => '0.9',
83 #'Test::EOL' => '0.6',
90 'Test::Memory::Cycle' => '0',
91 'Devel::Cycle' => '1.10',
95 'DateTime::Format::SQLite' => '0',
97 # t/96_is_deteministic_value.t
98 'DateTime::Format::Strptime'=> '0',
104 'DBIx::ContextualFetch' => '0',
105 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
106 'Class::Trigger' => '0',
107 'Time::Piece::MySQL' => '0',
109 'Date::Simple' => '3.03',
115 $ENV{DBICTEST_PG_DSN}
117 'Sys::SigAction' => '0',
118 'DBD::Pg' => '2.009002',
119 'DateTime::Format::Pg' => '0',
126 $ENV{DBICTEST_MYSQL_DSN}
128 'DateTime::Format::MySQL' => '0',
136 $ENV{DBICTEST_ORA_DSN}
138 'DateTime::Format::Oracle' => '0',
145 $ENV{DBICTEST_SYBASE_DSN}
147 'DateTime::Format::Sybase' => 0,
154 (scalar grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/})
156 'DateTime::Format::Strptime' => 0,
163 sub _all_optional_requirements {
164 return { map { %{ $reqs->{$_}{req} || {} } } (keys %$reqs) };
168 my ($class, $group) = @_;
170 croak "req_list_for() expects a requirement group name"
173 my $deps = $reqs->{$group}{req}
174 or croak "Requirement group '$group' does not exist";
180 our %req_availability_cache;
182 my ($class, $group) = @_;
184 croak "req_ok_for() expects a requirement group name"
187 $class->_check_deps ($group) unless $req_availability_cache{$group};
189 return $req_availability_cache{$group}{status};
192 sub req_missing_for {
193 my ($class, $group) = @_;
195 croak "req_missing_for() expects a requirement group name"
198 $class->_check_deps ($group) unless $req_availability_cache{$group};
200 return $req_availability_cache{$group}{missing};
203 sub req_errorlist_for {
204 my ($class, $group) = @_;
206 croak "req_errorlist_for() expects a requirement group name"
209 $class->_check_deps ($group) unless $req_availability_cache{$group};
211 return $req_availability_cache{$group}{errorlist};
215 my ($class, $group) = @_;
217 my $deps = $class->req_list_for ($group);
220 for my $mod (keys %$deps) {
221 if (my $ver = $deps->{$mod}) {
222 eval "use $mod $ver ()";
228 $errors{$mod} = $@ if $@;
232 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
233 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
234 $req_availability_cache{$group} = {
236 errorlist => { %errors },
241 $req_availability_cache{$group} = {
249 # This is to be called by the author onbly (automatically in Makefile.PL)
252 my $modfn = __PACKAGE__ . '.pm';
253 $modfn =~ s/\:\:/\//g;
256 my $distver = DBIx::Class->VERSION;
260 #########################################################################
261 ##################### A U T O G E N E R A T E D ########################
262 #########################################################################
264 # The contents of this POD file are auto-generated. Any changes you make
265 # will be lost. If you need to change the generated text edit _gen_pod()
266 # at the end of $modfn
270 "$class - Optional module dependency specifications (for module authors)",
271 '=head1 SYNOPSIS (EXPERIMENTAL)',
273 B<THE USAGE SHOWN HERE IS EXPERIMENTAL>
275 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
279 configure_requires 'DBIx::Class' => '$distver';
283 my \$deploy_deps = $class->req_list_for ('deploy');
285 for (keys %\$deploy_deps) {
286 requires \$_ => \$deploy_deps->{\$_};
291 Note that there are some caveats regarding C<configure_requires()>, more info
292 can be found at L<Module::Install/configure_requires>
294 '=head1 DESCRIPTION',
296 Some of the less-frequently used features of L<DBIx::Class> have external
297 module dependencies on their own. In order not to burden the average user
298 with modules he will never use, these optional dependencies are not included
299 in the base Makefile.PL. Instead an exception with a descriptive message is
300 thrown when a specific feature is missing one or several modules required for
301 its operation. This module is the central holding place for the current list
302 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
305 '=head1 CURRENT REQUIREMENT GROUPS',
307 Dependencies are organized in C<groups> and each group can list one or more
308 required modules, with an optional minimum version (or 0 for any version).
309 The group name can be used in the
313 for my $group (sort keys %$reqs) {
314 my $p = $reqs->{$group}{pod}
317 my $modlist = $reqs->{$group}{req}
320 next unless keys %$modlist;
323 "=head2 $p->{title}",
326 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
328 "Requirement group: B<$group>",
334 '=head2 req_list_for',
336 '=item Arguments: $group_name',
337 '=item Returns: \%list_of_module_version_pairs',
340 This method should be used by DBIx::Class extension authors, to determine the
341 version of modules a specific feature requires in the B<current> version of
342 DBIx::Class. See the L<SYNOPSIS|/SYNOPSIS (EXPERIMENTAL)> for a real-world
348 '=item Arguments: $group_name',
349 '=item Returns: 1|0',
351 'Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable',
353 '=head2 req_missing_for',
355 '=item Arguments: $group_name',
356 '=item Returns: $error_message_string',
359 Returns a single line string suitable for inclusion in larger error messages.
360 This method would normally be used by DBIx::Class core-module author, to
361 indicate to the user that he needs to install specific modules before he will
362 be able to use a specific feature.
364 For example if the requirements for C<replicated> are not available, the
365 returned string would look like:
367 Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see $class for details)
369 The author is expected to prepend the necessary text to this message before
370 returning the actual error seen by the user.
373 '=head2 req_errorlist_for',
375 '=item Arguments: $group_name',
376 '=item Returns: \%list_of_loaderrors_per_module',
379 Returns a hashref containing the actual errors that occured while attempting
380 to load each module in the requirement group.
383 'See L<DBIx::Class/CONTRIBUTORS>.',
385 'You may distribute this code under the same terms as Perl itself',
389 $fn =~ s/\.pm$/\.pod/;
391 open (my $fh, '>', $fn) or croak "Unable to write to $fn: $!";
392 print $fh join ("\n\n", @chunks);