X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FOptional%2FDependencies.pm;h=1f353a36805ec3e86ec8a0c1059d96036a68ea55;hb=be68095d16b02db81aa1c37dfd6f6595f19d1ac2;hp=aa4701ffa6c2526e537bb2e5b3382115bff23565;hpb=fb39747c525a55b3b569057867d971878457ede0;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm index aa4701f..1f353a3 100644 --- a/lib/DBIx/Class/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Optional/Dependencies.pm @@ -8,107 +8,375 @@ use Carp; # NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G) # This module is to be loaded by Makefile.PM on a pristine system +# POD is generated automatically by calling _gen_pod from the +# Makefile.PL in $AUTHOR mode + +my $json_any = { + 'JSON::Any' => '1.22', +}; + +my $moose_basic = { + 'Moose' => '0.98', + 'MooseX::Types' => '0.21', +}; + +my $replicated = { + %$moose_basic, + 'Hash::Merge' => '0.12', +}; + +my $admin_basic = { + %$moose_basic, + %$json_any, + 'MooseX::Types::Path::Class' => '0.05', + 'MooseX::Types::JSON' => '0.02', + 'namespace::autoclean' => '0.09', +}; + +my $datetime_basic = { + 'DateTime' => '0.55', + 'DateTime::Format::Strptime' => '1.2', +}; + +my $id_shortener = { + 'Math::BigInt' => '1.89', + 'Math::Base36' => '0.07', +}; + +my $rdbms_sqlite = { + 'DBD::SQLite' => '0', +}; +my $rdbms_pg = { + 'DBD::Pg' => '0', +}; +my $rdbms_mssql_odbc = { + 'DBD::ODBC' => '0', +}; +my $rdbms_mssql_sybase = { + 'DBD::Sybase' => '0', +}; +my $rdbms_mysql = { + 'DBD::mysql' => '0', +}; +my $rdbms_oracle = { + 'DBD::Oracle' => '0', + %$id_shortener, +}; +my $rdbms_ase = { + 'DBD::Sybase' => '0', +}; +my $rdbms_db2 = { + 'DBD::DB2' => '0', +}; + my $reqs = { dist => { #'Module::Install::Pod::Inherit' => '0.01', }, replicated => { - 'Moose' => '0.98', - 'MooseX::Types' => '0.21', - 'namespace::clean' => '0.11', - 'Hash::Merge' => '0.11', + req => $replicated, + pod => { + title => 'Storage::Replicated', + desc => 'Modules required for L', + }, }, + test_replicated => { + req => { + %$replicated, + 'Test::Moose' => '0', + }, + }, + + admin => { + req => { + %$admin_basic, + }, + pod => { + title => 'DBIx::Class::Admin', + desc => 'Modules required for the DBIx::Class administrative library', + }, + }, + + admin_script => { + req => { + %$moose_basic, + %$admin_basic, + 'Getopt::Long::Descriptive' => '0.081', + 'Text::CSV' => '1.16', + }, + pod => { + title => 'dbicadmin', + desc => 'Modules required for the CLI DBIx::Class interface dbicadmin', + }, }, deploy => { - 'SQL::Translator' => '0.11002', + req => { + 'SQL::Translator' => '0.11006', + }, + pod => { + title => 'Storage::DBI::deploy()', + desc => 'Modules required for L and L', + }, }, - author => { - 'Test::Pod' => '1.26', - 'Test::Pod::Coverage' => '1.08', - 'Pod::Coverage' => '0.20', - #'Test::NoTabs' => '0.9', - #'Test::EOL' => '0.6', + id_shortener => { + req => $id_shortener, }, - core => { - # t/52cycle.t - 'Test::Memory::Cycle' => '0', - 'Devel::Cycle' => '1.10', + test_pod => { + req => { + 'Test::Pod' => '1.41', + }, + }, - # t/36datetime.t - # t/60core.t - 'DateTime::Format::SQLite' => '0', + test_podcoverage => { + req => { + 'Test::Pod::Coverage' => '1.08', + 'Pod::Coverage' => '0.20', + }, + }, + + test_notabs => { + req => { + 'Test::NoTabs' => '0.9', + }, + }, + + test_eol => { + req => { + 'Test::EOL' => '0.6', + }, + }, + + test_prettydebug => { + req => $json_any, + }, + + test_leaks => { + req => { + 'Test::Memory::Cycle' => '0', + 'Devel::Cycle' => '1.10', + }, + }, + + test_dt => { + req => $datetime_basic, + }, + + test_dt_sqlite => { + req => { + %$datetime_basic, + # t/36datetime.t + # t/60core.t + 'DateTime::Format::SQLite' => '0', + }, + }, + + test_dt_mysql => { + req => { + %$datetime_basic, + # t/inflate/datetime_mysql.t + # (doesn't need Mysql itself) + 'DateTime::Format::MySQL' => '0', + }, + }, - # t/96_is_deteministic_value.t - 'DateTime::Format::Strptime'=> '0', + test_dt_pg => { + req => { + %$datetime_basic, + # t/inflate/datetime_pg.t + # (doesn't need PG itself) + 'DateTime::Format::Pg' => '0.16004', + }, }, - cdbicompat => { - 'DBIx::ContextualFetch' => '0', - 'Class::DBI::Plugin::DeepAbstractSearch' => '0', - 'Class::Trigger' => '0', - 'Time::Piece::MySQL' => '0', - 'Clone' => '0', - 'Date::Simple' => '3.03', + test_cdbicompat => { + req => { + 'DBIx::ContextualFetch' => '0', + 'Class::DBI::Plugin::DeepAbstractSearch' => '0', + 'Class::Trigger' => '0', + 'Time::Piece::MySQL' => '0', + 'Clone' => '0', + 'Date::Simple' => '3.03', + }, + }, + + # this is just for completeness as SQLite + # is a core dep of DBIC for testing + rdbms_sqlite => { + req => { + %$rdbms_sqlite, + }, + pod => { + title => 'SQLite support', + desc => 'Modules required to connect to SQLite', + }, }, rdbms_pg => { - $ENV{DBICTEST_PG_DSN} - ? ( - 'Sys::SigAction' => '0', - 'DBD::Pg' => '2.009002', - 'DateTime::Format::Pg' => '0', - ) : () + req => { + %$rdbms_pg, + }, + pod => { + title => 'PostgreSQL support', + desc => 'Modules required to connect to PostgreSQL', + }, + }, + + rdbms_mssql_odbc => { + req => { + %$rdbms_mssql_odbc, + }, + pod => { + title => 'MSSQL support via DBD::ODBC', + desc => 'Modules required to connect to MSSQL via DBD::ODBC', + }, + }, + + rdbms_mssql_sybase => { + req => { + %$rdbms_mssql_sybase, + }, + pod => { + title => 'MSSQL support via DBD::Sybase', + desc => 'Modules required to connect to MSSQL support via DBD::Sybase', + }, }, rdbms_mysql => { - $ENV{DBICTEST_MYSQL_DSN} - ? ( - 'DateTime::Format::MySQL' => '0', - 'DBD::mysql' => '0', - ) : () + req => { + %$rdbms_mysql, + }, + pod => { + title => 'MySQL support', + desc => 'Modules required to connect to MySQL', + }, }, rdbms_oracle => { - - $ENV{DBICTEST_ORA_DSN} - ? ( - 'DateTime::Format::Oracle' => '0', - ) : () + req => { + %$rdbms_oracle, + }, + pod => { + title => 'Oracle support', + desc => 'Modules required to connect to Oracle', + }, }, rdbms_ase => { - $ENV{DBICTEST_SYBASE_DSN} - ? ( - 'DateTime::Format::Sybase' => 0, - ) : () + req => { + %$rdbms_ase, + }, + pod => { + title => 'Sybase ASE support', + desc => 'Modules required to connect to Sybase ASE', + }, + }, + + rdbms_db2 => { + req => { + %$rdbms_db2, + }, + pod => { + title => 'DB2 support', + desc => 'Modules required to connect to DB2', + }, + }, + +# the order does matter because the rdbms support group might require +# a different version that the test group + test_rdbms_pg => { + req => { + $ENV{DBICTEST_PG_DSN} + ? ( + %$rdbms_pg, + 'Sys::SigAction' => '0', + 'DBD::Pg' => '2.009002', + ) : () + }, + }, + + test_rdbms_mssql_odbc => { + req => { + $ENV{DBICTEST_MSSQL_ODBC_DSN} + ? ( + %$rdbms_mssql_odbc, + ) : () + }, + }, + + test_rdbms_mssql_sybase => { + req => { + $ENV{DBICTEST_MSSQL_DSN} + ? ( + %$rdbms_mssql_sybase, + ) : () + }, + }, + + test_rdbms_mysql => { + req => { + $ENV{DBICTEST_MYSQL_DSN} + ? ( + %$rdbms_mysql, + ) : () + }, + }, + + test_rdbms_oracle => { + req => { + $ENV{DBICTEST_ORA_DSN} + ? ( + %$rdbms_oracle, + 'DateTime::Format::Oracle' => '0', + 'DBD::Oracle' => '1.24', + ) : () + }, + }, + + test_rdbms_ase => { + req => { + $ENV{DBICTEST_SYBASE_DSN} + ? ( + %$rdbms_ase, + 'DateTime::Format::Sybase' => '0', + ) : () + }, }, - rdbms_asa => { - grep $_, @ENV{qw/DBICTEST_SYBASE_ASA_DSN DBICTEST_SYBASE_ASA_ODBC_DSN/} - ? ( - 'DateTime::Format::Strptime' => 0, - ) : () + test_rdbms_db2 => { + req => { + $ENV{DBICTEST_DB2_DSN} + ? ( + %$rdbms_db2, + ) : () + }, }, + + test_memcached => { + req => { + $ENV{DBICTEST_MEMCACHED} + ? ( + 'Cache::Memcached' => 0, + ) : () + }, + }, + }; -sub all_optional_requirements { - return { map { %{ $_ || {} } } (values %$reqs) }; -} sub req_list_for { my ($class, $group) = @_; - die "req_list_for() expects a requirement group name" + croak "req_list_for() expects a requirement group name" unless $group; - my $deps = $reqs->{$group} - or die "Requirement group '$group' does not exist"; + my $deps = $reqs->{$group}{req} + or croak "Requirement group '$group' does not exist"; return { %$deps }; } @@ -121,9 +389,7 @@ sub req_ok_for { croak "req_ok_for() expects a requirement group name" unless $group; - $class->_check_deps ($group) unless $req_availability_cache{$group}; - - return $req_availability_cache{$group}{status}; + return $class->_check_deps($group)->{status}; } sub req_missing_for { @@ -132,9 +398,7 @@ sub req_missing_for { croak "req_missing_for() expects a requirement group name" unless $group; - $class->_check_deps ($group) unless $req_availability_cache{$group}; - - return $req_availability_cache{$group}{missing}; + return $class->_check_deps($group)->{missing}; } sub req_errorlist_for { @@ -143,43 +407,224 @@ sub req_errorlist_for { croak "req_errorlist_for() expects a requirement group name" unless $group; - $class->_check_deps ($group) unless $req_availability_cache{$group}; - - return $req_availability_cache{$group}{errorlist}; + return $class->_check_deps($group)->{errorlist}; } sub _check_deps { my ($class, $group) = @_; - my $deps = $reqs->{$group} - or croak "Requirement group '$group' does not exist"; + return $req_availability_cache{$group} ||= do { + + my $deps = $class->req_list_for ($group); + + my %errors; + for my $mod (keys %$deps) { + my $req_line = "require $mod;"; + if (my $ver = $deps->{$mod}) { + $req_line .= "$mod->VERSION($ver);"; + } - my %errors; - for my $mod (keys %$deps) { - if (my $ver = $deps->{$mod}) { - eval "use $mod $ver ()"; + eval $req_line; + + $errors{$mod} = $@ if $@; + } + + my $res; + + if (keys %errors) { + my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) ); + $missing .= " (see $class for details)" if $reqs->{$group}{pod}; + $res = { + status => 0, + errorlist => \%errors, + missing => $missing, + }; } else { - eval "require $mod"; + $res = { + status => 1, + errorlist => {}, + missing => '', + }; } - $errors{$mod} = $@ if $@; - } + $res; + }; +} + +sub req_group_list { + return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) }; +} - if (keys %errors) { - $req_availability_cache{$group} = { - status => 0, - errorlist => { %errors }, - missing => join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) ), - }; +# This is to be called by the author only (automatically in Makefile.PL) +sub _gen_pod { + my ($class, $distver) = @_; + + my $modfn = __PACKAGE__ . '.pm'; + $modfn =~ s/\:\:/\//g; + + my $podfn = __FILE__; + $podfn =~ s/\.pm$/\.pod/; + + $distver ||= + eval { require DBIx::Class; DBIx::Class->VERSION; } + || + die +"\n\n---------------------------------------------------------------------\n" . +'Unable to load core DBIx::Class module to determine current version, '. +'possibly due to missing dependencies. Author-mode autodocumentation ' . +"halted\n\n" . $@ . +"\n\n---------------------------------------------------------------------\n" + ; + + my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'} + or die "Hrmm? No sqlt dep?"; + + my @chunks = ( + <<'EOC', +######################################################################### +##################### A U T O G E N E R A T E D ######################## +######################################################################### +# +# The contents of this POD file are auto-generated. Any changes you make +# will be lost. If you need to change the generated text edit _gen_pod() +# at the end of $modfn +# +EOC + '=head1 NAME', + "$class - Optional module dependency specifications (for module authors)", + '=head1 SYNOPSIS', + <<"EOS", +Somewhere in your build-file (e.g. L's Makefile.PL): + + ... + + configure_requires 'DBIx::Class' => '$distver'; + + require $class; + + my \$deploy_deps = $class->req_list_for('deploy'); + + for (keys %\$deploy_deps) { + requires \$_ => \$deploy_deps->{\$_}; } - else { - $req_availability_cache{$group} = { - status => 1, - errorlist => {}, - missing => '', - }; + + ... + +Note that there are some caveats regarding C, more info +can be found at L +EOS + '=head1 DESCRIPTION', + <<'EOD', +Some of the less-frequently used features of L have external +module dependencies on their own. In order not to burden the average user +with modules he will never use, these optional dependencies are not included +in the base Makefile.PL. Instead an exception with a descriptive message is +thrown when a specific feature is missing one or several modules required for +its operation. This module is the central holding place for the current list +of such dependencies, for DBIx::Class core authors, and DBIx::Class extension +authors alike. +EOD + '=head1 CURRENT REQUIREMENT GROUPS', + <<'EOD', +Dependencies are organized in C and each group can list one or more +required modules, with an optional minimum version (or 0 for any version). +The group name can be used in the +EOD + ); + + for my $group (sort keys %$reqs) { + my $p = $reqs->{$group}{pod} + or next; + + my $modlist = $reqs->{$group}{req} + or next; + + next unless keys %$modlist; + + push @chunks, ( + "=head2 $p->{title}", + "$p->{desc}", + '=over', + ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ), + '=back', + "Requirement group: B<$group>", + ); } + + push @chunks, ( + '=head1 METHODS', + '=head2 req_group_list', + '=over', + '=item Arguments: none', + '=item Returns: \%list_of_requirement_groups', + '=back', + <<'EOD', +This method should be used by DBIx::Class packagers, to get a hashref of all +dependencies keyed by dependency group. Each key (group name) can be supplied +to one of the group-specific methods below. +EOD + + '=head2 req_list_for', + '=over', + '=item Arguments: $group_name', + '=item Returns: \%list_of_module_version_pairs', + '=back', + <<'EOD', +This method should be used by DBIx::Class extension authors, to determine the +version of modules a specific feature requires in the B version of +DBIx::Class. See the L for a real-world +example. +EOD + + '=head2 req_ok_for', + '=over', + '=item Arguments: $group_name', + '=item Returns: 1|0', + '=back', + <<'EOD', +Returns true or false depending on whether all modules required by +C<$group_name> are present on the system and loadable. +EOD + + '=head2 req_missing_for', + '=over', + '=item Arguments: $group_name', + '=item Returns: $error_message_string', + '=back', + <<"EOD", +Returns a single line string suitable for inclusion in larger error messages. +This method would normally be used by DBIx::Class core-module author, to +indicate to the user that he needs to install specific modules before he will +be able to use a specific feature. + +For example if some of the requirements for C are not available, +the returned string could look like: + + SQL::Translator >= $sqltver (see $class for details) + +The author is expected to prepend the necessary text to this message before +returning the actual error seen by the user. +EOD + + '=head2 req_errorlist_for', + '=over', + '=item Arguments: $group_name', + '=item Returns: \%list_of_loaderrors_per_module', + '=back', + <<'EOD', +Returns a hashref containing the actual errors that occured while attempting +to load each module in the requirement group. +EOD + '=head1 AUTHOR', + 'See L.', + '=head1 LICENSE', + 'You may distribute this code under the same terms as Perl itself', + ); + + open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!"; + print $fh join ("\n\n", @chunks); + close ($fh); } 1;