New namespace::clean to resolve the Package::Stash megafail
[dbsrgits/DBIx-Class.git] / Makefile.PL
index f96742b..e44489b 100644 (file)
-use inc::Module::Install 0.89;
+use inc::Module::Install 1.00;
 use strict;
 use warnings;
-use POSIX ();
 
 use 5.008001;
 
-# ****** DO NOT ADD OPTIONAL DEPENDENCIES. EVER. --mst ******
+use FindBin;
+use lib "$FindBin::Bin/lib";
+use DBIx::Class::Optional::Dependencies;
 
-name     'DBIx-Class';
-perl_version '5.008001';
-all_from 'lib/DBIx/Class.pm';
+# adjust ENV for $AUTHOR system() calls
+use Config;
+$ENV{PERL5LIB} = join ($Config{path_sep}, @INC);
 
+use Getopt::Long ();
 
-test_requires 'Test::Builder'       => '0.33';
-test_requires 'Test::Deep'          => '0';
-test_requires 'Test::Exception'     => '0';
-test_requires 'Test::More'          => '0.92';
-test_requires 'Test::Warn'          => '0.21';
-
-test_requires 'File::Temp'          => '0.22';
-
-
-# Core
-requires 'List::Util'               => '0';
-requires 'Scalar::Util'             => '0';
-requires 'Storable'                 => '0';
-
-# Dependencies (keep in alphabetical order)
-requires 'Carp::Clan'               => '6.0';
-requires 'Class::Accessor::Grouped' => '0.09002';
-requires 'Class::C3::Componentised' => '1.0005';
-requires 'Class::Inspector'         => '1.24';
-requires 'Data::Page'               => '2.00';
-requires 'DBD::SQLite'              => '1.25';
-requires 'DBI'                      => '1.609';
-requires 'JSON::Any'                => '1.18';
-requires 'MRO::Compat'              => '0.09';
-requires 'Module::Find'             => '0.06';
-requires 'Path::Class'              => '0.16';
-requires 'Scope::Guard'             => '0.03';
-requires 'SQL::Abstract'            => '1.60';
-requires 'SQL::Abstract::Limit'     => '0.13';
-requires 'Sub::Name'                => '0.04';
-requires 'Data::Dumper::Concise'    => '1.000';
-
-my %replication_requires = (
-  'Moose',                    => '0.90',
-  'MooseX::Types',            => '0.16',
-  'namespace::clean'          => '0.11',
-  'Hash::Merge',              => '0.11',
+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";
+}
 
-#************************************************************************#
-# Make *ABSOLUTELY SURE* that nothing on this list is a real require,    #
-# since every module listed in %force_requires_if_author is deleted      #
-# from the final META.yml (thus will never make it as a CPAN dependency) #
-#************************************************************************#
-my %force_requires_if_author = (
-  %replication_requires,
-
-  # when changing also adjust $DBIx::Class::Storage::DBI::minimum_sqlt_version
-  'SQL::Translator'           => '0.11002',
-
-#  'Module::Install::Pod::Inherit' => '0.01',
-
-  # when changing also adjust version in t/02pod.t
-  'Test::Pod'                 => '1.26',
-
-  # when changing also adjust version in t/03podcoverage.t
-  'Test::Pod::Coverage'       => '1.08',
-  'Pod::Coverage'             => '0.20',
-
-  # CDBI-compat related
-  'DBIx::ContextualFetch'     => '0',
-  'Class::DBI::Plugin::DeepAbstractSearch' => '0',
-  'Class::Trigger'            => '0',
-  'Time::Piece::MySQL'        => '0',
-  'Clone'                     => '0',
-  'Date::Simple'              => '3.03',
-
-  # t/52cycle.t
-  'Test::Memory::Cycle'       => '0',
-  'Devel::Cycle'              => '1.10',
-
-  # t/36datetime.t
-  # t/60core.t
-  'DateTime::Format::SQLite'  => '0',
-
-  # t/96_is_deteministic_value.t
-  'DateTime::Format::Strptime'=> '0',
-
-  # database-dependent reqs
-  #
-  $ENV{DBICTEST_PG_DSN}
-    ? (
-      'Sys::SigAction' => '0',
-      'DBD::Pg' => '2.009002',
-      'DateTime::Format::Pg' => '0',
-    ) : ()
-  ,
-
-  $ENV{DBICTEST_MYSQL_DSN}
-    ? (
-      'DateTime::Format::MySQL' => '0',
-    ) : ()
-  ,
-
-  $ENV{DBICTEST_ORA_DSN}
-    ? (
-      'DateTime::Format::Oracle' => '0',
-    ) : ()
-  ,
-
-  $ENV{DBICTEST_SYBASE_DSN}
-    ? (
-      'DateTime::Format::Sybase' => 0,
-    ) : ()
-  ,
-);
-#************************************************************************#
-# Make ABSOLUTELY SURE that nothing on the list above is a real require, #
-# since every module listed in %force_requires_if_author is deleted      #
-# from the final META.yml (thus will never make it as a CPAN dependency) #
-#************************************************************************#
+# 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
+###
 
-install_script (qw|
-    script/dbicadmin
-|);
-
-tests_recursive (qw|
-    t
-|);
+name     'DBIx-Class';
+perl_version '5.008001';
+all_from 'lib/DBIx/Class.pm';
 
-resources 'IRC'         => 'irc://irc.perl.org/#dbix-class';
-resources 'license'     => 'http://dev.perl.org/licenses/';
-resources 'repository'  => 'http://dev.catalyst.perl.org/repos/bast/DBIx-Class/';
-resources 'MailingList' => 'http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class';
+my $build_requires = {
+  # needed for testing only, not for operation
+  'DBD::SQLite'              => '1.29',
+};
+
+my $test_requires = {
+  'File::Temp'               => '0.22',
+  'Test::Builder'            => '0.33',
+  'Test::Exception'          => '0.31',
+  'Test::More'               => '0.92',
+  'Test::Warn'               => '0.21',
+};
+
+my $runtime_requires = {
+  'Carp::Clan'               => '6.0',
+  'Class::Accessor::Grouped' => '0.10002',
+  'Class::C3::Componentised' => '1.0005',
+  'Class::Inspector'         => '1.24',
+  'Config::Any'              => '0.20',
+  'Context::Preserve'        => '0.01',
+  'Data::Dumper::Concise'    => '1.000',
+  'Data::Page'               => '2.00',
+  'Hash::Merge'              => '0.12',
+  'MRO::Compat'              => '0.09',
+  'Module::Find'             => '0.06',
+  'Path::Class'              => '0.18',
+  'Scope::Guard'             => '0.03',
+  'SQL::Abstract'            => '1.72',
+  'Try::Tiny'                => '0.04',
+
+  # XS (or XS-dependent) libs
+  'DBI'                      => '1.609',
+  'namespace::clean'         => '0.20',
+  'Sub::Name'                => '0.04',
+  'Variable::Magic'          => '0.44',
+
+  # dual-life corelibs needing a specific bugfixed version
+  'File::Path'               => '2.07',
+};
+
+# 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 },
+};
+
+my %reqs_for_group = %{DBIx::Class::Optional::Dependencies->req_group_list};
+
+# exclude the rdbms_* groups which are for DBIC users
+my $opt_testdeps = {
+  map { %{$reqs_for_group{$_}} } grep { !/^rdbms_/ } keys %reqs_for_group
+};
+
+# 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';
 
-# Deprecated/internal modules need no exposure
-no_index directory => $_ for (qw|
-  lib/DBIx/Class/SQLAHacks
-  lib/DBIx/Class/PK/Auto 
-|);
-no_index package => $_ for (qw/
-  DBIx::Class::Storage::DBI::AmbiguousGlob
-  DBIx::Class::SQLAHacks DBIx::Class::Storage::DBIHacks
-/);
+******************************************************************************
+******************************************************************************
+***                                                                        ***
+*** 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.                                ***
+***                                                                        ***
+******************************************************************************
+******************************************************************************
 
-# re-build README and require extra modules for testing if we're in a checkout
+EOW
+  }
+  else {
+    $optdep_msg = <<'EOW';
 
-if ($Module::Install::AUTHOR) {
-  warn <<'EOW';
 ******************************************************************************
 ******************************************************************************
 ***                                                                        ***
 *** AUTHOR MODE: all optional test dependencies converted to hard requires ***
+***       ( to disable re-run Makefile.PL with --skip_author_deps )        ***
 ***                                                                        ***
 ******************************************************************************
 ******************************************************************************
 
 EOW
 
-  foreach my $module (sort keys %force_requires_if_author) {
-    build_requires ($module => $force_requires_if_author{$module});
+    $reqs->{test_requires} = {
+      %{$reqs->{test_requires}},
+      %$opt_testdeps
+    };
+  }
+}
+
+# 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');
@@ -174,21 +176,125 @@ EOW
     unlink 'MANIFEST';
   }
 
-#  require Module::Install::Pod::Inherit;
-#  PodInherit();
+  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();
 }
 
-auto_install();
+
+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)
-if ($Module::Install::AUTHOR) {
+# Re-write META.yml to _exclude_ all forced build-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 still suck
+# Also always test the result so we stop shipping borked dependency lists to CPAN
 
-  Meta->{values}{build_requires} = [ grep 
-    { not exists $force_requires_if_author{$_->[0]} }
-    ( @{Meta->{values}{build_requires}} )
-  ];
+# 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';
+  }
+}
 
+# Rewrite only in author mode, the original META should not contain anything anyway
+# if we executed as non-author
+if ($Module::Install::AUTHOR && keys %removed_build_requires) {
+  print "Regenerating META with author requires excluded\n";
   Meta->write;
 }
+
+# test that we really took things away (just in case, happened twice somehow)
+if (! -f 'META.yml') {
+  warn "No META.yml generated?! aborting...\n";
+  exit 1;
+}
+my $meta = do { local @ARGV = 'META.yml'; local $/; <> };
+
+# this is safe as there is a fatal check earlier to make sure $opt_testdeps does
+# not contain any real dependencies
+my @illegal_leftovers = grep
+  { $meta =~ /^ \s+ \Q$_\E \: \s+ /mx }
+  ( sort keys %$opt_testdeps )
+;
+
+if (@illegal_leftovers) {
+  die join ("\n",
+    "\n\nFATAL FAIL! It looks like some author dependencies made it to the META.yml:\n",
+    map { "\t$_" } @illegal_leftovers
+  ) . "\n\n";
+}