Clarify optdep API signatures to be explicitly single-argument

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Optional / Dependencies.pm

diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm
index aee78d0..bced829 100644 (file)
--- 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
@@ -95,6 +101,7 @@ my $dbic_reqs = {
     req => {
       'Test::Pod'                 => '1.42',
     },
+    release_testing_mandatory => 1,
   },
 
   test_podcoverage => {
@@ -102,6 +109,7 @@ my $dbic_reqs = {
       'Test::Pod::Coverage'       => '1.08',
       'Pod::Coverage'             => '0.20',
     },
+    release_testing_mandatory => 1,
   },
 
   test_whitespace => {
@@ -109,12 +117,14 @@ my $dbic_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 => {
@@ -414,7 +424,7 @@ my $dbic_reqs = {
   },
 
   test_rdbms_msaccess_odbc => {
-    include => [qw(rdbms_msaccess_odbc test_dt)],
+    include => 'rdbms_msaccess_odbc',
     env => [
       DBICTEST_MSACCESS_ODBC_DSN => 1,
       DBICTEST_MSACCESS_ODBC_USER => 0,
@@ -426,7 +436,7 @@ my $dbic_reqs = {
   },
 
   test_rdbms_msaccess_ado => {
-    include => [qw(rdbms_msaccess_ado test_dt)],
+    include => 'rdbms_msaccess_ado',
     env => [
       DBICTEST_MSACCESS_ADO_DSN => 1,
       DBICTEST_MSACCESS_ADO_USER => 0,
@@ -589,6 +599,27 @@ sub import {
       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'";
     }
@@ -610,11 +641,11 @@ sub unimport {
 # standalone library - keep the stupidity to a DBIC-secific shim!
 #
 sub req_list_for {
-  shift->_groups_to_reqs(@_)->{effective_modreqs};
+  shift->_groups_to_reqs(shift)->{effective_modreqs};
 }
 
 sub modreq_list_for {
-  shift->_groups_to_reqs(@_)->{modreqs};
+  shift->_groups_to_reqs(shift)->{modreqs};
 }
 
 sub req_group_list {
@@ -624,21 +655,21 @@ sub req_group_list {
   }
 }
 
-sub req_errorlist_for { shift->modreq_errorlist_for(@_) }  # deprecated
+sub req_errorlist_for { shift->modreq_errorlist_for(shift) }  # deprecated
 sub modreq_errorlist_for {
-  my $self = shift;
-  $self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} );
+  my ($self, $groups) = @_;
+  $self->_errorlist_for_modreqs( $self->_groups_to_reqs($groups)->{modreqs} );
 }
 
 sub req_ok_for {
-  shift->req_missing_for(@_) ? 0 : 1;
+  shift->req_missing_for(shift) ? 0 : 1;
 }
 
 sub req_missing_for {
-  my $self = shift;
+  my ($self, $groups) = @_;
 
-  my $reqs = $self->_groups_to_reqs(@_);
-  my $mods_missing = $self->modreq_missing_for(@_);
+  my $reqs = $self->_groups_to_reqs($groups);
+  my $mods_missing = $self->modreq_missing_for($groups);
 
   return '' if
     ! $mods_missing
@@ -661,9 +692,9 @@ sub req_missing_for {
 }
 
 sub modreq_missing_for {
-  my $self = shift;
+  my ($self, $groups) = @_;
 
-  my $reqs = $self->_groups_to_reqs(@_);
+  my $reqs = $self->_groups_to_reqs($groups);
   my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs})
     or return '';
 
@@ -674,7 +705,7 @@ sub modreq_missing_for {
 }
 
 sub die_unless_req_ok_for {
-  if (my $err = shift->req_missing_for(@_) ) {
+  if (my $err = shift->req_missing_for(shift) ) {
     die "Unable to continue due to missing requirements: $err\n";
   }
 }
@@ -822,6 +853,8 @@ sub _groups_to_reqs {
     $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;
@@ -1013,6 +1046,38 @@ EOC
 Even though this module is not an L<Exporter>, it recognizes several C<actions>
 supplied to its C<import> 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<RELEASE_TESTING> environment variable and
+behaves like L</-die_without> for any requirement groups marked as
+C<release_testing_mandatory>.
+
 =head2 -die_without
 
 =over