Make `perl Makefile.PL` runs more user friendly - better diagnostics

[dbsrgits/DBIx-Class.git] / maint / Makefile.PL.inc / 53_autogen_pod.pl

diff --git a/maint/Makefile.PL.inc/53_autogen_pod.pl b/maint/Makefile.PL.inc/53_autogen_pod.pl
index 0c69623..4efe837 100644 (file)
--- a/maint/Makefile.PL.inc/53_autogen_pod.pl
+++ b/maint/Makefile.PL.inc/53_autogen_pod.pl
@@ -1,48 +1,141 @@
+use File::Path();
+use File::Glob();
+
 # leftovers in old checkouts
 unlink 'lib/DBIx/Class/Optional/Dependencies.pod'
   if -f 'lib/DBIx/Class/Optional/Dependencies.pod';
+File::Path::rmtree( File::Glob::bsd_glob('.generated_pod'), { verbose => 0 } )
+  if -d '.generated_pod';
 
-my $pod_dir = '.generated_pod';
+my $pod_dir = 'maint/.Generated_Pod';
 my $ver = Meta->version;
 
 # cleanup the generated pod dir (again - kill leftovers from old checkouts)
-require File::Path;
-require File::Glob;
-File::Path::rmtree( [File::Glob::bsd_glob "$pod_dir/*"], { verbose => 0 } );
+if (-d $pod_dir) {
+  File::Path::rmtree( File::Glob::bsd_glob("$pod_dir/*"), { verbose => 0 } );
+}
+else {
+  mkdir $pod_dir or die "Unable to create $pod_dir: $!";
+}
 
 # generate the OptDeps pod both in the clone-dir and during the makefile distdir
 {
   print "Regenerating Optional/Dependencies.pod\n";
+
+  # this should always succeed - hence no error checking
+  # if someone breaks OptDeps - travis should catch it
   require DBIx::Class::Optional::Dependencies;
-  DBIx::Class::Optional::Dependencies->_gen_pod ($ver, $pod_dir);
+  DBIx::Class::Optional::Dependencies->_gen_pod ($ver, "$pod_dir/lib");
 
   postamble <<"EOP";
 
-.PHONY: dbic_clonedir_gen_optdeps_pod
-
-create_distdir : dbic_clonedir_gen_optdeps_pod
+clonedir_generate_files : dbic_clonedir_gen_optdeps_pod
 
 dbic_clonedir_gen_optdeps_pod :
-\t\$(ABSPERL) -Ilib -MDBIx::Class::Optional::Dependencies -e "DBIx::Class::Optional::Dependencies->_gen_pod(qw($ver $pod_dir))"
+\t@{[
+  $mm_proto->oneliner("DBIx::Class::Optional::Dependencies->_gen_pod(q($ver), q($pod_dir/lib))", [qw/-Ilib -MDBIx::Class::Optional::Dependencies/])
+]}
 
 EOP
 }
 
-# generate the inherit pods both in the clone-dir and during the makefile distdir
-{
-  print "Regenerating project documentation to include inherited methods\n";
 
-  # if the author doesn't have them, don't fail the initial "perl Makefile.pl" step
-  do "maint/gen_pod_inherit" or print "\n!!! FAILED: $@\n";
+# generate the script/dbicadmin pod
+{
+  print "Regenerating script/dbicadmin.pod\n";
+
+  # generating it in the root of $pod_dir
+  # it will *not* be copied over due to not being listed at the top
+  # of MANIFEST.SKIP - this is a *good* thing
+  # we only want to ship a script/dbicadmin, with the POD appended
+  # (see inject_dbicadmin_pod.pl), but still want to spellcheck and
+  # whatnot the intermediate step
+  my $pod_fn = "$pod_dir/dbicadmin.pod";
+
+  # if the author doesn't have the prereqs, don't fail the initial "perl Makefile.pl" step
+  my $great_success;
+  {
+    local @ARGV = ('--documentation-as-pod', $pod_fn);
+    local *CORE::GLOBAL::exit = sub { $great_success++; die; };
+    do 'script/dbicadmin';
+  }
+  if (!$great_success and ($@ || $!) ) {
+    printf ("FAILED!!! Subsequent `make dist` will fail. %s\n",
+      $ENV{DBICDIST_DEBUG}
+        ? 'Full error: ' . ($@ || $!)
+        : 'Re-run with $ENV{DBICDIST_DEBUG} set for more info'
+    );
+  }
 
   postamble <<"EOP";
 
-.PHONY: dbic_clonedir_gen_inherit_pods
+clonedir_generate_files : dbic_clonedir_gen_dbicadmin_pod
+
+dbic_clonedir_gen_dbicadmin_pod :
+\t\$(ABSPERLRUN) -Ilib -- script/dbicadmin --documentation-as-pod @{[ $mm_proto->quote_literal($pod_fn) ]}
+
+EOP
+}
 
-create_distdir : dbic_clonedir_gen_inherit_pods
+
+# generate the inherit pods only during distbuilding phase
+# it is too slow to do at regular Makefile.PL
+{
+  postamble <<"EOP";
+
+clonedir_generate_files : dbic_clonedir_gen_inherit_pods
 
 dbic_clonedir_gen_inherit_pods :
-\t\$(ABSPERL) -Ilib maint/gen_pod_inherit
+\t\$(ABSPERLRUN) -Ilib maint/gen_pod_inherit
+
+EOP
+}
+
+
+# on some OSes generated files may have an incorrect \n - fix it
+# so that the xt tests pass on a fresh checkout (also shipping a
+# dist with CRLFs is beyond obnoxious)
+if ($^O eq 'MSWin32' or $^O eq 'cygwin') {
+  {
+    local $ENV{PERLIO} = 'unix';
+    system( $^X, qw( -MExtUtils::Command -e dos2unix -- ), $pod_dir );
+  }
+
+  postamble <<"EOP";
+
+clonedir_post_generate_files : pod_crlf_fixup
+
+pod_crlf_fixup :
+@{[ $crlf_fixup->($pod_dir) ]}
+
+EOP
+}
+
+{
+  postamble <<"EOP";
+
+clonedir_post_generate_files : dbic_clonedir_copy_generated_pod
+
+dbic_clonedir_copy_generated_pod :
+\t\$(RM_F) $pod_dir.packlist
+\t@{[
+  $mm_proto->oneliner("install([ from_to => {q($pod_dir) => File::Spec->curdir(), write => q($pod_dir.packlist)}, verbose => 0, uninstall_shadows => 0, skip => [] ])", ['-MExtUtils::Install'])
+]}
+
+EOP
+}
+
+
+# everything that came from $pod_dir, needs to be removed from the workdir
+{
+  postamble <<"EOP";
+
+clonedir_cleanup_generated_files : dbic_clonedir_cleanup_generated_pod_copies
+
+dbic_clonedir_cleanup_generated_pod_copies :
+\t@{[
+  $mm_proto->oneliner("uninstall(q($pod_dir.packlist))", ['-MExtUtils::Install'])
+]}
 
 EOP
 }