recommended-0.003/000755 000765 000024 00000000000 12516254176 014241 5ustar00davidstaff000000 000000 recommended-0.003/Changes000644 000765 000024 00000001033 12516254176 015531 0ustar00davidstaff000000 000000 Revision history for recommended 0.003 2015-04-23 16:39:23-04:00 America/New_York [Fixes] - Ensures that has() returns a false value not the empty-list in list context. This avoids a subtle bug in C<< use if recommended->has("Something"), "Foo" >>. 0.002 2014-11-05 22:03:17-05:00 America/New_York [Fixes] - Throws an error if a recommended/suggested module fails to compile instead of silently ignoring this case 0.001 2014-11-05 16:37:00-05:00 America/New_York - First release recommended-0.003/CONTRIBUTING.mkdn000644 000765 000024 00000005751 12516254176 017033 0ustar00davidstaff000000 000000 ## HOW TO CONTRIBUTE Thank you for considering contributing to this distribution. This file contains instructions that will help you work with the source code. The distribution is managed with Dist::Zilla. This means than many of the usual files you might expect are not in the repository, but are generated at release time, as is much of the documentation. Some generated files are kept in the repository as a convenience (e.g. Makefile.PL or cpanfile). Generally, **you do not need Dist::Zilla to contribute patches**. You do need Dist::Zilla to create a tarball. See below for guidance. ### Getting dependencies If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy dependencies like this: $ cpanm --installdeps . Otherwise, look for either a `Makefile.PL` or `cpanfile` file for a list of dependencies to satisfy. ### Running tests You can run tests directly using the `prove` tool: $ prove -l $ prove -lv t/some_test_file.t For most of my distributions, `prove` is entirely sufficient for you to test any patches you have. I use `prove` for 99% of my testing during development. ### Code style and tidying Please try to match any existing coding style. If there is a `.perltidyrc` file, please install Perl::Tidy and use perltidy before submitting patches. If there is a `tidyall.ini` file, you can also install Code::TidyAll and run `tidyall` on a file or `tidyall -a` to tidy all files. ### Patching documentation Much of the documentation Pod is generated at release time. Some is generated boilerplate; other documentation is built from pseudo-POD directives in the source like C<=method> or C<=func>. If you would like to submit a documentation edit, please limit yourself to the documentation you see. If you see typos or documentation issues in the generated docs, please email or open a bug ticket instead of patching. ### Installing and using Dist::Zilla Dist::Zilla is a very powerful authoring tool, optimized for maintaining a large number of distributions with a high degree of automation, but it has a large dependency chain, a bit of a learning curve and requires a number of author-specific plugins. To install it from CPAN, I recommend one of the following approaches for the quickest installation: # using CPAN.pm, but bypassing non-functional pod tests $ cpan TAP::Harness::Restricted $ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla # using cpanm, bypassing *all* tests $ cpanm -n Dist::Zilla In either case, it's probably going to take about 10 minutes. Go for a walk, go get a cup of your favorite beverage, take a bathroom break, or whatever. When you get back, Dist::Zilla should be ready for you. Then you need to install any plugins specific to this distribution: $ cpan `dzil authordeps` $ dzil authordeps | cpanm Once installed, here are some dzil commands you might try: $ dzil build $ dzil test $ dzil xtest You can learn more about Dist::Zilla at http://dzil.org/ recommended-0.003/cpanfile000644 000765 000024 00000001774 12516254176 015756 0ustar00davidstaff000000 000000 requires "Carp" => "0"; requires "Module::Runtime" => "0.014"; requires "perl" => "5.008001"; requires "strict" => "0"; requires "version" => "0"; requires "warnings" => "0"; on 'test' => sub { requires "ExtUtils::MakeMaker" => "0"; requires "File::Spec" => "0"; requires "Test::More" => "0"; requires "perl" => "5.008001"; }; on 'test' => sub { recommends "CPAN::Meta" => "2.120900"; }; on 'configure' => sub { requires "ExtUtils::MakeMaker" => "6.17"; requires "perl" => "5.008001"; }; on 'develop' => sub { requires "Dist::Zilla" => "5"; requires "Dist::Zilla::PluginBundle::DAGOLDEN" => "0.072"; requires "File::Spec" => "0"; requires "File::Temp" => "0"; requires "IO::Handle" => "0"; requires "IPC::Open3" => "0"; requires "Pod::Coverage::TrustPod" => "0"; requires "Test::CPAN::Meta" => "0"; requires "Test::More" => "0"; requires "Test::Pod" => "1.41"; requires "Test::Pod::Coverage" => "1.08"; requires "Test::Spelling" => "0.12"; requires "Test::Version" => "1"; }; recommended-0.003/dist.ini000644 000765 000024 00000000255 12516254176 015707 0ustar00davidstaff000000 000000 name = recommended author = David Golden license = Apache_2_0 copyright_holder = David Golden copyright_year = 2014 [@DAGOLDEN] :version = 0.072 recommended-0.003/lib/000755 000765 000024 00000000000 12516254176 015007 5ustar00davidstaff000000 000000 recommended-0.003/LICENSE000644 000765 000024 00000026354 12516254176 015260 0ustar00davidstaff000000 000000 This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. recommended-0.003/Makefile.PL000644 000765 000024 00000002526 12516254176 016220 0ustar00davidstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.035. use strict; use warnings; use 5.008001; use ExtUtils::MakeMaker 6.17; my %WriteMakefileArgs = ( "ABSTRACT" => "Load recommended modules on demand when available", "AUTHOR" => "David Golden ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.17" }, "DISTNAME" => "recommended", "EXE_FILES" => [], "LICENSE" => "apache", "MIN_PERL_VERSION" => "5.008001", "NAME" => "recommended", "PREREQ_PM" => { "Carp" => 0, "Module::Runtime" => "0.014", "strict" => 0, "version" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Test::More" => 0 }, "VERSION" => "0.003", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "ExtUtils::MakeMaker" => "6.17", "File::Spec" => 0, "Module::Runtime" => "0.014", "Test::More" => 0, "strict" => 0, "version" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); recommended-0.003/MANIFEST000644 000765 000024 00000001001 12516254176 015362 0ustar00davidstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.035. CONTRIBUTING.mkdn Changes LICENSE MANIFEST META.json META.yml Makefile.PL README cpanfile dist.ini lib/recommended.pm lib/suggested.pm perlcritic.rc t/00-report-prereqs.dd t/00-report-prereqs.t t/basic.t tidyall.ini xt/author/00-compile.t xt/author/critic.t xt/author/pod-spell.t xt/release/distmeta.t xt/release/minimum-version.t xt/release/pod-coverage.t xt/release/pod-syntax.t xt/release/portability.t xt/release/test-version.t recommended-0.003/META.json000644 000765 000024 00000004721 12516254176 015666 0ustar00davidstaff000000 000000 { "abstract" : "Load recommended modules on demand when available", "author" : [ "David Golden " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 5.035, CPAN::Meta::Converter version 2.150002", "license" : [ "apache_2_0" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "recommended", "no_index" : { "directory" : [ "t", "xt", "examples", "corpus" ], "package" : [ "DB" ] }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.17", "perl" : "5.008001" } }, "develop" : { "requires" : { "Dist::Zilla" : "5", "Dist::Zilla::PluginBundle::DAGOLDEN" : "0.072", "File::Spec" : "0", "File::Temp" : "0", "IO::Handle" : "0", "IPC::Open3" : "0", "Pod::Coverage::TrustPod" : "0", "Test::CPAN::Meta" : "0", "Test::More" : "0", "Test::Pod" : "1.41", "Test::Pod::Coverage" : "1.08", "Test::Spelling" : "0.12", "Test::Version" : "1" } }, "runtime" : { "requires" : { "Carp" : "0", "Module::Runtime" : "0.014", "perl" : "5.008001", "strict" : "0", "version" : "0", "warnings" : "0" } }, "test" : { "recommends" : { "CPAN::Meta" : "2.120900" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec" : "0", "Test::More" : "0", "perl" : "5.008001" } } }, "provides" : { "recommended" : { "file" : "lib/recommended.pm", "version" : "0.003" }, "suggested" : { "file" : "lib/suggested.pm", "version" : "0.003" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/dagolden/recommended/issues" }, "homepage" : "https://github.com/dagolden/recommended", "repository" : { "type" : "git", "url" : "https://github.com/dagolden/recommended.git", "web" : "https://github.com/dagolden/recommended" } }, "version" : "0.003", "x_authority" : "cpan:DAGOLDEN" } recommended-0.003/META.yml000644 000765 000024 00000002054 12516254176 015513 0ustar00davidstaff000000 000000 --- abstract: 'Load recommended modules on demand when available' author: - 'David Golden ' build_requires: ExtUtils::MakeMaker: '0' File::Spec: '0' Test::More: '0' perl: '5.008001' configure_requires: ExtUtils::MakeMaker: '6.17' perl: '5.008001' dynamic_config: 0 generated_by: 'Dist::Zilla version 5.035, CPAN::Meta::Converter version 2.150002' license: apache meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: recommended no_index: directory: - t - xt - examples - corpus package: - DB provides: recommended: file: lib/recommended.pm version: '0.003' suggested: file: lib/suggested.pm version: '0.003' requires: Carp: '0' Module::Runtime: '0.014' perl: '5.008001' strict: '0' version: '0' warnings: '0' resources: bugtracker: https://github.com/dagolden/recommended/issues homepage: https://github.com/dagolden/recommended repository: https://github.com/dagolden/recommended.git version: '0.003' x_authority: cpan:DAGOLDEN recommended-0.003/perlcritic.rc000644 000765 000024 00000001166 12516254176 016733 0ustar00davidstaff000000 000000 severity = 5 verbose = 8 [Variables::ProhibitPunctuationVars] allow = $@ $! [TestingAndDebugging::ProhibitNoStrict] allow = refs [Variables::ProhibitEvilVariables] variables = $DB::single # Turn these off [-BuiltinFunctions::ProhibitStringyEval] [-ControlStructures::ProhibitPostfixControls] [-ControlStructures::ProhibitUnlessBlocks] [-Documentation::RequirePodSections] [-InputOutput::ProhibitInteractiveTest] [-References::ProhibitDoubleSigils] [-RegularExpressions::RequireExtendedFormatting] [-InputOutput::ProhibitTwoArgOpen] [-Modules::ProhibitEvilModules] # Turn this on [Lax::ProhibitStringyEval::ExceptForRequire] recommended-0.003/README000644 000765 000024 00000006450 12516254176 015126 0ustar00davidstaff000000 000000 NAME recommended - Load recommended modules on demand when available VERSION version 0.003 SYNOPSIS use recommended 'Foo::Bar', { 'Bar::Baz' => '1.23', 'Wibble' => '0.14', }; if ( recommended->has( 'Foo::Bar' ) ) { # do something with Foo::Bar } # default version required if ( recommended->has( 'Wibble' ) ) { # do something with Wibble if >= version 0.14 } # custom version required if ( recommended->has( 'Wibble', '0.10' ) ) { # do something with Wibble if >= version 0.10 } DESCRIPTION This module gathers a list of recommended modules and versions and provides means to check if they are available. It is a thin veneer around Module::Runtime. There are two major benefits over using Module::Runtime directly: * Self-documents recommended modules together with versions at the top of your code, while still loading them on demand elsewhere. * Dies if a recommended module exists but fails to compile, but doesn't die if the module is missing or the version is insufficient. This is not something that Module::Runtime offers in a single subroutine. USAGE import use recommended 'Foo::Bar', { 'Bar::Baz' => '1.23', 'Wibble' => '0.14', }; Scalar import arguments are treated as module names with a minimum required version of zero. Hash references are treated as module/minimum-version pairs. If you repeat, the later minimum version overwrites the earlier one. The list of modules and versions are kept separate for each calling package. has recommended->has( $module ); recommended->has( $module, $alt_minimum_version ); The "has" method takes a module name and optional alternative minimum version requirement and returns true if the following conditions are met: * the module was recommended in the current package (via "use recommended") * the module can be loaded * the module meets the default or alternate minimum version Otherwise, it returns false. If the module exists but fails to compile, an error is thrown. This avoids some edge-cases where things are left in an incomplete state or subsequent normal loads of the module by other packages get a misleading error. The module is loaded without invoking the module's "import" method, as running import on an optional module at runtime is just weird. SEE ALSO * Module::Runtime * Test::Requires SUPPORT Bugs / Feature Requests Please report any bugs or feature requests through the issue tracker at . You will be notified automatically of any progress on your issue. Source Code This is open source software. The code repository is available for public review and contribution under the terms of the license. git clone https://github.com/dagolden/recommended.git AUTHOR David Golden COPYRIGHT AND LICENSE This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 recommended-0.003/t/000755 000765 000024 00000000000 12516254176 014504 5ustar00davidstaff000000 000000 recommended-0.003/tidyall.ini000644 000765 000024 00000000240 12516254176 016400 0ustar00davidstaff000000 000000 ; Install Code::TidyAll ; run "tidyall -a" to tidy all files ; run "tidyall -g" to tidy only files modified from git [PerlTidy] select = {lib,t}/**/*.{pl,pm,t} recommended-0.003/xt/000755 000765 000024 00000000000 12516254176 014674 5ustar00davidstaff000000 000000 recommended-0.003/xt/author/000755 000765 000024 00000000000 12516254176 016176 5ustar00davidstaff000000 000000 recommended-0.003/xt/release/000755 000765 000024 00000000000 12516254176 016314 5ustar00davidstaff000000 000000 recommended-0.003/xt/release/distmeta.t000644 000765 000024 00000000172 12516254176 020313 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::MetaTests. use Test::CPAN::Meta; meta_yaml_ok(); recommended-0.003/xt/release/minimum-version.t000644 000765 000024 00000000266 12516254176 021643 0ustar00davidstaff000000 000000 #!perl use Test::More; eval "use Test::MinimumVersion"; plan skip_all => "Test::MinimumVersion required for testing minimum versions" if $@; all_minimum_version_ok( qq{5.010} ); recommended-0.003/xt/release/pod-coverage.t000644 000765 000024 00000000334 12516254176 021054 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); recommended-0.003/xt/release/pod-syntax.t000644 000765 000024 00000000220 12516254176 020601 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use Test::More; use Test::Pod 1.41; all_pod_files_ok(); recommended-0.003/xt/release/portability.t000644 000765 000024 00000000332 12516254176 021041 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; use Test::More; eval 'use Test::Portability::Files'; plan skip_all => 'Test::Portability::Files required for testing portability' if $@; options(test_one_dot => 0); run_tests(); recommended-0.003/xt/release/test-version.t000644 000765 000024 00000000604 12516254176 021143 0ustar00davidstaff000000 000000 use strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::Version 0.003001 use Test::Version; my @imports = ( 'version_all_ok' ); my $params = { is_strict => 0, has_version => 1, }; push @imports, $params if version->parse( $Test::Version::VERSION ) >= version->parse('1.002'); Test::Version->import(@imports); version_all_ok; done_testing; recommended-0.003/xt/author/00-compile.t000644 000765 000024 00000002167 12516254176 020236 0ustar00davidstaff000000 000000 use 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.052 use Test::More; plan tests => 3; my @module_files = ( 'recommended.pm', 'suggested.pm' ); # fake home for cpan-testers use File::Temp; local $ENV{HOME} = File::Temp::tempdir( CLEANUP => 1 ); my $inc_switch = -d 'blib' ? '-Mblib' : '-Ilib'; use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, $inc_switch, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ); recommended-0.003/xt/author/critic.t000644 000765 000024 00000000435 12516254176 017642 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; use Test::More; use English qw(-no_match_vars); eval "use Test::Perl::Critic"; plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; all_critic_ok(); recommended-0.003/xt/author/pod-spell.t000644 000765 000024 00000000425 12516254176 020263 0ustar00davidstaff000000 000000 use strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::PodSpelling 2.006008 use Test::Spelling 0.12; use Pod::Wordlist; add_stopwords(); all_pod_files_spelling_ok( qw( bin lib ) ); __DATA__ David Golden dagolden lib recommended suggested recommended-0.003/t/00-report-prereqs.dd000644 000765 000024 00000004233 12516254176 020226 0ustar00davidstaff000000 000000 do { my $x = { 'configure' => { 'requires' => { 'ExtUtils::MakeMaker' => '6.17', 'perl' => '5.008001' } }, 'develop' => { 'requires' => { 'Dist::Zilla' => '5', 'Dist::Zilla::PluginBundle::DAGOLDEN' => '0.072', 'File::Spec' => '0', 'File::Temp' => '0', 'IO::Handle' => '0', 'IPC::Open3' => '0', 'Pod::Coverage::TrustPod' => '0', 'Test::CPAN::Meta' => '0', 'Test::More' => '0', 'Test::Pod' => '1.41', 'Test::Pod::Coverage' => '1.08', 'Test::Spelling' => '0.12', 'Test::Version' => '1' } }, 'runtime' => { 'requires' => { 'Carp' => '0', 'Module::Runtime' => '0.014', 'perl' => '5.008001', 'strict' => '0', 'version' => '0', 'warnings' => '0' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '2.120900' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec' => '0', 'Test::More' => '0', 'perl' => '5.008001' } } }; $x; }recommended-0.003/t/00-report-prereqs.t000644 000765 000024 00000012731 12516254176 020104 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.021 use Test::More tests => 1; use ExtUtils::MakeMaker; use File::Spec; # from $version::LAX my $lax_version_re = qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? | (?:\.[0-9]+) (?:_[0-9]+)? ) | (?: v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? | (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? ) )/x; # hide optional CPAN::Meta modules from prereq scanner # and check if they are available my $cpan_meta = "CPAN::Meta"; my $cpan_meta_pre = "CPAN::Meta::Prereqs"; my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic # Verify requirements? my $DO_VERIFY_PREREQS = 1; sub _max { my $max = shift; $max = ( $_ > $max ) ? $_ : $max for @_; return $max; } sub _merge_prereqs { my ($collector, $prereqs) = @_; # CPAN::Meta::Prereqs object if (ref $collector eq $cpan_meta_pre) { return $collector->with_merged_prereqs( CPAN::Meta::Prereqs->new( $prereqs ) ); } # Raw hashrefs for my $phase ( keys %$prereqs ) { for my $type ( keys %{ $prereqs->{$phase} } ) { for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; } } } return $collector; } my @include = qw( ); my @exclude = qw( ); # Add static prereqs to the included modules list my $static_prereqs = do 't/00-report-prereqs.dd'; # Merge all prereqs (either with ::Prereqs or a hashref) my $full_prereqs = _merge_prereqs( ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), $static_prereqs ); # Add dynamic prereqs to the included modules list (if we can) my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; if ( $source && $HAS_CPAN_META ) { if ( my $meta = eval { CPAN::Meta->load_file($source) } ) { $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); } } else { $source = 'static metadata'; } my @full_reports; my @dep_errors; my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; # Add static includes into a fake section for my $mod (@include) { $req_hash->{other}{modules}{$mod} = 0; } for my $phase ( qw(configure build test runtime develop other) ) { next unless $req_hash->{$phase}; next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); for my $type ( qw(requires recommends suggests conflicts modules) ) { next unless $req_hash->{$phase}{$type}; my $title = ucfirst($phase).' '.ucfirst($type); my @reports = [qw/Module Want Have/]; for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { next if $mod eq 'perl'; next if grep { $_ eq $mod } @exclude; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; my $want = $req_hash->{$phase}{$type}{$mod}; $want = "undef" unless defined $want; $want = "any" if !$want && $want == 0; my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; if ($prefix) { my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); $have = "undef" unless defined $have; push @reports, [$mod, $want, $have]; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { if ( $have !~ /\A$lax_version_re\z/ ) { push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; } elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { push @dep_errors, "$mod version '$have' is not in required range '$want'"; } } } else { push @reports, [$mod, $want, "missing"]; if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { push @dep_errors, "$mod is not installed ($req_string)"; } } } if ( @reports ) { push @full_reports, "=== $title ===\n\n"; my $ml = _max( map { length $_->[0] } @reports ); my $wl = _max( map { length $_->[1] } @reports ); my $hl = _max( map { length $_->[2] } @reports ); if ($type eq 'modules') { splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; } else { splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; } push @full_reports, "\n"; } } } if ( @full_reports ) { diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; } if ( @dep_errors ) { diag join("\n", "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n", "The following REQUIRED prerequisites were not satisfied:\n", @dep_errors, "\n" ); } pass; # vim: ts=4 sts=4 sw=4 et: recommended-0.003/t/basic.t000644 000765 000024 00000003515 12516254176 015756 0ustar00davidstaff000000 000000 use 5.008001; use strict; use warnings; use Test::More; plan tests => 13; { package Foo; use Test::More; use recommended 'File::Spec'; ok( recommended->has('File::Spec'), "has File::Spec" ); use recommended 'Devel::Peek', { 'IO::File' => 1, 'File::Temp' => 999, }, 'Acme::DoesNotExistNotInstalled'; ok( !$INC{'Devel/Peek.pm'}, "Devel::Peek not yet loaded" ); ok( recommended->has('Devel::Peek'), "has recommended Devel::Peek" ); ok( recommended->has('IO::File'), "has recommended IO::File 1" ); ok( !recommended->has('File::Temp'), "doesn't have recommended File::Temp 999" ); ok( !recommended->has('Acme::DoesNotExistNotInstalled'), "doesn't have recommended Acme::DoesNotExistNotInstalled" ); ok( recommended->has( 'File::Temp', 0 ), "has recommended File::Temp 0" ); use suggested 'File::Copy'; ok( suggested->has('File::Copy'), "has suggested File::Copy" ); ok( !suggested->has('IO::File'), "IO::File was not suggested" ); } { package Bar; use Test::More; use recommended 'File::Temp'; ok( recommended->has('File::Temp'), "other package has recommended File::Temp 0" ); ok( !recommended->has('Devel::Peek'), "other package doesn't have recommended Devel::Peek" ); ok( !suggested->has('File::Copy'), "other package doesn't have recommended File::Copy" ); my $use_if = eval "use if recommended->has('File::Basename'), 'Pod::Usage';"; my $err = $@; ok( !$INC{'Pod/Usage.pm'}, "Pod::Usage not loaded from 'use if ...'" ); diag $err if $err; } done_testing; # # This file is part of recommended # # This software is Copyright (c) 2014 by David Golden. # # This is free software, licensed under: # # The Apache License, Version 2.0, January 2004 # # vim: ts=4 sts=4 sw=4 et: recommended-0.003/lib/recommended.pm000644 000765 000024 00000012254 12516254176 017633 0ustar00davidstaff000000 000000 use 5.008001; use strict; use warnings; package recommended; # ABSTRACT: Load recommended modules on demand when available use version; use Carp (); use Module::Runtime 0.014 (); # bugfixes for use_package_optimistically our $VERSION = '0.003'; # $MODULES{$type}{$caller}{$mod} = [$min_version, $satisfied] my %MODULES; # for testing and diagnostics sub __modules { return \%MODULES } sub import { my $class = shift; my $caller = caller; for my $arg (@_) { my $type = ref $arg; if ( !$type ) { $MODULES{$class}{$caller}{$arg} = [ 0, undef ]; } elsif ( $type eq 'HASH' ) { while ( my ( $mod, $ver ) = each %$arg ) { Carp::croak("module '$mod': '$ver' is not a valid version string") if !version::is_lax($ver); $MODULES{$class}{$caller}{$mod} = [ $ver, undef ]; } } else { Carp::croak("arguments to 'recommended' must be scalars or a hash ref"); } } } sub has { my ( $class, $mod, $ver ) = @_; my $caller = caller; my $spec = $MODULES{$class}{$caller}{$mod}; return 0 unless $spec; # explicit to ensure a value even in list context if ( defined $ver ) { Carp::croak("module '$mod': '$ver' is not a valid version string") if !version::is_lax($ver); } else { # shortcut if default already checked return $spec->[1] if defined $spec->[1]; $ver = $spec->[0]; } # don't call with a version; we want this to die only on compile failure Module::Runtime::use_package_optimistically($mod); my $ok = $INC{ Module::Runtime::module_notional_filename($mod) } && $mod->VERSION >= version->new($ver); return $spec->[1] = $ok ? 1 : 0; } 1; # vim: ts=4 sts=4 sw=4 et: __END__ =pod =encoding UTF-8 =head1 NAME recommended - Load recommended modules on demand when available =head1 VERSION version 0.003 =head1 SYNOPSIS use recommended 'Foo::Bar', { 'Bar::Baz' => '1.23', 'Wibble' => '0.14', }; if ( recommended->has( 'Foo::Bar' ) ) { # do something with Foo::Bar } # default version required if ( recommended->has( 'Wibble' ) ) { # do something with Wibble if >= version 0.14 } # custom version required if ( recommended->has( 'Wibble', '0.10' ) ) { # do something with Wibble if >= version 0.10 } =head1 DESCRIPTION This module gathers a list of recommended modules and versions and provides means to check if they are available. It is a thin veneer around L. There are two major benefits over using L directly: =over 4 =item * Self-documents recommended modules together with versions at the top of your code, while still loading them on demand elsewhere. =item * Dies if a recommended module exists but fails to compile, but doesn't die if the module is missing or the version is insufficient. This is not something that L offers in a single subroutine. =back =head1 USAGE =head2 import use recommended 'Foo::Bar', { 'Bar::Baz' => '1.23', 'Wibble' => '0.14', }; Scalar import arguments are treated as module names with a minimum required version of zero. Hash references are treated as module/minimum-version pairs. If you repeat, the later minimum version overwrites the earlier one. The list of modules and versions are kept separate for each calling package. =head2 has recommended->has( $module ); recommended->has( $module, $alt_minimum_version ); The C method takes a module name and optional alternative minimum version requirement and returns true if the following conditions are met: =over 4 =item * the module was recommended in the current package (via C) =item * the module can be loaded =item * the module meets the default or alternate minimum version =back Otherwise, it returns false. If the module exists but fails to compile, an error is thrown. This avoids some edge-cases where things are left in an incomplete state or subsequent normal loads of the module by other packages get a misleading error. The module is loaded without invoking the module's C method, as running import on an optional module at runtime is just weird. =head1 SEE ALSO =over 4 =item * L =item * L =back =for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan =head1 SUPPORT =head2 Bugs / Feature Requests Please report any bugs or feature requests through the issue tracker at L. You will be notified automatically of any progress on your issue. =head2 Source Code This is open source software. The code repository is available for public review and contribution under the terms of the license. L git clone https://github.com/dagolden/recommended.git =head1 AUTHOR David Golden =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut recommended-0.003/lib/suggested.pm000644 000765 000024 00000001704 12516254176 017341 0ustar00davidstaff000000 000000 use 5.008001; use strict; use warnings; package suggested; # ABSTRACT: Load suggested modules on demand when available require recommended; our @ISA = qw/recommended/; our $VERSION = '0.003'; 1; # vim: ts=4 sts=4 sw=4 et: __END__ =pod =encoding UTF-8 =head1 NAME suggested - Load suggested modules on demand when available =head1 VERSION version 0.003 =head1 SYNOPSIS use suggested 'Foo::Bar', { 'Bar::Baz' => '1.23', 'Wibble' => '0.14', }; if ( suggested->has( 'Foo::Bar' ) ) { # do something with Foo::Bar } =head1 DESCRIPTION This works just like L, but a suggestion is less strong than a recommendation. This is provided for self-documentation purposes. =head1 AUTHOR David Golden =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut