};
my $id_shortener = {
- 'Digest::MD5' => '0',
'Math::BigInt' => '1.80',
'Math::Base36' => '0.07',
};
'DBD::ODBC' => '0',
};
-my $reqs = {
+my $dbic_reqs = {
replicated => {
req => $replicated,
pod => {
},
},
-# the order does matter because the rdbms support group might require
-# a different version that the test group
test_rdbms_pg => {
req => {
$ENV{DBICTEST_PG_DSN}
? (
+ # the order does matter because the rdbms support group might require
+ # a different version that the test group
+ #
# when changing this list make sure to adjust xt/optional_deps.t
%$rdbms_pg,
'DBD::Pg' => '2.009002',
};
-our %req_availability_cache;
-sub req_list_for {
- my ($class, $group) = @_;
- croak "req_list_for() expects a requirement group name"
- unless $group;
+### Public API
- my $deps = $reqs->{$group}{req}
- or croak "Requirement group '$group' does not exist";
+# OO for (mistakenly considered) ease of extensibility, not due to any need to
+# carry state of any sort. This API is currently used outside, so leave as-is.
+# FIXME - make sure to not propagate this further if module is extracted as a
+# standalone library - keep the stupidity to a DBIC-secific shim!
+#
+sub req_list_for {
+ shift->_groups_to_reqs(@_)->{modreqs};
+}
+
+sub req_group_list {
+ +{ map
+ { $_ => $_[0]->_groups_to_reqs($_) }
+ keys %$dbic_reqs
+ }
+}
- return { %$deps };
+sub req_errorlist_for {
+ my $self = shift;
+ $self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} );
}
+sub req_ok_for {
+ my $self = shift;
+ $self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} )
+ ? 0
+ : 1
+ ;
+}
-sub die_unless_req_ok_for {
- my ($class, $group) = @_;
+sub req_missing_for {
+ my $self = shift;
- croak "die_unless_req_ok_for() expects a requirement group name"
- unless $group;
+ my $reqs = $self->_groups_to_reqs(@_);
+ my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs}) or return '';
- $class->_check_deps($group)->{status}
- or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
+ join ' ',
+ (map { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ } sort keys %$modreq_errors),
+ ( $reqs->{modreqs_fully_documented} ? "(see @{[ ref $self || $self ]} documentation for details)" : () ),
+ ;
}
-sub req_ok_for {
- my ($class, $group) = @_;
+sub die_unless_req_ok_for {
+ if (my $err = shift->req_missing_for(@_) ) {
+ die "Required modules missing, unable to continue: $err\n";
+ }
+}
- croak "req_ok_for() expects a requirement group name"
- unless $group;
- return $class->_check_deps($group)->{status};
-}
-sub req_missing_for {
- my ($class, $group) = @_;
+### Private OO API
+our %req_unavailability_cache;
- croak "req_missing_for() expects a requirement group name"
- unless $group;
+# this method is just a lister/metadata checker - it does not try to load anything
+sub _groups_to_reqs {
+ my ($self, $groups) = @_;
- return $class->_check_deps($group)->{missing};
-}
+ $groups = [ $groups || () ]
+ unless ref $groups eq 'ARRAY';
-sub req_errorlist_for {
- my ($class, $group) = @_;
+ croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names"
+ unless @$groups;
- croak "req_errorlist_for() expects a requirement group name"
- unless $group;
+ my $ret = {
+ modreqs => {},
+ modreqs_fully_documented => 1,
+ };
- return $class->_check_deps($group)->{errorlist};
-}
-sub _check_deps {
- my ($class, $group) = @_;
+ for my $group ( @$groups ) {
- return $req_availability_cache{$group} ||= do {
+ $group =~ /\A [A-Za-z][0-9A-Z_a-z]* \z/x
+ or croak "Invalid requirement group name '$group': only ascii alphanumerics and _ are allowed";
- my $deps = $class->req_list_for ($group);
+ my $group_reqs = ($dbic_reqs->{$group}||{})->{req}
+ or croak "Requirement group '$group' is not defined";
- my %errors;
- for my $mod (keys %$deps) {
- my $req_line = "require $mod;";
- if (my $ver = $deps->{$mod}) {
- $req_line .= "$mod->VERSION($ver);";
- }
+ # sanity-check
+ for (keys %$group_reqs) {
- eval $req_line;
+ $_ =~ /\A [A-Z_a-z][0-9A-Z_a-z]* (?:::[0-9A-Z_a-z]+)* \z /x
+ or croak "Requirement '$_' in group '$group' is not a valid module name";
- $errors{$mod} = $@ if $@;
+ # !!!DO NOT CHANGE!!!
+ # remember - version.pm may not be available on the system
+ croak "Requirement '$_' in group '$group' specifies an invalid version '$group_reqs->{$_}' (only plain non-underscored floating point decimals are supported)"
+ if ( ($group_reqs->{$_}||0) !~ / \A [0-9]+ (?: \. [0-9]+ )? \z /x );
}
- my $res;
+ # assemble into the final ret
+ for (keys %$group_reqs) {
- if (keys %errors) {
- my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
- $missing .= " (see $class for details)" if $reqs->{$group}{pod};
- $res = {
- status => 0,
- errorlist => \%errors,
- missing => $missing,
- };
- }
- else {
- $res = {
- status => 1,
- errorlist => {},
- missing => '',
- };
+ $ret->{modreqs}{$_} = $group_reqs->{$_}||0 if (
+
+ ! exists $ret->{modreqs}{$_}
+ or
+ # we sanitized the version to be numeric above - we can just -gt it
+ ($group_reqs->{$_}||0) > $ret->{modreqs}{$_}
+
+ );
}
- $res;
- };
+ $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod};
+ }
+
+ return $ret;
}
-sub req_group_list {
- return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
+
+# this method tries to load specified modreqs and returns a hashref of
+# module/loaderror pairs for anything that failed
+sub _errorlist_for_modreqs {
+ # args supposedly already went through _groups_to_reqs and are therefore sanitized
+ # safe to eval at will
+ my ($self, $reqs) = @_;
+
+ my $ret;
+
+ for my $m ( keys %$reqs ) {
+ my $v = $reqs->{$m};
+
+ if (! exists $req_unavailability_cache{$m}{$v} ) {
+ local $@;
+ eval( "require $m;" . ( $v ? "$m->VERSION(q($v))" : '' ) );
+ $req_unavailability_cache{$m}{$v} = $@;
+ }
+
+ $ret->{$m} = $req_unavailability_cache{$m}{$v}
+ if $req_unavailability_cache{$m}{$v};
+ }
+
+ $ret;
}
+
# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
my ($class, $distver, $pod_dir) = @_;
File::Path::mkpath([$dir]);
- my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
+ my $sqltver = $class->req_list_for('deploy')->{'SQL::Translator'}
or die "Hrmm? No sqlt dep?";
- my @chunks = (
- <<"EOC",
+
+ my @chunks;
+
+#@@
+#@@ HEADER
+#@@
+ push @chunks, <<"EOC";
#########################################################################
##################### A U T O G E N E R A T E D ########################
#########################################################################
# will be lost. If you need to change the generated text edit _gen_pod()
# at the end of $modfn
#
+
+=head1 NAME
+
+$class - Optional module dependency specifications (for module authors)
EOC
- '=head1 NAME',
- "$class - Optional module dependency specifications (for module authors)",
- '=head1 SYNOPSIS',
- <<"EOS",
-Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
+
+
+#@@
+#@@ SYNOPSIS HEADING
+#@@
+ push @chunks, <<"EOC";
+=head1 SYNOPSIS
+
+Somewhere in your build-file (e.g. L<ExtUtils::MakeMaker>'s F<Makefile.PL>):
...
- configure_requires 'DBIx::Class' => '$distver';
+ \$EUMM_ARGS{CONFIGURE_REQUIRES} = {
+ \%{ \$EUMM_ARGS{CONFIGURE_REQUIRES} || {} },
+ 'DBIx::Class' => '$distver',
+ };
- require $class;
+ ...
- my \$deploy_deps = $class->req_list_for('deploy');
+ my %DBIC_DEPLOY_DEPS = %{ eval {
+ require $class;
+ $class->req_list_for('deploy');
+ } || {} };
- for (keys %\$deploy_deps) {
- requires \$_ => \$deploy_deps->{\$_};
- }
+ \$EUMM_ARGS{PREREQ_PM} = {
+ \%DBIC_DEPLOY_DEPS,
+ \%{ \$EUMM_ARGS{PREREQ_PM} || {} },
+ };
...
-Note that there are some caveats regarding C<configure_requires()>, more info
-can be found at L<Module::Install/configure_requires>
-EOS
- '=head1 DESCRIPTION',
- <<'EOD',
+ ExtUtils::MakeMaker::WriteMakefile(\%EUMM_ARGS);
+
+B<Note>: The C<eval> protection within the example is due to support for
+requirements during L<the C<configure> build phase|CPAN::Meta::Spec/Phases>
+not being available on a sufficient portion of production installations of
+Perl. Robust support for such dependency requirements is available in the
+L<CPAN> installer only since version C<1.94_56> first made available for
+production with perl version C<5.12>. It is the belief of the current
+maintainer that support for requirements during the C<configure> build phase
+will not be sufficiently ubiquitous until the B<year 2020> at the earliest,
+hence the extra care demonstrated above. It should also be noted that some
+3rd party installers (e.g. L<cpanminus|App::cpanminus>) do the right thing
+with configure requirements independent from the versions of perl and CPAN
+available.
+EOC
+
+
+#@@
+#@@ DESCRIPTION HEADING
+#@@
+ push @chunks, <<'EOC';
+=head1 DESCRIPTION
+
Some of the less-frequently used features of L<DBIx::Class> have external
module dependencies on their own. In order not to burden the average user
-with modules he will never use, these optional dependencies are not included
+with modules they will never use, these optional dependencies are not included
in the base Makefile.PL. Instead an exception with a descriptive message is
-thrown when a specific feature is missing one or several modules required for
-its operation. This module is the central holding place for the current list
+thrown when a specific feature can't find one or several modules required for
+its operation. This module is the central holding place for the current list
of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
authors alike.
-EOD
- '=head1 CURRENT REQUIREMENT GROUPS',
- <<'EOD',
-Dependencies are organized in C<groups> and each group can list one or more
-required modules, with an optional minimum version (or 0 for any version).
-The group name can be used in the
-EOD
- );
-
- for my $group (sort keys %$reqs) {
- my $p = $reqs->{$group}{pod}
+
+Dependencies are organized in L<groups|/CURRENT REQUIREMENT GROUPS> where each
+group can list one or more required modules, with an optional minimum version
+(or 0 for any version). Each group name (or a combination thereof) can be used
+in the L<public methods|/METHODS> as described below.
+EOC
+
+
+#@@
+#@@ REQUIREMENT GROUPLIST HEADING
+#@@
+ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS';
+
+ for my $group (sort keys %$dbic_reqs) {
+ my $p = $dbic_reqs->{$group}{pod}
or next;
- my $modlist = $reqs->{$group}{req}
+ my $modlist = $dbic_reqs->{$group}{req}
or next;
next unless keys %$modlist;
);
}
- push @chunks, (
- '=head1 METHODS',
- '=head2 req_group_list',
- '=over',
- '=item Arguments: none',
- '=item Return Value: \%list_of_requirement_groups',
- '=back',
- <<'EOD',
+
+#@@
+#@@ API DOCUMENTATION HEADING
+#@@
+ push @chunks, <<'EOC';
+
+=head1 METHODS
+
+=head2 req_group_list
+
+=over
+
+=item Arguments: none
+
+=item Return Value: \%list_of_requirement_groups
+
+=back
+
This method should be used by DBIx::Class packagers, to get a hashref of all
-dependencies keyed by dependency group. Each key (group name) can be supplied
-to one of the group-specific methods below.
-EOD
-
- '=head2 req_list_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Return Value: \%list_of_module_version_pairs',
- '=back',
- <<'EOD',
+dependencies B<keyed> by dependency group. Each key (group name), or a combination
+thereof (as an arrayref) can be supplied to the methods below.
+The B<values> of the returned hash are currently a set of options B<without a
+well defined structure>. If you have use for any of the contents - contact the
+maintainers, instead of treating this as public (left alone stable) API.
+
+=head2 req_list_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: \%set_of_module_version_pairs
+
+=back
+
This method should be used by DBIx::Class extension authors, to determine the
-version of modules a specific feature requires in the B<current> version of
-DBIx::Class. See the L</SYNOPSIS> for a real-world
-example.
-EOD
-
- '=head2 req_ok_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Return Value: 1|0',
- '=back',
- <<'EOD',
+version of modules a specific set of features requires for this version of
+DBIx::Class. See the L</SYNOPSIS> for a real-world example.
+
+=head2 req_ok_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: 1|0
+
+=back
+
Returns true or false depending on whether all modules required by
-C<$group_name> are present on the system and loadable.
-EOD
-
- '=head2 req_missing_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Return Value: $error_message_string',
- '=back',
- <<"EOD",
-Returns a single line string suitable for inclusion in larger error messages.
-This method would normally be used by DBIx::Class core-module author, to
-indicate to the user that he needs to install specific modules before he will
-be able to use a specific feature.
+the group(s) are present on the system and loadable.
+
+=head2 req_missing_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: $error_message_string
+
+=back
+
+Returns a single-line string suitable for inclusion in larger error messages.
+This method would normally be used by DBIx::Class core-modules, to indicate to
+the user that they need to install specific modules before being able to use a
+specific feature set.
For example if some of the requirements for C<deploy> are not available,
the returned string could look like:
+EOC
- SQL::Translator >= $sqltver (see $class for details)
+ push @chunks, qq{ "SQL::Translator~>=$sqltver" (see $class documentation for details)};
+ push @chunks, <<'EOC';
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user.
-EOD
-
- '=head2 die_unless_req_ok_for',
- '=over',
- '=item Arguments: $group_name',
- '=back',
- <<'EOD',
-Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
+
+=head2 die_unless_req_ok_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=back
+
+Checks if L</req_ok_for> passes for the supplied group(s), and
in case of failure throws an exception including the information
from L</req_missing_for>.
-EOD
-
- '=head2 req_errorlist_for',
- '=over',
- '=item Arguments: $group_name',
- '=item Return Value: \%list_of_loaderrors_per_module',
- '=back',
- <<'EOD',
+
+=head2 req_errorlist_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: \%set_of_loaderrors_per_module
+
+=back
+
Returns a hashref containing the actual errors that occurred while attempting
-to load each module in the requirement group.
-EOD
- '=head1 FURTHER QUESTIONS?',
- 'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
- '=head1 COPYRIGHT AND LICENSE',
- <<'EOL',
+to load each module in the requirement group(s).
+EOC
+
+
+#@@
+#@@ FOOTER
+#@@
+ push @chunks, <<'EOC';
+=head1 FURTHER QUESTIONS?
+
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
+
+=head1 COPYRIGHT AND LICENSE
+
This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
-EOL
-
- );
+EOC
eval {
open (my $fh, '>', $podfn) or die;