fix and regression test for RT #62642
[dbsrgits/DBIx-Class.git] / Makefile.PL
index 03939bd..5fe648b 100644 (file)
-use inc::Module::Install 0.67;
+use inc::Module::Install 1.00;
 use strict;
 use warnings;
-use POSIX ();
 
-use 5.006001; # delete this line if you want to send patches for earlier.
+use 5.008001;
+
+use FindBin;
+use lib "$FindBin::Bin/lib";
+
+# adjust ENV for $AUTHOR system() calls
+use Config;
+$ENV{PERL5LIB} = join ($Config{path_sep}, @INC);
+
+use Getopt::Long ();
+
+my $getopt = Getopt::Long::Parser->new(
+  config => [qw/gnu_getopt bundling_override no_ignore_case pass_through/]
+);
+my $args = {
+  skip_author_deps => undef,
+};
+$getopt->getoptions($args, 'skip_author_deps');
+if (@ARGV) {
+  warn "\nIgnoring unrecognized option(s): @ARGV\n\n";
+}
+
+# get cpanX --installdeps . to behave in a checkout (most users do not need
+# the deps for a full test suite run, and if they do - there's MI::AutoInstall
+# for that)
+##
+## DO NOT USE THIS HACK IN YOUR DISTS!!! (it makes #toolchain sad)
+##
+$Module::Install::AUTHOR = 0 if (grep { $ENV{"PERL5_${_}_IS_RUNNING"} } (qw/CPANM CPANPLUS CPAN/) );
+
+###
+### DO NOT ADD OPTIONAL DEPENDENCIES HERE, EVEN AS recommends()
+### All of them should go to DBIx::Class::Optional::Dependencies
+###
 
 name     'DBIx-Class';
-perl_version '5.006001';
+perl_version '5.008001';
 all_from 'lib/DBIx/Class.pm';
 
-requires 'Data::Page'                => 2.00;
-requires 'Scalar::Util'              => 0;
-requires 'SQL::Abstract'             => 1.24;
-requires 'SQL::Abstract::Limit'      => 0.13;
-requires 'Class::C3'                 => 0.20;
-requires 'Class::C3::Componentised'  => 0;
-requires 'Storable'                  => 0;
-requires 'Carp::Clan'                => 0;
-requires 'DBI'                       => 1.40;
-requires 'Module::Find'              => 0;
-requires 'Class::Inspector'          => 0;
-requires 'Class::Accessor::Grouped'  => 0.08002;
-requires 'JSON::Any'                 => 1.17;
-requires 'Scope::Guard'              => 0.03;
-requires 'Path::Class'               => 0;
-requires 'List::Util'                => 1.19;
-requires 'Sub::Name'                 => 0.04;
-requires 'namespace::clean'          => 0.09;
-
-# Perl 5.8.0 doesn't have utf8::is_utf8()
-requires 'Encode'                    => 0 if ($] <= 5.008000);  
-
-configure_requires 'DBD::SQLite'         => 1.14;
-
-test_requires 'Test::Builder'       => 0.33;
-test_requires 'Test::Warn'          => 0.11;
-test_requires 'Test::Exception'     => 0;
-test_requires 'Test::Deep'          => 0;
-
-install_script 'script/dbicadmin';
-
-tests_recursive 't';
-
-# re-build README and require CDBI modules for testing if we're in a checkout
-
-my @force_build_requires_if_author = qw(
-  DBIx::ContextualFetch
-  Class::Trigger
-  Time::Piece
-  Clone
-  Test::Pod::Coverage
-  Test::Memory::Cycle
-);
+my $build_requires = {
+  'DBD::SQLite'              => '1.29',
+};
 
-if ($Module::Install::AUTHOR) {
+my $test_requires = {
+  'File::Temp'               => '0.22',
+  'Test::Builder'            => '0.33',
+  'Test::Exception'          => '0.31',
+  'Test::More'               => '0.92',
+  'Test::Warn'               => '0.21',
+};
 
-  foreach my $module (@force_build_requires_if_author) {
-    build_requires $module;
-  }
+my $runtime_requires = {
+  'Carp::Clan'               => '6.0',
+  'Class::Accessor::Grouped' => '0.09008',
+  'Class::C3::Componentised' => '1.0005',
+  'Class::Inspector'         => '1.24',
+  'Data::Page'               => '2.00',
+  'DBI'                      => '1.609',
+  'File::Path'               => '2.07',
+  'MRO::Compat'              => '0.09',
+  'Module::Find'             => '0.06',
+  'Path::Class'              => '0.18',
+  'SQL::Abstract'            => '1.69',
+  'Sub::Name'                => '0.04',
+  'Variable::Magic'          => '0.44',
+  'Data::Dumper::Concise'    => '1.000',
+  'Scope::Guard'             => '0.03',
+  'Context::Preserve'        => '0.01',
+  'Try::Tiny'                => '0.04',
+  'namespace::clean'         => '0.14',
+  'Math::BigInt'             => '1.89',
+  'Math::Base36'             => '0.07',
+  'Config::Any'              => '0.20',
+};
 
-  system('pod2text lib/DBIx/Class.pm > README');
-}
+# this is so we can order requires alphabetically
+# copies are needed for author requires injection
+my $reqs = {
+  build_requires => { %$build_requires },
+  requires => { %$runtime_requires },
+  test_requires => { %$test_requires },
+};
 
-auto_provides;
 
-auto_install;
+# require extra modules for testing if we're in a checkout
+my $optdep_msg;
+if ($Module::Install::AUTHOR) {
+  if ($args->{skip_author_deps}) {
+    $optdep_msg = <<'EOW';
 
-# Have all prerequisites, check DBD::SQLite sanity
-if (! $ENV{DBICTEST_NO_SQLITE_CHECK} ) {
+******************************************************************************
+******************************************************************************
+***                                                                        ***
+*** IGNORING AUTHOR MODE: no optional test dependencies will be forced.    ***
+***                                                                        ***
+*** If you are using this checkout with the intention of submitting a DBIC ***
+*** patch, you are *STRONGLY ENCOURAGED* to install all dependencies, so   ***
+*** that every possible unit-test will run.                                ***
+***                                                                        ***
+******************************************************************************
+******************************************************************************
 
-  my $pid = fork();
-  if (not defined $pid) {
-      die "Unable to fork(): $!";
+EOW
   }
-  elsif (! $pid) {
-
-      # Win32 does not have real fork()s so a segfault will bring
-      # everything down. Warn about it.
-      if ($^O eq 'MSWin32') {
-        print <<'EOW';
-
-######################################################################
-#                                                                    #
-# A short stress-testing of DBD::SQLite will follow. If you have a   #
-# buggy library this might very well be the last text you will see   #
-# before the installation silently terminates. If this happens it    #
-# would mean that you are running a buggy version of DBD::SQLite     #
-# known to randomly segfault on errors. Even if you have the latest  #
-# CPAN module version, the system sqlite3 dynamic library might have #
-# been compiled against an older buggy sqlite3 dev library (oddly    #
-# DBD::SQLite will prefer the system library against the one bundled #
-# with it). You are strongly advised to resolve this issue before    #
-# proceeding.                                                        #
-#                                                                    #
-# If this happens to you (this text is the last thing you see), and  #
-# you just want to install this module without worrying about the    #
-# tests (which will almost certainly fail) - set the environment     #
-# variable DBICTEST_NO_SQLITE_CHECK to a true value and try again.   #
-#                                                                    #
-######################################################################
+  else {
+    $optdep_msg = <<'EOW';
+
+******************************************************************************
+******************************************************************************
+***                                                                        ***
+*** AUTHOR MODE: all optional test dependencies converted to hard requires ***
+***       ( to disable re-run Makefile.PL with --skip_author_deps )        ***
+***                                                                        ***
+******************************************************************************
+******************************************************************************
 
 EOW
-      }
-
-      require DBI;
-      for (1 .. 100) {
-          my $dbh;
-          $dbh = DBI->connect ('dbi:SQLite::memory:', undef, undef, {
-              AutoCommit => 1,
-              RaiseError => 0,
-              PrintError => 0,
-          })
-              or die "Unable to connect to database: $@";
-          $dbh->do ('CREATE TABLE name_with_no_columns');   # a subtle syntax error
-          $dbh->do ('COMMIT');                              # followed by commit
-          $dbh->disconnect;
-      }
-
-      exit 0;
+
+    require DBIx::Class::Optional::Dependencies;
+    $reqs->{test_requires} = {
+      %{$reqs->{test_requires}},
+      map { %$_ } (values %{DBIx::Class::Optional::Dependencies->req_group_list}),
+    };
   }
-  else {
-      eval {
-          local $SIG{ALRM} = sub { die "timeout\n" };
-          alarm 5;
-          wait();
-          alarm 0;
-      };
-      my $sig = $? & 127;
-      if ($@ || $sig == POSIX::SIGSEGV() || $sig == POSIX::SIGABRT()
-        || $sig == 7) {
-          warn (<<EOE);
-
-############################### WARNING #################################
-#                                                                       #
-# You are running a buggy version of DBD::SQLite known to randomly      #
-# segfault on errors.  Even if you have the latest CPAN module version, #
-# the sqlite3 dynamic library on this system might have been compiled   #
-# against an older buggy sqlite3 dev library (oddly DBD::SQLite will    #
-# prefer the system library against the one bundled with it). You are   #
-# strongly advised to resolve this issue before proceeding.             #
-#                                                                       #
-#########################################################################
-
-EOE
-          my $ans = prompt (
-            "The test suite of this module is almost certain to fail.\n"
-            . 'Do you really want to continue?',
-            'no',
-          );
-          exit 0 unless ($ans =~ /^y(es)?$/i);
-      }
+}
+
+# compose final req list, for alphabetical ordering
+my %final_req;
+for my $rtype (keys %$reqs) {
+  for my $mod (keys %{$reqs->{$rtype}} ) {
+
+    # sanity check req duplications
+    if ($final_req{$mod}) {
+      die "$mod specified as both a '$rtype' and a '$final_req{$mod}[0]'\n";
+    }
+
+    $final_req{$mod} = [ $rtype, $reqs->{$rtype}{$mod}||0 ],
   }
 }
 
+# actual require
+for my $mod (sort keys %final_req) {
+  my ($rtype, $ver) = @{$final_req{$mod}};
+  no strict 'refs';
+  $rtype->($mod, $ver);
+}
+
+# output twice since the deplist is > 70 lines
+warn $optdep_msg if $Module::Install::AUTHOR;
+auto_install();
+warn $optdep_msg if $Module::Install::AUTHOR;
+
+# re-create various autogenerated documentation bits
+if ($Module::Install::AUTHOR) {
+
+  print "Regenerating README\n";
+  system('pod2text lib/DBIx/Class.pm > README');
+
+  if (-f 'MANIFEST') {
+    print "Removing MANIFEST\n";
+    unlink 'MANIFEST';
+  }
+
+  print "Regenerating Optional/Dependencies.pod\n";
+  require DBIx::Class::Optional::Dependencies;
+  DBIx::Class::Optional::Dependencies->_gen_pod (Meta->version);
+
+  # FIXME Disabled due to unsolved issues, ask theorbtwo
+  #  require Module::Install::Pod::Inherit;
+  #  PodInherit();
+}
+
+
+tests_recursive (qw|
+    t
+|);
+
+# temporary(?) until I get around to fix M::I wrt xt/
+# needs Module::Install::AuthorTests
+eval {
+  recursive_author_tests (qw/xt/);
+  1;
+} || do {
+  if ($Module::Install::AUTHOR && ! $args->{skip_author_deps}) {
+    my $err = $@;
+    eval { require Module::Install::AuthorTests }
+      || die "\nYou need Module::Install::AuthorTests installed to run this Makefile.PL in author mode (or supply --skip_author_deps):\n\n$@\n";
+    die $@;
+  }
+};
+
+
+install_script (qw|
+    script/dbicadmin
+|);
+
+
+### Mangle makefile - read the comments for more info
+#
+postamble <<"EOP";
+
+# This will add an extra dep-spec for the distdir target,
+# which `make` will fold together in a first-come first-serve
+# fashion. What we do here is essentially adding extra
+# commands to execute once the distdir is assembled (via
+# create_distdir), but before control is returned to a higher
+# calling rule.
+distdir : dbicadmin_pod_inject
+
+# The pod self-injection code is in fact a hidden option in
+# dbicadmin itself
+dbicadmin_pod_inject :
+\tcd \$(DISTVNAME) && \$(ABSPERL) -Ilib script/dbicadmin --selfinject-pod
+
+# Regenerate manifest before running create_distdir.
+create_distdir : manifest
+
+EOP
+
+homepage 'http://www.dbix-class.org/';
+resources 'IRC'         => 'irc://irc.perl.org/#dbix-class';
+resources 'license'     => 'http://dev.perl.org/licenses/';
+resources 'repository'  => 'git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git';
+resources 'MailingList' => 'http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class';
+resources 'bugtracker'  => 'http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class';
+
+# Deprecated/internal modules need no exposure
+no_index directory => $_ for (qw|
+  lib/DBIx/Class/Admin
+  lib/DBIx/Class/PK/Auto
+  lib/DBIx/Class/CDBICompat
+|);
+no_index package => $_ for (qw/
+  DBIx::Class::Storage::DBIHacks
+/);
 
 WriteAll();
 
+# Re-write META.yml to _exclude_ all forced requires (we do not want to ship this)
+# We are also not using M::I::AuthorRequires as this will be an extra dep, and
+# deps in Makefile.PL suck (no autoinstall)
+if ($Module::Install::AUTHOR && ! $args->{skip_author_deps} ) {
 
-if ($Module::Install::AUTHOR) {
-  # Need to do this _after_ WriteAll else it looses track of them
-  Meta->{values}{build_requires} = [ grep {
-    my $ok = 1;
-    foreach my $module (@force_build_requires_if_author) {
-      if ($_->[0] =~ /$module/) {
-        $ok = 0;
-        last;
-      }
+  # FIXME test_requires is not yet part of META
+  my %original_build_requires = ( %$build_requires, %$test_requires );
+  my @all_build_requires = @{delete Meta->{values}{build_requires}};
+  my %removed_build_requires;
+
+  for (@all_build_requires) {
+    if ($original_build_requires{$_->[0]}) {
+      push @{Meta->{values}{build_requires}}, $_;
+    }
+    else {
+      $removed_build_requires{$_->[0]} = $_->[1]
+        unless $_->[0] eq 'ExtUtils::MakeMaker';
     }
-    $ok;
-  } @{Meta->{values}{build_requires}} ];
-
-  my @scalar_keys = Module::Install::Metadata::Meta_TupleKeys();
-  my $cr = Module::Install::Metadata->can("Meta_TupleKeys");
-  {
-    no warnings 'redefine';
-    *Module::Install::Metadata::Meta_TupleKeys = sub {
-      return $cr->(@_), 'resources';
-    };
   }
-  Meta->{values}{resources} = [ 
-    [ 'MailingList', 'http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class' ],
-    [ 'IRC', 'irc://irc.perl.org/#dbix-class' ],
-    [ 'license', 'http://dev.perl.org/licenses/' ],
-    [ 'repository', 'http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/' ],
-  ];
+
+  print "Regenerating META with author requires excluded\n";
   Meta->write;
+
+  # test that we really took things away (just in case)
+  my $meta = do { local @ARGV = 'META.yml'; local $/; <> };
+  for (keys %removed_build_requires) {
+    delete $removed_build_requires{$_}
+      unless $meta =~ /^ \s+ $_: \s+ $removed_build_requires{$_} \s* $/mx
+  }
+
+  if (keys %removed_build_requires) {
+    die join ("\n",
+      "\n\nFATAL FAIL! It looks like some author dependencies made it to the META.yml:",
+      "(most likely a broken Module::Install)\n",
+      map { "\t$_" } (keys %removed_build_requires)
+    ) . "\n\n";
+  }
 }