X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FOptional%2FDependencies.pm;h=56f04dcce829553e22033fc2f4e833cb27f473da;hb=83eef5621cc3a7b77a280b4b01f1175e9935fff6;hp=ff28cad028584400fc4014766a16d36298875072;hpb=7d2772a4fa08eb1c76a54f57dc7f623d81ff8472;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm index ff28cad..56f04dc 100644 --- a/lib/DBIx/Class/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Optional/Dependencies.pm @@ -43,8 +43,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 => {}, + _icdt_strptime_based => { + augment => { + icdt => { + req => { + 'DateTime::Format::Strptime' => '1.2', + }, + }, + } + }, _rdbms_generic_odbc => { req => { @@ -58,6 +65,20 @@ 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', + }, + }, + replicated => { req => $moose_basic, pod => { @@ -108,6 +129,20 @@ my $dbic_reqs = { }, }, + icdt => { + req => { + 'DateTime' => '0.55', + }, + 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 +150,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,48 +220,6 @@ 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', - }, - }, # this is just for completeness as SQLite # is a core dep of DBIC for testing @@ -231,9 +231,30 @@ my $dbic_reqs = { title => 'SQLite support', desc => 'Modules required to connect to SQLite', }, + augment => { + icdt => { + 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 + # not _-prefixed so that it will show up under req_group_list + icdt_pg => { + augment => { + icdt => { + req => { + 'DateTime::Format::Pg' => '0.16004', + }, + }, + }, }, rdbms_pg => { + include => 'icdt_pg', req => { # when changing this list make sure to adjust xt/optional_deps.t 'DBD::Pg' => 0, @@ -295,7 +316,21 @@ 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 + # not _-prefixed so that it will show up under req_group_list + icdt_mysql => { + augment => { + icdt => { + req => { + 'DateTime::Format::MySQL' => '0', + }, + }, + }, + }, + rdbms_mysql => { + include => 'icdt_mysql', req => { 'DBD::mysql' => 0, }, @@ -314,6 +349,13 @@ my $dbic_reqs = { title => 'Oracle support', desc => 'Modules required to connect to Oracle', }, + augment => { + icdt => { + req => { + 'DateTime::Format::Oracle' => '0', + }, + }, + }, }, rdbms_ase => { @@ -328,6 +370,13 @@ my $dbic_reqs = { }, _rdbms_db2_common => { + augment => { + icdt => { + req => { + 'DateTime::Format::DB2' => '0', + }, + }, + }, }, rdbms_db2 => { @@ -514,7 +563,6 @@ my $dbic_reqs = { DBICTEST_ORA_PASS => 0, ], req => { - 'DateTime::Format::Oracle' => '0', 'DBD::Oracle' => '1.24', }, }, @@ -757,6 +805,23 @@ sub modreq_missing_for { ; } +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,59 +853,54 @@ sub __envvar_group_desc { 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, - }; +my $groupname_re = qr/ [A-Z_a-z][0-9A-Z_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. +# This allows reliably marking the rest of the mod reqs as variable (this is +# also why variable includes are currently not allowed) +sub __expand_includes { + my ($groups, $seen) = @_; + + # !! DIFFERENT !! behavior and return depending on invocation mode + # (easier to recurse this way) + my $is_toplevel = $seen + ? 0 + : !! ($seen = {}) + ; - for my $group ( grep { ! $processed_groups->{$_} } @$groups ) { + my ($res_per_type, $missing_envvars); - $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"; + # breadth-first evaluation, with non-variable includes on top + for my $g (@$groups) { - croak "Requirement group '$group' is not defined" unless defined $dbic_reqs->{$group}; + croak "Invalid requirement group name '$g': only ascii alphanumerics and _ are allowed" + if $g !~ qr/ \A $groupname_re \z/x; - my $group_reqs = $dbic_reqs->{$group}{req}; + my $r = $dbic_reqs->{$g} + or croak "Requirement group '$g' is not defined"; - # sanity-check - for (keys %$group_reqs) { + # always do this check *before* the $seen check + croak "Group '$g' with variable effective_modreqs can not be specified as an 'include'" + if ( $r->{env} and ! $is_toplevel ); - $_ =~ /\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"; + next if $seen->{$g}++; - # !!!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 ); - } + my $req_type = 'static'; - # 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} || [] }) { + if ( my @e = @{$r->{env}||[]} ) { - croak "Unexpected 'env' attribute under group '$group' (only allowed in test_* groups)" - unless $group =~ /^test_/; + croak "Unexpected 'env' attribute under group '$g' (only allowed in test_* groups)" + unless $g =~ /^test_/; - croak "Unexpected *odd* list in 'env' under group '$group'" + croak "Unexpected *odd* list in 'env' under group '$g'" if @e % 2; - my @group_envnames_list; - # deconstruct the whole thing + my (@group_envnames_list, $some_envs_required, $some_required_missing); while (@e) { push @group_envnames_list, my $envname = shift @e; @@ -849,44 +909,158 @@ sub _groups_to_reqs { $some_envs_required ||= 1; - $some_envs_missing ||= ( + $some_required_missing ||= ( ! defined $ENV{$envname} or ! length $ENV{$envname} ); } - croak "None of the envvars in group '$group' declared as required, making the requirement moot" + croak "None of the envvars in group '$g' declared as required, making the requirement moot" unless $some_envs_required; - push @{$ret->{missing_envvars}}, \@group_envnames_list if $some_envs_missing; + if ($some_required_missing) { + push @{$missing_envvars->{$g}}, \@group_envnames_list; + $req_type = 'variable'; + } + } + + push @{$res_per_type->{"base_${req_type}"}}, $g; + + if (my $i = $dbic_reqs->{$g}{include}) { + $i = [ $i ] unless ref $i eq 'ARRAY'; + + croak "Malformed 'include' for group '$g': must be another existing group name or arrayref of existing group names" + unless @$i; + + push @{$res_per_type->{"incs_${req_type}"}}, @$i; + } + } + + my @ret = map { + @{ $res_per_type->{"base_${_}"} || [] }, + ( $res_per_type->{"incs_${_}"} ? __expand_includes( $res_per_type->{"incs_${_}"}, $seen ) : () ), + } qw(static variable); + + return ! $is_toplevel ? @ret : do { + my $rv = {}; + $rv->{$_} = { + idx => 1 + keys %$rv, + missing_envvars => $missing_envvars->{$_}, + } for @ret; + $rv->{$_}{user_requested} = 1 for @$groups; + $rv; + }; +} + +### Private OO API +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, $want) = @_; + + $want = [ $want || () ] + unless ref $want eq 'ARRAY'; + + croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names" + 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] ]}()" } + } - # get the reqs for includes if any - my $inc_reqs; - if (my $incs = $dbic_reqs->{$group}{include}) { - $incs = [ $incs ] unless ref $incs eq 'ARRAY'; + my $all_groups = __expand_includes($groups); - croak "Malformed 'include' for group '$group': must be another existing group name or arrayref of existing group names" - unless @$incs; + # 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) { - local $processed_groups->{$group} = 1; + croak "Group '$requesting_group' claims to augment a non-existent group '$target_group'" + unless $dbic_reqs->{$target_group}; - my $subreqs = $self->_groups_to_reqs($incs); + croak "Augmentation combined with variable effective_modreqs currently unsupported for group '$requesting_group'" + if $dbic_reqs->{$requesting_group}{env}; - croak "Includes with variable effective_modreqs not yet supported" - if $subreqs->{effective_modreqs_differ}; + croak "Augmentation of group '$target_group' with variable effective_modreqs unsupported (requested by '$requesting_group')" + if $dbic_reqs->{$target_group}{env}; - $inc_reqs = $subreqs->{modreqs}; + 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 my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { + for (keys %$req_bag) { + + $_ =~ / \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 '$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}) { + push @{$ret->{missing_envvars}}, @$e; } # assemble into the final ret for my $type ( 'modreqs', - $some_envs_missing ? () : 'effective_modreqs' + ( $ret->{missing_envvars} ? () : 'effective_modreqs' ), ) { - for my $req_bag ($group_reqs, $inc_reqs||()) { + for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { for my $mod (keys %$req_bag) { $ret->{$type}{$mod} = $req_bag->{$mod}||0 if ( @@ -901,9 +1075,8 @@ sub _groups_to_reqs { } } - $ret->{effective_modreqs_differ} ||= !!$some_envs_missing; - - $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}; } @@ -1008,13 +1181,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 icdt )]); } || {} }; \$EUMM_ARGS{PREREQ_PM} = { - \%DBIC_DEPLOY_DEPS, + \%DBIC_DEPLOY_AND_ORACLE_DEPS, \%{ \$EUMM_ARGS{PREREQ_PM} || {} }, }; @@ -1068,22 +1241,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', + ); + } + } } @@ -1274,6 +1488,31 @@ 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