point out where in the docs a user is most likely to spend reading time
[dbsrgits/DBIx-Class.git] / Makefile.PL
1 use strict;
2 use warnings;
3
4 use 5.008001;
5 use inc::Module::Install 1.06;
6
7 ##
8 ## DO NOT USE THIS HACK IN YOUR DISTS!!! (it makes #toolchain sad)
9 ##
10 # get cpanX --installdeps . to behave in a checkout (most users do not expect
11 # the deps for a full test suite run, and if they do - there's MI::AutoInstall
12 # for that)
13 BEGIN {
14   $Module::Install::AUTHOR = 0 if (grep { $ENV{"PERL5_${_}_IS_RUNNING"} } (qw/CPANM CPANPLUS CPAN/) );
15   makemaker_args( NORECURS => 1 );
16 }
17
18 homepage 'http://www.dbix-class.org/';
19 resources 'IRC'         => 'irc://irc.perl.org/#dbix-class';
20 resources 'license'     => 'http://dev.perl.org/licenses/';
21 resources 'repository'  => 'https://github.com/dbsrgits/DBIx-Class';
22 resources 'MailingList' => 'http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class';
23 resources 'bugtracker'  => 'http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class';
24
25 name     'DBIx-Class';
26 perl_version '5.008001';
27 all_from 'lib/DBIx/Class.pm';
28 Meta->{values}{x_authority} = 'cpan:RIBASUSHI';
29
30 tests_recursive (qw|
31     t
32 |);
33
34 install_script (qw|
35     script/dbicadmin
36 |);
37
38 ###
39 ### DO NOT ADD OPTIONAL DEPENDENCIES HERE, EVEN AS recommends()
40 ### All of them *MUST* go to DBIx::Class::Optional::Dependencies
41 ###
42 my $runtime_requires = {
43   # FIXME - temporary workaround for RT#83143 (Path::Class)
44   'File::Spec'               => '3.30',
45
46   # FIXME - temporary, needs throwing out for something more efficient
47   'Data::Compare'            => '1.22',
48
49   # DBI itself should be capable of installation and execution in pure-perl
50   # mode. However it has never been tested yet, so consider XS for the time
51   # being
52   'DBI'                      => '1.57',
53
54   # on older versions first() leaks
55   # for the time being make it a hard dep - when we get
56   # rid of Sub::Name will revisit this (possibility is
57   # to use Devel::HideXS to force the pure-perl version
58   # or something like that)
59   'List::Util'               => '1.16',
60
61   # XS (or XS-dependent) libs
62   'Sub::Name'                => '0.04',
63
64   # pure-perl (FatPack-able) libs
65   'Class::Accessor::Grouped' => '0.10010',
66   'Class::C3::Componentised' => '1.0009',
67   'Class::Inspector'         => '1.24',
68   'Config::Any'              => '0.20',
69   'Context::Preserve'        => '0.01',
70   'Data::Dumper::Concise'    => '2.020',
71   'Data::Page'               => '2.00',
72   'Devel::GlobalDestruction' => '0.09',
73   'Hash::Merge'              => '0.12',
74   'Moo'                      => '1.000006',
75   'MRO::Compat'              => '0.12',
76   'Module::Find'             => '0.07',
77   'namespace::clean'         => '0.24',
78   'Path::Class'              => '0.18',
79   'Scope::Guard'             => '0.03',
80   'SQL::Abstract'            => '1.73',
81   'Try::Tiny'                => '0.07',
82
83   # Technically this is not a core dependency - it is only required
84   # by the MySQL codepath. However this particular version is bundled
85   # since 5.10.0 and is a pure-perl module anyway - let it slide
86   'Text::Balanced'           => '2.00',
87 };
88
89 my $build_requires = {
90   # needed for testing only, not for operation
91   # we will move away from this dep eventually, perhaps to DBD::CSV or something
92   'DBD::SQLite'              => '1.29',
93 };
94
95 my $test_requires = {
96   'File::Temp'               => '0.22',
97   'Test::Deep'               => '0.101',
98   'Test::Exception'          => '0.31',
99   'Test::Warn'               => '0.21',
100   'Test::More'               => '0.94',
101   # not sure if this is necessary at all, ask schwern some day
102   'Test::Builder'            => '0.94',
103
104   # this is already a dep of n::c, but just in case - used by t/55namespaces_cleaned.t
105   # remove and do a manual glob-collection if n::c is no longer a dep
106   'Package::Stash'           => '0.28',
107 };
108
109 # make strictures.pm happy (DO NOT LIKE, TOO MUCH XS!)
110 # (i.e. what if the .git/.svn is *not* because of DBIC?)
111 #
112 # Note - this is added as test_requires *directly*, so it gets properly
113 # excluded on META.yml cleansing
114 if (-e '.git' or -e '.svn') {
115   test_requires 'indirect'              => '0.25';
116   test_requires 'multidimensional'      => '0.008';
117   test_requires 'bareword::filehandles' => '0.003';
118 }
119
120 # if the user has this env var set and no SQLT installed, tests will fail
121 # same rationale for direct test_requires as the strictures stuff above
122 # (even though no dist will be created from this)
123 # we force this req regarless of author_deps, worst case scenario it will
124 # be specified twice
125 if ($ENV{DBICTEST_SQLT_DEPLOY}) {
126   local @INC = ('lib', @INC);
127   require DBIx::Class::Optional::Dependencies;
128   my $dep_req = DBIx::Class::Optional::Dependencies->req_list_for('deploy');
129   for (keys %$dep_req) {
130     test_requires ($_ => $dep_req->{$_})
131   }
132 }
133
134 # this is so we can order requires alphabetically
135 # copies are needed for potential author requires injection
136 my $reqs = {
137   build_requires => { %$build_requires },
138   requires => { %$runtime_requires },
139   test_requires => { %$test_requires },
140 };
141
142 # only do author-includes if not part of a `make` run
143 if ($Module::Install::AUTHOR  and ! $ENV{MAKELEVEL}) {
144   # get options here, make $args available to all snippets
145   require Getopt::Long;
146   my $getopt = Getopt::Long::Parser->new(
147     config => [qw/gnu_getopt bundling_override no_ignore_case pass_through/]
148   );
149   my $args = {
150     skip_author_deps => undef,
151   };
152   $getopt->getoptions($args, qw/
153     skip_author_deps|skip-author-deps
154   /);
155   if (@ARGV) {
156     warn "\nIgnoring unrecognized option(s): @ARGV\n\n";
157   }
158
159   # We need the MM facilities to generate the pieces for the final MM run.
160   # Just instantiate a throaway object here
161   my $mm_proto = ExtUtils::MakeMaker->new({
162     NORECURS => 1,
163     NAME => Meta->name || die 'The Module::Install metadata must be available at this point but is not - did you rearrange the Makefile.PL...?',
164   });
165
166   # Crutch for DISTBUILDING_IN_HELL
167   # Spits back a working dos2unix snippet to be used on the supplied path(s)
168   # Ironically EUMM's dos2unix is broken on win32 itself - it does
169   # not take into account the CRLF layer present on win32
170   my $crlf_fixup = sub {
171     return '' unless ($^O eq 'MSWin32' or $^O eq 'cygwin');
172     my $targets = join ', ', map { "q($_)" } @_;
173     "\t" . $mm_proto->oneliner( qq(\$ENV{PERLIO}='unix' and system( \$^X, qw( -MExtUtils::Command -e dos2unix -- ), $targets ) ) );
174   };
175
176   # we are in the process of (re)writing the makefile - some things we
177   # call below very well may fail
178   local $ENV{DBICTEST_NO_MAKEFILE_VERIFICATION} = 1;
179
180   require File::Spec;
181   # string-eval, not do(), because we need to provide the
182   # $mm_proto, $reqs and $*_requires lexicals to the included file
183   # (some includes *do* modify $reqs above)
184   for my $inc (sort glob ( File::Spec->catfile('maint', 'Makefile.PL.inc', '*') ) ) {
185     my $src = do { local (@ARGV, $/) = $inc; <> } or die $!;
186     eval "use warnings; use strict; $src" or die sprintf
187       "Failed execution of %s: %s\n",
188       $inc,
189       ($@ || $! || 'Unknown error'),
190     ;
191   }
192 }
193 else {
194   # make sure this Makefile can not be used to make a dist
195   # (without the author includes there are no meta cleanup, no sanity checks, etc)
196   postamble <<EOP;
197 create_distdir: nonauthor_stop_distdir_creation
198 nonauthor_stop_distdir_creation:
199 \t\$(NOECHO) \$(ECHO) Creation of dists in non-author mode is not allowed
200 \t\$(NOECHO) \$(FALSE)
201 EOP
202 }
203
204 # compose final req list, for alphabetical ordering
205 my %final_req;
206 for my $rtype (keys %$reqs) {
207   for my $mod (keys %{$reqs->{$rtype}} ) {
208
209     # sanity check req duplications
210     if ($final_req{$mod}) {
211       die "$mod specified as both a '$rtype' and a '$final_req{$mod}[0]'\n";
212     }
213
214     $final_req{$mod} = [ $rtype, $reqs->{$rtype}{$mod}||0 ],
215   }
216 }
217
218 # actual require
219 for my $mod (sort keys %final_req) {
220   my ($rtype, $ver) = @{$final_req{$mod}};
221   no strict 'refs';
222   $rtype->($mod, $ver);
223 }
224
225 # author-mode or not - this is where we show a list of missing deps
226 # IFF we are running interactively
227 auto_install();
228
229 WriteAll();