# POD is generated automatically by calling _gen_pod from the
# Makefile.PL in $AUTHOR mode
+my $json_any = {
+ 'JSON::Any' => '1.22',
+};
+
my $moose_basic = {
- 'Moose' => '0.98',
- 'MooseX::Types' => '0.21',
+ 'Moose' => '0.98',
+ 'MooseX::Types' => '0.21',
+};
+
+my $replicated = {
+ %$moose_basic,
+ 'Hash::Merge' => '0.12',
};
my $admin_basic = {
%$moose_basic,
- 'MooseX::Types::Path::Class' => '0.05',
- 'MooseX::Types::JSON' => '0.02',
- 'JSON::Any' => '1.22',
- 'namespace::autoclean' => '0.09',
+ %$json_any,
+ 'MooseX::Types::Path::Class' => '0.05',
+ 'MooseX::Types::JSON' => '0.02',
+ 'namespace::autoclean' => '0.09',
+};
+
+my $datetime_basic = {
+ 'DateTime' => '0.55',
+ 'DateTime::Format::Strptime' => '1.2',
};
my $reqs = {
},
replicated => {
- req => {
- %$moose_basic,
- 'namespace::clean' => '0.11',
- 'Hash::Merge' => '0.12',
- },
+ req => $replicated,
pod => {
title => 'Storage::Replicated',
desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
},
},
+ test_replicated => {
+ req => {
+ %$replicated,
+ 'Test::Moose' => '0',
+ },
+ },
+
+
admin => {
req => {
%$admin_basic,
deploy => {
req => {
- 'SQL::Translator' => '0.11002',
+ 'SQL::Translator' => '0.11006',
},
pod => {
title => 'Storage::DBI::deploy()',
},
},
-
test_pod => {
req => {
'Test::Pod' => '1.41',
test_notabs => {
req => {
- #'Test::NoTabs' => '0.9',
+ 'Test::NoTabs' => '0.9',
},
},
test_eol => {
req => {
- #'Test::EOL' => '0.6',
+ 'Test::EOL' => '0.6',
},
},
- test_cycle => {
+ test_prettydebug => {
+ req => $json_any,
+ },
+
+ test_leaks => {
req => {
'Test::Memory::Cycle' => '0',
'Devel::Cycle' => '1.10',
},
},
- test_dtrelated => {
+ test_dt => {
+ req => $datetime_basic,
+ },
+
+ test_dt_sqlite => {
req => {
+ %$datetime_basic,
# t/36datetime.t
# t/60core.t
'DateTime::Format::SQLite' => '0',
+ },
+ },
- # t/96_is_deteministic_value.t
- 'DateTime::Format::Strptime'=> '0',
-
+ test_dt_mysql => {
+ req => {
+ %$datetime_basic,
# t/inflate/datetime_mysql.t
# (doesn't need Mysql itself)
- 'DateTime::Format::MySQL' => '0',
+ 'DateTime::Format::MySQL' => '0',
+ },
+ },
+ test_dt_pg => {
+ req => {
+ %$datetime_basic,
# t/inflate/datetime_pg.t
# (doesn't need PG itself)
- 'DateTime::Format::Pg' => '0',
+ 'DateTime::Format::Pg' => '0.16004',
},
},
- cdbicompat => {
+ test_cdbicompat => {
req => {
'DBIx::ContextualFetch' => '0',
'Class::DBI::Plugin::DeepAbstractSearch' => '0',
},
},
- rdbms_pg => {
+ test_rdbms_pg => {
req => {
$ENV{DBICTEST_PG_DSN}
? (
},
},
- rdbms_mysql => {
+ test_rdbms_mssql_odbc => {
+ req => {
+ $ENV{DBICTEST_MSSQL_ODBC_DSN}
+ ? (
+ 'DBD::ODBC' => '0',
+ ) : ()
+ },
+ },
+
+ test_rdbms_mssql_sybase => {
+ req => {
+ $ENV{DBICTEST_MSSQL_DSN}
+ ? (
+ 'DBD::Sybase' => '0',
+ ) : ()
+ },
+ },
+
+ test_rdbms_mysql => {
req => {
$ENV{DBICTEST_MYSQL_DSN}
? (
- 'DBD::mysql' => '0',
+ 'DBD::mysql' => '0',
) : ()
},
},
- rdbms_oracle => {
+ test_rdbms_oracle => {
req => {
$ENV{DBICTEST_ORA_DSN}
? (
'DateTime::Format::Oracle' => '0',
+ 'DBD::Oracle' => '1.24',
) : ()
},
},
- rdbms_ase => {
+ test_rdbms_ase => {
req => {
$ENV{DBICTEST_SYBASE_DSN}
? (
},
},
- rdbms_asa => {
+ test_rdbms_db2 => {
req => {
- (scalar grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/})
+ $ENV{DBICTEST_DB2_DSN}
? (
- 'DateTime::Format::Strptime' => 0,
+ 'DBD::DB2' => 0,
) : ()
},
},
- rdbms_db2 => {
+ test_memcached => {
req => {
- $ENV{DBICTEST_DB2_DSN}
+ $ENV{DBICTEST_MEMCACHED}
? (
- 'DBD::DB2' => 0,
+ 'Cache::Memcached' => 0,
) : ()
},
},
};
-sub _all_optional_requirements {
- return { map { %{ $reqs->{$_}{req} || {} } } (keys %$reqs) };
-}
-
sub req_list_for {
my ($class, $group) = @_;
croak "req_ok_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{status};
+ return $class->_check_deps($group)->{status};
}
sub req_missing_for {
croak "req_missing_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{missing};
+ return $class->_check_deps($group)->{missing};
}
sub req_errorlist_for {
croak "req_errorlist_for() expects a requirement group name"
unless $group;
- $class->_check_deps ($group) unless $req_availability_cache{$group};
-
- return $req_availability_cache{$group}{errorlist};
+ return $class->_check_deps($group)->{errorlist};
}
sub _check_deps {
my ($class, $group) = @_;
- my $deps = $class->req_list_for ($group);
+ return $req_availability_cache{$group} ||= do {
+
+ my $deps = $class->req_list_for ($group);
+
+ my %errors;
+ for my $mod (keys %$deps) {
+ my $req_line = "require $mod;";
+ if (my $ver = $deps->{$mod}) {
+ $req_line .= "$mod->VERSION($ver);";
+ }
+
+ eval $req_line;
+
+ $errors{$mod} = $@ if $@;
+ }
+
+ my $res;
- my %errors;
- for my $mod (keys %$deps) {
- if (my $ver = $deps->{$mod}) {
- eval "use $mod $ver ()";
+ 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 {
- eval "require $mod";
+ $res = {
+ status => 1,
+ errorlist => {},
+ missing => '',
+ };
}
- $errors{$mod} = $@ if $@;
- }
+ $res;
+ };
+}
- if (keys %errors) {
- my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
- $missing .= " (see $class for details)" if $reqs->{$group}{pod};
- $req_availability_cache{$group} = {
- status => 0,
- errorlist => { %errors },
- missing => $missing,
- };
- }
- else {
- $req_availability_cache{$group} = {
- status => 1,
- errorlist => {},
- missing => '',
- };
- }
+sub req_group_list {
+ return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
}
-# This is to be called by the author onbly (automatically in Makefile.PL)
+# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
- my $class = shift;
+ my ($class, $distver) = @_;
+
my $modfn = __PACKAGE__ . '.pm';
$modfn =~ s/\:\:/\//g;
- require DBIx::Class;
- my $distver = DBIx::Class->VERSION;
+ my $podfn = __FILE__;
+ $podfn =~ s/\.pm$/\.pod/;
+
+ $distver ||=
+ eval { require DBIx::Class; DBIx::Class->VERSION; }
+ ||
+ die
+"\n\n---------------------------------------------------------------------\n" .
+'Unable to load core DBIx::Class module to determine current version, '.
+'possibly due to missing dependencies. Author-mode autodocumentation ' .
+"halted\n\n" . $@ .
+"\n\n---------------------------------------------------------------------\n"
+ ;
+
+ my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
+ or die "Hrmm? No sqlt dep?";
my @chunks = (
- <<"EOC",
+ <<'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)",
- '=head1 SYNOPSIS (EXPERIMENTAL)',
- <<EOS,
-B<THE USAGE SHOWN HERE IS EXPERIMENTAL>
-
+ '=head1 SYNOPSIS',
+ <<"EOS",
Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
...
<<'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
+The group name can be used in the
EOD
);
push @chunks, (
'=head1 METHODS',
+ '=head2 req_group_list',
+ '=over',
+ '=item Arguments: none',
+ '=item Returns: \%list_of_requirement_groups',
+ '=back',
+ <<'EOD',
+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 Returns: \%list_of_module_version_pairs',
'=back',
- <<EOD,
+ <<'EOD',
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|/SYNOPSIS (EXPERIMENTAL)> for a real-world
+DBIx::Class. See the L</SYNOPSIS> for a real-world
example.
EOD
'=item Arguments: $group_name',
'=item Returns: 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',
+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 Returns: $error_message_string',
'=back',
- <<EOD,
+ <<"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.
-For example if the requirements for C<replicated> are not available, the
-returned string would look like:
+For example if some of the requirements for C<deploy> are not available,
+the returned string could look like:
- Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see $class for details)
+ SQL::Translator >= $sqltver (see $class for details)
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user.
'You may distribute this code under the same terms as Perl itself',
);
- my $fn = __FILE__;
- $fn =~ s/\.pm$/\.pod/;
-
- open (my $fh, '>', $fn) or croak "Unable to write to $fn: $!";
+ open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!";
print $fh join ("\n\n", @chunks);
close ($fh);
}
projects / dbsrgits/DBIx-Class.git / blobdiff