'MooseX::Types::LoadableClass' => '0.011',
};
-my $replicated = {
- %$moose_basic,
-};
-
-my $admin_basic = {
- %$moose_basic,
- %$min_json_any,
- 'MooseX::Types::Path::Class' => '0.05',
- 'MooseX::Types::JSON' => '0.02',
-};
-
-my $admin_script = {
- %$moose_basic,
- %$admin_basic,
- 'Getopt::Long::Descriptive' => '0.081',
- 'Text::CSV' => '1.16',
-};
-
-my $datetime_basic = {
- 'DateTime' => '0.55',
- 'DateTime::Format::Strptime' => '1.2',
-};
-
-my $id_shortener = {
- 'Math::BigInt' => '1.80',
- 'Math::Base36' => '0.07',
-};
-
-my $rdbms_sqlite = {
- 'DBD::SQLite' => '0',
-};
-my $rdbms_pg = {
- 'DBD::Pg' => '0',
-};
-my $rdbms_mssql_odbc = {
- 'DBD::ODBC' => '0',
-};
-my $rdbms_mssql_sybase = {
- 'DBD::Sybase' => '0',
-};
-my $rdbms_mssql_ado = {
- 'DBD::ADO' => '0',
-};
-my $rdbms_msaccess_odbc = {
- 'DBD::ODBC' => '0',
-};
-my $rdbms_msaccess_ado = {
- 'DBD::ADO' => '0',
-};
-my $rdbms_mysql = {
- 'DBD::mysql' => '0',
-};
-my $rdbms_oracle = {
- 'DBD::Oracle' => '0',
- %$id_shortener,
-};
-my $rdbms_ase = {
- 'DBD::Sybase' => '0',
-};
-my $rdbms_db2 = {
- 'DBD::DB2' => '0',
-};
-my $rdbms_db2_400 = {
- 'DBD::ODBC' => '0',
-};
-my $rdbms_informix = {
- 'DBD::Informix' => '0',
-};
-my $rdbms_sqlanywhere = {
- 'DBD::SQLAnywhere' => '0',
-};
-my $rdbms_sqlanywhere_odbc = {
- 'DBD::ODBC' => '0',
-};
-my $rdbms_firebird = {
- 'DBD::Firebird' => '0',
-};
-my $rdbms_firebird_interbase = {
- 'DBD::InterBase' => '0',
-};
-my $rdbms_firebird_odbc = {
- 'DBD::ODBC' => '0',
-};
-
my $dbic_reqs = {
replicated => {
- req => $replicated,
+ req => $moose_basic,
pod => {
title => 'Storage::Replicated',
desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
},
test_replicated => {
+ include => 'replicated',
req => {
- %$replicated,
- 'Test::Moose' => '0',
+ 'Test::Moose' => '0',
},
},
-
admin => {
req => {
- %$admin_basic,
+ %$moose_basic,
+ %$min_json_any,
+ 'MooseX::Types::Path::Class' => '0.05',
+ 'MooseX::Types::JSON' => '0.02',
},
pod => {
title => 'DBIx::Class::Admin',
},
admin_script => {
+ include => 'admin',
req => {
- %$admin_script,
+ 'Getopt::Long::Descriptive' => '0.081',
+ 'Text::CSV' => '1.16',
},
pod => {
title => 'dbicadmin',
},
id_shortener => {
- req => $id_shortener,
+ req => {
+ 'Math::BigInt' => '1.80',
+ 'Math::Base36' => '0.07',
+ },
},
test_component_accessor => {
},
test_admin_script => {
+ include => 'admin_script',
req => {
- %$admin_script,
%$test_and_dist_json_any,
'JSON' => 0,
'JSON::PP' => 0,
},
test_dt => {
- req => $datetime_basic,
+ req => {
+ 'DateTime' => '0.55',
+ 'DateTime::Format::Strptime' => '1.2',
+ },
},
test_dt_sqlite => {
+ include => 'test_dt',
req => {
- %$datetime_basic,
# t/36datetime.t
# t/60core.t
'DateTime::Format::SQLite' => '0',
},
test_dt_mysql => {
+ include => 'test_dt',
req => {
- %$datetime_basic,
# t/inflate/datetime_mysql.t
# (doesn't need Mysql itself)
'DateTime::Format::MySQL' => '0',
},
test_dt_pg => {
+ include => 'test_dt',
req => {
- %$datetime_basic,
# t/inflate/datetime_pg.t
# (doesn't need PG itself)
'DateTime::Format::Pg' => '0.16004',
},
test_cdbicompat => {
+ include => 'test_dt',
req => {
'Class::DBI::Plugin::DeepAbstractSearch' => '0',
- %$datetime_basic,
'Time::Piece::MySQL' => '0',
'Date::Simple' => '3.03',
},
},
+ rdbms_generic_odbc => {
+ req => {
+ 'DBD::ODBC' => 0,
+ }
+ },
+
+ rdbms_generic_ado => {
+ req => {
+ 'DBD::ADO' => 0,
+ }
+ },
+
# this is just for completeness as SQLite
# is a core dep of DBIC for testing
rdbms_sqlite => {
req => {
- %$rdbms_sqlite,
+ 'DBD::SQLite' => 0,
},
pod => {
title => 'SQLite support',
rdbms_pg => {
req => {
# when changing this list make sure to adjust xt/optional_deps.t
- %$rdbms_pg,
+ 'DBD::Pg' => 0,
},
pod => {
title => 'PostgreSQL support',
},
rdbms_mssql_odbc => {
- req => {
- %$rdbms_mssql_odbc,
- },
+ include => 'rdbms_generic_odbc',
pod => {
title => 'MSSQL support via DBD::ODBC',
desc => 'Modules required to connect to MSSQL via DBD::ODBC',
rdbms_mssql_sybase => {
req => {
- %$rdbms_mssql_sybase,
+ 'DBD::Sybase' => 0,
},
pod => {
title => 'MSSQL support via DBD::Sybase',
},
rdbms_mssql_ado => {
- req => {
- %$rdbms_mssql_ado,
- },
+ include => 'rdbms_generic_ado',
pod => {
title => 'MSSQL support via DBD::ADO (Windows only)',
desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
},
rdbms_msaccess_odbc => {
- req => {
- %$rdbms_msaccess_odbc,
- },
+ include => 'rdbms_generic_odbc',
pod => {
title => 'MS Access support via DBD::ODBC',
desc => 'Modules required to connect to MS Access via DBD::ODBC',
},
rdbms_msaccess_ado => {
- req => {
- %$rdbms_msaccess_ado,
- },
+ include => 'rdbms_generic_ado',
pod => {
title => 'MS Access support via DBD::ADO (Windows only)',
desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
rdbms_mysql => {
req => {
- %$rdbms_mysql,
+ 'DBD::mysql' => 0,
},
pod => {
title => 'MySQL support',
},
rdbms_oracle => {
+ include => 'id_shortener',
req => {
- %$rdbms_oracle,
+ 'DBD::Oracle' => 0,
},
pod => {
title => 'Oracle support',
rdbms_ase => {
req => {
- %$rdbms_ase,
+ 'DBD::Sybase' => 0,
},
pod => {
title => 'Sybase ASE support',
rdbms_db2 => {
req => {
- %$rdbms_db2,
+ 'DBD::DB2' => 0,
},
pod => {
title => 'DB2 support',
},
rdbms_db2_400 => {
- req => {
- %$rdbms_db2_400,
- },
+ include => 'rdbms_generic_odbc',
pod => {
title => 'DB2 on AS/400 support',
desc => 'Modules required to connect to DB2 on AS/400',
rdbms_informix => {
req => {
- %$rdbms_informix,
+ 'DBD::Informix' => 0,
},
pod => {
title => 'Informix support',
rdbms_sqlanywhere => {
req => {
- %$rdbms_sqlanywhere,
+ 'DBD::SQLAnywhere' => 0,
},
pod => {
title => 'SQLAnywhere support',
},
rdbms_sqlanywhere_odbc => {
- req => {
- %$rdbms_sqlanywhere_odbc,
- },
+ include => 'rdbms_generic_odbc',
pod => {
title => 'SQLAnywhere support via DBD::ODBC',
desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
rdbms_firebird => {
req => {
- %$rdbms_firebird,
+ 'DBD::Firebird' => 0,
},
pod => {
title => 'Firebird support',
rdbms_firebird_interbase => {
req => {
- %$rdbms_firebird_interbase,
+ 'DBD::InterBase' => 0,
},
pod => {
title => 'Firebird support via DBD::InterBase',
},
rdbms_firebird_odbc => {
- req => {
- %$rdbms_firebird_odbc,
- },
+ include => 'rdbms_generic_odbc',
pod => {
title => 'Firebird support via DBD::ODBC',
desc => 'Modules required to connect to Firebird via DBD::ODBC',
},
test_rdbms_pg => {
+ include => 'rdbms_pg',
+ env => [
+ DBICTEST_PG_DSN => 1,
+ DBICTEST_PG_USER => 0,
+ DBICTEST_PG_PASS => 0,
+ ],
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',
- ) : ()
+ # 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
+ 'DBD::Pg' => '2.009002', # specific version to test bytea
},
},
test_rdbms_mssql_odbc => {
- req => {
- $ENV{DBICTEST_MSSQL_ODBC_DSN}
- ? (
- %$rdbms_mssql_odbc,
- ) : ()
- },
+ include => 'rdbms_mssql_odbc',
+ env => [
+ DBICTEST_MSSQL_ODBC_DSN => 1,
+ DBICTEST_MSSQL_ODBC_USER => 0,
+ DBICTEST_MSSQL_ODBC_PASS => 0,
+ ],
},
test_rdbms_mssql_ado => {
- req => {
- $ENV{DBICTEST_MSSQL_ADO_DSN}
- ? (
- %$rdbms_mssql_ado,
- ) : ()
- },
+ include => 'rdbms_mssql_ado',
+ env => [
+ DBICTEST_MSSQL_ADO_DSN => 1,
+ DBICTEST_MSSQL_ADO_USER => 0,
+ DBICTEST_MSSQL_ADO_PASS => 0,
+ ],
},
test_rdbms_mssql_sybase => {
- req => {
- $ENV{DBICTEST_MSSQL_DSN}
- ? (
- %$rdbms_mssql_sybase,
- ) : ()
- },
+ include => 'rdbms_mssql_sybase',
+ env => [
+ DBICTEST_MSSQL_DSN => 1,
+ DBICTEST_MSSQL_USER => 0,
+ DBICTEST_MSSQL_PASS => 0,
+ ],
},
test_rdbms_msaccess_odbc => {
+ include => [qw(rdbms_msaccess_odbc test_dt)],
+ env => [
+ DBICTEST_MSACCESS_ODBC_DSN => 1,
+ DBICTEST_MSACCESS_ODBC_USER => 0,
+ DBICTEST_MSACCESS_ODBC_PASS => 0,
+ ],
req => {
- $ENV{DBICTEST_MSACCESS_ODBC_DSN}
- ? (
- %$rdbms_msaccess_odbc,
- %$datetime_basic,
- 'Data::GUID' => '0',
- ) : ()
+ 'Data::GUID' => '0',
},
},
test_rdbms_msaccess_ado => {
+ include => [qw(rdbms_msaccess_ado test_dt)],
+ env => [
+ DBICTEST_MSACCESS_ADO_DSN => 1,
+ DBICTEST_MSACCESS_ADO_USER => 0,
+ DBICTEST_MSACCESS_ADO_PASS => 0,
+ ],
req => {
- $ENV{DBICTEST_MSACCESS_ADO_DSN}
- ? (
- %$rdbms_msaccess_ado,
- %$datetime_basic,
- 'Data::GUID' => 0,
- ) : ()
+ 'Data::GUID' => 0,
},
},
test_rdbms_mysql => {
- req => {
- $ENV{DBICTEST_MYSQL_DSN}
- ? (
- %$rdbms_mysql,
- ) : ()
- },
+ include => 'rdbms_mysql',
+ env => [
+ DBICTEST_MYSQL_DSN => 1,
+ DBICTEST_MYSQL_USER => 0,
+ DBICTEST_MYSQL_PASS => 0,
+ ],
},
test_rdbms_oracle => {
+ include => 'rdbms_oracle',
+ env => [
+ DBICTEST_ORA_DSN => 1,
+ DBICTEST_ORA_USER => 0,
+ DBICTEST_ORA_PASS => 0,
+ ],
req => {
- $ENV{DBICTEST_ORA_DSN}
- ? (
- %$rdbms_oracle,
- 'DateTime::Format::Oracle' => '0',
- 'DBD::Oracle' => '1.24',
- ) : ()
+ 'DateTime::Format::Oracle' => '0',
+ 'DBD::Oracle' => '1.24',
},
},
test_rdbms_ase => {
- req => {
- $ENV{DBICTEST_SYBASE_DSN}
- ? (
- %$rdbms_ase,
- ) : ()
- },
+ include => 'rdbms_ase',
+ env => [
+ DBICTEST_SYBASE_DSN => 1,
+ DBICTEST_SYBASE_USER => 0,
+ DBICTEST_SYBASE_PASS => 0,
+ ],
},
test_rdbms_db2 => {
- req => {
- $ENV{DBICTEST_DB2_DSN}
- ? (
- %$rdbms_db2,
- ) : ()
- },
+ include => 'rdbms_db2',
+ env => [
+ DBICTEST_DB2_DSN => 1,
+ DBICTEST_DB2_USER => 0,
+ DBICTEST_DB2_PASS => 0,
+ ],
},
test_rdbms_db2_400 => {
- req => {
- $ENV{DBICTEST_DB2_400_DSN}
- ? (
- %$rdbms_db2_400,
- ) : ()
- },
+ include => 'rdbms_db2_400',
+ env => [
+ DBICTEST_DB2_400_DSN => 1,
+ DBICTEST_DB2_400_USER => 0,
+ DBICTEST_DB2_400_PASS => 0,
+ ],
},
test_rdbms_informix => {
- req => {
- $ENV{DBICTEST_INFORMIX_DSN}
- ? (
- %$rdbms_informix,
- ) : ()
- },
+ include => 'rdbms_informix',
+ env => [
+ DBICTEST_INFORMIX_DSN => 1,
+ DBICTEST_INFORMIX_USER => 0,
+ DBICTEST_INFORMIX_PASS => 0,
+ ],
},
test_rdbms_sqlanywhere => {
- req => {
- $ENV{DBICTEST_SQLANYWHERE_DSN}
- ? (
- %$rdbms_sqlanywhere,
- ) : ()
- },
+ include => 'rdbms_sqlanywhere',
+ env => [
+ DBICTEST_SQLANYWHERE_DSN => 1,
+ DBICTEST_SQLANYWHERE_USER => 0,
+ DBICTEST_SQLANYWHERE_PASS => 0,
+ ],
},
test_rdbms_sqlanywhere_odbc => {
- req => {
- $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
- ? (
- %$rdbms_sqlanywhere_odbc,
- ) : ()
- },
+ include => 'rdbms_sqlanywhere_odbc',
+ env => [
+ DBICTEST_SQLANYWHERE_ODBC_DSN => 1,
+ DBICTEST_SQLANYWHERE_ODBC_USER => 0,
+ DBICTEST_SQLANYWHERE_ODBC_PASS => 0,
+ ],
},
test_rdbms_firebird => {
- req => {
- $ENV{DBICTEST_FIREBIRD_DSN}
- ? (
- %$rdbms_firebird,
- ) : ()
- },
+ include => 'rdbms_firebird',
+ env => [
+ DBICTEST_FIREBIRD_DSN => 1,
+ DBICTEST_FIREBIRD_USER => 0,
+ DBICTEST_FIREBIRD_PASS => 0,
+ ],
},
test_rdbms_firebird_interbase => {
- req => {
- $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
- ? (
- %$rdbms_firebird_interbase,
- ) : ()
- },
+ include => 'rdbms_firebird_interbase',
+ env => [
+ DBICTEST_FIREBIRD_INTERBASE_DSN => 1,
+ DBICTEST_FIREBIRD_INTERBASE_USER => 0,
+ DBICTEST_FIREBIRD_INTERBASE_PASS => 0,
+ ],
},
test_rdbms_firebird_odbc => {
- req => {
- $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
- ? (
- %$rdbms_firebird_odbc,
- ) : ()
- },
+ include => 'rdbms_firebird_odbc',
+ env => [
+ DBICTEST_FIREBIRD_ODBC_DSN => 1,
+ DBICTEST_FIREBIRD_ODBC_USER => 0,
+ DBICTEST_FIREBIRD_ODBC_PASS => 0,
+ ],
},
test_memcached => {
+ env => [
+ DBICTEST_MEMCACHED => 1,
+ ],
req => {
- $ENV{DBICTEST_MEMCACHED}
- ? (
- 'Cache::Memcached' => 0,
- ) : ()
+ 'Cache::Memcached' => 0,
},
},
'CPAN::Uploader' => '0.103001',
},
},
-
};
# standalone library - keep the stupidity to a DBIC-secific shim!
#
sub req_list_for {
+ shift->_groups_to_reqs(@_)->{effective_modreqs};
+}
+
+sub modreq_list_for {
shift->_groups_to_reqs(@_)->{modreqs};
}
}
}
-sub req_errorlist_for {
+sub req_errorlist_for { shift->modreq_errorlist_for(@_) } # deprecated
+sub modreq_errorlist_for {
my $self = shift;
$self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} );
}
sub req_ok_for {
+ shift->req_missing_for(@_) ? 0 : 1;
+}
+
+sub req_missing_for {
my $self = shift;
- $self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} )
- ? 0
- : 1
+
+ my $reqs = $self->_groups_to_reqs(@_);
+ my $mods_missing = $self->modreq_missing_for(@_);
+
+ return '' if
+ ! $mods_missing
+ and
+ ! $reqs->{missing_envvars}
;
+
+ my @res = $mods_missing || ();
+
+ push @res, 'the following group(s) of environment variables: ' . join ' and ', map
+ { __envvar_group_desc($_) }
+ @{$reqs->{missing_envvars}}
+ if $reqs->{missing_envvars};
+
+ return (
+ ( join ' as well as ', @res )
+ .
+ ( $reqs->{modreqs_fully_documented} ? " (see @{[ ref $self || $self ]} documentation for details)" : '' ),
+ );
}
-sub req_missing_for {
+sub modreq_missing_for {
my $self = shift;
my $reqs = $self->_groups_to_reqs(@_);
- my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs}) or return '';
+ my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs})
+ or return '';
- join ' ',
- (map { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ } sort keys %$modreq_errors),
- ( $reqs->{modreqs_fully_documented} ? "(see @{[ ref $self || $self ]} documentation for details)" : () ),
+ join ' ', map
+ { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ }
+ sort { lc($a) cmp lc($b) } keys %$modreq_errors
;
}
sub die_unless_req_ok_for {
if (my $err = shift->req_missing_for(@_) ) {
- die "Required modules missing, unable to continue: $err\n";
+ die "Unable to continue due to missing requirements: $err\n";
}
}
+### Private functions
+
+# potentially shorten group desc
+sub __envvar_group_desc {
+ my @envs = @{$_[0]};
+
+ my (@res, $last_prefix);
+ while (my $ev = shift @envs) {
+ my ($pref, $sep, $suff) = split / ([\_\-]) (?= [^\_\-]+ \z )/x, $ev;
+
+ if ( defined $sep and ($last_prefix||'') eq $pref ) {
+ push @res, "...${sep}${suff}"
+ }
+ else {
+ push @res, $ev;
+ }
+
+ $last_prefix = $pref if $sep;
+ }
+
+ join '/', @res;
+}
+
+
+
### Private OO API
our %req_unavailability_cache;
-# this method is just a lister/metadata checker - it does not try to load anything
+# this method is just a lister and envvar/metadata checker - it does not try to load anything
+my $processed_groups = {};
sub _groups_to_reqs {
my ($self, $groups) = @_;
modreqs_fully_documented => 1,
};
-
- for my $group ( @$groups ) {
+ for my $group ( grep { ! $processed_groups->{$_} } @$groups ) {
$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 $group_reqs = ($dbic_reqs->{$group}||{})->{req}
- or croak "Requirement group '$group' is not defined";
+ croak "Requirement group '$group' is not defined" unless defined $dbic_reqs->{$group};
+
+ my $group_reqs = $dbic_reqs->{$group}{req};
# sanity-check
for (keys %$group_reqs) {
if ( ($group_reqs->{$_}||0) !~ / \A [0-9]+ (?: \. [0-9]+ )? \z /x );
}
- # assemble into the final ret
- for (keys %$group_reqs) {
+ # check if we have all required envvars if such names are defined
+ my ($some_envs_required, $some_envs_missing);
+ if (my @e = @{$dbic_reqs->{$group}{env} || [] }) {
+
+ croak "Unexpected 'env' attribute under group '$group' (only allowed in test_* groups)"
+ unless $group =~ /^test_/;
+
+ croak "Unexpected *odd* list in 'env' under group '$group'"
+ if @e % 2;
+
+ my @group_envnames_list;
+
+ # deconstruct the whole thing
+ while (@e) {
+ push @group_envnames_list, my $envname = shift @e;
+
+ # env required or not
+ next unless shift @e;
+
+ $some_envs_required ||= 1;
+
+ $some_envs_missing ||= (
+ ! defined $ENV{$envname}
+ or
+ ! length $ENV{$envname}
+ );
+ }
+
+ croak "None of the envvars in group '$group' declared as required, making the requirement moot"
+ unless $some_envs_required;
+
+ push @{$ret->{missing_envvars}}, \@group_envnames_list if $some_envs_missing;
+ }
+
+ # get the reqs for includes if any
+ my $inc_reqs;
+ if (my $incs = $dbic_reqs->{$group}{include}) {
+ $incs = [ $incs ] unless ref $incs eq 'ARRAY';
- $ret->{modreqs}{$_} = $group_reqs->{$_}||0 if (
+ croak "Malformed 'include' for group '$group': must be another existing group name or arrayref of existing group names"
+ unless @$incs;
- ! exists $ret->{modreqs}{$_}
- or
- # we sanitized the version to be numeric above - we can just -gt it
- ($group_reqs->{$_}||0) > $ret->{modreqs}{$_}
+ local $processed_groups->{$group} = 1;
- );
+ my $subreqs = $self->_groups_to_reqs($incs);
+
+ croak "Includes with variable effective_modreqs not yet supported"
+ if $subreqs->{effective_modreqs_differ};
+
+ $inc_reqs = $subreqs->{modreqs};
+
+ }
+
+ # assemble into the final ret
+ for my $type (
+ 'modreqs',
+ $some_envs_missing ? () : 'effective_modreqs'
+ ) {
+ for my $req_bag ($group_reqs, $inc_reqs||()) {
+ for my $mod (keys %$req_bag) {
+
+ $ret->{$type}{$mod} = $req_bag->{$mod}||0 if (
+
+ ! exists $ret->{$type}{$mod}
+ or
+ # we sanitized the version to be numeric above - we can just -gt it
+ ($req_bag->{$mod}||0) > $ret->{$type}{$mod}
+
+ );
+ }
+ }
}
+ $ret->{effective_modreqs_differ} ||= !!$some_envs_missing;
+
$ret->{modreqs_fully_documented} &&= !!$dbic_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.
+(or 0 for any version). In addition groups prefixed with C<test_> can specify
+a set of environment variables, some (or all) of which are marked as required
+for the group to be considered by L</req_list_for>
+
+Each group name (or a combination thereof) can be used in the
+L<public methods|/METHODS> as described below.
EOC
my $p = $dbic_reqs->{$group}{pod}
or next;
- my $modlist = $dbic_reqs->{$group}{req}
- or next;
+ my $modlist = $class->modreq_list_for($group);
next unless keys %$modlist;
This method should be used by DBIx::Class extension authors, to determine the
version of modules a specific set of features requires for this version of
-DBIx::Class. See the L</SYNOPSIS> for a real-world example.
+DBIx::Class (regardless of their availability on the system).
+See the L</SYNOPSIS> for a real-world example.
+
+When handling C<test_*> groups this method behaves B<differently> from
+L</modreq_list_for> below (and is the only such inconsistency among the
+C<req_*> methods). If a particular group declares as requirements some
+C<environment variables> and these requirements are not satisfied (the envvars
+are unset) - then the C<module requirements> of this group are not included in
+the returned list.
+
+=head2 modreq_list_for
+
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: \%set_of_module_version_pairs
+
+=back
+
+Same as L</req_list_for> but does not take into consideration any
+C<environment variable requirements> - returns just the list of required
+modules.
=head2 req_ok_for
=back
-Returns true or false depending on whether all modules required by
-the group(s) are present on the system and loadable.
+Returns true or false depending on whether all modules/envvars required by
+the group(s) are loadable/set on the system.
=head2 req_missing_for
=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.
+This method would normally be used by DBIx::Class core features, to indicate to
+the user that they need to install specific modules and/or set specific
+environment variables 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:
push @chunks, <<'EOC';
The author is expected to prepend the necessary text to this message before
-returning the actual error seen by the user.
+returning the actual error seen by the user. See also L</modreq_missing_for>
+
+=head2 modreq_missing_for
+=over
+
+=item Arguments: $group_name | \@group_names
+
+=item Return Value: $error_message_string
+
+=back
+
+Same as L</req_missing_for> except that the error string is guaranteed to be
+either empty, or contain a set of module requirement specifications suitable
+for piping to e.g. L<cpanminus|App::cpanminus>. The method explicitly does not
+attempt to validate the state of required environment variables (if any).
+
+For instance if some of the requirements for C<deploy> are not available,
+the returned string could look like:
+EOC
+
+ push @chunks, qq{ "SQL::Translator~>=$sqltver"};
+
+ push @chunks, <<'EOC';
=head2 die_unless_req_ok_for
=over
in case of failure throws an exception including the information
from L</req_missing_for>.
-=head2 req_errorlist_for
+=head2 modreq_errorlist_for
=over
Returns a hashref containing the actual errors that occurred while attempting
to load each module in the requirement group(s).
-EOC
+=head2 req_errorlist_for
+
+Deprecated method name, equivalent (via proxy) to L</modreq_errorlist_for>.
+
+EOC
#@@
#@@ FOOTER
projects / dbsrgits/DBIx-Class.git / blobdiff