maint/gen_pod_inherit

   1 #!/usr/bin/env perl
   2
   3 use warnings;
   4 use strict;
   5
   6 my $lib_dir = 'lib';
   7 my $pod_dir = '.generated_pod';
   8
   9 my $result_metapod_fn = "$lib_dir/DBIx/Class/Manual/ResultClass.pod";
  10
  11 die "POD generator must be executed from the dist root\n"
  12   unless -d $lib_dir and -d $pod_dir;
  13
  14 require File::Copy;
  15 File::Copy::copy(
  16   "$result_metapod_fn.proto",
  17   "$result_metapod_fn",
  18 ) or die "Copying ResultClass proto pod ($result_metapod_fn.pod) failed: $!";
  19
  20 # cleanup
  21 END {
  22   local ($@, $!, $?);
  23   unlink $result_metapod_fn;
  24 }
  25
  26 require Pod::Inherit;
  27
  28 Pod::Inherit->new({
  29    input_files       => $lib_dir,
  30    out_dir           => $pod_dir,
  31    force_permissions => 1,
  32    class_map         => {
  33       "DBIx::Class::Relationship::HasMany"    => "DBIx::Class::Relationship",
  34       "DBIx::Class::Relationship::HasOne"     => "DBIx::Class::Relationship",
  35       "DBIx::Class::Relationship::BelongsTo"  => "DBIx::Class::Relationship",
  36       "DBIx::Class::Relationship::ManyToMany" => "DBIx::Class::Relationship",
  37       "DBIx::Class::ResultSourceProxy"        => "DBIx::Class::ResultSource",
  38    },
  39    # skip the deprecated classes that give out *DEPRECATED* warnings
  40    skip_classes      => [ qw(
  41       lib/DBIx/Class/Storage/DBI/Sybase/MSSQL.pm
  42       lib/DBIx/Class/Serialize/Storable.pm
  43       lib/DBIx/Class/ResultSetManager.pm
  44       lib/DBIx/Class/InflateColumn/File.pm
  45       lib/DBIx/Class/DB.pm
  46       lib/DBIx/Class/CDBICompat/
  47       lib/DBIx/Class/CDBICompat.pm
  48    ),
  49    # skip the ::Storage:: family for now
  50    qw(
  51       lib/DBIx/Class/Storage/
  52       lib/DBIx/Class/Storage.pm
  53    ),
  54       'lib/DBIx/Class/Storage/DBI/Replicated/Pool.pm',  # this one just errors out with: The 'add_attribute' method cannot be called on an immutable instance
  55       'lib/DBIx/Class/Relationship.pm',                 # it already documents its own inheritors
  56       'lib/DBIx/Class/Core.pm',                         # we actually don't want this populated in favor of redirecting users to the ResultClass docs
  57       'lib/DBIx/Class/Optional/Dependencies.pm'         # the POD is already auto-generated
  58    ],
  59    # these appear everywhere, and are typically lower-level methods not used by the general user
  60    skip_inherits     => [ qw/
  61       DBIx::Class
  62       DBIx::Class::Componentised
  63       Class::C3::Componentised
  64       DBIx::Class::AccessorGroup
  65       Class::Accessor::Grouped
  66       Moose::Object
  67       Exporter
  68    / ],
  69    force_inherits    => {
  70       'DBIx::Class::Manual::ResultClass' => 'DBIx::Class::Core',  # this forces the contents of ::Core to be dumped into the POD doc for ::ResultClass
  71    },
  72    dead_links        => '',
  73    method_format     => 'L<%m|%c/%m>',
  74    #debug => 1,
  75 })->write_pod;
  76
  77 # important - write_pod returns undef >.<
  78 1;