1 package DBIx::Class::Optional::Dependencies;
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
11 # POD is generated automatically by calling _gen_pod from the
12 # Makefile.PL in $AUTHOR mode
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
18 'JSON::Any' => '1.23',
20 my $test_and_dist_json_any = {
21 'JSON::Any' => '1.31',
26 'MooseX::Types' => '0.21',
27 'MooseX::Types::LoadableClass' => '0.011',
34 title => 'Storage::Replicated',
35 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
40 include => 'replicated',
50 'MooseX::Types::Path::Class' => '0.05',
51 'MooseX::Types::JSON' => '0.02',
54 title => 'DBIx::Class::Admin',
55 desc => 'Modules required for the DBIx::Class administrative library',
62 'Getopt::Long::Descriptive' => '0.081',
63 'Text::CSV' => '1.16',
67 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
73 'SQL::Translator' => '0.11018',
76 title => 'Storage::DBI::deploy()',
77 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
83 'Math::BigInt' => '1.80',
84 'Math::Base36' => '0.07',
88 test_component_accessor => {
90 'Class::Unload' => '0.07',
96 'Test::Pod' => '1.42',
100 test_podcoverage => {
102 'Test::Pod::Coverage' => '1.08',
103 'Pod::Coverage' => '0.20',
109 'Test::EOL' => '1.0',
110 'Test::NoTabs' => '0.9',
116 'Test::Strict' => '0.20',
120 test_prettydebug => {
121 req => $min_json_any,
124 test_admin_script => {
125 include => 'admin_script',
127 %$test_and_dist_json_any,
130 'Cpanel::JSON::XS' => 0,
133 # for t/admin/10script.t
134 ? ('Win32::ShellQuote' => 0)
135 # DWIW does not compile (./configure even) on win32
136 : ('JSON::DWIW' => 0 )
141 test_leaks_heavy => {
143 'Class::MethodCache' => '0.02',
144 'PadWalker' => '1.06',
150 'DateTime' => '0.55',
151 'DateTime::Format::Strptime' => '1.2',
156 include => 'test_dt',
160 'DateTime::Format::SQLite' => '0',
165 include => 'test_dt',
167 # t/inflate/datetime_mysql.t
168 # (doesn't need Mysql itself)
169 'DateTime::Format::MySQL' => '0',
174 include => 'test_dt',
176 # t/inflate/datetime_pg.t
177 # (doesn't need PG itself)
178 'DateTime::Format::Pg' => '0.16004',
183 include => 'test_dt',
185 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
186 'Time::Piece::MySQL' => '0',
187 'Date::Simple' => '3.03',
191 rdbms_generic_odbc => {
197 rdbms_generic_ado => {
203 # this is just for completeness as SQLite
204 # is a core dep of DBIC for testing
210 title => 'SQLite support',
211 desc => 'Modules required to connect to SQLite',
217 # when changing this list make sure to adjust xt/optional_deps.t
221 title => 'PostgreSQL support',
222 desc => 'Modules required to connect to PostgreSQL',
226 rdbms_mssql_odbc => {
227 include => 'rdbms_generic_odbc',
229 title => 'MSSQL support via DBD::ODBC',
230 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
234 rdbms_mssql_sybase => {
239 title => 'MSSQL support via DBD::Sybase',
240 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
245 include => 'rdbms_generic_ado',
247 title => 'MSSQL support via DBD::ADO (Windows only)',
248 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
252 rdbms_msaccess_odbc => {
253 include => 'rdbms_generic_odbc',
255 title => 'MS Access support via DBD::ODBC',
256 desc => 'Modules required to connect to MS Access via DBD::ODBC',
260 rdbms_msaccess_ado => {
261 include => 'rdbms_generic_ado',
263 title => 'MS Access support via DBD::ADO (Windows only)',
264 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
273 title => 'MySQL support',
274 desc => 'Modules required to connect to MySQL',
279 include => 'id_shortener',
284 title => 'Oracle support',
285 desc => 'Modules required to connect to Oracle',
294 title => 'Sybase ASE support',
295 desc => 'Modules required to connect to Sybase ASE',
304 title => 'DB2 support',
305 desc => 'Modules required to connect to DB2',
310 include => 'rdbms_generic_odbc',
312 title => 'DB2 on AS/400 support',
313 desc => 'Modules required to connect to DB2 on AS/400',
319 'DBD::Informix' => 0,
322 title => 'Informix support',
323 desc => 'Modules required to connect to Informix',
327 rdbms_sqlanywhere => {
329 'DBD::SQLAnywhere' => 0,
332 title => 'SQLAnywhere support',
333 desc => 'Modules required to connect to SQLAnywhere',
337 rdbms_sqlanywhere_odbc => {
338 include => 'rdbms_generic_odbc',
340 title => 'SQLAnywhere support via DBD::ODBC',
341 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
347 'DBD::Firebird' => 0,
350 title => 'Firebird support',
351 desc => 'Modules required to connect to Firebird',
355 rdbms_firebird_interbase => {
357 'DBD::InterBase' => 0,
360 title => 'Firebird support via DBD::InterBase',
361 desc => 'Modules required to connect to Firebird via DBD::InterBase',
365 rdbms_firebird_odbc => {
366 include => 'rdbms_generic_odbc',
368 title => 'Firebird support via DBD::ODBC',
369 desc => 'Modules required to connect to Firebird via DBD::ODBC',
374 include => 'rdbms_pg',
376 DBICTEST_PG_DSN => 1,
377 DBICTEST_PG_USER => 0,
378 DBICTEST_PG_PASS => 0,
381 # the order does matter because the rdbms support group might require
382 # a different version that the test group
384 # when changing this list make sure to adjust xt/optional_deps.t
385 'DBD::Pg' => '2.009002', # specific version to test bytea
389 test_rdbms_mssql_odbc => {
390 include => 'rdbms_mssql_odbc',
392 DBICTEST_MSSQL_ODBC_DSN => 1,
393 DBICTEST_MSSQL_ODBC_USER => 0,
394 DBICTEST_MSSQL_ODBC_PASS => 0,
398 test_rdbms_mssql_ado => {
399 include => 'rdbms_mssql_ado',
401 DBICTEST_MSSQL_ADO_DSN => 1,
402 DBICTEST_MSSQL_ADO_USER => 0,
403 DBICTEST_MSSQL_ADO_PASS => 0,
407 test_rdbms_mssql_sybase => {
408 include => 'rdbms_mssql_sybase',
410 DBICTEST_MSSQL_DSN => 1,
411 DBICTEST_MSSQL_USER => 0,
412 DBICTEST_MSSQL_PASS => 0,
416 test_rdbms_msaccess_odbc => {
417 include => [qw(rdbms_msaccess_odbc test_dt)],
419 DBICTEST_MSACCESS_ODBC_DSN => 1,
420 DBICTEST_MSACCESS_ODBC_USER => 0,
421 DBICTEST_MSACCESS_ODBC_PASS => 0,
428 test_rdbms_msaccess_ado => {
429 include => [qw(rdbms_msaccess_ado test_dt)],
431 DBICTEST_MSACCESS_ADO_DSN => 1,
432 DBICTEST_MSACCESS_ADO_USER => 0,
433 DBICTEST_MSACCESS_ADO_PASS => 0,
440 test_rdbms_mysql => {
441 include => 'rdbms_mysql',
443 DBICTEST_MYSQL_DSN => 1,
444 DBICTEST_MYSQL_USER => 0,
445 DBICTEST_MYSQL_PASS => 0,
449 test_rdbms_oracle => {
450 include => 'rdbms_oracle',
452 DBICTEST_ORA_DSN => 1,
453 DBICTEST_ORA_USER => 0,
454 DBICTEST_ORA_PASS => 0,
457 'DateTime::Format::Oracle' => '0',
458 'DBD::Oracle' => '1.24',
463 include => 'rdbms_ase',
465 DBICTEST_SYBASE_DSN => 1,
466 DBICTEST_SYBASE_USER => 0,
467 DBICTEST_SYBASE_PASS => 0,
472 include => 'rdbms_db2',
474 DBICTEST_DB2_DSN => 1,
475 DBICTEST_DB2_USER => 0,
476 DBICTEST_DB2_PASS => 0,
480 test_rdbms_db2_400 => {
481 include => 'rdbms_db2_400',
483 DBICTEST_DB2_400_DSN => 1,
484 DBICTEST_DB2_400_USER => 0,
485 DBICTEST_DB2_400_PASS => 0,
489 test_rdbms_informix => {
490 include => 'rdbms_informix',
492 DBICTEST_INFORMIX_DSN => 1,
493 DBICTEST_INFORMIX_USER => 0,
494 DBICTEST_INFORMIX_PASS => 0,
498 test_rdbms_sqlanywhere => {
499 include => 'rdbms_sqlanywhere',
501 DBICTEST_SQLANYWHERE_DSN => 1,
502 DBICTEST_SQLANYWHERE_USER => 0,
503 DBICTEST_SQLANYWHERE_PASS => 0,
507 test_rdbms_sqlanywhere_odbc => {
508 include => 'rdbms_sqlanywhere_odbc',
510 DBICTEST_SQLANYWHERE_ODBC_DSN => 1,
511 DBICTEST_SQLANYWHERE_ODBC_USER => 0,
512 DBICTEST_SQLANYWHERE_ODBC_PASS => 0,
516 test_rdbms_firebird => {
517 include => 'rdbms_firebird',
519 DBICTEST_FIREBIRD_DSN => 1,
520 DBICTEST_FIREBIRD_USER => 0,
521 DBICTEST_FIREBIRD_PASS => 0,
525 test_rdbms_firebird_interbase => {
526 include => 'rdbms_firebird_interbase',
528 DBICTEST_FIREBIRD_INTERBASE_DSN => 1,
529 DBICTEST_FIREBIRD_INTERBASE_USER => 0,
530 DBICTEST_FIREBIRD_INTERBASE_PASS => 0,
534 test_rdbms_firebird_odbc => {
535 include => 'rdbms_firebird_odbc',
537 DBICTEST_FIREBIRD_ODBC_DSN => 1,
538 DBICTEST_FIREBIRD_ODBC_USER => 0,
539 DBICTEST_FIREBIRD_ODBC_PASS => 0,
545 DBICTEST_MEMCACHED => 1,
548 'Cache::Memcached' => 0,
554 %$test_and_dist_json_any,
555 'ExtUtils::MakeMaker' => '6.64',
556 'Pod::Inherit' => '0.91',
562 'CPAN::Uploader' => '0.103001',
578 if ($action eq '-die_without') {
582 eval { $class->die_unless_req_ok_for(\@_); 1 }
585 die "\n$err\n" if $err;
587 elsif ($action eq '-list_missing') {
588 print $class->modreq_missing_for(\@_);
592 elsif ($action =~ /^-/) {
593 croak "Unknown import-time action '$action'";
596 croak "$class is not an exporter, unable to import '$action'";
604 croak( __PACKAGE__ . " does not implement unimport" );
607 # OO for (mistakenly considered) ease of extensibility, not due to any need to
608 # carry state of any sort. This API is currently used outside, so leave as-is.
609 # FIXME - make sure to not propagate this further if module is extracted as a
610 # standalone library - keep the stupidity to a DBIC-secific shim!
613 shift->_groups_to_reqs(@_)->{effective_modreqs};
616 sub modreq_list_for {
617 shift->_groups_to_reqs(@_)->{modreqs};
622 { $_ => $_[0]->_groups_to_reqs($_) }
627 sub req_errorlist_for { shift->modreq_errorlist_for(@_) } # deprecated
628 sub modreq_errorlist_for {
630 $self->_errorlist_for_modreqs( $self->_groups_to_reqs(@_)->{modreqs} );
634 shift->req_missing_for(@_) ? 0 : 1;
637 sub req_missing_for {
640 my $reqs = $self->_groups_to_reqs(@_);
641 my $mods_missing = $self->modreq_missing_for(@_);
646 ! $reqs->{missing_envvars}
649 my @res = $mods_missing || ();
651 push @res, 'the following group(s) of environment variables: ' . join ' and ', map
652 { __envvar_group_desc($_) }
653 @{$reqs->{missing_envvars}}
654 if $reqs->{missing_envvars};
657 ( join ' as well as ', @res )
659 ( $reqs->{modreqs_fully_documented} ? " (see @{[ ref $self || $self ]} documentation for details)" : '' ),
663 sub modreq_missing_for {
666 my $reqs = $self->_groups_to_reqs(@_);
667 my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs})
671 { $reqs->{modreqs}{$_} ? qq("$_~>=$reqs->{modreqs}{$_}") : $_ }
672 sort { lc($a) cmp lc($b) } keys %$modreq_errors
676 sub die_unless_req_ok_for {
677 if (my $err = shift->req_missing_for(@_) ) {
678 die "Unable to continue due to missing requirements: $err\n";
684 ### Private functions
686 # potentially shorten group desc
687 sub __envvar_group_desc {
690 my (@res, $last_prefix);
691 while (my $ev = shift @envs) {
692 my ($pref, $sep, $suff) = split / ([\_\-]) (?= [^\_\-]+ \z )/x, $ev;
694 if ( defined $sep and ($last_prefix||'') eq $pref ) {
695 push @res, "...${sep}${suff}"
701 $last_prefix = $pref if $sep;
710 our %req_unavailability_cache;
712 # this method is just a lister and envvar/metadata checker - it does not try to load anything
713 my $processed_groups = {};
714 sub _groups_to_reqs {
715 my ($self, $groups) = @_;
717 $groups = [ $groups || () ]
718 unless ref $groups eq 'ARRAY';
720 croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names"
725 modreqs_fully_documented => 1,
728 for my $group ( grep { ! $processed_groups->{$_} } @$groups ) {
730 $group =~ /\A [A-Za-z][0-9A-Z_a-z]* \z/x
731 or croak "Invalid requirement group name '$group': only ascii alphanumerics and _ are allowed";
733 croak "Requirement group '$group' is not defined" unless defined $dbic_reqs->{$group};
735 my $group_reqs = $dbic_reqs->{$group}{req};
738 for (keys %$group_reqs) {
740 $_ =~ /\A [A-Z_a-z][0-9A-Z_a-z]* (?:::[0-9A-Z_a-z]+)* \z /x
741 or croak "Requirement '$_' in group '$group' is not a valid module name";
743 # !!!DO NOT CHANGE!!!
744 # remember - version.pm may not be available on the system
745 croak "Requirement '$_' in group '$group' specifies an invalid version '$group_reqs->{$_}' (only plain non-underscored floating point decimals are supported)"
746 if ( ($group_reqs->{$_}||0) !~ / \A [0-9]+ (?: \. [0-9]+ )? \z /x );
749 # check if we have all required envvars if such names are defined
750 my ($some_envs_required, $some_envs_missing);
751 if (my @e = @{$dbic_reqs->{$group}{env} || [] }) {
753 croak "Unexpected 'env' attribute under group '$group' (only allowed in test_* groups)"
754 unless $group =~ /^test_/;
756 croak "Unexpected *odd* list in 'env' under group '$group'"
759 my @group_envnames_list;
761 # deconstruct the whole thing
763 push @group_envnames_list, my $envname = shift @e;
765 # env required or not
766 next unless shift @e;
768 $some_envs_required ||= 1;
770 $some_envs_missing ||= (
771 ! defined $ENV{$envname}
773 ! length $ENV{$envname}
777 croak "None of the envvars in group '$group' declared as required, making the requirement moot"
778 unless $some_envs_required;
780 push @{$ret->{missing_envvars}}, \@group_envnames_list if $some_envs_missing;
783 # get the reqs for includes if any
785 if (my $incs = $dbic_reqs->{$group}{include}) {
786 $incs = [ $incs ] unless ref $incs eq 'ARRAY';
788 croak "Malformed 'include' for group '$group': must be another existing group name or arrayref of existing group names"
791 local $processed_groups->{$group} = 1;
793 my $subreqs = $self->_groups_to_reqs($incs);
795 croak "Includes with variable effective_modreqs not yet supported"
796 if $subreqs->{effective_modreqs_differ};
798 $inc_reqs = $subreqs->{modreqs};
802 # assemble into the final ret
805 $some_envs_missing ? () : 'effective_modreqs'
807 for my $req_bag ($group_reqs, $inc_reqs||()) {
808 for my $mod (keys %$req_bag) {
810 $ret->{$type}{$mod} = $req_bag->{$mod}||0 if (
812 ! exists $ret->{$type}{$mod}
814 # we sanitized the version to be numeric above - we can just -gt it
815 ($req_bag->{$mod}||0) > $ret->{$type}{$mod}
822 $ret->{effective_modreqs_differ} ||= !!$some_envs_missing;
824 $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod};
831 # this method tries to load specified modreqs and returns a hashref of
832 # module/loaderror pairs for anything that failed
833 sub _errorlist_for_modreqs {
834 # args supposedly already went through _groups_to_reqs and are therefore sanitized
835 # safe to eval at will
836 my ($self, $reqs) = @_;
840 for my $m ( keys %$reqs ) {
843 if (! exists $req_unavailability_cache{$m}{$v} ) {
845 eval( "require $m;" . ( $v ? "$m->VERSION(q($v))" : '' ) );
846 $req_unavailability_cache{$m}{$v} = $@;
849 $ret->{$m} = $req_unavailability_cache{$m}{$v}
850 if $req_unavailability_cache{$m}{$v};
857 # This is to be called by the author only (automatically in Makefile.PL)
859 my ($class, $distver, $pod_dir) = @_;
861 die "No POD root dir supplied" unless $pod_dir;
864 eval { require DBIx::Class; DBIx::Class->VERSION; }
867 "\n\n---------------------------------------------------------------------\n" .
868 'Unable to load core DBIx::Class module to determine current version, '.
869 'possibly due to missing dependencies. Author-mode autodocumentation ' .
871 "\n\n---------------------------------------------------------------------\n"
874 # do not ask for a recent version, use 1.x API calls
875 # this *may* execute on a smoker with old perl or whatnot
878 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
880 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
881 (my $dir = $podfn) =~ s|/[^/]+$||;
883 File::Path::mkpath([$dir]);
885 my $sqltver = $class->req_list_for('deploy')->{'SQL::Translator'}
886 or die "Hrmm? No sqlt dep?";
894 push @chunks, <<"EOC";
895 #########################################################################
896 ##################### A U T O G E N E R A T E D ########################
897 #########################################################################
899 # The contents of this POD file are auto-generated. Any changes you make
900 # will be lost. If you need to change the generated text edit _gen_pod()
901 # at the end of $modfn
906 $class - Optional module dependency specifications (for module authors)
913 push @chunks, <<"EOC";
916 Somewhere in your build-file (e.g. L<ExtUtils::MakeMaker>'s F<Makefile.PL>):
920 \$EUMM_ARGS{CONFIGURE_REQUIRES} = {
921 \%{ \$EUMM_ARGS{CONFIGURE_REQUIRES} || {} },
922 'DBIx::Class' => '$distver',
927 my %DBIC_DEPLOY_DEPS = %{ eval {
929 $class->req_list_for('deploy');
932 \$EUMM_ARGS{PREREQ_PM} = {
934 \%{ \$EUMM_ARGS{PREREQ_PM} || {} },
939 ExtUtils::MakeMaker::WriteMakefile(\%EUMM_ARGS);
941 B<Note>: The C<eval> protection within the example is due to support for
942 requirements during L<the C<configure> build phase|CPAN::Meta::Spec/Phases>
943 not being available on a sufficient portion of production installations of
944 Perl. Robust support for such dependency requirements is available in the
945 L<CPAN> installer only since version C<1.94_56> first made available for
946 production with perl version C<5.12>. It is the belief of the current
947 maintainer that support for requirements during the C<configure> build phase
948 will not be sufficiently ubiquitous until the B<year 2020> at the earliest,
949 hence the extra care demonstrated above. It should also be noted that some
950 3rd party installers (e.g. L<cpanminus|App::cpanminus>) do the right thing
951 with configure requirements independent from the versions of perl and CPAN
957 #@@ DESCRIPTION HEADING
959 push @chunks, <<'EOC';
962 Some of the less-frequently used features of L<DBIx::Class> have external
963 module dependencies on their own. In order not to burden the average user
964 with modules they will never use, these optional dependencies are not included
965 in the base Makefile.PL. Instead an exception with a descriptive message is
966 thrown when a specific feature can't find one or several modules required for
967 its operation. This module is the central holding place for the current list
968 of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
971 Dependencies are organized in L<groups|/CURRENT REQUIREMENT GROUPS> where each
972 group can list one or more required modules, with an optional minimum version
973 (or 0 for any version). In addition groups prefixed with C<test_> can specify
974 a set of environment variables, some (or all) of which are marked as required
975 for the group to be considered by L</req_list_for>
977 Each group name (or a combination thereof) can be used in the
978 L<public methods|/METHODS> as described below.
983 #@@ REQUIREMENT GROUPLIST HEADING
985 push @chunks, '=head1 CURRENT REQUIREMENT GROUPS';
987 for my $group (sort keys %$dbic_reqs) {
988 my $p = $dbic_reqs->{$group}{pod}
991 my $modlist = $class->modreq_list_for($group);
993 next unless keys %$modlist;
996 "=head2 $p->{title}",
999 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
1001 "Requirement group: B<$group>",
1007 #@@ API DOCUMENTATION HEADING
1009 push @chunks, <<'EOC';
1011 =head1 IMPORT-LIKE ACTIONS
1013 Even though this module is not an L<Exporter>, it recognizes several C<actions>
1014 supplied to its C<import> method.
1020 =item Arguments: @group_names
1024 A convenience wrapper around L</die_unless_req_ok_for>:
1027 push @chunks, " use $class -die_without => qw(deploy admin);";
1029 push @chunks, <<'EOC';
1031 =head2 -list_missing
1035 =item Arguments: @group_names
1039 A convenience wrapper around L</modreq_missing_for>:
1041 perl -Ilib -MDBIx::Class::Optional::Dependencies=-list_missing,deploy,admin | cpanm
1045 =head2 req_group_list
1049 =item Arguments: none
1051 =item Return Value: \%list_of_requirement_groups
1055 This method should be used by DBIx::Class packagers, to get a hashref of all
1056 dependencies B<keyed> by dependency group. Each key (group name), or a combination
1057 thereof (as an arrayref) can be supplied to the methods below.
1058 The B<values> of the returned hash are currently a set of options B<without a
1059 well defined structure>. If you have use for any of the contents - contact the
1060 maintainers, instead of treating this as public (left alone stable) API.
1066 =item Arguments: $group_name | \@group_names
1068 =item Return Value: \%set_of_module_version_pairs
1072 This method should be used by DBIx::Class extension authors, to determine the
1073 version of modules a specific set of features requires for this version of
1074 DBIx::Class (regardless of their availability on the system).
1075 See the L</SYNOPSIS> for a real-world example.
1077 When handling C<test_*> groups this method behaves B<differently> from
1078 L</modreq_list_for> below (and is the only such inconsistency among the
1079 C<req_*> methods). If a particular group declares as requirements some
1080 C<environment variables> and these requirements are not satisfied (the envvars
1081 are unset) - then the C<module requirements> of this group are not included in
1084 =head2 modreq_list_for
1088 =item Arguments: $group_name | \@group_names
1090 =item Return Value: \%set_of_module_version_pairs
1094 Same as L</req_list_for> but does not take into consideration any
1095 C<environment variable requirements> - returns just the list of required
1102 =item Arguments: $group_name | \@group_names
1104 =item Return Value: 1|0
1108 Returns true or false depending on whether all modules/envvars required by
1109 the group(s) are loadable/set on the system.
1111 =head2 req_missing_for
1115 =item Arguments: $group_name | \@group_names
1117 =item Return Value: $error_message_string
1121 Returns a single-line string suitable for inclusion in larger error messages.
1122 This method would normally be used by DBIx::Class core features, to indicate to
1123 the user that they need to install specific modules and/or set specific
1124 environment variables before being able to use a specific feature set.
1126 For example if some of the requirements for C<deploy> are not available,
1127 the returned string could look like:
1130 push @chunks, qq{ "SQL::Translator~>=$sqltver" (see $class documentation for details)};
1132 push @chunks, <<'EOC';
1133 The author is expected to prepend the necessary text to this message before
1134 returning the actual error seen by the user. See also L</modreq_missing_for>
1136 =head2 modreq_missing_for
1140 =item Arguments: $group_name | \@group_names
1142 =item Return Value: $error_message_string
1146 Same as L</req_missing_for> except that the error string is guaranteed to be
1147 either empty, or contain a set of module requirement specifications suitable
1148 for piping to e.g. L<cpanminus|App::cpanminus>. The method explicitly does not
1149 attempt to validate the state of required environment variables (if any).
1151 For instance if some of the requirements for C<deploy> are not available,
1152 the returned string could look like:
1155 push @chunks, qq{ "SQL::Translator~>=$sqltver"};
1157 push @chunks, <<'EOC';
1159 See also L</-list_missing>.
1161 =head2 die_unless_req_ok_for
1165 =item Arguments: $group_name | \@group_names
1169 Checks if L</req_ok_for> passes for the supplied group(s), and
1170 in case of failure throws an exception including the information
1171 from L</req_missing_for>. See also L</-die_without>.
1173 =head2 modreq_errorlist_for
1177 =item Arguments: $group_name | \@group_names
1179 =item Return Value: \%set_of_loaderrors_per_module
1183 Returns a hashref containing the actual errors that occurred while attempting
1184 to load each module in the requirement group(s).
1186 =head2 req_errorlist_for
1188 Deprecated method name, equivalent (via proxy) to L</modreq_errorlist_for>.
1195 push @chunks, <<'EOC';
1196 =head1 FURTHER QUESTIONS?
1198 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1200 =head1 COPYRIGHT AND LICENSE
1202 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1203 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1204 redistribute it and/or modify it under the same terms as the
1205 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
1209 open (my $fh, '>', $podfn) or die;
1210 print $fh join ("\n\n", @chunks) or die;
1211 print $fh "\n" or die;
1213 } or croak( "Unable to write $podfn: " . ( $! || $@ || 'unknown error') );