[dbsrgits/DBIx-Class.git] / Makefile.PL

use strict;
use warnings;

use 5.008001;
use inc::Module::Install 1.06;
BEGIN { makemaker_args( NORECURS => 1 ) } # needs to happen early for old EUMM

##
## DO NOT USE THIS HACK IN YOUR DISTS!!! (it makes #toolchain sad)
##
# get cpanX --installdeps . to behave in a checkout (most users do not expect
# the deps for a full test suite run, and if they do - there's MI::AutoInstall
# for that)
BEGIN {
  $Module::Install::AUTHOR = 0 if (grep { $ENV{"PERL5_${_}_IS_RUNNING"} } (qw/CPANM CPANPLUS CPAN/) );
}

##
## TEMPORARY (and non-portable)
## Get trial SQLA
##
BEGIN {
  my $target_libdir = 'lib/DBIx/Class/_TempExtlib';

  if ( ($Module::Install::AUTHOR or $ENV{TRAVIS}) and ! $ENV{MAKELEVEL} ) {

    `rm -rf $target_libdir`;
    `mkdir $target_libdir`;
    for (
      [ 'SQL-Abstract' => 'master' ],
    ) {
      my $tdir = "/tmp/dbictemplib/$_->[0]/";

      `rm -rf $tdir`;

      `GIT_SSH=maint/careless_ssh.bash git clone --bare --quiet --branch=$_->[1] --depth=1 git://git.shadowcat.co.uk/dbsrgits/$_->[0] $tdir`;
      printf "\nIncluding %s git rev %s\n",
        $_->[0],
        scalar `GIT_DIR=$tdir git rev-parse $_->[1]`,
      ;
      `git archive --format=tar --remote=file://$tdir $_->[1] lib/ | tar --strip-components=1 -xC $target_libdir`;

      #`rm -rf $tdir`;
    }

    unshift @INC, $target_libdir;

    no_index directory => $target_libdir;
  }
}

name         'DBIx-Class';
version_from 'lib/DBIx/Class.pm';
perl_version '5.008001';

###
### DO NOT ADD OPTIONAL DEPENDENCIES HERE, EVEN AS recommends()
### All of them *MUST* go to DBIx::Class::Optional::Dependencies
###
my $runtime_requires = {
  # FIXME - temporary, needs throwing out for something more efficient
  'Data::Compare'            => '1.22',

  # DBI itself should be capable of installation and execution in pure-perl
  # mode. However it has never been tested yet, so consider XS for the time
  # being
###
### IMPORTANT - do not raise this dependency
### even though many bugfixes are present in newer versions, the general DBIC
### rule is to bend over backwards for available DBI versions (given upgrading
### them is often *not* easy or even possible)
###
  'DBI'                      => '1.57',

  # on older versions first() leaks
  # for the time being make it a hard dep - when we get
  # rid of Sub::Name will revisit this (possibility is
  # to use Devel::HideXS to force the pure-perl version
  # or something like that)
  'List::Util'               => '1.16',

  # XS (or XS-dependent) libs
  'Sub::Name'                => '0.04',

  # pure-perl (FatPack-able) libs
  'Class::Accessor::Grouped' => '0.10010',
  'Class::C3::Componentised' => '1.0009',
  'Class::Inspector'         => '1.24',
  'Config::Any'              => '0.20',
  'Context::Preserve'        => '0.01',
  'Data::Dumper::Concise'    => '2.020',
  'Data::Page'               => '2.00',
  'Devel::GlobalDestruction' => '0.09',
  'Hash::Merge'              => '0.12',
  'Moo'                      => '1.004005',
  'MRO::Compat'              => '0.12',
  'Module::Find'             => '0.07',
  'namespace::clean'         => '0.24',
  'Path::Class'              => '0.18',
  'Scope::Guard'             => '0.03',
  'SQL::Abstract'            => '1.78',
  'Try::Tiny'                => '0.07',

  # Technically this is not a core dependency - it is only required
  # by the MySQL codepath. However this particular version is bundled
  # since 5.10.0 and is a pure-perl module anyway - let it slide
  'Text::Balanced'           => '2.00',
};

my $build_requires = {
};

my $test_requires = {
  'File::Temp'               => '0.22',
  'Test::Deep'               => '0.101',
  'Test::Exception'          => '0.31',
  'Test::Warn'               => '0.21',
  'Test::More'               => '0.94',

  # needed for testing only, not for operation
  # we will move away from this dep eventually, perhaps to DBD::CSV or something
###
### IMPORTANT - do not raise this dependency
### even though many bugfixes are present in newer versions, the general DBIC
### rule is to bend over backwards for available DBDs (given upgrading them is
### often *not* easy or even possible)
###
  'DBD::SQLite'              => '1.29',

  # this is already a dep of n::c, but just in case - used by t/55namespaces_cleaned.t
  # remove and do a manual glob-collection if n::c is no longer a dep
  'Package::Stash'           => '0.28',
};

# if the user has this env var set and no SQLT installed, tests will fail
# Note - this is added as test_requires *directly*, so it gets properly
# excluded on META.yml cleansing (even though no dist can be created from this)
# we force this req regarless of author_deps, worst case scenario it will
# be specified twice
#
# also note that we *do* set dynamic_config => 0, as this is the only thing
# that we determine dynamically, and in all fairness if someone sets the
# envvar *and* is not running a full Makefile/make/maketest cycle - they get
# to keep the pieces
if ($ENV{DBICTEST_SQLT_DEPLOY}) {
  local @INC = ('lib', @INC);
  require DBIx::Class::Optional::Dependencies;
  my $dep_req = DBIx::Class::Optional::Dependencies->req_list_for('deploy');
  for (keys %$dep_req) {
    test_requires ($_ => $dep_req->{$_})
  }
}

tests_recursive (qw|
    t
|);

install_script (qw|
    script/dbicadmin
|);

# this is so we can order requires alphabetically
# copies are needed for potential author requires injection
my $reqs = {
  build_requires => { %$build_requires },
  requires => { %$runtime_requires },
  test_requires => { %$test_requires },
};

# only do author-includes if not part of a `make` run
if ($Module::Install::AUTHOR  and ! $ENV{MAKELEVEL}) {
  invoke_author_mode()
}
else {
  # make sure this Makefile can not be used to make a dist
  # (without the author includes there are no meta cleanup, no sanity checks, etc)
  postamble <<EOP;
create_distdir: nonauthor_stop_distdir_creation
nonauthor_stop_distdir_creation:
\t\$(NOECHO) \$(ECHO) Creation of dists in non-author mode is not allowed
\t\$(NOECHO) \$(FALSE)
EOP
}

# 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
    die "$mod specified as both a '$rtype' and a '$final_req{$mod}[0]'\n"
      if $final_req{$mod};

    $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);
}

# author-mode or not - this is where we show a list of missing deps
# IFF we are running interactively
auto_install();

WriteAll();

exit 0;


###
### Nothing user-serviceable beyond this point
### (none of this executes on regular install)
###


# needs to be here to keep 5.8 string eval happy
# (the include of Makefile.PL.inc loop)
my $mm_proto;

sub invoke_author_mode {
  # get options here, make $args available to all snippets
  require 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, qw/
    skip_author_deps|skip-author-deps
  /);
  if (@ARGV) {
    warn "\nIgnoring unrecognized option(s): @ARGV\n\n";
  }

  # We need the MM facilities to generate the pieces for the final MM run.
  # Just instantiate a throaway object here
  #
  # Also EUMM and MI disagree on what is the format of Meta->name, just
  # punt here until a new M::I is shipped (if at all)
  my $name = Meta->name || die 'The Module::Install metadata must be available at this point but is not - did you rearrange the Makefile.PL...?';
  $name =~ s/\-/::/g;
  $mm_proto = ExtUtils::MakeMaker->new({
    NORECURS => 1,
    NAME => $name,
  });

  # Crutch for DISTBUILDING_IN_HELL
  # Spits back a working dos2unix snippet to be used on the supplied path(s)
  # Ironically EUMM's dos2unix is broken on win32 itself - it does
  # not take into account the CRLF layer present on win32
  my $crlf_fixup = sub {
    return '' unless ($^O eq 'MSWin32' or $^O eq 'cygwin');
    my $targets = join ', ', map { "q($_)" } @_;
    "\t" . $mm_proto->oneliner( qq(\$ENV{PERLIO}='unix' and system( \$^X, qw( -MExtUtils::Command -e dos2unix -- ), $targets ) ) );
  };

  # we are in the process of (re)writing the makefile - some things we
  # call below very well may fail
  local $ENV{DBICTEST_NO_MAKEFILE_VERIFICATION} = 1;

  require File::Spec;
  # string-eval, not do(), because we need to provide the
  # $mm_proto, $reqs and $*_requires lexicals to the included file
  # (some includes *do* modify $reqs above)
  for my $inc (sort glob ( File::Spec->catfile('maint', 'Makefile.PL.inc', '*') ) ) {
    my $src = do { local (@ARGV, $/) = $inc; <> } or die $!;
    eval "use warnings; use strict; $src" or die sprintf
      "Failed execution of %s: %s\n",
      $inc,
      ($@ || $! || 'Unknown error'),
    ;
  }
}
Commit	Line	Data
fe650234	1	use strict;
	2	use warnings;
	3
55087b99	4	use 5.008001;
6c96d73f	5	use inc::Module::Install 1.06;
90706de1	6	BEGIN { makemaker_args( NORECURS => 1 ) } # needs to happen early for old EUMM
ce4c07df	7
d1dc7a98	8	##
	9	## DO NOT USE THIS HACK IN YOUR DISTS!!! (it makes #toolchain sad)
	10	##
fc4b0448	11	# get cpanX --installdeps . to behave in a checkout (most users do not expect
	12	# the deps for a full test suite run, and if they do - there's MI::AutoInstall
	13	# for that)
	14	BEGIN {
	15	$Module::Install::AUTHOR = 0 if (grep { $ENV{"PERL5_${_}_IS_RUNNING"} } (qw/CPANM CPANPLUS CPAN/) );
	16	}
4b5544ad	17
d0435d75	18	##
	19	## TEMPORARY (and non-portable)
	20	## Get trial SQLA
	21	##
	22	BEGIN {
	23	my $target_libdir = 'lib/DBIx/Class/_TempExtlib';
	24
	25	if ( ($Module::Install::AUTHOR or $ENV{TRAVIS}) and ! $ENV{MAKELEVEL} ) {
	26
	27	`rm -rf $target_libdir`;
	28	`mkdir $target_libdir`;
	29	for (
	30	[ 'SQL-Abstract' => 'master' ],
	31	) {
	32	my $tdir = "/tmp/dbictemplib/$_->[0]/";
	33
	34	`rm -rf $tdir`;
	35
	36	`GIT_SSH=maint/careless_ssh.bash git clone --bare --quiet --branch=$_->[1] --depth=1 git://git.shadowcat.co.uk/dbsrgits/$_->[0] $tdir`;
	37	printf "\nIncluding %s git rev %s\n",
	38	$_->[0],
	39	scalar `GIT_DIR=$tdir git rev-parse $_->[1]`,
	40	;
	41	`git archive --format=tar --remote=file://$tdir $_->[1] lib/ \| tar --strip-components=1 -xC $target_libdir`;
	42
	43	#`rm -rf $tdir`;
	44	}
	45
	46	unshift @INC, $target_libdir;
	47
	48	no_index directory => $target_libdir;
	49	}
	50	}
	51
20e84e74	52	name 'DBIx-Class';
20e84e74	53	version_from 'lib/DBIx/Class.pm';
b50d0dd3	54	perl_version '5.008001';
90cfe42b	55
fc4b0448	56	###
	57	### DO NOT ADD OPTIONAL DEPENDENCIES HERE, EVEN AS recommends()
	58	### All of them MUST go to DBIx::Class::Optional::Dependencies
	59	###
8057ed01	60	my $runtime_requires = {
fc4b0448	61	# FIXME - temporary, needs throwing out for something more efficient
	62	'Data::Compare' => '1.22',
	63
	64	# DBI itself should be capable of installation and execution in pure-perl
	65	# mode. However it has never been tested yet, so consider XS for the time
	66	# being
5342cd1a	67	###
	68	### IMPORTANT - do not raise this dependency
	69	### even though many bugfixes are present in newer versions, the general DBIC
	70	### rule is to bend over backwards for available DBI versions (given upgrading
	71	### them is often not easy or even possible)
	72	###
fc4b0448	73	'DBI' => '1.57',
fc4b0448	74
a08e7b00	75	# on older versions first() leaks
	76	# for the time being make it a hard dep - when we get
	77	# rid of Sub::Name will revisit this (possibility is
	78	# to use Devel::HideXS to force the pure-perl version
	79	# or something like that)
	80	'List::Util' => '1.16',
	81
fc4b0448	82	# XS (or XS-dependent) libs
	83	'Sub::Name' => '0.04',
	84
	85	# pure-perl (FatPack-able) libs
f390d66d	86	'Class::Accessor::Grouped' => '0.10010',
9c1700e3	87	'Class::C3::Componentised' => '1.0009',
8057ed01	88	'Class::Inspector' => '1.24',
79680fc0	89	'Config::Any' => '0.20',
79680fc0	90	'Context::Preserve' => '0.01',
2b8cc2f2	91	'Data::Dumper::Concise' => '2.020',
8057ed01	92	'Data::Page' => '2.00',
90fb8e19	93	'Devel::GlobalDestruction' => '0.09',
b8d22f13	94	'Hash::Merge' => '0.12',
c480ff4a	95	'Moo' => '1.004005',
90fb8e19	96	'MRO::Compat' => '0.12',
	97	'Module::Find' => '0.07',
	98	'namespace::clean' => '0.24',
f4d7449c	99	'Path::Class' => '0.18',
b7b18f32	100	'Scope::Guard' => '0.03',
d0435d75	101	'SQL::Abstract' => '1.78',
90fb8e19	102	'Try::Tiny' => '0.07',
45150bc4	103
	104	# Technically this is not a core dependency - it is only required
	105	# by the MySQL codepath. However this particular version is bundled
	106	# since 5.10.0 and is a pure-perl module anyway - let it slide
	107	'Text::Balanced' => '2.00',
fc4b0448	108	};
cd122820	109
fc4b0448	110	my $build_requires = {
7850f06e	111	};
	112
	113	my $test_requires = {
	114	'File::Temp' => '0.22',
	115	'Test::Deep' => '0.101',
	116	'Test::Exception' => '0.31',
	117	'Test::Warn' => '0.21',
	118	'Test::More' => '0.94',
	119
fc4b0448	120	# needed for testing only, not for operation
fc4b0448	121	# we will move away from this dep eventually, perhaps to DBD::CSV or something
5342cd1a	122	###
	123	### IMPORTANT - do not raise this dependency
	124	### even though many bugfixes are present in newer versions, the general DBIC
	125	### rule is to bend over backwards for available DBDs (given upgrading them is
	126	### often not easy or even possible)
	127	###
fc4b0448	128	'DBD::SQLite' => '1.29',
fc4b0448	129
	130	# this is already a dep of n::c, but just in case - used by t/55namespaces_cleaned.t
	131	# remove and do a manual glob-collection if n::c is no longer a dep
	132	'Package::Stash' => '0.28',
	133	};
bb7950c0	134
20beaf5f	135	# if the user has this env var set and no SQLT installed, tests will fail
5b0543d6	136	# Note - this is added as test_requires directly, so it gets properly
5b0543d6	137	# excluded on META.yml cleansing (even though no dist can be created from this)
20beaf5f	138	# we force this req regarless of author_deps, worst case scenario it will
20beaf5f	139	# be specified twice
5b0543d6	140	#
	141	# also note that we do set dynamic_config => 0, as this is the only thing
	142	# that we determine dynamically, and in all fairness if someone sets the
	143	# envvar and is not running a full Makefile/make/maketest cycle - they get
	144	# to keep the pieces
20beaf5f	145	if ($ENV{DBICTEST_SQLT_DEPLOY}) {
	146	local @INC = ('lib', @INC);
	147	require DBIx::Class::Optional::Dependencies;
	148	my $dep_req = DBIx::Class::Optional::Dependencies->req_list_for('deploy');
	149	for (keys %$dep_req) {
	150	test_requires ($_ => $dep_req->{$_})
	151	}
	152	}
	153
20e84e74	154	tests_recursive (qw\|
	155	t
	156	\|);
	157
	158	install_script (qw\|
	159	script/dbicadmin
	160	\|);
	161
8057ed01	162	# this is so we can order requires alphabetically
fc4b0448	163	# copies are needed for potential author requires injection
8057ed01	164	my $reqs = {
	165	build_requires => { %$build_requires },
	166	requires => { %$runtime_requires },
	167	test_requires => { %$test_requires },
	168	};
3a4251e2	169
c78f9f5b	170	# only do author-includes if not part of a `make` run
c78f9f5b	171	if ($Module::Install::AUTHOR and ! $ENV{MAKELEVEL}) {
ffc55e52	172	invoke_author_mode()
	173	}
	174	else {
	175	# make sure this Makefile can not be used to make a dist
	176	# (without the author includes there are no meta cleanup, no sanity checks, etc)
	177	postamble <<EOP;
	178	create_distdir: nonauthor_stop_distdir_creation
	179	nonauthor_stop_distdir_creation:
	180	\t\$(NOECHO) \$(ECHO) Creation of dists in non-author mode is not allowed
	181	\t\$(NOECHO) \$(FALSE)
	182	EOP
	183	}
	184
	185	# compose final req list, for alphabetical ordering
	186	my %final_req;
	187	for my $rtype (keys %$reqs) {
	188	for my $mod (keys %{$reqs->{$rtype}} ) {
	189
	190	# sanity check req duplications
	191	die "$mod specified as both a '$rtype' and a '$final_req{$mod}[0]'\n"
	192	if $final_req{$mod};
	193
	194	$final_req{$mod} = [ $rtype, $reqs->{$rtype}{$mod}\|\|0 ],
	195	}
	196	}
	197
	198	# actual require
	199	for my $mod (sort keys %final_req) {
	200	my ($rtype, $ver) = @{$final_req{$mod}};
	201	no strict 'refs';
	202	$rtype->($mod, $ver);
	203	}
	204
	205	# author-mode or not - this is where we show a list of missing deps
	206	# IFF we are running interactively
	207	auto_install();
	208
	209	WriteAll();
	210
	211	exit 0;
	212
20e84e74	213
	214	###
	215	### Nothing user-serviceable beyond this point
	216	### (none of this executes on regular install)
	217	###
	218
	219
ffc55e52	220	# needs to be here to keep 5.8 string eval happy
	221	# (the include of Makefile.PL.inc loop)
	222	my $mm_proto;
	223
	224	sub invoke_author_mode {
fc4b0448	225	# get options here, make $args available to all snippets
	226	require Getopt::Long;
	227	my $getopt = Getopt::Long::Parser->new(
	228	config => [qw/gnu_getopt bundling_override no_ignore_case pass_through/]
	229	);
	230	my $args = {
	231	skip_author_deps => undef,
	232	};
df65d4da	233	$getopt->getoptions($args, qw/
	234	skip_author_deps\|skip-author-deps
	235	/);
fc4b0448	236	if (@ARGV) {
fc4b0448	237	warn "\nIgnoring unrecognized option(s): @ARGV\n\n";
0424d17a	238	}
8057ed01	239
3ba58fe4	240	# We need the MM facilities to generate the pieces for the final MM run.
3ba58fe4	241	# Just instantiate a throaway object here
6b3e3947	242	#
	243	# Also EUMM and MI disagree on what is the format of Meta->name, just
	244	# punt here until a new M::I is shipped (if at all)
	245	my $name = Meta->name \|\| die 'The Module::Install metadata must be available at this point but is not - did you rearrange the Makefile.PL...?';
	246	$name =~ s/\-/::/g;
ffc55e52	247	$mm_proto = ExtUtils::MakeMaker->new({
3054407e	248	NORECURS => 1,
6b3e3947	249	NAME => $name,
3ba58fe4	250	});
3ba58fe4	251
ffce4b65	252	# Crutch for DISTBUILDING_IN_HELL
	253	# Spits back a working dos2unix snippet to be used on the supplied path(s)
	254	# Ironically EUMM's dos2unix is broken on win32 itself - it does
	255	# not take into account the CRLF layer present on win32
	256	my $crlf_fixup = sub {
	257	return '' unless ($^O eq 'MSWin32' or $^O eq 'cygwin');
	258	my $targets = join ', ', map { "q($_)" } @_;
	259	"\t" . $mm_proto->oneliner( qq(\$ENV{PERLIO}='unix' and system( \$^X, qw( -MExtUtils::Command -e dos2unix -- ), $targets ) ) );
	260	};
	261
e01862e4	262	# we are in the process of (re)writing the makefile - some things we
	263	# call below very well may fail
	264	local $ENV{DBICTEST_NO_MAKEFILE_VERIFICATION} = 1;
	265
fc4b0448	266	require File::Spec;
fc4b0448	267	# string-eval, not do(), because we need to provide the
3ba58fe4	268	# $mm_proto, $reqs and $*_requires lexicals to the included file
fc4b0448	269	# (some includes do modify $reqs above)
8baa2122	270	for my $inc (sort glob ( File::Spec->catfile('maint', 'Makefile.PL.inc', '*') ) ) {
	271	my $src = do { local (@ARGV, $/) = $inc; <> } or die $!;
	272	eval "use warnings; use strict; $src" or die sprintf
	273	"Failed execution of %s: %s\n",
	274	$inc,
	275	($@ \|\| $! \|\| 'Unknown error'),
	276	;
0424d17a	277	}
8057ed01	278	}