X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FOptional%2FDependencies.pm;h=a7ab5e5bc37e1c39b7fd41bf99f47cc41f2c3925;hb=25c1ed5f32dfcefdc12df885669e1dcf9baabbe9;hp=2a8b1777d65a6219e4f80c2f1e159bf0402a585d;hpb=a3f8bd014894e2b48c0a8bb12d07e0524c6b9a35;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm index 2a8b177..a7ab5e5 100644 --- a/lib/DBIx/Class/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Optional/Dependencies.pm @@ -2,8 +2,12 @@ package DBIx::Class::Optional::Dependencies; ### 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'; +BEGIN { + if ( $ENV{RELEASE_TESTING} ) { + require warnings and warnings->import; + require strict and strict->import; + } +} sub croak { require Carp; @@ -43,8 +47,15 @@ my $dbic_reqs = { }, # a common placeholder for engines with IC::DT support based off DT::F::S - # currently unused on purpose (see next commits) - _icdt_strptime_based => {}, + _ic_dt_strptime_based => { + augment => { + ic_dt => { + req => { + 'DateTime::Format::Strptime' => '1.2', + }, + }, + } + }, _rdbms_generic_odbc => { req => { @@ -58,6 +69,21 @@ my $dbic_reqs = { } }, + # must list any dep used by adhoc testing + # this prevents the "skips due to forgotten deps" issue + test_adhoc => { + req => { + 'Class::DBI::Plugin::DeepAbstractSearch' => '0', + 'Class::DBI' => '3.000005', + 'Date::Simple' => '3.03', + 'YAML' => '0', + 'Class::Unload' => '0.07', + 'Time::Piece' => '0', + 'Time::Piece::MySQL' => '0', + 'DBD::mysql' => '4.023', + }, + }, + replicated => { req => $moose_basic, pod => { @@ -73,8 +99,18 @@ my $dbic_reqs = { }, }, + config_file_reader => { + pod => { + title => 'Generic config reader', + desc => 'Modules required for generic config file parsing, currently Config::Any (rarely used at runtime)', + }, + req => { + 'Config::Any' => '0.20', + }, + }, + admin => { - include => '_json_any', + include => [qw( _json_any config_file_reader )], req => { %$moose_basic, 'MooseX::Types::Path::Class' => '0.05', @@ -108,6 +144,21 @@ my $dbic_reqs = { }, }, + ic_dt => { + req => { + 'DateTime' => '0.55', + 'DateTime::TimeZone::OlsonDB' => 0, + }, + pod => { + title => 'InflateColumn::DateTime support', + desc => + 'Modules required for L. ' + . 'Note that this group does not require much on its own, but ' + . 'instead is augmented by various RDBMS-specific groups. See the ' + . 'documentation of each C group for details', + }, + }, + id_shortener => { req => { 'Math::BigInt' => '1.80', @@ -115,9 +166,16 @@ my $dbic_reqs = { }, }, - test_component_accessor => { + cdbicompat => { req => { - 'Class::Unload' => '0.07', + 'Class::Data::Inheritable' => '0', + 'Class::Trigger' => '0', + 'DBIx::ContextualFetch' => '0', + 'Clone' => '0.32', + }, + pod => { + title => 'DBIx::Class::CDBICompat support', + desc => 'Modules required for L' }, }, @@ -178,46 +236,15 @@ my $dbic_reqs = { }, }, - test_dt => { - req => { - 'DateTime' => '0.55', - 'DateTime::Format::Strptime' => '1.2', - }, - }, - - test_dt_sqlite => { - include => 'test_dt', - req => { - # t/36datetime.t - # t/60core.t - 'DateTime::Format::SQLite' => '0', - }, - }, - - test_dt_mysql => { - include => 'test_dt', - req => { - # t/inflate/datetime_mysql.t - # (doesn't need Mysql itself) - 'DateTime::Format::MySQL' => '0', - }, - }, - - test_dt_pg => { - include => 'test_dt', - req => { - # 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', - 'Time::Piece::MySQL' => '0', - 'Date::Simple' => '3.03', + binary_data => { + pod => { + title => 'Binary datatype support (certain RDBMS)', + desc => + 'Some RDBMS engines require specific versions of the respective DBD ' + . 'driver for binary data support. Note that this group does not ' + . 'require anything on its own, but instead is augmented by various ' + . 'RDBMS-specific groups. See the documentation of each rbms_* group ' + . 'for details', }, }, @@ -231,21 +258,51 @@ my $dbic_reqs = { title => 'SQLite support', desc => 'Modules required to connect to SQLite', }, + augment => { + ic_dt => { + req => { + 'DateTime::Format::SQLite' => '0', + }, + }, + }, + }, + + # centralize the specification, as we have ICDT tests which can + # test the full behavior of RDBMS-specific ICDT on top of bare SQLite + _ic_dt_pg_base => { + augment => { + ic_dt => { + req => { + 'DateTime::Format::Pg' => '0.16004', + }, + }, + }, + }, + + ic_dt_pg => { + include => [qw( ic_dt _ic_dt_pg_base )], }, rdbms_pg => { + include => '_ic_dt_pg_base', req => { - # when changing this list make sure to adjust xt/optional_deps.t 'DBD::Pg' => 0, }, pod => { title => 'PostgreSQL support', desc => 'Modules required to connect to PostgreSQL', }, + augment => { + binary_data => { + req => { + 'DBD::Pg' => '2.009002' + }, + } + }, }, _rdbms_mssql_common => { - include => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', }, rdbms_mssql_odbc => { @@ -276,7 +333,7 @@ my $dbic_reqs = { }, _rdbms_msaccess_common => { - include => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', }, rdbms_msaccess_odbc => { @@ -295,7 +352,24 @@ my $dbic_reqs = { }, }, + # centralize the specification, as we have ICDT tests which can + # test the full behavior of RDBMS-specific ICDT on top of bare SQLite + _ic_dt_mysql_base => { + augment => { + ic_dt => { + req => { + 'DateTime::Format::MySQL' => '0', + }, + }, + }, + }, + + ic_dt_mysql => { + include => [qw( ic_dt _ic_dt_mysql_base )], + }, + rdbms_mysql => { + include => '_ic_dt_mysql_base', req => { 'DBD::mysql' => 0, }, @@ -314,10 +388,17 @@ my $dbic_reqs = { title => 'Oracle support', desc => 'Modules required to connect to Oracle', }, + augment => { + ic_dt => { + req => { + 'DateTime::Format::Oracle' => '0', + }, + }, + }, }, rdbms_ase => { - include => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', req => { 'DBD::Sybase' => 0, }, @@ -328,6 +409,13 @@ my $dbic_reqs = { }, _rdbms_db2_common => { + augment => { + ic_dt => { + req => { + 'DateTime::Format::DB2' => '0', + }, + }, + }, }, rdbms_db2 => { @@ -350,7 +438,7 @@ my $dbic_reqs = { }, rdbms_informix => { - include => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', req => { 'DBD::Informix' => 0, }, @@ -361,7 +449,7 @@ my $dbic_reqs = { }, _rdbms_sqlanywhere_common => { - inclide => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', }, rdbms_sqlanywhere => { @@ -384,7 +472,7 @@ my $dbic_reqs = { }, _rdbms_firebird_common => { - include => '_icdt_strptime_based', + include => '_ic_dt_strptime_based', }, rdbms_firebird => { @@ -437,13 +525,6 @@ my $dbic_reqs = { DBICTEST_PG_USER => 0, DBICTEST_PG_PASS => 0, ], - req => { - # 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 => { @@ -514,7 +595,6 @@ my $dbic_reqs = { DBICTEST_ORA_PASS => 0, ], req => { - 'DateTime::Format::Oracle' => '0', 'DBD::Oracle' => '1.24', }, }, @@ -613,9 +693,19 @@ my $dbic_reqs = { # 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 )], + include => [qw( + admin_script + _json_xs_compatible_json_any + id_shortener + deploy + test_pod + test_podcoverage + test_whitespace + test_strictures + )], req => { 'ExtUtils::MakeMaker' => '6.64', + 'Module::Install' => '1.06', 'Pod::Inherit' => '0.91', }, }, @@ -722,7 +812,11 @@ sub req_missing_for { my ($self, $groups) = @_; my $reqs = $self->_groups_to_reqs($groups); - my $mods_missing = $self->modreq_missing_for($groups); + + my $mods_missing = $reqs->{missing_envvars} + ? $self->_list_physically_missing_modules( $reqs->{modreqs} ) + : $self->modreq_missing_for($groups) + ; return '' if ! $mods_missing @@ -752,11 +846,28 @@ sub modreq_missing_for { or return ''; join ' ', map - { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ } + { $reqs->{modreqs}{$_} ? "$_~$reqs->{modreqs}{$_}" : $_ } sort { lc($a) cmp lc($b) } keys %$modreq_errors ; } +my $tb; +sub skip_without { + my ($self, $groups) = @_; + + $tb ||= do { local $@; eval { Test::Builder->new } } + or croak "Calling skip_without() before loading Test::Builder makes no sense"; + + if ( my $err = $self->req_missing_for($groups) ) { + my ($fn, $ln) = (caller(0))[1,2]; + $tb->skip("block in $fn around line $ln requires $err"); + local $^W = 0; + last SKIP; + } + + 1; +} + sub die_unless_req_ok_for { if (my $err = shift->req_missing_for(shift) ) { die "Unable to continue due to missing requirements: $err\n"; @@ -788,6 +899,10 @@ sub __envvar_group_desc { join '/', @res; } +my $groupname_re = qr/ [a-z_] [0-9_a-z]* /x; +my $modname_re = qr/ [A-Z_a-z] [0-9A-Z_a-z]* (?:::[0-9A-Z_a-z]+)* /x; +my $modver_re = qr/ [0-9]+ (?: \. [0-9]+ )? /x; + # Expand includes from a random group in a specific order: # nonvariable groups first, then their includes, then the variable groups, # then their includes. @@ -809,7 +924,7 @@ sub __expand_includes { for my $g (@$groups) { croak "Invalid requirement group name '$g': only ascii alphanumerics and _ are allowed" - if $g !~ /\A [A-Z_a-z][0-9A-Z_a-z]* \z/x; + if $g !~ qr/ \A $groupname_re \z/x; my $r = $dbic_reqs->{$g} or croak "Requirement group '$g' is not defined"; @@ -879,6 +994,7 @@ sub __expand_includes { idx => 1 + keys %$rv, missing_envvars => $missing_envvars->{$_}, } for @ret; + $rv->{$_}{user_requested} = 1 for @$groups; $rv; }; } @@ -888,35 +1004,97 @@ our %req_unavailability_cache; # this method is just a lister and envvar/metadata checker - it does not try to load anything sub _groups_to_reqs { - my ($self, $groups) = @_; + my ($self, $want) = @_; - $groups = [ $groups || () ] - unless ref $groups eq 'ARRAY'; + $want = [ $want || () ] + unless ref $want eq 'ARRAY'; croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names" - unless @$groups; + unless @$want; my $ret = { modreqs => {}, modreqs_fully_documented => 1, }; + my $groups; + for my $piece (@$want) { + if ($piece =~ qr/ \A $groupname_re \z /x) { + push @$groups, $piece; + } + elsif ( my ($mod, $ver) = $piece =~ qr/ \A ($modname_re) \>\= ($modver_re) \z /x ) { + croak "Ad hoc module specification lists '$mod' twice" + if exists $ret->{modreqs}{$mod}; + + croak "Ad hoc module specification '${mod} >= $ver' (or greater) not listed in the test_adhoc optdep group" if ( + ! defined $dbic_reqs->{test_adhoc}{req}{$mod} + or + $dbic_reqs->{test_adhoc}{req}{$mod} < $ver + ); + + $ret->{modreqs}{$mod} = $ver; + $ret->{modreqs_fully_documented} = 0; + } + else { + croak "Unsupported argument '$piece' supplied to @{[ (caller(1))[3] ]}()" + } + } + my $all_groups = __expand_includes($groups); + # pre-assemble list of augmentations, perform basic sanity checks + # Note that below we *DO NOT* respect the source/target reationship, but + # instead always default to augment the "later" group + # This is done so that the "stable/variable" boundary keeps working as + # expected + my $augmentations; + for my $requesting_group (keys %$all_groups) { + if (my $ag = $dbic_reqs->{$requesting_group}{augment}) { + for my $target_group (keys %$ag) { + + croak "Group '$requesting_group' claims to augment a non-existent group '$target_group'" + unless $dbic_reqs->{$target_group}; + + croak "Augmentation combined with variable effective_modreqs currently unsupported for group '$requesting_group'" + if $dbic_reqs->{$requesting_group}{env}; + + croak "Augmentation of group '$target_group' with variable effective_modreqs unsupported (requested by '$requesting_group')" + if $dbic_reqs->{$target_group}{env}; + + if (my @foreign = grep { $_ ne 'req' } keys %{$ag->{$target_group}} ) { + croak "Only 'req' augmentations are currently supported (group '$requesting_group' attempts to alter '$foreign[0]' of group '$target_group'"; + } + + $ret->{augments}{$target_group} = 1; + + # no augmentation for stuff that hasn't been selected + if ( $all_groups->{$target_group} and my $ar = $ag->{$target_group}{req} ) { + push @{$augmentations->{ + ( $all_groups->{$requesting_group}{idx} < $all_groups->{$target_group}{idx} ) + ? $target_group + : $requesting_group + }}, $ar; + } + } + } + } + for my $group (sort { $all_groups->{$a}{idx} <=> $all_groups->{$b}{idx} } keys %$all_groups ) { my $group_reqs = $dbic_reqs->{$group}{req}; # sanity-check - for (keys %$group_reqs) { + for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { + for (keys %$req_bag) { - $_ =~ /\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"; + $_ =~ / \A $modname_re \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 ); + # !!!DO NOT CHANGE!!! + # remember - version.pm may not be available on the system + croak "Requirement '$_' in group '$group' specifies an invalid version '$req_bag->{$_}' (only plain non-underscored floating point decimals are supported)" + if ( ($req_bag->{$_}||0) !~ qr/ \A $modver_re \z /x ); + } } if (my $e = $all_groups->{$group}{missing_envvars}) { @@ -928,7 +1106,7 @@ sub _groups_to_reqs { 'modreqs', ( $ret->{missing_envvars} ? () : 'effective_modreqs' ), ) { - for my $req_bag ($group_reqs) { + for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { for my $mod (keys %$req_bag) { $ret->{$type}{$mod} = $req_bag->{$mod}||0 if ( @@ -943,7 +1121,8 @@ sub _groups_to_reqs { } } - $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod}; + $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod} + if $all_groups->{$group}{user_requested}; $ret->{release_testing_mandatory} ||= !!$dbic_reqs->{$group}{release_testing_mandatory}; } @@ -952,7 +1131,7 @@ sub _groups_to_reqs { } -# this method tries to load specified modreqs and returns a hashref of +# this method tries to find/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 @@ -977,6 +1156,36 @@ sub _errorlist_for_modreqs { $ret; } +# Unlike the above DO NOT try to load anything +# This is executed when some needed envvars are not available +# which in turn means a module load will never be reached anyway +# This is important because some modules (especially DBDs) can be +# *really* fickle when a require() is attempted, with pretty confusing +# side-effects (especially on windows) +sub _list_physically_missing_modules { + my ($self, $modreqs) = @_; + + # in case there is a coderef in @INC there is nothing we can definitively prove + # so short circuit directly + return '' if grep { length ref $_ } @INC; + + my @definitely_missing; + for my $mod (keys %$modreqs) { + (my $fn = $mod . '.pm') =~ s|::|/|g; + + push @definitely_missing, $mod unless grep + # this should work on any combination of slashes + { $_ and -d $_ and -f "$_/$fn" and -r "$_/$fn" } + @INC + ; + } + + join ' ', map + { $modreqs->{$_} ? "$_~$modreqs->{$_}" : $_ } + sort { lc($a) cmp lc($b) } @definitely_missing + ; +} + # This is to be called by the author only (automatically in Makefile.PL) sub _gen_pod { @@ -1048,13 +1257,13 @@ Somewhere in your build-file (e.g. L's F): ... - my %DBIC_DEPLOY_DEPS = %{ eval { + my %DBIC_DEPLOY_AND_ORACLE_DEPS = %{ eval { require $class; - $class->req_list_for('deploy'); + $class->req_list_for([qw( deploy rdbms_oracle ic_dt )]); } || {} }; \$EUMM_ARGS{PREREQ_PM} = { - \%DBIC_DEPLOY_DEPS, + \%DBIC_DEPLOY_AND_ORACLE_DEPS, \%{ \$EUMM_ARGS{PREREQ_PM} || {} }, }; @@ -1108,22 +1317,63 @@ EOC #@@ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; + my $standalone_info; + for my $group (sort keys %$dbic_reqs) { - my $p = $dbic_reqs->{$group}{pod} - or next; - my $modlist = $class->modreq_list_for($group); + my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group); + + next unless ( + $info->{modreqs_fully_documented} + and + ( $info->{augments} or $info->{modreqs} ) + ); - next unless keys %$modlist; + my $p = $dbic_reqs->{$group}{pod}; push @chunks, ( "=head2 $p->{title}", - "$p->{desc}", + "=head3 $group", + $p->{desc}, '=over', - ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ), - '=back', - "Requirement group: B<$group>", ); + + if ( keys %{ $info->{modreqs}||{} } ) { + push @chunks, map + { "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : '') } + ( sort keys %{ $info->{modreqs} } ) + ; + } + else { + push @chunks, '=item * No standalone requirements', + } + + push @chunks, '=back'; + + for my $ag ( sort keys %{ $info->{augments} || {} } ) { + my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag); + + my $newreqs = $class->modreq_list_for([ $group, $ag ]); + for (keys %$newreqs) { + delete $newreqs->{$_} if ( + ( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} ) + or + ( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} ) + ); + } + + if (keys %$newreqs) { + push @chunks, ( + "Combined with L additionally requires:", + '=over', + ( map + { "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : '') } + ( sort keys %$newreqs ) + ), + '=back', + ); + } + } } @@ -1283,7 +1533,7 @@ For example if some of the requirements for C are not available, the returned string could look like: EOC - push @chunks, qq{ "SQL::Translator~>=$sqltver" (see $class documentation 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 @@ -1308,12 +1558,37 @@ 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, qq{ "SQL::Translator~$sqltver"}; push @chunks, <<'EOC'; See also L. +=head2 skip_without + +=over + +=item Arguments: $group_name | \@group_names + +=back + +A convenience wrapper around L. It does not take neither +a reason (it is generated by L) nor an amount of skipped tests +(it is always C<1>, thus mandating unconditional use of +L). Most useful in combination with ad hoc +requirement specifications: +EOC + + push @chunks, <skip_without([ deploy YAML>=0.90 ]); + + ... + } +EOC + + push @chunks, <<'EOC'; + =head2 die_unless_req_ok_for =over