Test-Perl-Critic-1.04000755001750001750 013256205605 13545 5ustar00andyandy000000000000Test-Perl-Critic-1.04/.travis.yml000444001750001750 75713256205605 16004 0ustar00andyandy000000000000language: perl perl: - "5.26" - "5.24" - "5.22" - "5.20" - "5.18" - "5.16" - "5.14" - "5.12" - "5.10" notifications: email: recipients: - andy@petdance.com on_success: change on_failure: always irc: channels: - "irc.perl.org#perlcritic" template: - "%{branch}: %{message} %{build_url}" script: - export HARNESS_OPTIONS='j:c' - perl Build.PL - ./Build authortest Test-Perl-Critic-1.04/Build.PL000444001750001750 413613256205605 15202 0ustar00andyandy000000000000use 5.006001; use strict; use warnings; use Module::Build; my $class = Module::Build->subclass( code => <<'END_SUBCLASS' ); sub ACTION_test { my ($self) = @_; $self->depends_on('manifest'); return $self->SUPER::ACTION_test(); } sub ACTION_authortest { my ($self) = @_; $self->depends_on('build'); $self->depends_on('manifest'); $self->depends_on('distmeta'); $self->test_files( qw< t xt > ); $self->recursive_test_files(1); $self->depends_on('test'); return; } # end ACTION_authortest() sub ACTION_distdir { my ($self) = @_; $self->depends_on('authortest'); return $self->SUPER::ACTION_distdir; } # end ACTION_distdir END_SUBCLASS my $builder = $class->new( module_name => 'Test::Perl::Critic', dist_author => 'Jeffrey Thalhammer ', dist_abstract => 'Use Perl::Critic in test programs.', license => 'perl', create_readme => 1, create_packlist => 1, sign => 0, configure_requires => { 'Module::Build' => 0.4, }, requires => { 'Carp' => 0, 'English' => 0, 'MCE' => 1.827, 'Perl::Critic' => 1.105, 'Perl::Critic::Utils' => 1.105, 'Perl::Critic::Violation' => 1.105, 'strict' => 0, 'Test::Builder' => 0.88, 'warnings' => 0, }, build_requires => { 'Test::More' => 0, }, add_to_cleanup => [ qw(Test-Perl-Critic-* MANIFEST.bak) ], meta_merge => { resources => { bugtracker => 'https://github.com/Perl-Critic/Test-Perl-Critic/issues', repository => 'git://github.com/Perl-Critic/Test-Perl-Critic.git', license => [ 'http://dev.perl.org/licenses' ], homepage => 'http://perlcritic.com', }, }, ); $builder->create_build_script(); Test-Perl-Critic-1.04/Changes000444001750001750 1004713256205605 15217 0ustar00andyandy000000000000[1.04] Released on 2018-03-26 Sped up critic_ok() by 4x by not recreating a Perl::Critic object over and over. Thanks, Jan Holčapek. (GH#10) Now requires Test::Builder~0.88 or later to support the done_testing() method. (GH#2) Now requires MCE 1.827 to deal with problems running under taint mode. Thanks, Alexandr Ciornii. (GH #6) [1.03] Released on 2015-02-03 all_critic_ok() will now run tests in parallel over multiple cores. So if you have 8 cores, your Perl::Critic tests could run 8x faster. However, the actual performance depends on the size and shape of your code base and your Perl::Critic configuration. Thank you Mario Roy for writing the wonderful MCE module that makes this all possible! If you're using the critic_ok() function directly (perhaps because you want more control over which files are tested) then you won't see any performance boost. I recommend gathering your list of files first, and then passing the list to all_critic_ok(). The deprecated function all_code_files() has now been removed from Test::Perl::Critic. Use Perl::Critic::Utils::all_perl_files() instead. [1.02] Released on 2009-10-22 Documentation changes. META.yml "enhancements". Moved author tests out of the way of normal testing. Now requires Perl-Critic version 1.105 or newer. Fixed source code to be compliant with this version. Reported by Xavier Caron. [1.01] Released on 2007-01-24 PRODUCTION RELEASE: You may now consider the public API of Test::Perl::Critic as stable. Edited documentation. Includes better example for using Test::Perl::Critic in CPAN distributions. Added a t/perlcritic.t test to further demonstrate the typical usage for CPAN distributions. No code changes. [0.08] Released on 2006-11-05 All parameters to Test::Perl::Critic can now be controlled through the .perlcriticrc file. See the Perl::Critic POD for more info. Now compatible with the perlcritic.t test script that is generate by Module::Starter::PBP. In my humble opinion, the test script is flawed, but at least it will work now. [0.07] Released on 2006-08-20 All exceptions during testing are now fatal. Now supports -verbose option, just like `perlcritic` does. Added support for PPI::Cache, which can speedup repeated tests. See Test::Perl::Critic documentation for more details. Now requires Perl-Critic version 0.19 or higher. [0.06] Released on 2006-05-14 No functionality changes or bug fixes, just refactorings. The all_code_files() function is now deprecated. See all_perl_files() in Perl::Critic::Utils instead Now requires Perl::Critic version 0.15_03 or higher. [0.05] Released on 2006-03-26 Modified import() interface to pass all arguments to Perl::Critic. This give you a direct hook to configure Perl::Critic and should still be backward compatible. [0.04] Released on 2006-01-15 Updated to be compatible with Perl-Critic 0.14, but is not backward compatible with older versions of Perl-Critic. If you want to use the -severity option with Perl-Critic, you need to use Perl-Critic version 0.14 or later. [0.03] Released on 2005-10-31 Now catching exceptions from Perl::Critic so the tests fail gracefully if PPI has errors. Added -format option, which is similar to the -verbose option that perlcritic has. I'm not sure why I didn't make it exactly the same. Added a few more test cases. In general, this module doesn't have very good test coverage because I haven't really figured out how to test a Test. [0.02] Released on 2005-09-30 Some minor tweaks; Edited POD. Removed Test::Pod and Test::Pod::Coverage from the prerequisites list. Those tests only run if the modules are installed. Test::Perl::Critic is going to require Perl::Critic version 0.08 or later, or it won't pass its own criticism tests. [0.01] Not released "Plan to throw one away" -Frederick Brooks Test-Perl-Critic-1.04/INSTALL000444001750001750 31113256205605 14706 0ustar00andyandy000000000000INSTALLATION To install Test::Perl::Critic, give the following commands: tar -zxf Test-Perl-Critic-1.04.tar.gz cd Test-Perl-Critic-1.04 perl Build.pl ./Build ./Build test ./Build install Test-Perl-Critic-1.04/LICENSE000444001750001750 4736313256205605 14744 0ustar00andyandy000000000000Terms of Perl itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" ---------------------------------------------------------------------------- The General Public License (GPL) Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS ---------------------------------------------------------------------------- The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Test-Perl-Critic-1.04/MANIFEST000444001750001750 36013256205605 15012 0ustar00andyandy000000000000.travis.yml Build.PL Changes INSTALL lib/Test/Perl/Critic.pm LICENSE MANIFEST This list of files MANIFEST.SKIP META.json META.yml README t/00_compile.t t/01_api.t xt/96_perlcritic.t xt/98_pod_syntax.t xt/99_pod_coverage.t xt/perlcriticrc Test-Perl-Critic-1.04/MANIFEST.SKIP000444001750001750 132513256205605 15601 0ustar00andyandy000000000000^Test-Perl-Critic- ## Below here are generic entries that apply to any project ## # Version Control files ^\.cvsignore$ CVS RCS ,v$ \.svn \.git \.gitignore # Distribution files \.zip$ \.gz$ \.tgz$ \.tar\.gz$ \.tar$ \-docs\b # Devel/Build files ^\.perltidyrc$ ^t/01distribution\.t$ \.devel\b ^_build ^Build$ ^blib ^Makefile$ ^cover_db ^nytprof ^pm_to_blib$ ^Makefile.old$ ^patch \.patch$ \.rej$ \.old$ ^t/00_local_.*t$ ^tags$ # Temp/backup files ~$ \.bak$ ^temp[^l] ^temp$ \.tmp$ \.\#.+ \#$ \.swp$ \.vim_backup$ # Mac/SMB files \.DS_Store ^\._.+ \bIcon\x0d # Flash development \.swd$ ^test\.swf$ # Avoid Eclipse files. \.project\b ^\.includepath$ # Avoid my Ant build script ^build\.xml$ ^MYMETA\.yml$ ^MYMETA\.json$ Test-Perl-Critic-1.04/META.json000444001750001750 304613256205605 15326 0ustar00andyandy000000000000{ "abstract" : "Use Perl::Critic in test programs.", "author" : [ "Jeffrey Thalhammer " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4224", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Test-Perl-Critic", "prereqs" : { "build" : { "requires" : { "Test::More" : "0" } }, "configure" : { "requires" : { "Module::Build" : "0.4" } }, "runtime" : { "requires" : { "Carp" : "0", "English" : "0", "MCE" : "1.827", "Perl::Critic" : "1.105", "Perl::Critic::Utils" : "1.105", "Perl::Critic::Violation" : "1.105", "Test::Builder" : "0.88", "strict" : "0", "warnings" : "0" } } }, "provides" : { "Test::Perl::Critic" : { "file" : "lib/Test/Perl/Critic.pm", "version" : "1.04" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/Perl-Critic/Test-Perl-Critic/issues" }, "homepage" : "http://perlcritic.com", "license" : [ "http://dev.perl.org/licenses/" ], "repository" : { "url" : "git://github.com/Perl-Critic/Test-Perl-Critic.git" } }, "version" : "1.04", "x_serialization_backend" : "JSON::PP version 2.27400_02" } Test-Perl-Critic-1.04/META.yml000444001750001750 173213256205605 15156 0ustar00andyandy000000000000--- abstract: 'Use Perl::Critic in test programs.' author: - 'Jeffrey Thalhammer ' build_requires: Test::More: '0' configure_requires: Module::Build: '0.4' dynamic_config: 1 generated_by: 'Module::Build version 0.4224, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Test-Perl-Critic provides: Test::Perl::Critic: file: lib/Test/Perl/Critic.pm version: '1.04' requires: Carp: '0' English: '0' MCE: '1.827' Perl::Critic: '1.105' Perl::Critic::Utils: '1.105' Perl::Critic::Violation: '1.105' Test::Builder: '0.88' strict: '0' warnings: '0' resources: bugtracker: https://github.com/Perl-Critic/Test-Perl-Critic/issues homepage: http://perlcritic.com license: http://dev.perl.org/licenses/ repository: git://github.com/Perl-Critic/Test-Perl-Critic.git version: '1.04' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Test-Perl-Critic-1.04/README000444001750001750 2361713256205605 14613 0ustar00andyandy000000000000NAME Test::Perl::Critic - Use Perl::Critic in test programs SYNOPSIS Test one file: use Test::Perl::Critic; use Test::More tests => 1; critic_ok($file); Or test all files in one or more directories: use Test::Perl::Critic; all_critic_ok($dir_1, $dir_2, $dir_N ); Or test all files in a distribution: use Test::Perl::Critic; all_critic_ok(); Recommended usage for CPAN distributions: use strict; use warnings; use File::Spec; use Test::More; use English qw(-no_match_vars); if ( not $ENV{TEST_AUTHOR} ) { my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.'; plan( skip_all => $msg ); } eval { require Test::Perl::Critic; }; if ( $EVAL_ERROR ) { my $msg = 'Test::Perl::Critic required to criticise code'; plan( skip_all => $msg ); } my $rcfile = File::Spec->catfile( 't', 'perlcriticrc' ); Test::Perl::Critic->import( -profile => $rcfile ); all_critic_ok(); DESCRIPTION Test::Perl::Critic wraps the Perl::Critic engine in a convenient subroutine suitable for test programs written using the Test::More framework. This makes it easy to integrate coding-standards enforcement into the build process. For ultimate convenience (at the expense of some flexibility), see the criticism pragma. If you have an large existing code base, you might prefer to use Test::Perl::Critic::Progressive, which allows you to clean your code incrementally instead of all at once.. If you'd like to try Perl::Critic without installing anything, there is a web-service available at . The web-service does not support all the configuration features that are available in the native Perl::Critic API, but it should give you a good idea of what Perl::Critic can do. SUBROUTINES all_critic_ok( [ @FILES ] ) Runs "critic_ok()" for all Perl files in the list of @FILES. If a file is actually a directory, then all Perl files beneath that directory (recursively) will be run through "critic_ok()". If @FILES is empty or not given, then the blib/ is used if it exists, and if not, then lib/ is used. Returns true if all files are okay, or false if any file fails. This subroutine emits its own test plan, so you do not need to specify the expected number of tests or call "done_testing()". Therefore, "all_critic_ok" generally cannot be used in a test script that includes other sorts of tests. "all_critic_ok()" is also optimized to run tests in parallel over multiple cores (if you have them) so it is usually better to call this function than calling "critic_ok()" directly. critic_ok( $FILE [, $TEST_NAME ] ) Okays the test if Perl::Critic does not find any violations in $FILE. If it does, the violations will be reported in the test diagnostics. The optional second argument is the name of test, which defaults to "Perl::Critic test for $FILE". If you use this form, you should load Test::More and emit your own test plan first or call "done_testing()" afterwards. CONFIGURATION Perl::Critic is highly configurable. By default, Test::Perl::Critic invokes Perl::Critic with its default configuration. But if you have developed your code against a custom Perl::Critic configuration, you will want to configure Test::Perl::Critic to do the same. Any arguments passed through the "use" pragma (or via "Test::Perl::Critic->import()" )will be passed into the Perl::Critic constructor. So if you have developed your code using a custom ~/.perlcriticrc file, you can direct Test::Perl::Critic to use your custom file too. use Test::Perl::Critic (-profile => 't/perlcriticrc'); all_critic_ok(); Now place a copy of your own ~/.perlcriticrc file in the distribution as t/perlcriticrc. Then, "critic_ok()" will be run on all Perl files in this distribution using this same Perl::Critic configuration. See the Perl::Critic documentation for details on the .perlcriticrc file format. Any argument that is supported by the Perl::Critic constructor can be passed through this interface. For example, you can also set the minimum severity level, or include & exclude specific policies like this: use Test::Perl::Critic (-severity => 2, -exclude => ['RequireRcsKeywords']); all_critic_ok(); See the Perl::Critic documentation for complete details on its options and arguments. DIAGNOSTIC DETAILS By default, Test::Perl::Critic displays basic information about each Policy violation in the diagnostic output of the test. You can customize the format and content of this information by using the "-verbose" option. This behaves exactly like the "-verbose" switch on the perlcritic program. For example: use Test::Perl::Critic (-verbose => 6); #or... use Test::Perl::Critic (-verbose => '%f: %m at %l'); If given a number, Test::Perl::Critic reports violations using one of the predefined formats described below. If given a string, it is interpreted to be an actual format specification. If the "-verbose" option is not specified, it defaults to 3. Verbosity Format Specification ----------- ------------------------------------------------------- 1 "%f:%l:%c:%m\n", 2 "%f: (%l:%c) %m\n", 3 "%m at %f line %l\n", 4 "%m at line %l, column %c. %e. (Severity: %s)\n", 5 "%f: %m at line %l, column %c. %e. (Severity: %s)\n", 6 "%m at line %l, near '%r'. (Severity: %s)\n", 7 "%f: %m at line %l near '%r'. (Severity: %s)\n", 8 "[%p] %m at line %l, column %c. (Severity: %s)\n", 9 "[%p] %m at line %l, near '%r'. (Severity: %s)\n", 10 "%m at line %l, column %c.\n %p (Severity: %s)\n%d\n", 11 "%m at line %l, near '%r'.\n %p (Severity: %s)\n%d\n" Formats are a combination of literal and escape characters similar to the way "sprintf" works. See String::Format for a full explanation of the formatting capabilities. Valid escape characters are: Escape Meaning ------- ---------------------------------------------------------------- %c Column number where the violation occurred %d Full diagnostic discussion of the violation (DESCRIPTION in POD) %e Explanation of violation or page numbers in PBP %F Just the name of the logical file where the violation occurred. %f Path to the logical file where the violation occurred. %G Just the name of the physical file where the violation occurred. %g Path to the physical file where the violation occurred. %l Logical line number where the violation occurred %L Physical line number where the violation occurred %m Brief description of the violation %P Full name of the Policy module that created the violation %p Name of the Policy without the Perl::Critic::Policy:: prefix %r The string of source code that caused the violation %C The class of the PPI::Element that caused the violation %s The severity level of the violation CAVEATS Despite the convenience of using a test script to enforce your coding standards, there are some inherent risks when distributing those tests to others. Since you don't know which version of Perl::Critic the end-user has and whether they have installed any additional Policy modules, you can't really be sure that your code will pass the Test::Perl::Critic tests on another machine. For these reasons, we strongly advise you to make your perlcritic tests optional, or exclude them from the distribution entirely. The recommended usage in the "SYNOPSIS" section illustrates one way to make your perlcritic.t test optional. Another option is to put perlcritic.t and other author-only tests in a separate directory (xt/ seems to be common), and then use a custom build action when you want to run them. Also, you should not list Test::Perl::Critic as a requirement in your build script. These tests are only relevant to the author and should not be a prerequisite for end-use. See for an interesting discussion about Test::Perl::Critic and other types of author-only regression tests. FOR Dist::Zilla USERS If you use Test::Perl::Critic with Dist::Zilla, beware that some DZ plugins may mutate your code in ways that are not compliant with your Perl::Critic rules. In particular, the standard Dist::Zilla::Plugin::PkgVersion will inject a $VERSION declaration at the top of the file, which will violate Perl::Critic::Policy::TestingAndDebugging::RequireUseStrict. One solution is to use the Dist::Zilla::Plugin::OurPkgVersion which allows you to control where the $VERSION declaration appears. EXPORTS critic_ok() all_critic_ok() BUGS If you find any bugs, please submit them to . Thanks. SEE ALSO Module::Starter::PBP Perl::Critic Test::More CREDITS Andy Lester, whose Test::Pod module provided most of the code and documentation for Test::Perl::Critic. Thanks, Andy. AUTHOR Jeffrey Ryan Thalhammer COPYRIGHT Copyright (c) 2005-2018 Jeffrey Ryan Thalhammer. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. Test-Perl-Critic-1.04/lib000755001750001750 013256205605 14313 5ustar00andyandy000000000000Test-Perl-Critic-1.04/lib/Test000755001750001750 013256205605 15232 5ustar00andyandy000000000000Test-Perl-Critic-1.04/lib/Test/Perl000755001750001750 013256205605 16134 5ustar00andyandy000000000000Test-Perl-Critic-1.04/lib/Test/Perl/Critic.pm000444001750001750 3346213256205605 20074 0ustar00andyandy000000000000package Test::Perl::Critic; use 5.006001; use strict; use warnings; use Carp qw(croak); use English qw(-no_match_vars); use Test::Builder qw(); use Perl::Critic qw(); use Perl::Critic::Violation qw(); use Perl::Critic::Utils; #--------------------------------------------------------------------------- our $VERSION = '1.04'; #--------------------------------------------------------------------------- my $TEST = Test::Builder->new; my $DIAG_INDENT = q{ }; my %CRITIC_ARGS = (); my $CRITIC_OBJ = undef; my $BUILD_CRITIC = sub { return $CRITIC_OBJ if defined $CRITIC_OBJ; $CRITIC_OBJ = Perl::Critic->new( @_ ); }; #--------------------------------------------------------------------------- sub import { my ( $self, %args ) = @_; my $caller = caller; { no strict 'refs'; ## no critic qw(ProhibitNoStrict) *{ $caller . '::critic_ok' } = \&critic_ok; *{ $caller . '::all_critic_ok' } = \&all_critic_ok; } # -format is supported for backward compatibility. if ( exists $args{-format} ) { $args{-verbose} = $args{-format}; } %CRITIC_ARGS = %args; # Reset possibly lazy-initialized Perl::Critic. $CRITIC_OBJ = undef; $TEST->exported_to($caller); return 1; } #--------------------------------------------------------------------------- sub critic_ok { my ( $file, $test_name ) = @_; croak q{no file specified} if not defined $file; croak qq{"$file" does not exist} if not -f $file; $test_name ||= qq{Test::Perl::Critic for "$file"}; my $critic = undef; my @violations = (); my $ok = 0; # Run Perl::Critic my $status = eval { $critic = $BUILD_CRITIC->( %CRITIC_ARGS ); @violations = $critic->critique( $file ); $ok = not scalar @violations; 1; }; # Evaluate results $TEST->ok($ok, $test_name ); if (!$status || $EVAL_ERROR) { # Trap exceptions from P::C $TEST->diag( "\n" ); # Just to get on a new line. $TEST->diag( qq{Perl::Critic had errors in "$file":} ); $TEST->diag( qq{\t$EVAL_ERROR} ); } elsif ( not $ok ) { # Report Policy violations $TEST->diag( "\n" ); # Just to get on a new line. my $verbose = $critic->config->verbose(); Perl::Critic::Violation::set_format( $verbose ); for my $viol (@violations) { $TEST->diag($DIAG_INDENT . $viol) } } return $ok; } #--------------------------------------------------------------------------- sub all_critic_ok { my @dirs_or_files = @_ ? @_ : (-e 'blib' ? 'blib' : 'lib'); my @files = Perl::Critic::Utils::all_perl_files(@dirs_or_files); croak 'Nothing to critique' if not @files; my $have_mce = eval { require MCE::Grep; MCE::Grep->import; 1 }; return $have_mce ? _test_parallel(@files) : _test_serial(@files); } #--------------------------------------------------------------------------- sub _test_parallel { my @files = @_; # Since tests are running in forked MCE workers, test results could arrive # in any order. The test numbers will be meaningless, so turn them off. $TEST->use_numbers(0); # The parent won't know about any of the tests that were run by the forked # workers. So we disable the T::B sanity checks at the end of its life. $TEST->no_ending(1); my $okays = MCE::Grep->run( sub { critic_ok($_) }, @files ); my $pass = $okays == @files; # To make Test::Harness happy, we must emit a test plan and a sensible exit # status. Usually, T::B does this for us, but we disabled the ending above. $pass || eval 'END { $? = 1 }'; ## no critic qw(Eval Interpolation) $TEST->done_testing(scalar @files); return $pass; } #--------------------------------------------------------------------------- sub _test_serial { my @files = @_; my $okays = grep {critic_ok($_)} @files; my $pass = $okays == @files; $TEST->done_testing(scalar @files); return $pass; } #--------------------------------------------------------------------------- 1; __END__ =pod =for stopwords API =head1 NAME Test::Perl::Critic - Use Perl::Critic in test programs =head1 SYNOPSIS Test one file: use Test::Perl::Critic; use Test::More tests => 1; critic_ok($file); Or test all files in one or more directories: use Test::Perl::Critic; all_critic_ok($dir_1, $dir_2, $dir_N ); Or test all files in a distribution: use Test::Perl::Critic; all_critic_ok(); Recommended usage for CPAN distributions: use strict; use warnings; use File::Spec; use Test::More; use English qw(-no_match_vars); if ( not $ENV{TEST_AUTHOR} ) { my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.'; plan( skip_all => $msg ); } eval { require Test::Perl::Critic; }; if ( $EVAL_ERROR ) { my $msg = 'Test::Perl::Critic required to criticise code'; plan( skip_all => $msg ); } my $rcfile = File::Spec->catfile( 't', 'perlcriticrc' ); Test::Perl::Critic->import( -profile => $rcfile ); all_critic_ok(); =head1 DESCRIPTION Test::Perl::Critic wraps the L engine in a convenient subroutine suitable for test programs written using the L framework. This makes it easy to integrate coding-standards enforcement into the build process. For ultimate convenience (at the expense of some flexibility), see the L pragma. If you have an large existing code base, you might prefer to use L, which allows you to clean your code incrementally instead of all at once.. If you'd like to try L without installing anything, there is a web-service available at L. The web-service does not support all the configuration features that are available in the native Perl::Critic API, but it should give you a good idea of what Perl::Critic can do. =head1 SUBROUTINES =over =item all_critic_ok( [ @FILES ] ) Runs C for all Perl files in the list of C<@FILES>. If a file is actually a directory, then all Perl files beneath that directory (recursively) will be run through C. If C<@FILES> is empty or not given, then the F is used if it exists, and if not, then F is used. Returns true if all files are okay, or false if any file fails. This subroutine emits its own test plan, so you do not need to specify the expected number of tests or call C. Therefore, C generally cannot be used in a test script that includes other sorts of tests. C is also optimized to run tests in parallel over multiple cores (if you have them) so it is usually better to call this function than calling C directly. =item critic_ok( $FILE [, $TEST_NAME ] ) Okays the test if Perl::Critic does not find any violations in C<$FILE>. If it does, the violations will be reported in the test diagnostics. The optional second argument is the name of test, which defaults to "Perl::Critic test for $FILE". If you use this form, you should load L and emit your own test plan first or call C afterwards. =back =head1 CONFIGURATION L is highly configurable. By default, Test::Perl::Critic invokes Perl::Critic with its default configuration. But if you have developed your code against a custom Perl::Critic configuration, you will want to configure Test::Perl::Critic to do the same. Any arguments passed through the C pragma (or via C<< Test::Perl::Critic->import() >> )will be passed into the L constructor. So if you have developed your code using a custom F<~/.perlcriticrc> file, you can direct L to use your custom file too. use Test::Perl::Critic (-profile => 't/perlcriticrc'); all_critic_ok(); Now place a copy of your own F<~/.perlcriticrc> file in the distribution as F. Then, C will be run on all Perl files in this distribution using this same Perl::Critic configuration. See the L documentation for details on the F<.perlcriticrc> file format. Any argument that is supported by the L constructor can be passed through this interface. For example, you can also set the minimum severity level, or include & exclude specific policies like this: use Test::Perl::Critic (-severity => 2, -exclude => ['RequireRcsKeywords']); all_critic_ok(); See the L documentation for complete details on its options and arguments. =head1 DIAGNOSTIC DETAILS By default, Test::Perl::Critic displays basic information about each Policy violation in the diagnostic output of the test. You can customize the format and content of this information by using the C<-verbose> option. This behaves exactly like the C<-verbose> switch on the F program. For example: use Test::Perl::Critic (-verbose => 6); #or... use Test::Perl::Critic (-verbose => '%f: %m at %l'); If given a number, L reports violations using one of the predefined formats described below. If given a string, it is interpreted to be an actual format specification. If the C<-verbose> option is not specified, it defaults to 3. Verbosity Format Specification ----------- ------------------------------------------------------- 1 "%f:%l:%c:%m\n", 2 "%f: (%l:%c) %m\n", 3 "%m at %f line %l\n", 4 "%m at line %l, column %c. %e. (Severity: %s)\n", 5 "%f: %m at line %l, column %c. %e. (Severity: %s)\n", 6 "%m at line %l, near '%r'. (Severity: %s)\n", 7 "%f: %m at line %l near '%r'. (Severity: %s)\n", 8 "[%p] %m at line %l, column %c. (Severity: %s)\n", 9 "[%p] %m at line %l, near '%r'. (Severity: %s)\n", 10 "%m at line %l, column %c.\n %p (Severity: %s)\n%d\n", 11 "%m at line %l, near '%r'.\n %p (Severity: %s)\n%d\n" Formats are a combination of literal and escape characters similar to the way C works. See L for a full explanation of the formatting capabilities. Valid escape characters are: Escape Meaning ------- ---------------------------------------------------------------- %c Column number where the violation occurred %d Full diagnostic discussion of the violation (DESCRIPTION in POD) %e Explanation of violation or page numbers in PBP %F Just the name of the logical file where the violation occurred. %f Path to the logical file where the violation occurred. %G Just the name of the physical file where the violation occurred. %g Path to the physical file where the violation occurred. %l Logical line number where the violation occurred %L Physical line number where the violation occurred %m Brief description of the violation %P Full name of the Policy module that created the violation %p Name of the Policy without the Perl::Critic::Policy:: prefix %r The string of source code that caused the violation %C The class of the PPI::Element that caused the violation %s The severity level of the violation =head1 CAVEATS Despite the convenience of using a test script to enforce your coding standards, there are some inherent risks when distributing those tests to others. Since you don't know which version of L the end-user has and whether they have installed any additional Policy modules, you can't really be sure that your code will pass the Test::Perl::Critic tests on another machine. B The recommended usage in the L<"SYNOPSIS"> section illustrates one way to make your F test optional. Another option is to put F and other author-only tests in a separate directory (F seems to be common), and then use a custom build action when you want to run them. Also, you should B list Test::Perl::Critic as a requirement in your build script. These tests are only relevant to the author and should not be a prerequisite for end-use. See L for an interesting discussion about Test::Perl::Critic and other types of author-only regression tests. =head1 FOR Dist::Zilla USERS If you use Test::Perl::Critic with L, beware that some DZ plugins may mutate your code in ways that are not compliant with your Perl::Critic rules. In particular, the standard L will inject a C<$VERSION> declaration at the top of the file, which will violate L. One solution is to use the L which allows you to control where the C<$VERSION> declaration appears. =head1 EXPORTS critic_ok() all_critic_ok() =head1 BUGS If you find any bugs, please submit them to L. Thanks. =head1 SEE ALSO L L L =head1 CREDITS Andy Lester, whose L module provided most of the code and documentation for Test::Perl::Critic. Thanks, Andy. =head1 AUTHOR Jeffrey Ryan Thalhammer =head1 COPYRIGHT Copyright (c) 2005-2018 Jeffrey Ryan Thalhammer. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. =cut ############################################################################## # Local Variables: # mode: cperl # cperl-indent-level: 4 # fill-column: 78 # indent-tabs-mode: nil # c-indentation-style: bsd # End: # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround : Test-Perl-Critic-1.04/t000755001750001750 013256205605 14010 5ustar00andyandy000000000000Test-Perl-Critic-1.04/t/00_compile.t000444001750001750 62413256205605 16243 0ustar00andyandy000000000000 use strict; use warnings; use Test::More tests => 3; #--------------------------------------------------------------------------- use_ok('Test::Perl::Critic'); can_ok('Test::Perl::Critic', 'critic_ok'); can_ok('Test::Perl::Critic', 'all_critic_ok'); diag( "Testing Test::Perl::Critic $Test::Perl::Critic::VERSION with Perl::Critic $Perl::Critic::VERSION and PPI $PPI::VERSION, under Perl $], $^X" ); Test-Perl-Critic-1.04/t/01_api.t000444001750001750 112513256205605 15402 0ustar00andyandy000000000000 use strict; use warnings; use Test::More tests => 4; use Test::Perl::Critic; use English qw(-no_match_vars); #--------------------------------------------------------------------------- # Export tests can_ok('main', 'critic_ok'); can_ok('main', 'all_critic_ok'); #--------------------------------------------------------------------------- # Test exception for missing files eval{ critic_ok('foobar') }; ok( defined $EVAL_ERROR ); #--------------------------------------------------------------------------- # Test exception for null file eval{ critic_ok() }; ok( defined $EVAL_ERROR ); Test-Perl-Critic-1.04/xt000755001750001750 013256205605 14200 5ustar00andyandy000000000000Test-Perl-Critic-1.04/xt/96_perlcritic.t000444001750001750 27513256205605 17164 0ustar00andyandy000000000000 use strict; use warnings; use File::Spec; my $rcfile; BEGIN { $rcfile = File::Spec->catfile( qw< xt perlcriticrc > ); } use Test::Perl::Critic -profile => $rcfile; all_critic_ok(); Test-Perl-Critic-1.04/xt/98_pod_syntax.t000444001750001750 23513256205605 17212 0ustar00andyandy000000000000 use strict; use warnings; use Test::More; eval 'use Test::Pod 1.00'; plan skip_all => 'Test::Pod 1.00 required for testing POD' if $@; all_pod_files_ok(); Test-Perl-Critic-1.04/xt/99_pod_coverage.t000444001750001750 37613256205605 17466 0ustar00andyandy000000000000 use strict; use warnings; use Test::More; eval 'use Test::Pod::Coverage 1.00'; plan skip_all => 'Test::Pod::Coverage 1.00 requried to test POD' if $@; my $trustme = { trustme => [ qr{ \A (?: new | violations ) \z }x ] }; all_pod_coverage_ok($trustme); Test-Perl-Critic-1.04/xt/perlcriticrc000444001750001750 171213256205605 16746 0ustar00andyandy000000000000 profile-strictness = quiet severity = 1 theme = core verbose = %f: %m at line %l, column %c. %e. (Severity: %s, %p)\n #----------------------------------------------------------------------------- [-CodeLayout::RequireTidyCode] [-Subroutines::RequireArgUnpacking] [-Documentation::RequirePodLinksIncludeText] [Documentation::RequirePodSections] lib_sections = NAME|DESCRIPTION|AUTHOR|COPYRIGHT script_sections = NAME|DESCRIPTION|AUTHOR|COPYRIGHT [CodeLayout::ProhibitHardTabs] allow_leading_tabs = 0 [Documentation::PodSpelling] stop_words = autoflushes CPAN CGI CVS Dolan HEREDOC HEREDOCs HEREDOCS IDE Maxia Mehner namespace namespaces PBP perl perlcritic perlcriticrc PPI pragma refactor sigil sigils SQL STDERR STDIN STDOUT TerMarsch Thalhammer TODO [InputOutput::RequireCheckedSyscalls] functions = open close [RegularExpressions::ProhibitUnusualDelimiters] allow_all_brackets = 1 [RegularExpressions::RequireBracesForMultiline] allow_all_brackets = 1