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',
30 #'Module::Install::Pod::Inherit' => '0.01',
36 'namespace::clean' => '0.11',
37 'Hash::Merge' => '0.11',
40 title => 'Storage::Replicated',
41 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
50 title => 'DBIx::Class::Admin',
51 desc => 'Modules required for the DBIx::Class administrative library',
59 'Getopt::Long::Descriptive' => '0.081',
60 'Text::CSV' => '1.16',
64 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
70 'SQL::Translator' => '0.11002',
73 title => 'Storage::DBI::deploy()',
74 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>',
80 'Test::Pod' => '1.26',
81 'Test::Pod::Coverage' => '1.08',
82 'Pod::Coverage' => '0.20',
83 #'Test::NoTabs' => '0.9',
84 #'Test::EOL' => '0.6',
91 'Test::Memory::Cycle' => '0',
92 'Devel::Cycle' => '1.10',
96 'DateTime::Format::SQLite' => '0',
98 # t/96_is_deteministic_value.t
99 'DateTime::Format::Strptime'=> '0',
105 'DBIx::ContextualFetch' => '0',
106 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
107 'Class::Trigger' => '0',
108 'Time::Piece::MySQL' => '0',
110 'Date::Simple' => '3.03',
116 $ENV{DBICTEST_PG_DSN}
118 'Sys::SigAction' => '0',
119 'DBD::Pg' => '2.009002',
120 'DateTime::Format::Pg' => '0',
127 $ENV{DBICTEST_MYSQL_DSN}
129 'DateTime::Format::MySQL' => '0',
137 $ENV{DBICTEST_ORA_DSN}
139 'DateTime::Format::Oracle' => '0',
146 $ENV{DBICTEST_SYBASE_DSN}
148 'DateTime::Format::Sybase' => 0,
155 grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/}
157 'DateTime::Format::Strptime' => 0,
164 sub _all_optional_requirements {
165 return { map { %{ $reqs->{$_}{req} || {} } } (keys %$reqs) };
169 my ($class, $group) = @_;
171 croak "req_list_for() expects a requirement group name"
174 my $deps = $reqs->{$group}{req}
175 or croak "Requirement group '$group' does not exist";
181 our %req_availability_cache;
183 my ($class, $group) = @_;
185 croak "req_ok_for() expects a requirement group name"
188 $class->_check_deps ($group) unless $req_availability_cache{$group};
190 return $req_availability_cache{$group}{status};
193 sub req_missing_for {
194 my ($class, $group) = @_;
196 croak "req_missing_for() expects a requirement group name"
199 $class->_check_deps ($group) unless $req_availability_cache{$group};
201 return $req_availability_cache{$group}{missing};
204 sub req_errorlist_for {
205 my ($class, $group) = @_;
207 croak "req_errorlist_for() expects a requirement group name"
210 $class->_check_deps ($group) unless $req_availability_cache{$group};
212 return $req_availability_cache{$group}{errorlist};
216 my ($class, $group) = @_;
218 my $deps = $class->req_list_for ($group);
221 for my $mod (keys %$deps) {
222 if (my $ver = $deps->{$mod}) {
223 eval "use $mod $ver ()";
229 $errors{$mod} = $@ if $@;
233 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
234 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
235 $req_availability_cache{$group} = {
237 errorlist => { %errors },
242 $req_availability_cache{$group} = {
252 my $modfn = __PACKAGE__ . '.pm';
253 $modfn =~ s/\:\:/\//g;
257 #########################################################################
258 ##################### A U T O G E N E R A T E D ########################
259 #########################################################################
261 # The contents of this POD file are auto-generated. Any changes you make
262 # will be lost. If you need to change the generated text edit _gen_pod()
263 # at the end of $modfn
267 "$class - Optional module dependency specifications",
268 '=head1 DESCRIPTION',
270 Some of the less-frequently used features of L<DBIx::Class> have external
271 module dependencies on their own. In order not to burden the average user
272 with modules he will never use, these optional dependencies are not included
273 in the base Makefile.PL. Instead an exception with a descriptive message is
274 thrown when a specific feature is missing one or several modules required for
275 its operation. This module is the central holding place for the current list
276 of such dependencies.
278 '=head1 CURRENT REQUIREMENT GROUPS',
280 Dependencies are organized in C<groups> and each group can list one or more
281 required modules, with an optional minimum version (or 0 for any version).
282 The group name can be used in the
286 for my $group (sort keys %$reqs) {
287 my $p = $reqs->{$group}{pod}
290 my $modlist = $reqs->{$group}{req}
293 next unless keys %$modlist;
296 "=head2 $p->{title}",
299 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
301 "Requirement group: B<$group>",
307 '=head2 req_list_for',
309 '=item Arguments: $group_name',
310 '=item Returns: \%list_of_module_version_pairs',
313 This method should be used by DBIx::Class extension authors, to determine the
314 version of modules which a specific feature requires in the current version of
315 DBIx::Class. For example if you write a module/extension that requires
316 DBIx::Class and also requires the availability of
317 L<DBIx::Class::Storage::DBI/deploy>, you can do the following in your
318 C<Makefile.PL> or C<Build.PL>
321 my \$dep_list = $class->req_list_for ('deploy');
323 Which will give you a list of module/version pairs necessary for the particular
324 feature to function with this version of DBIx::Class.
329 '=item Arguments: $group_name',
330 '=item Returns: 1|0',
332 'Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable',
334 '=head2 req_missing_for',
336 '=item Arguments: $group_name',
337 '=item Returns: $error_message_string',
340 Returns a single line string suitable for inclusion in larger error messages.
341 This method would normally be used by DBIx::Class core-module author, to
342 indicate to the user that he needs to install specific modules before he will
343 be able to use a specific feature.
345 For example if the requirements for C<replicated> are not available, the
346 returned string would look like:
348 Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see $class for details)
350 The author is expected to prepend the necessary text to this message before
351 returning the actual error seen by the user.
354 '=head2 req_errorlist_for',
356 '=item Arguments: $group_name',
357 '=item Returns: \%list_of_loaderrors_per_module',
360 Returns a hashref containing the actual errors that occured while attempting
361 to load each module in the requirement group.
364 'See L<DBIx::Class/CONTRIBUTORS>.',
366 'You may distribute this code under the same terms as Perl itself',
370 $fn =~ s/\.pm$/\.pod/;
372 open (my $fh, '>', $fn) or croak "Unable to write to $fn: $!";
373 print $fh join ("\n\n", @chunks);