X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FOptional%2FDependencies.pm;h=ff28cad028584400fc4014766a16d36298875072;hb=7d2772a4fa08eb1c76a54f57dc7f623d81ff8472;hp=94b61c4a6371ac0d23a790e90dd940f8fa695338;hpb=79b1bf0a9e0d827d5737c389523adb858dff986a;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm index 94b61c4..ff28cad 100644 --- a/lib/DBIx/Class/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Optional/Dependencies.pm @@ -1,9 +1,15 @@ package DBIx::Class::Optional::Dependencies; -use warnings; -use strict; - -use Carp; +### This may look crazy, but it in fact tangibly ( by 50(!)% ) shortens +# the skip-test time when everything requested is unavailable +use if $ENV{RELEASE_TESTING} => 'warnings'; +use if $ENV{RELEASE_TESTING} => 'strict'; + +sub croak { + require Carp; + Carp::croak(@_); +}; +### # 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 @@ -11,109 +17,49 @@ use Carp; # POD is generated automatically by calling _gen_pod from the # Makefile.PL in $AUTHOR mode -# NOTE: the rationale for 2 JSON::Any versions is that -# we need the newer only to work around JSON::XS, which -# itself is an optional dep -my $min_json_any = { - 'JSON::Any' => '1.23', -}; -my $test_and_dist_json_any = { - 'JSON::Any' => '1.31', -}; - +# *DELIBERATELY* not making a group for these - they must disappear +# forever as optdeps in the first place my $moose_basic = { 'Moose' => '0.98', 'MooseX::Types' => '0.21', 'MooseX::Types::LoadableClass' => '0.011', }; -my $replicated = { - %$moose_basic, -}; +my $dbic_reqs = { -my $admin_basic = { - %$moose_basic, - %$min_json_any, - 'MooseX::Types::Path::Class' => '0.05', - 'MooseX::Types::JSON' => '0.02', -}; + # NOTE: the rationale for 2 JSON::Any versions is that + # we need the newer only to work around JSON::XS, which + # itself is an optional dep + _json_any => { + req => { + 'JSON::Any' => '1.23', + }, + }, -my $admin_script = { - %$moose_basic, - %$admin_basic, - 'Getopt::Long::Descriptive' => '0.081', - 'Text::CSV' => '1.16', -}; + _json_xs_compatible_json_any => { + req => { + 'JSON::Any' => '1.31', + }, + }, -my $datetime_basic = { - 'DateTime' => '0.55', - 'DateTime::Format::Strptime' => '1.2', -}; + # a common placeholder for engines with IC::DT support based off DT::F::S + # currently unused on purpose (see next commits) + _icdt_strptime_based => {}, -my $id_shortener = { - 'Math::BigInt' => '1.80', - 'Math::Base36' => '0.07', -}; + _rdbms_generic_odbc => { + req => { + 'DBD::ODBC' => 0, + } + }, -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', -}; + _rdbms_generic_ado => { + req => { + 'DBD::ADO' => 0, + } + }, -my $reqs = { replicated => { - req => $replicated, + req => $moose_basic, pod => { title => 'Storage::Replicated', desc => 'Modules required for L', @@ -121,16 +67,18 @@ my $reqs = { }, test_replicated => { + include => 'replicated', req => { - %$replicated, - 'Test::Moose' => '0', + 'Test::Moose' => '0', }, }, - admin => { + include => '_json_any', req => { - %$admin_basic, + %$moose_basic, + 'MooseX::Types::Path::Class' => '0.05', + 'MooseX::Types::JSON' => '0.02', }, pod => { title => 'DBIx::Class::Admin', @@ -139,8 +87,10 @@ my $reqs = { }, admin_script => { + include => 'admin', req => { - %$admin_script, + 'Getopt::Long::Descriptive' => '0.081', + 'Text::CSV' => '1.16', }, pod => { title => 'dbicadmin', @@ -159,7 +109,10 @@ my $reqs = { }, id_shortener => { - req => $id_shortener, + req => { + 'Math::BigInt' => '1.80', + 'Math::Base36' => '0.07', + }, }, test_component_accessor => { @@ -172,6 +125,7 @@ my $reqs = { req => { 'Test::Pod' => '1.42', }, + release_testing_mandatory => 1, }, test_podcoverage => { @@ -179,6 +133,7 @@ my $reqs = { 'Test::Pod::Coverage' => '1.08', 'Pod::Coverage' => '0.20', }, + release_testing_mandatory => 1, }, test_whitespace => { @@ -186,22 +141,23 @@ my $reqs = { 'Test::EOL' => '1.0', 'Test::NoTabs' => '0.9', }, + release_testing_mandatory => 1, }, test_strictures => { req => { 'Test::Strict' => '0.20', }, + release_testing_mandatory => 1, }, test_prettydebug => { - req => $min_json_any, + include => '_json_any', }, test_admin_script => { + include => [qw( admin_script _json_xs_compatible_json_any )], req => { - %$admin_script, - %$test_and_dist_json_any, 'JSON' => 0, 'JSON::PP' => 0, 'Cpanel::JSON::XS' => 0, @@ -223,12 +179,15 @@ my $reqs = { }, 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', @@ -236,8 +195,8 @@ my $reqs = { }, test_dt_mysql => { + include => 'test_dt', req => { - %$datetime_basic, # t/inflate/datetime_mysql.t # (doesn't need Mysql itself) 'DateTime::Format::MySQL' => '0', @@ -245,8 +204,8 @@ my $reqs = { }, test_dt_pg => { + include => 'test_dt', req => { - %$datetime_basic, # t/inflate/datetime_pg.t # (doesn't need PG itself) 'DateTime::Format::Pg' => '0.16004', @@ -254,9 +213,9 @@ my $reqs = { }, test_cdbicompat => { + include => 'test_dt', req => { 'Class::DBI::Plugin::DeepAbstractSearch' => '0', - %$datetime_basic, 'Time::Piece::MySQL' => '0', 'Date::Simple' => '3.03', }, @@ -266,7 +225,7 @@ my $reqs = { # is a core dep of DBIC for testing rdbms_sqlite => { req => { - %$rdbms_sqlite, + 'DBD::SQLite' => 0, }, pod => { title => 'SQLite support', @@ -277,7 +236,7 @@ my $reqs = { rdbms_pg => { req => { # when changing this list make sure to adjust xt/optional_deps.t - %$rdbms_pg, + 'DBD::Pg' => 0, }, pod => { title => 'PostgreSQL support', @@ -285,10 +244,12 @@ my $reqs = { }, }, + _rdbms_mssql_common => { + include => '_icdt_strptime_based', + }, + rdbms_mssql_odbc => { - req => { - %$rdbms_mssql_odbc, - }, + include => [qw( _rdbms_generic_odbc _rdbms_mssql_common )], pod => { title => 'MSSQL support via DBD::ODBC', desc => 'Modules required to connect to MSSQL via DBD::ODBC', @@ -296,8 +257,9 @@ my $reqs = { }, rdbms_mssql_sybase => { + include => '_rdbms_mssql_common', req => { - %$rdbms_mssql_sybase, + 'DBD::Sybase' => 0, }, pod => { title => 'MSSQL support via DBD::Sybase', @@ -306,19 +268,19 @@ my $reqs = { }, rdbms_mssql_ado => { - req => { - %$rdbms_mssql_ado, - }, + include => [qw( _rdbms_generic_ado _rdbms_mssql_common )], 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_common => { + include => '_icdt_strptime_based', + }, + rdbms_msaccess_odbc => { - req => { - %$rdbms_msaccess_odbc, - }, + include => [qw( _rdbms_generic_odbc _rdbms_msaccess_common )], pod => { title => 'MS Access support via DBD::ODBC', desc => 'Modules required to connect to MS Access via DBD::ODBC', @@ -326,9 +288,7 @@ my $reqs = { }, rdbms_msaccess_ado => { - req => { - %$rdbms_msaccess_ado, - }, + include => [qw( _rdbms_generic_ado _rdbms_msaccess_common )], 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', @@ -337,7 +297,7 @@ my $reqs = { rdbms_mysql => { req => { - %$rdbms_mysql, + 'DBD::mysql' => 0, }, pod => { title => 'MySQL support', @@ -346,8 +306,9 @@ my $reqs = { }, rdbms_oracle => { + include => 'id_shortener', req => { - %$rdbms_oracle, + 'DBD::Oracle' => 0, }, pod => { title => 'Oracle support', @@ -356,8 +317,9 @@ my $reqs = { }, rdbms_ase => { + include => '_icdt_strptime_based', req => { - %$rdbms_ase, + 'DBD::Sybase' => 0, }, pod => { title => 'Sybase ASE support', @@ -365,9 +327,13 @@ my $reqs = { }, }, + _rdbms_db2_common => { + }, + rdbms_db2 => { + include => '_rdbms_db2_common', req => { - %$rdbms_db2, + 'DBD::DB2' => 0, }, pod => { title => 'DB2 support', @@ -376,9 +342,7 @@ my $reqs = { }, rdbms_db2_400 => { - req => { - %$rdbms_db2_400, - }, + include => [qw( _rdbms_generic_odbc _rdbms_db2_common )], pod => { title => 'DB2 on AS/400 support', desc => 'Modules required to connect to DB2 on AS/400', @@ -386,8 +350,9 @@ my $reqs = { }, rdbms_informix => { + include => '_icdt_strptime_based', req => { - %$rdbms_informix, + 'DBD::Informix' => 0, }, pod => { title => 'Informix support', @@ -395,9 +360,14 @@ my $reqs = { }, }, + _rdbms_sqlanywhere_common => { + inclide => '_icdt_strptime_based', + }, + rdbms_sqlanywhere => { + include => '_rdbms_sqlanywhere_common', req => { - %$rdbms_sqlanywhere, + 'DBD::SQLAnywhere' => 0, }, pod => { title => 'SQLAnywhere support', @@ -406,18 +376,21 @@ my $reqs = { }, rdbms_sqlanywhere_odbc => { - req => { - %$rdbms_sqlanywhere_odbc, - }, + include => [qw( _rdbms_generic_odbc _rdbms_sqlanywhere_common )], pod => { title => 'SQLAnywhere support via DBD::ODBC', desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC', }, }, + _rdbms_firebird_common => { + include => '_icdt_strptime_based', + }, + rdbms_firebird => { + include => '_rdbms_firebird_common', req => { - %$rdbms_firebird, + 'DBD::Firebird' => 0, }, pod => { title => 'Firebird support', @@ -426,8 +399,9 @@ my $reqs = { }, rdbms_firebird_interbase => { + include => '_rdbms_firebird_common', req => { - %$rdbms_firebird_interbase, + 'DBD::InterBase' => 0, }, pod => { title => 'Firebird support via DBD::InterBase', @@ -436,190 +410,211 @@ my $reqs = { }, rdbms_firebird_odbc => { - req => { - %$rdbms_firebird_odbc, - }, + include => [qw( _rdbms_generic_odbc _rdbms_firebird_common )], pod => { title => 'Firebird support via DBD::ODBC', desc => 'Modules required to connect to Firebird via DBD::ODBC', }, }, -# the order does matter because the rdbms support group might require -# a different version that the test group - test_rdbms_pg => { + test_rdbms_sqlite => { + include => 'rdbms_sqlite', req => { - $ENV{DBICTEST_PG_DSN} - ? ( - # when changing this list make sure to adjust xt/optional_deps.t - %$rdbms_pg, - 'DBD::Pg' => '2.009002', - ) : () + ### + ### IMPORTANT - do not raise this dependency + ### even though many bugfixes are present in newer versions, the general DBIC + ### rule is to bend over backwards for available DBDs (given upgrading them is + ### often *not* easy or even possible) + ### + 'DBD::SQLite' => '1.29', }, }, - test_rdbms_mssql_odbc => { + test_rdbms_pg => { + include => 'rdbms_pg', + env => [ + DBICTEST_PG_DSN => 1, + DBICTEST_PG_USER => 0, + DBICTEST_PG_PASS => 0, + ], req => { - $ENV{DBICTEST_MSSQL_ODBC_DSN} - ? ( - %$rdbms_mssql_odbc, - ) : () + # 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 => { + 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 => 'rdbms_msaccess_odbc', + 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 => 'rdbms_msaccess_ado', + 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, }, }, dist_dir => { + # we need to run the dbicadmin so we can self-generate its POD + # also we do not want surprises in case JSON::XS is in the path + # so make sure we get an always-working JSON::Any + include => [qw( admin_script _json_xs_compatible_json_any )], req => { - %$test_and_dist_json_any, 'ExtUtils::MakeMaker' => '6.64', 'Pod::Inherit' => '0.91', }, @@ -630,118 +625,319 @@ my $reqs = { 'CPAN::Uploader' => '0.103001', }, }, - }; ### Public API +sub import { + my $class = shift; + + if (@_) { + + my $action = shift; + + if ($action eq '-die_without') { + my $err; + { + local $@; + eval { $class->die_unless_req_ok_for(\@_); 1 } + or $err = $@; + } + die "\n$err\n" if $err; + } + elsif ($action eq '-list_missing') { + print $class->modreq_missing_for(\@_); + print "\n"; + exit 0; + } + elsif ($action eq '-skip_all_without') { + + # sanity check - make sure ->current_test is 0 and no plan has been declared + do { + local $@; + defined eval { + Test::Builder->new->current_test + or + Test::Builder->new->has_plan + }; + } and croak("Unable to invoke -skip_all_without after testing has started"); + + if ( my $missing = $class->req_missing_for(\@_) ) { + + die ("\nMandatory requirements not satisfied during release-testing: $missing\n\n") + if $ENV{RELEASE_TESTING} and $class->_groups_to_reqs(\@_)->{release_testing_mandatory}; + + print "1..0 # SKIP requirements not satisfied: $missing\n"; + exit 0; + } + } + elsif ($action =~ /^-/) { + croak "Unknown import-time action '$action'"; + } + else { + croak "$class is not an exporter, unable to import '$action'"; + } + } + + 1; +} + +sub unimport { + croak( __PACKAGE__ . " does not implement unimport" ); +} + # 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) = @_; + shift->_groups_to_reqs(shift)->{effective_modreqs}; +} - croak "req_list_for() expects a requirement group name" - unless $group; +sub modreq_list_for { + shift->_groups_to_reqs(shift)->{modreqs}; +} - my $deps = $reqs->{$group}{req} - or croak "Requirement group '$group' does not exist"; +sub req_group_list { + +{ map + { $_ => $_[0]->_groups_to_reqs($_) } + grep { $_ !~ /^_/ } keys %$dbic_reqs + } +} - return { %$deps }; +sub req_errorlist_for { shift->modreq_errorlist_for(shift) } # deprecated +sub modreq_errorlist_for { + my ($self, $groups) = @_; + $self->_errorlist_for_modreqs( $self->_groups_to_reqs($groups)->{modreqs} ); } -sub req_group_list { - return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) }; +sub req_ok_for { + shift->req_missing_for(shift) ? 0 : 1; } -sub req_errorlist_for { - my ($class, $group) = @_; +sub req_missing_for { + my ($self, $groups) = @_; - croak "req_errorlist_for() expects a requirement group name" - unless $group; + my $reqs = $self->_groups_to_reqs($groups); + my $mods_missing = $self->modreq_missing_for($groups); - return $class->_check_deps($group)->{errorlist}; -} + return '' if + ! $mods_missing + and + ! $reqs->{missing_envvars} + ; -sub req_ok_for { - my ($class, $group) = @_; + my @res = $mods_missing || (); - croak "req_ok_for() expects a requirement group name" - unless $group; + push @res, 'the following group(s) of environment variables: ' . join ' and ', sort map + { __envvar_group_desc($_) } + @{$reqs->{missing_envvars}} + if $reqs->{missing_envvars}; - return $class->_check_deps($group)->{status}; + return ( + ( join ' as well as ', @res ) + . + ( $reqs->{modreqs_fully_documented} ? " (see @{[ ref $self || $self ]} documentation for details)" : '' ), + ); } -sub req_missing_for { - my ($class, $group) = @_; +sub modreq_missing_for { + my ($self, $groups) = @_; - croak "req_missing_for() expects a requirement group name" - unless $group; + my $reqs = $self->_groups_to_reqs($groups); + my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs}) + or return ''; - return $class->_check_deps($group)->{missing}; + join ' ', map + { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ } + sort { lc($a) cmp lc($b) } keys %$modreq_errors + ; } sub die_unless_req_ok_for { - my ($class, $group) = @_; + if (my $err = shift->req_missing_for(shift) ) { + die "Unable to continue due to missing requirements: $err\n"; + } +} - croak "die_unless_req_ok_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} ); -} +### 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 and envvar/metadata checker - it does not try to load anything +my $processed_groups = {}; +sub _groups_to_reqs { + my ($self, $groups) = @_; + + $groups = [ $groups || () ] + unless ref $groups eq 'ARRAY'; + + croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names" + unless @$groups; + + my $ret = { + modreqs => {}, + modreqs_fully_documented => 1, + }; + + for my $group ( grep { ! $processed_groups->{$_} } @$groups ) { + + $group =~ /\A [A-Z_a-z][0-9A-Z_a-z]* \z/x + or croak "Invalid requirement group name '$group': only ascii alphanumerics and _ are allowed"; + + 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) { + + $_ =~ /\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"; + + # !!!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 ); + } + + # 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; -our %req_availability_cache; -sub _check_deps { - my ($class, $group) = @_; + my @group_envnames_list; - return $req_availability_cache{$group} ||= do { + # deconstruct the whole thing + while (@e) { + push @group_envnames_list, my $envname = shift @e; - my $deps = $class->req_list_for ($group); + # env required or not + next unless shift @e; - my %errors; - for my $mod (keys %$deps) { - my $req_line = "require $mod;"; - if (my $ver = $deps->{$mod}) { - $req_line .= "$mod->VERSION($ver);"; + $some_envs_required ||= 1; + + $some_envs_missing ||= ( + ! defined $ENV{$envname} + or + ! length $ENV{$envname} + ); } - eval $req_line; + croak "None of the envvars in group '$group' declared as required, making the requirement moot" + unless $some_envs_required; - $errors{$mod} = $@ if $@; + push @{$ret->{missing_envvars}}, \@group_envnames_list if $some_envs_missing; } - my $res; + # get the reqs for includes if any + my $inc_reqs; + if (my $incs = $dbic_reqs->{$group}{include}) { + $incs = [ $incs ] unless ref $incs eq 'ARRAY'; + + croak "Malformed 'include' for group '$group': must be another existing group name or arrayref of existing group names" + unless @$incs; + + 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}; - if (keys %errors) { - my $missing = join (', ', map { $deps->{$_} ? qq("${_}~>=$deps->{$_}") : $_ } (sort keys %errors) ); - $missing .= " (see $class documentation for details)" if $reqs->{$group}{pod}; - $res = { - status => 0, - errorlist => \%errors, - missing => $missing, - }; } - else { - $res = { - status => 1, - errorlist => {}, - missing => '', - }; + + # 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} + + ); + } + } } - $res; - }; + $ret->{effective_modreqs_differ} ||= !!$some_envs_missing; + + $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod}; + + $ret->{release_testing_mandatory} ||= !!$dbic_reqs->{$group}{release_testing_mandatory}; + } + + return $ret; +} + + +# 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) = @_; @@ -770,7 +966,7 @@ sub _gen_pod { 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?"; @@ -858,7 +1054,11 @@ authors alike. Dependencies are organized in L where 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 +(or 0 for any version). In addition groups prefixed with C can specify +a set of environment variables, some (or all) of which are marked as required +for the group to be considered by L + +Each group name (or a combination thereof) can be used in the L as described below. EOC @@ -868,12 +1068,11 @@ EOC #@@ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; - for my $group (sort keys %$reqs) { - my $p = $reqs->{$group}{pod} + for my $group (sort keys %$dbic_reqs) { + my $p = $dbic_reqs->{$group}{pod} or next; - my $modlist = $reqs->{$group}{req} - or next; + my $modlist = $class->modreq_list_for($group); next unless keys %$modlist; @@ -893,6 +1092,70 @@ EOC #@@ push @chunks, <<'EOC'; +=head1 IMPORT-LIKE ACTIONS + +Even though this module is not an L, it recognizes several C +supplied to its C method. + +=head2 -skip_all_without + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper for use during testing: +EOC + + push @chunks, " use $class -skip_all_without => qw(admin test_rdbms_mysql);"; + + push @chunks, 'Roughly equivalent to the following code:'; + + push @chunks, sprintf <<'EOS', ($class) x 2; + + BEGIN { + require %s; + if ( my $missing = %s->req_missing_for(\@group_names_) ) { + print "1..0 # SKIP requirements not satisfied: $missing\n"; + exit 0; + } + } +EOS + + push @chunks, <<'EOC'; + +It also takes into account the C environment variable and +behaves like L for any requirement groups marked as +C. + +=head2 -die_without + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper around L: +EOC + + push @chunks, " use $class -die_without => qw(deploy admin);"; + + push @chunks, <<'EOC'; + +=head2 -list_missing + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper around L: + + perl -Ilib -MDBIx::Class::Optional::Dependencies=-list_missing,deploy,admin | cpanm + =head1 METHODS =head2 req_group_list @@ -906,8 +1169,8 @@ EOC =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. +dependencies B by dependency group. Each key (group name), or a combination +thereof (as an arrayref) can be supplied to the methods below. The B of the returned hash are currently a set of options B. If you have use for any of the contents - contact the maintainers, instead of treating this as public (left alone stable) API. @@ -916,42 +1179,65 @@ maintainers, instead of treating this as public (left alone stable) API. =over -=item Arguments: $group_name +=item Arguments: $group_name | \@group_names -=item Return Value: \%list_of_module_version_pairs +=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 version of -DBIx::Class. See the L for a real-world example. +version of modules a specific set of features requires for this version of +DBIx::Class (regardless of their availability on the system). +See the L for a real-world example. + +When handling C groups this method behaves B from +L below (and is the only such inconsistency among the +C methods). If a particular group declares as requirements some +C and these requirements are not satisfied (the envvars +are unset) - then the C 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 but does not take into consideration any +C - returns just the list of required +modules. =head2 req_ok_for =over -=item Arguments: $group_name +=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. +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 =over -=item Arguments: $group_name +=item Arguments: $group_name | \@group_names =item Return Value: $error_message_string =back -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. +Returns a single-line string suitable for inclusion in larger error messages. +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 are not available, the returned string could look like: @@ -961,32 +1247,62 @@ EOC 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 + +=head2 modreq_missing_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: $error_message_string + +=back + +Same as L 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. 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 are not available, +the returned string could look like: +EOC + + push @chunks, qq{ "SQL::Translator~>=$sqltver"}; + + push @chunks, <<'EOC'; + +See also L. =head2 die_unless_req_ok_for =over -=item Arguments: $group_name +=item Arguments: $group_name | \@group_names =back -Checks if L passes for the supplied C<$group_name>, and +Checks if L passes for the supplied group(s), and in case of failure throws an exception including the information -from L. +from L. See also L. -=head2 req_errorlist_for +=head2 modreq_errorlist_for =over -=item Arguments: $group_name +=item Arguments: $group_name | \@group_names -=item Return Value: \%list_of_loaderrors_per_module +=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. +to load each module in the requirement group(s). + +=head2 req_errorlist_for + +Deprecated method name, equivalent (via proxy) to L. + EOC #@@