lib/DBIx/Class/Optional/Dependencies.pm

   1 package DBIx::Class::Optional::Dependencies;
   2
   3 use warnings;
   4 use strict;
   5
   6 use Carp ();
   7
   8 # NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G)
   9 # This module is to be loaded by Makefile.PM on a pristine system
  10
  11 # POD is generated automatically by calling _gen_pod from the
  12 # Makefile.PL in $AUTHOR mode
  13
  14 # NOTE: the rationale for 2 JSON::Any versions is that
  15 # we need the newer only to work around JSON::XS, which
  16 # itself is an optional dep
  17 my $min_json_any = {
  18   'JSON::Any'                     => '1.23',
  19 };
  20 my $test_and_dist_json_any = {
  21   'JSON::Any'                     => '1.31',
  22 };
  23
  24 my $moose_basic = {
  25   'Moose'                         => '0.98',
  26   'MooseX::Types'                 => '0.21',
  27   'MooseX::Types::LoadableClass'  => '0.011',
  28 };
  29
  30 my $replicated = {
  31   %$moose_basic,
  32 };
  33
  34 my $admin_basic = {
  35   %$moose_basic,
  36   %$min_json_any,
  37   'MooseX::Types::Path::Class'    => '0.05',
  38   'MooseX::Types::JSON'           => '0.02',
  39 };
  40
  41 my $admin_script = {
  42   %$moose_basic,
  43   %$admin_basic,
  44   'Getopt::Long::Descriptive' => '0.081',
  45   'Text::CSV'                 => '1.16',
  46 };
  47
  48 my $datetime_basic = {
  49   'DateTime'                      => '0.55',
  50   'DateTime::Format::Strptime'    => '1.2',
  51 };
  52
  53 my $id_shortener = {
  54   'Math::BigInt'                  => '1.80',
  55   'Math::Base36'                  => '0.07',
  56 };
  57
  58 my $rdbms_sqlite = {
  59   'DBD::SQLite'                   => '0',
  60 };
  61 my $rdbms_pg = {
  62   'DBD::Pg'                       => '0',
  63 };
  64 my $rdbms_mssql_odbc = {
  65   'DBD::ODBC'                     => '0',
  66 };
  67 my $rdbms_mssql_sybase = {
  68   'DBD::Sybase'                   => '0',
  69 };
  70 my $rdbms_mssql_ado = {
  71   'DBD::ADO'                      => '0',
  72 };
  73 my $rdbms_msaccess_odbc = {
  74   'DBD::ODBC'                     => '0',
  75 };
  76 my $rdbms_msaccess_ado = {
  77   'DBD::ADO'                      => '0',
  78 };
  79 my $rdbms_mysql = {
  80   'DBD::mysql'                    => '0',
  81 };
  82 my $rdbms_oracle = {
  83   'DBD::Oracle'                   => '0',
  84   %$id_shortener,
  85 };
  86 my $rdbms_ase = {
  87   'DBD::Sybase'                   => '0',
  88 };
  89 my $rdbms_db2 = {
  90   'DBD::DB2'                      => '0',
  91 };
  92 my $rdbms_db2_400 = {
  93   'DBD::ODBC'                     => '0',
  94 };
  95 my $rdbms_informix = {
  96   'DBD::Informix'                 => '0',
  97 };
  98 my $rdbms_sqlanywhere = {
  99   'DBD::SQLAnywhere'              => '0',
 100 };
 101 my $rdbms_sqlanywhere_odbc = {
 102   'DBD::ODBC'                     => '0',
 103 };
 104 my $rdbms_firebird = {
 105   'DBD::Firebird'                 => '0',
 106 };
 107 my $rdbms_firebird_interbase = {
 108   'DBD::InterBase'                => '0',
 109 };
 110 my $rdbms_firebird_odbc = {
 111   'DBD::ODBC'                     => '0',
 112 };
 113
 114 my $reqs = {
 115   replicated => {
 116     req => $replicated,
 117     pod => {
 118       title => 'Storage::Replicated',
 119       desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
 120     },
 121   },
 122
 123   test_replicated => {
 124     req => {
 125       %$replicated,
 126       'Test::Moose'               => '0',
 127     },
 128   },
 129
 130
 131   admin => {
 132     req => {
 133       %$admin_basic,
 134     },
 135     pod => {
 136       title => 'DBIx::Class::Admin',
 137       desc => 'Modules required for the DBIx::Class administrative library',
 138     },
 139   },
 140
 141   admin_script => {
 142     req => {
 143       %$admin_script,
 144     },
 145     pod => {
 146       title => 'dbicadmin',
 147       desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
 148     },
 149   },
 150
 151   deploy => {
 152     req => {
 153       'SQL::Translator'           => '0.11018',
 154     },
 155     pod => {
 156       title => 'Storage::DBI::deploy()',
 157       desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
 158     },
 159   },
 160
 161   id_shortener => {
 162     req => $id_shortener,
 163   },
 164
 165   test_component_accessor => {
 166     req => {
 167       'Class::Unload'             => '0.07',
 168     },
 169   },
 170
 171   test_pod => {
 172     req => {
 173       'Test::Pod'                 => '1.42',
 174     },
 175   },
 176
 177   test_podcoverage => {
 178     req => {
 179       'Test::Pod::Coverage'       => '1.08',
 180       'Pod::Coverage'             => '0.20',
 181     },
 182   },
 183
 184   test_whitespace => {
 185     req => {
 186       'Test::EOL'                 => '1.0',
 187       'Test::NoTabs'              => '0.9',
 188     },
 189   },
 190
 191   test_strictures => {
 192     req => {
 193       'Test::Strict'              => '0.20',
 194     },
 195   },
 196
 197   test_prettydebug => {
 198     req => $min_json_any,
 199   },
 200
 201   test_admin_script => {
 202     req => {
 203       %$admin_script,
 204       %$test_and_dist_json_any,
 205       'JSON' => 0,
 206       'JSON::PP' => 0,
 207       'Cpanel::JSON::XS' => 0,
 208       'JSON::XS' => 0,
 209       $^O eq 'MSWin32'
 210         # for t/admin/10script.t
 211         ? ('Win32::ShellQuote' => 0)
 212         # DWIW does not compile (./configure even) on win32
 213         : ('JSON::DWIW' => 0 )
 214       ,
 215     }
 216   },
 217
 218   test_leaks_heavy => {
 219     req => {
 220       'Class::MethodCache' => '0.02',
 221       'PadWalker' => '1.06',
 222     },
 223   },
 224
 225   test_dt => {
 226     req => $datetime_basic,
 227   },
 228
 229   test_dt_sqlite => {
 230     req => {
 231       %$datetime_basic,
 232       # t/36datetime.t
 233       # t/60core.t
 234       'DateTime::Format::SQLite'  => '0',
 235     },
 236   },
 237
 238   test_dt_mysql => {
 239     req => {
 240       %$datetime_basic,
 241       # t/inflate/datetime_mysql.t
 242       # (doesn't need Mysql itself)
 243       'DateTime::Format::MySQL'   => '0',
 244     },
 245   },
 246
 247   test_dt_pg => {
 248     req => {
 249       %$datetime_basic,
 250       # t/inflate/datetime_pg.t
 251       # (doesn't need PG itself)
 252       'DateTime::Format::Pg'      => '0.16004',
 253     },
 254   },
 255
 256   test_cdbicompat => {
 257     req => {
 258       'Class::DBI::Plugin::DeepAbstractSearch' => '0',
 259       %$datetime_basic,
 260       'Time::Piece::MySQL'        => '0',
 261       'Date::Simple'              => '3.03',
 262     },
 263   },
 264
 265   # this is just for completeness as SQLite
 266   # is a core dep of DBIC for testing
 267   rdbms_sqlite => {
 268     req => {
 269       %$rdbms_sqlite,
 270     },
 271     pod => {
 272       title => 'SQLite support',
 273       desc => 'Modules required to connect to SQLite',
 274     },
 275   },
 276
 277   rdbms_pg => {
 278     req => {
 279       # when changing this list make sure to adjust xt/optional_deps.t
 280       %$rdbms_pg,
 281     },
 282     pod => {
 283       title => 'PostgreSQL support',
 284       desc => 'Modules required to connect to PostgreSQL',
 285     },
 286   },
 287
 288   rdbms_mssql_odbc => {
 289     req => {
 290       %$rdbms_mssql_odbc,
 291     },
 292     pod => {
 293       title => 'MSSQL support via DBD::ODBC',
 294       desc => 'Modules required to connect to MSSQL via DBD::ODBC',
 295     },
 296   },
 297
 298   rdbms_mssql_sybase => {
 299     req => {
 300       %$rdbms_mssql_sybase,
 301     },
 302     pod => {
 303       title => 'MSSQL support via DBD::Sybase',
 304       desc => 'Modules required to connect to MSSQL via DBD::Sybase',
 305     },
 306   },
 307
 308   rdbms_mssql_ado => {
 309     req => {
 310       %$rdbms_mssql_ado,
 311     },
 312     pod => {
 313       title => 'MSSQL support via DBD::ADO (Windows only)',
 314       desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
 315     },
 316   },
 317
 318   rdbms_msaccess_odbc => {
 319     req => {
 320       %$rdbms_msaccess_odbc,
 321     },
 322     pod => {
 323       title => 'MS Access support via DBD::ODBC',
 324       desc => 'Modules required to connect to MS Access via DBD::ODBC',
 325     },
 326   },
 327
 328   rdbms_msaccess_ado => {
 329     req => {
 330       %$rdbms_msaccess_ado,
 331     },
 332     pod => {
 333       title => 'MS Access support via DBD::ADO (Windows only)',
 334       desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
 335     },
 336   },
 337
 338   rdbms_mysql => {
 339     req => {
 340       %$rdbms_mysql,
 341     },
 342     pod => {
 343       title => 'MySQL support',
 344       desc => 'Modules required to connect to MySQL',
 345     },
 346   },
 347
 348   rdbms_oracle => {
 349     req => {
 350       %$rdbms_oracle,
 351     },
 352     pod => {
 353       title => 'Oracle support',
 354       desc => 'Modules required to connect to Oracle',
 355     },
 356   },
 357
 358   rdbms_ase => {
 359     req => {
 360       %$rdbms_ase,
 361     },
 362     pod => {
 363       title => 'Sybase ASE support',
 364       desc => 'Modules required to connect to Sybase ASE',
 365     },
 366   },
 367
 368   rdbms_db2 => {
 369     req => {
 370       %$rdbms_db2,
 371     },
 372     pod => {
 373       title => 'DB2 support',
 374       desc => 'Modules required to connect to DB2',
 375     },
 376   },
 377
 378   rdbms_db2_400 => {
 379     req => {
 380       %$rdbms_db2_400,
 381     },
 382     pod => {
 383       title => 'DB2 on AS/400 support',
 384       desc => 'Modules required to connect to DB2 on AS/400',
 385     },
 386   },
 387
 388   rdbms_informix => {
 389     req => {
 390       %$rdbms_informix,
 391     },
 392     pod => {
 393       title => 'Informix support',
 394       desc => 'Modules required to connect to Informix',
 395     },
 396   },
 397
 398   rdbms_sqlanywhere => {
 399     req => {
 400       %$rdbms_sqlanywhere,
 401     },
 402     pod => {
 403       title => 'SQLAnywhere support',
 404       desc => 'Modules required to connect to SQLAnywhere',
 405     },
 406   },
 407
 408   rdbms_sqlanywhere_odbc => {
 409     req => {
 410       %$rdbms_sqlanywhere_odbc,
 411     },
 412     pod => {
 413       title => 'SQLAnywhere support via DBD::ODBC',
 414       desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
 415     },
 416   },
 417
 418   rdbms_firebird => {
 419     req => {
 420       %$rdbms_firebird,
 421     },
 422     pod => {
 423       title => 'Firebird support',
 424       desc => 'Modules required to connect to Firebird',
 425     },
 426   },
 427
 428   rdbms_firebird_interbase => {
 429     req => {
 430       %$rdbms_firebird_interbase,
 431     },
 432     pod => {
 433       title => 'Firebird support via DBD::InterBase',
 434       desc => 'Modules required to connect to Firebird via DBD::InterBase',
 435     },
 436   },
 437
 438   rdbms_firebird_odbc => {
 439     req => {
 440       %$rdbms_firebird_odbc,
 441     },
 442     pod => {
 443       title => 'Firebird support via DBD::ODBC',
 444       desc => 'Modules required to connect to Firebird via DBD::ODBC',
 445     },
 446   },
 447
 448 # the order does matter because the rdbms support group might require
 449 # a different version that the test group
 450   test_rdbms_pg => {
 451     req => {
 452       $ENV{DBICTEST_PG_DSN}
 453         ? (
 454           # when changing this list make sure to adjust xt/optional_deps.t
 455           %$rdbms_pg,
 456           'DBD::Pg'               => '2.009002',
 457         ) : ()
 458     },
 459   },
 460
 461   test_rdbms_mssql_odbc => {
 462     req => {
 463       $ENV{DBICTEST_MSSQL_ODBC_DSN}
 464         ? (
 465           %$rdbms_mssql_odbc,
 466         ) : ()
 467     },
 468   },
 469
 470   test_rdbms_mssql_ado => {
 471     req => {
 472       $ENV{DBICTEST_MSSQL_ADO_DSN}
 473         ? (
 474           %$rdbms_mssql_ado,
 475         ) : ()
 476     },
 477   },
 478
 479   test_rdbms_mssql_sybase => {
 480     req => {
 481       $ENV{DBICTEST_MSSQL_DSN}
 482         ? (
 483           %$rdbms_mssql_sybase,
 484         ) : ()
 485     },
 486   },
 487
 488   test_rdbms_msaccess_odbc => {
 489     req => {
 490       $ENV{DBICTEST_MSACCESS_ODBC_DSN}
 491         ? (
 492           %$rdbms_msaccess_odbc,
 493           %$datetime_basic,
 494           'Data::GUID' => '0',
 495         ) : ()
 496     },
 497   },
 498
 499   test_rdbms_msaccess_ado => {
 500     req => {
 501       $ENV{DBICTEST_MSACCESS_ADO_DSN}
 502         ? (
 503           %$rdbms_msaccess_ado,
 504           %$datetime_basic,
 505           'Data::GUID' => 0,
 506         ) : ()
 507     },
 508   },
 509
 510   test_rdbms_mysql => {
 511     req => {
 512       $ENV{DBICTEST_MYSQL_DSN}
 513         ? (
 514           %$rdbms_mysql,
 515         ) : ()
 516     },
 517   },
 518
 519   test_rdbms_oracle => {
 520     req => {
 521       $ENV{DBICTEST_ORA_DSN}
 522         ? (
 523           %$rdbms_oracle,
 524           'DateTime::Format::Oracle' => '0',
 525           'DBD::Oracle'              => '1.24',
 526         ) : ()
 527     },
 528   },
 529
 530   test_rdbms_ase => {
 531     req => {
 532       $ENV{DBICTEST_SYBASE_DSN}
 533         ? (
 534           %$rdbms_ase,
 535         ) : ()
 536     },
 537   },
 538
 539   test_rdbms_db2 => {
 540     req => {
 541       $ENV{DBICTEST_DB2_DSN}
 542         ? (
 543           %$rdbms_db2,
 544         ) : ()
 545     },
 546   },
 547
 548   test_rdbms_db2_400 => {
 549     req => {
 550       $ENV{DBICTEST_DB2_400_DSN}
 551         ? (
 552           %$rdbms_db2_400,
 553         ) : ()
 554     },
 555   },
 556
 557   test_rdbms_informix => {
 558     req => {
 559       $ENV{DBICTEST_INFORMIX_DSN}
 560         ? (
 561           %$rdbms_informix,
 562         ) : ()
 563     },
 564   },
 565
 566   test_rdbms_sqlanywhere => {
 567     req => {
 568       $ENV{DBICTEST_SQLANYWHERE_DSN}
 569         ? (
 570           %$rdbms_sqlanywhere,
 571         ) : ()
 572     },
 573   },
 574
 575   test_rdbms_sqlanywhere_odbc => {
 576     req => {
 577       $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
 578         ? (
 579           %$rdbms_sqlanywhere_odbc,
 580         ) : ()
 581     },
 582   },
 583
 584   test_rdbms_firebird => {
 585     req => {
 586       $ENV{DBICTEST_FIREBIRD_DSN}
 587         ? (
 588           %$rdbms_firebird,
 589         ) : ()
 590     },
 591   },
 592
 593   test_rdbms_firebird_interbase => {
 594     req => {
 595       $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
 596         ? (
 597           %$rdbms_firebird_interbase,
 598         ) : ()
 599     },
 600   },
 601
 602   test_rdbms_firebird_odbc => {
 603     req => {
 604       $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
 605         ? (
 606           %$rdbms_firebird_odbc,
 607         ) : ()
 608     },
 609   },
 610
 611   test_memcached => {
 612     req => {
 613       $ENV{DBICTEST_MEMCACHED}
 614         ? (
 615           'Cache::Memcached' => 0,
 616         ) : ()
 617     },
 618   },
 619
 620   dist_dir => {
 621     req => {
 622       %$test_and_dist_json_any,
 623       'ExtUtils::MakeMaker' => '6.64',
 624       'Pod::Inherit'        => '0.90',
 625       'Pod::Tree'           => '0',
 626     }
 627   },
 628
 629   dist_upload => {
 630     req => {
 631       'CPAN::Uploader' => '0.103001',
 632     },
 633   },
 634
 635 };
 636
 637 our %req_availability_cache;
 638
 639 sub req_list_for {
 640   my ($class, $group) = @_;
 641
 642   Carp::croak "req_list_for() expects a requirement group name"
 643     unless $group;
 644
 645   my $deps = $reqs->{$group}{req}
 646     or Carp::croak "Requirement group '$group' does not exist";
 647
 648   return { %$deps };
 649 }
 650
 651
 652 sub die_unless_req_ok_for {
 653   my ($class, $group) = @_;
 654
 655   Carp::croak "die_unless_req_ok_for() expects a requirement group name"
 656     unless $group;
 657
 658   $class->_check_deps($group)->{status}
 659     or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
 660 }
 661
 662 sub req_ok_for {
 663   my ($class, $group) = @_;
 664
 665   Carp::croak "req_ok_for() expects a requirement group name"
 666     unless $group;
 667
 668   return $class->_check_deps($group)->{status};
 669 }
 670
 671 sub req_missing_for {
 672   my ($class, $group) = @_;
 673
 674   Carp::croak "req_missing_for() expects a requirement group name"
 675     unless $group;
 676
 677   return $class->_check_deps($group)->{missing};
 678 }
 679
 680 sub req_errorlist_for {
 681   my ($class, $group) = @_;
 682
 683   Carp::croak "req_errorlist_for() expects a requirement group name"
 684     unless $group;
 685
 686   return $class->_check_deps($group)->{errorlist};
 687 }
 688
 689 sub _check_deps {
 690   my ($class, $group) = @_;
 691
 692   return $req_availability_cache{$group} ||= do {
 693
 694     my $deps = $class->req_list_for ($group);
 695
 696     my %errors;
 697     for my $mod (keys %$deps) {
 698       my $req_line = "require $mod;";
 699       if (my $ver = $deps->{$mod}) {
 700         $req_line .= "$mod->VERSION($ver);";
 701       }
 702
 703       eval $req_line;
 704
 705       $errors{$mod} = $@ if $@;
 706     }
 707
 708     my $res;
 709
 710     if (keys %errors) {
 711       my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
 712       $missing .= " (see $class for details)" if $reqs->{$group}{pod};
 713       $res = {
 714         status => 0,
 715         errorlist => \%errors,
 716         missing => $missing,
 717       };
 718     }
 719     else {
 720       $res = {
 721         status => 1,
 722         errorlist => {},
 723         missing => '',
 724       };
 725     }
 726
 727     $res;
 728   };
 729 }
 730
 731 sub req_group_list {
 732   return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
 733 }
 734
 735 # This is to be called by the author only (automatically in Makefile.PL)
 736 sub _gen_pod {
 737   my ($class, $distver, $pod_dir) = @_;
 738
 739   die "No POD root dir supplied" unless $pod_dir;
 740
 741   $distver ||=
 742     eval { require DBIx::Class; DBIx::Class->VERSION; }
 743       ||
 744     die
 745 "\n\n---------------------------------------------------------------------\n" .
 746 'Unable to load core DBIx::Class module to determine current version, '.
 747 'possibly due to missing dependencies. Author-mode autodocumentation ' .
 748 "halted\n\n" . $@ .
 749 "\n\n---------------------------------------------------------------------\n"
 750   ;
 751
 752   # do not ask for a recent version, use 1.x API calls
 753   # this *may* execute on a smoker with old perl or whatnot
 754   require File::Path;
 755
 756   (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
 757
 758   (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
 759   (my $dir = $podfn) =~ s|/[^/]+$||;
 760
 761   File::Path::mkpath([$dir]);
 762
 763   my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
 764     or die "Hrmm? No sqlt dep?";
 765
 766   my @chunks = (
 767     <<"EOC",
 768 #########################################################################
 769 #####################  A U T O G E N E R A T E D ########################
 770 #########################################################################
 771 #
 772 # The contents of this POD file are auto-generated.  Any changes you make
 773 # will be lost. If you need to change the generated text edit _gen_pod()
 774 # at the end of $modfn
 775 #
 776 EOC
 777     '=head1 NAME',
 778     "$class - Optional module dependency specifications (for module authors)",
 779     '=head1 SYNOPSIS',
 780     <<"EOS",
 781 Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
 782
 783   ...
 784
 785   configure_requires 'DBIx::Class' => '$distver';
 786
 787   require $class;
 788
 789   my \$deploy_deps = $class->req_list_for('deploy');
 790
 791   for (keys %\$deploy_deps) {
 792     requires \$_ => \$deploy_deps->{\$_};
 793   }
 794
 795   ...
 796
 797 Note that there are some caveats regarding C<configure_requires()>, more info
 798 can be found at L<Module::Install/configure_requires>
 799 EOS
 800     '=head1 DESCRIPTION',
 801     <<'EOD',
 802 Some of the less-frequently used features of L<DBIx::Class> have external
 803 module dependencies on their own. In order not to burden the average user
 804 with modules he will never use, these optional dependencies are not included
 805 in the base Makefile.PL. Instead an exception with a descriptive message is
 806 thrown when a specific feature is missing one or several modules required for
 807 its operation. This module is the central holding place for  the current list
 808 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
 809 authors alike.
 810 EOD
 811     '=head1 CURRENT REQUIREMENT GROUPS',
 812     <<'EOD',
 813 Dependencies are organized in C<groups> and each group can list one or more
 814 required modules, with an optional minimum version (or 0 for any version).
 815 The group name can be used in the
 816 EOD
 817   );
 818
 819   for my $group (sort keys %$reqs) {
 820     my $p = $reqs->{$group}{pod}
 821       or next;
 822
 823     my $modlist = $reqs->{$group}{req}
 824       or next;
 825
 826     next unless keys %$modlist;
 827
 828     push @chunks, (
 829       "=head2 $p->{title}",
 830       "$p->{desc}",
 831       '=over',
 832       ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
 833       '=back',
 834       "Requirement group: B<$group>",
 835     );
 836   }
 837
 838   push @chunks, (
 839     '=head1 METHODS',
 840     '=head2 req_group_list',
 841     '=over',
 842     '=item Arguments: none',
 843     '=item Return Value: \%list_of_requirement_groups',
 844     '=back',
 845     <<'EOD',
 846 This method should be used by DBIx::Class packagers, to get a hashref of all
 847 dependencies keyed by dependency group. Each key (group name) can be supplied
 848 to one of the group-specific methods below.
 849 EOD
 850
 851     '=head2 req_list_for',
 852     '=over',
 853     '=item Arguments: $group_name',
 854     '=item Return Value: \%list_of_module_version_pairs',
 855     '=back',
 856     <<'EOD',
 857 This method should be used by DBIx::Class extension authors, to determine the
 858 version of modules a specific feature requires in the B<current> version of
 859 DBIx::Class. See the L</SYNOPSIS> for a real-world
 860 example.
 861 EOD
 862
 863     '=head2 req_ok_for',
 864     '=over',
 865     '=item Arguments: $group_name',
 866     '=item Return Value: 1|0',
 867     '=back',
 868     <<'EOD',
 869 Returns true or false depending on whether all modules required by
 870 C<$group_name> are present on the system and loadable.
 871 EOD
 872
 873     '=head2 req_missing_for',
 874     '=over',
 875     '=item Arguments: $group_name',
 876     '=item Return Value: $error_message_string',
 877     '=back',
 878     <<"EOD",
 879 Returns a single line string suitable for inclusion in larger error messages.
 880 This method would normally be used by DBIx::Class core-module author, to
 881 indicate to the user that he needs to install specific modules before he will
 882 be able to use a specific feature.
 883
 884 For example if some of the requirements for C<deploy> are not available,
 885 the returned string could look like:
 886
 887  SQL::Translator >= $sqltver (see $class for details)
 888
 889 The author is expected to prepend the necessary text to this message before
 890 returning the actual error seen by the user.
 891 EOD
 892
 893     '=head2 die_unless_req_ok_for',
 894     '=over',
 895     '=item Arguments: $group_name',
 896     '=back',
 897     <<'EOD',
 898 Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
 899 in case of failure throws an exception including the information
 900 from L</req_missing_for>.
 901 EOD
 902
 903     '=head2 req_errorlist_for',
 904     '=over',
 905     '=item Arguments: $group_name',
 906     '=item Return Value: \%list_of_loaderrors_per_module',
 907     '=back',
 908     <<'EOD',
 909 Returns a hashref containing the actual errors that occurred while attempting
 910 to load each module in the requirement group.
 911 EOD
 912     '=head1 FURTHER QUESTIONS?',
 913     'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
 914     '=head1 COPYRIGHT AND LICENSE',
 915     <<'EOL',
 916 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
 917 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
 918 redistribute it and/or modify it under the same terms as the
 919 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
 920 EOL
 921
 922   );
 923
 924   open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
 925   print $fh join ("\n\n", @chunks);
 926   print $fh "\n";
 927   close ($fh);
 928 }
 929
 930 1;