Revert TempExtlib ( b46b85376 ) - new Sub::Quote shipped
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Optional / Dependencies.pm
index 56f04dc..4bb44ff 100644 (file)
@@ -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,9 +47,9 @@ my $dbic_reqs = {
   },
 
   # a common placeholder for engines with IC::DT support based off DT::F::S
-  _icdt_strptime_based => {
+  _ic_dt_strptime_based => {
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::Strptime' => '1.2',
         },
@@ -76,6 +80,7 @@ my $dbic_reqs = {
       'Class::Unload' => '0.07',
       'Time::Piece' => '0',
       'Time::Piece::MySQL' => '0',
+      'DBD::mysql' => '4.023',
     },
   },
 
@@ -94,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',
@@ -129,9 +144,20 @@ my $dbic_reqs = {
     },
   },
 
-  icdt => {
+  ic_file => {
+    req => {
+      'Path::Class' => '0.18',
+    },
+    pod => {
+      title => 'DBIx::Class::InflateColumn::File (Deprecated)',
+      desc => 'Modules required for the deprecated L<DBIx::Class::InflateColumn::File>',
+    },
+  },
+
+  ic_dt => {
     req => {
       'DateTime' => '0.55',
+      'DateTime::TimeZone::OlsonDB' => 0,
     },
     pod => {
       title => 'InflateColumn::DateTime support',
@@ -152,7 +178,6 @@ my $dbic_reqs = {
 
   cdbicompat => {
     req => {
-      'Class::Data::Inheritable' => '0',
       'Class::Trigger' => '0',
       'DBIx::ContextualFetch' => '0',
       'Clone' => '0.32',
@@ -220,6 +245,17 @@ my $dbic_reqs = {
     },
   },
 
+  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',
+    },
+  },
 
   # this is just for completeness as SQLite
   # is a core dep of DBIC for testing
@@ -232,7 +268,7 @@ my $dbic_reqs = {
       desc => 'Modules required to connect to SQLite',
     },
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::SQLite' => '0',
         },
@@ -242,10 +278,9 @@ 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_pg => {
+  _ic_dt_pg_base => {
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::Pg' => '0.16004',
         },
@@ -253,20 +288,30 @@ my $dbic_reqs = {
     },
   },
 
+  ic_dt_pg => {
+    include => [qw( ic_dt _ic_dt_pg_base )],
+  },
+
   rdbms_pg => {
-    include => 'icdt_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 => {
@@ -297,7 +342,7 @@ my $dbic_reqs = {
   },
 
   _rdbms_msaccess_common => {
-    include => '_icdt_strptime_based',
+    include => '_ic_dt_strptime_based',
   },
 
   rdbms_msaccess_odbc => {
@@ -318,10 +363,9 @@ 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 => {
+  _ic_dt_mysql_base => {
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::MySQL' => '0',
         },
@@ -329,8 +373,12 @@ my $dbic_reqs = {
     },
   },
 
+  ic_dt_mysql => {
+    include => [qw( ic_dt _ic_dt_mysql_base )],
+  },
+
   rdbms_mysql => {
-    include => 'icdt_mysql',
+    include => '_ic_dt_mysql_base',
     req => {
       'DBD::mysql' => 0,
     },
@@ -350,7 +398,7 @@ my $dbic_reqs = {
       desc => 'Modules required to connect to Oracle',
     },
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::Oracle' => '0',
         },
@@ -359,7 +407,7 @@ my $dbic_reqs = {
   },
 
   rdbms_ase => {
-    include => '_icdt_strptime_based',
+    include => '_ic_dt_strptime_based',
     req => {
       'DBD::Sybase' => 0,
     },
@@ -371,7 +419,7 @@ my $dbic_reqs = {
 
   _rdbms_db2_common => {
     augment => {
-      icdt => {
+      ic_dt => {
         req => {
           'DateTime::Format::DB2' => '0',
         },
@@ -399,7 +447,7 @@ my $dbic_reqs = {
   },
 
   rdbms_informix => {
-    include => '_icdt_strptime_based',
+    include => '_ic_dt_strptime_based',
     req => {
       'DBD::Informix' => 0,
     },
@@ -410,7 +458,7 @@ my $dbic_reqs = {
   },
 
   _rdbms_sqlanywhere_common => {
-    inclide => '_icdt_strptime_based',
+    include => '_ic_dt_strptime_based',
   },
 
   rdbms_sqlanywhere => {
@@ -433,7 +481,7 @@ my $dbic_reqs = {
   },
 
   _rdbms_firebird_common => {
-    include => '_icdt_strptime_based',
+    include => '_ic_dt_strptime_based',
   },
 
   rdbms_firebird => {
@@ -486,13 +534,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 => {
@@ -661,9 +702,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',
     },
   },
@@ -770,7 +821,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
@@ -800,7 +855,7 @@ 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
   ;
 }
@@ -815,7 +870,9 @@ sub skip_without {
   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;
+
+    BEGIN { ${^WARNING_BITS} = "" }
+
     last SKIP;
   }
 
@@ -853,7 +910,7 @@ sub __envvar_group_desc {
   join '/', @res;
 }
 
-my $groupname_re = qr/ [A-Z_a-z][0-9A-Z_a-z]* /x;
+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;
 
@@ -1085,7 +1142,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
@@ -1098,6 +1155,9 @@ sub _errorlist_for_modreqs {
     my $v = $reqs->{$m};
 
     if (! exists $req_unavailability_cache{$m}{$v} ) {
+      # masking this off is important, as it may very well be
+      # a transient error
+      local $SIG{__DIE__} if $SIG{__DIE__};
       local $@;
       eval( "require $m;" . ( $v ? "$m->VERSION(q($v))" : '' ) );
       $req_unavailability_cache{$m}{$v} = $@;
@@ -1110,6 +1170,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 {
@@ -1128,16 +1218,12 @@ sub _gen_pod {
 "\n\n---------------------------------------------------------------------\n"
   ;
 
-  # do not ask for a recent version, use 1.x API calls
-  # this *may* execute on a smoker with old perl or whatnot
-  require File::Path;
-
   (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
 
   (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
-  (my $dir = $podfn) =~ s|/[^/]+$||;
 
-  File::Path::mkpath([$dir]);
+  require DBIx::Class::_Util;
+  DBIx::Class::_Util::mkdir_p( DBIx::Class::_Util::parent_dir( $podfn ) );
 
   my $sqltver = $class->req_list_for('deploy')->{'SQL::Translator'}
     or die "Hrmm? No sqlt dep?";
@@ -1183,7 +1269,7 @@ Somewhere in your build-file (e.g. L<ExtUtils::MakeMaker>'s F<Makefile.PL>):
 
   my %DBIC_DEPLOY_AND_ORACLE_DEPS = %{ eval {
     require $class;
-    $class->req_list_for([qw( deploy rdbms_oracle icdt )]);
+    $class->req_list_for([qw( deploy rdbms_oracle ic_dt )]);
   } || {} };
 
   \$EUMM_ARGS{PREREQ_PM} = {
@@ -1457,7 +1543,7 @@ For example if some of the requirements for C<deploy> 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
@@ -1482,7 +1568,7 @@ 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, qq{ "SQL::Translator~$sqltver"};
 
   push @chunks, <<'EOC';