use warnings;
use strict;
-use Carp ();
+use Carp;
# NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G)
# This module is to be loaded by Makefile.PM on a pristine system
};
my $id_shortener = {
+ 'Digest::MD5' => '0',
'Math::BigInt' => '1.80',
'Math::Base36' => '0.07',
};
},
pod => {
title => 'Storage::DBI::deploy()',
- desc => 'Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deployment_statements>',
+ desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
},
},
? (
# when changing this list make sure to adjust xt/optional_deps.t
%$rdbms_pg,
- ($^O ne 'MSWin32' ? ('Sys::SigAction' => '0') : ()),
'DBD::Pg' => '2.009002',
) : ()
},
req => {
%$test_and_dist_json_any,
'ExtUtils::MakeMaker' => '6.64',
- 'Pod::Inherit' => '0.90',
- 'Pod::Tree' => '0',
- }
+ 'Pod::Inherit' => '0.91',
+ },
},
dist_upload => {
};
-our %req_availability_cache;
+
+### Public API
+
+# 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 {
my ($class, $group) = @_;
- Carp::croak "req_list_for() expects a requirement group name"
+ croak "req_list_for() expects a requirement group name"
unless $group;
my $deps = $reqs->{$group}{req}
- or Carp::croak "Requirement group '$group' does not exist";
+ or croak "Requirement group '$group' does not exist";
return { %$deps };
}
+sub req_group_list {
+ return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
+}
-sub die_unless_req_ok_for {
+sub req_errorlist_for {
my ($class, $group) = @_;
- Carp::croak "die_unless_req_ok_for() expects a requirement group name"
+ croak "req_errorlist_for() expects a requirement group name"
unless $group;
- $class->_check_deps($group)->{status}
- or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
+ return $class->_check_deps($group)->{errorlist};
}
sub req_ok_for {
my ($class, $group) = @_;
- Carp::croak "req_ok_for() expects a requirement group name"
+ croak "req_ok_for() expects a requirement group name"
unless $group;
return $class->_check_deps($group)->{status};
sub req_missing_for {
my ($class, $group) = @_;
- Carp::croak "req_missing_for() expects a requirement group name"
+ croak "req_missing_for() expects a requirement group name"
unless $group;
return $class->_check_deps($group)->{missing};
}
-sub req_errorlist_for {
+sub die_unless_req_ok_for {
my ($class, $group) = @_;
- Carp::croak "req_errorlist_for() expects a requirement group name"
+ croak "die_unless_req_ok_for() expects a requirement group name"
unless $group;
- return $class->_check_deps($group)->{errorlist};
+ $class->_check_deps($group)->{status}
+ or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
}
+
+
+### Private API
+
+our %req_availability_cache;
sub _check_deps {
my ($class, $group) = @_;
};
}
-sub req_group_list {
- return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
-}
-
# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
my ($class, $distver, $pod_dir) = @_;
my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
or die "Hrmm? No sqlt dep?";
- my @chunks = (
+
+ my @chunks;
+
+#@@
+#@@ HEADER
+#@@
+ push @chunks, (
<<"EOC",
#########################################################################
##################### A U T O G E N E R A T E D ########################
EOC
'=head1 NAME',
"$class - Optional module dependency specifications (for module authors)",
+ );
+
+
+#@@
+#@@ SYNOPSIS HEADING
+#@@
+ push @chunks, (
'=head1 SYNOPSIS',
<<"EOS",
Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
Note that there are some caveats regarding C<configure_requires()>, more info
can be found at L<Module::Install/configure_requires>
EOS
+ );
+
+
+#@@
+#@@ DESCRIPTION HEADING
+#@@
+ push @chunks, (
'=head1 DESCRIPTION',
<<'EOD',
Some of the less-frequently used features of L<DBIx::Class> have external
of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
authors alike.
EOD
+ );
+
+
+#@@
+#@@ REQUIREMENT GROUPLIST HEADING
+#@@
+ push @chunks, (
'=head1 CURRENT REQUIREMENT GROUPS',
<<'EOD',
Dependencies are organized in C<groups> and each group can list one or more
);
}
+
+#@@
+#@@ API DOCUMENTATION HEADING
+#@@
push @chunks, (
'=head1 METHODS',
'=head2 req_group_list',
Returns a hashref containing the actual errors that occurred while attempting
to load each module in the requirement group.
EOD
- '=head1 AUTHOR',
- 'See L<DBIx::Class/CONTRIBUTORS>.',
- '=head1 LICENSE',
- 'You may distribute this code under the same terms as Perl itself',
);
- open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
- print $fh join ("\n\n", @chunks);
- print $fh "\n";
- close ($fh);
+
+#@@
+#@@ FOOTER
+#@@
+ push @chunks, (
+ '=head1 FURTHER QUESTIONS?',
+ 'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
+ '=head1 COPYRIGHT AND LICENSE',
+ <<'EOL',
+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
+
+ );
+
+
+ eval {
+ open (my $fh, '>', $podfn) or die;
+ print $fh join ("\n\n", @chunks) or die;
+ print $fh "\n" or die;
+ close ($fh) or die;
+ } or croak( "Unable to write $podfn: " . ( $! || $@ || 'unknown error') );
}
1;
projects / dbsrgits/DBIx-Class.git / blobdiff