Cleanup that namespacing mess
[dbsrgits/DBIx-Class.git] / Makefile.PL
1 use inc::Module::Install 1.00;
2 use strict;
3 use warnings;
4
5 use 5.008001;
6
7 use FindBin;
8 use lib "$FindBin::Bin/lib";
9 use DBIx::Class::Optional::Dependencies;
10
11 # adjust ENV for $AUTHOR system() calls
12 use Config;
13 $ENV{PERL5LIB} = join ($Config{path_sep}, @INC);
14
15 use Getopt::Long ();
16
17 my $getopt = Getopt::Long::Parser->new(
18   config => [qw/gnu_getopt bundling_override no_ignore_case pass_through/]
19 );
20 my $args = {
21   skip_author_deps => undef,
22 };
23 $getopt->getoptions($args, 'skip_author_deps');
24 if (@ARGV) {
25   warn "\nIgnoring unrecognized option(s): @ARGV\n\n";
26 }
27
28 # get cpanX --installdeps . to behave in a checkout (most users do not need
29 # the deps for a full test suite run, and if they do - there's MI::AutoInstall
30 # for that)
31 ##
32 ## DO NOT USE THIS HACK IN YOUR DISTS!!! (it makes #toolchain sad)
33 ##
34 $Module::Install::AUTHOR = 0 if (grep { $ENV{"PERL5_${_}_IS_RUNNING"} } (qw/CPANM CPANPLUS CPAN/) );
35
36 ###
37 ### DO NOT ADD OPTIONAL DEPENDENCIES HERE, EVEN AS recommends()
38 ### All of them should go to DBIx::Class::Optional::Dependencies
39 ###
40
41 name     'DBIx-Class';
42 perl_version '5.008001';
43 all_from 'lib/DBIx/Class.pm';
44
45 my $build_requires = {
46   # needed for testing only, not for operation
47   'DBD::SQLite'              => '1.29',
48 };
49
50 my $test_requires = {
51   'File::Temp'               => '0.22',
52   'Test::Builder'            => '0.33',
53   'Test::Exception'          => '0.31',
54   'Test::More'               => '0.92',
55   'Test::Warn'               => '0.21',
56 };
57
58 my $runtime_requires = {
59   'Carp::Clan'               => '6.0',
60   'Class::Accessor::Grouped' => '0.10002',
61   'Class::C3::Componentised' => '1.0009',
62   'Class::Inspector'         => '1.24',
63   'Config::Any'              => '0.20',
64   'Context::Preserve'        => '0.01',
65   'Data::Dumper::Concise'    => '2.020',
66   'Data::Page'               => '2.00',
67   'Hash::Merge'              => '0.12',
68   'MRO::Compat'              => '0.09',
69   'Module::Find'             => '0.06',
70   'Path::Class'              => '0.18',
71   'Scope::Guard'             => '0.03',
72   'SQL::Abstract'            => '1.72',
73   'Try::Tiny'                => '0.04',
74
75   # XS (or XS-dependent) libs
76   'DBI'                      => '1.609',
77   'namespace::clean'         => '0.20',
78   'Sub::Name'                => '0.04',
79   'Variable::Magic'          => '0.44',
80
81   # dual-life corelibs needing a specific bugfixed version
82   'File::Path'               => '2.07',
83 };
84
85 # this is so we can order requires alphabetically
86 # copies are needed for author requires injection
87 my $reqs = {
88   build_requires => { %$build_requires },
89   requires => { %$runtime_requires },
90   test_requires => { %$test_requires },
91 };
92
93 my %reqs_for_group = %{DBIx::Class::Optional::Dependencies->req_group_list};
94
95 # exclude the rdbms_* groups which are for DBIC users
96 my $opt_testdeps = {
97   map { %{$reqs_for_group{$_}} } grep { !/^rdbms_/ } keys %reqs_for_group
98 };
99
100 # require extra modules for testing if we're in a checkout
101 my $optdep_msg;
102 if ($Module::Install::AUTHOR) {
103   if ($args->{skip_author_deps}) {
104     $optdep_msg = <<'EOW';
105
106 ******************************************************************************
107 ******************************************************************************
108 ***                                                                        ***
109 *** IGNORING AUTHOR MODE: no optional test dependencies will be forced.    ***
110 ***                                                                        ***
111 *** If you are using this checkout with the intention of submitting a DBIC ***
112 *** patch, you are *STRONGLY ENCOURAGED* to install all dependencies, so   ***
113 *** that every possible unit-test will run.                                ***
114 ***                                                                        ***
115 ******************************************************************************
116 ******************************************************************************
117
118 EOW
119   }
120   else {
121     $optdep_msg = <<'EOW';
122
123 ******************************************************************************
124 ******************************************************************************
125 ***                                                                        ***
126 *** AUTHOR MODE: all optional test dependencies converted to hard requires ***
127 ***       ( to disable re-run Makefile.PL with --skip_author_deps )        ***
128 ***                                                                        ***
129 ******************************************************************************
130 ******************************************************************************
131
132 EOW
133
134     $reqs->{test_requires} = {
135       %{$reqs->{test_requires}},
136       %$opt_testdeps
137     };
138   }
139 }
140
141 # compose final req list, for alphabetical ordering
142 my %final_req;
143 for my $rtype (keys %$reqs) {
144   for my $mod (keys %{$reqs->{$rtype}} ) {
145
146     # sanity check req duplications
147     if ($final_req{$mod}) {
148       die "$mod specified as both a '$rtype' and a '$final_req{$mod}[0]'\n";
149     }
150
151     $final_req{$mod} = [ $rtype, $reqs->{$rtype}{$mod}||0 ],
152   }
153 }
154
155 # actual require
156 for my $mod (sort keys %final_req) {
157   my ($rtype, $ver) = @{$final_req{$mod}};
158   no strict 'refs';
159   $rtype->($mod, $ver);
160 }
161
162 # output twice since the deplist is > 70 lines
163 warn $optdep_msg if $Module::Install::AUTHOR;
164 auto_install();
165 warn $optdep_msg if $Module::Install::AUTHOR;
166
167
168 # re-create various autogenerated documentation bits
169 if ($Module::Install::AUTHOR) {
170
171   print "Regenerating README\n";
172   system('pod2text lib/DBIx/Class.pm > README');
173
174   if (-f 'MANIFEST') {
175     print "Removing MANIFEST\n";
176     unlink 'MANIFEST';
177   }
178
179   print "Regenerating Optional/Dependencies.pod\n";
180   require DBIx::Class::Optional::Dependencies;
181   DBIx::Class::Optional::Dependencies->_gen_pod (Meta->version);
182
183   # FIXME Disabled due to unsolved issues, ask theorbtwo
184   #  require Module::Install::Pod::Inherit;
185   #  PodInherit();
186 }
187
188
189 tests_recursive (qw|
190     t
191 |);
192
193 # temporary(?) until I get around to fix M::I wrt xt/
194 # needs Module::Install::AuthorTests
195 eval {
196   # this should not be necessary since the autoloader is supposed
197   # to work, but there were reports of it failing
198   require Module::Install::AuthorTests;
199   recursive_author_tests (qw/xt/);
200   1;
201 } || do {
202   if ($Module::Install::AUTHOR && ! $args->{skip_author_deps}) {
203     my $err = $@;
204
205     # better error message in case of missing dep
206     eval { require Module::Install::AuthorTests }
207       || die "\nYou need Module::Install::AuthorTests installed to run this Makefile.PL in author mode (or supply --skip_author_deps):\n\n$@\n";
208
209     die $err;
210   }
211 };
212
213
214 install_script (qw|
215     script/dbicadmin
216 |);
217
218
219 ### Mangle makefile - read the comments for more info
220 #
221 postamble <<"EOP";
222
223 # This will add an extra dep-spec for the distdir target,
224 # which `make` will fold together in a first-come first-serve
225 # fashion. What we do here is essentially adding extra
226 # commands to execute once the distdir is assembled (via
227 # create_distdir), but before control is returned to a higher
228 # calling rule.
229 distdir : dbicadmin_pod_inject
230
231 # The pod self-injection code is in fact a hidden option in
232 # dbicadmin itself
233 dbicadmin_pod_inject :
234 \tcd \$(DISTVNAME) && \$(ABSPERL) -Ilib script/dbicadmin --selfinject-pod
235
236 # Regenerate manifest before running create_distdir.
237 create_distdir : manifest
238
239 EOP
240
241 homepage 'http://www.dbix-class.org/';
242 resources 'IRC'         => 'irc://irc.perl.org/#dbix-class';
243 resources 'license'     => 'http://dev.perl.org/licenses/';
244 resources 'repository'  => 'git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git';
245 resources 'MailingList' => 'http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class';
246 resources 'bugtracker'  => 'http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class';
247
248 # Deprecated/internal modules need no exposure
249 no_index directory => $_ for (qw|
250   lib/DBIx/Class/Admin
251   lib/DBIx/Class/PK/Auto
252   lib/DBIx/Class/CDBICompat
253 |);
254 no_index package => $_ for (qw/
255   DBIx::Class::Storage::DBIHacks
256 /);
257
258 WriteAll();
259
260 # Re-write META.yml to _exclude_ all forced build-requires (we do not want to ship
261 # this) We are also not using M::I::AuthorRequires as this will be an extra dep,
262 # and deps in Makefile.PL still suck
263 # Also always test the result so we stop shipping borked dependency lists to CPAN
264
265 # FIXME test_requires is not yet part of META
266 my %original_build_requires = ( %$build_requires, %$test_requires );
267 my @all_build_requires = @{delete Meta->{values}{build_requires}};
268 my %removed_build_requires;
269
270 for (@all_build_requires) {
271   if ($original_build_requires{$_->[0]}) {
272     push @{Meta->{values}{build_requires}}, $_;
273   }
274   else {
275     $removed_build_requires{$_->[0]} = $_->[1]
276       unless $_->[0] eq 'ExtUtils::MakeMaker';
277   }
278 }
279
280 # Rewrite only in author mode, the original META should not contain anything anyway
281 # if we executed as non-author
282 if ($Module::Install::AUTHOR && keys %removed_build_requires) {
283   print "Regenerating META with author requires excluded\n";
284   Meta->write;
285 }
286
287 # test that we really took things away (just in case, happened twice somehow)
288 if (! -f 'META.yml') {
289   warn "No META.yml generated?! aborting...\n";
290   exit 1;
291 }
292 my $meta = do { local @ARGV = 'META.yml'; local $/; <> };
293
294 # this is safe as there is a fatal check earlier to make sure $opt_testdeps does
295 # not contain any real dependencies
296 my @illegal_leftovers = grep
297   { $meta =~ /^ \s+ \Q$_\E \: \s+ /mx }
298   ( sort keys %$opt_testdeps )
299 ;
300
301 if (@illegal_leftovers) {
302   die join ("\n",
303     "\n\nFATAL FAIL! It looks like some author dependencies made it to the META.yml:\n",
304     map { "\t$_" } @illegal_leftovers
305   ) . "\n\n";
306 }