diff options
author | Lorry Tar Creator <lorry-tar-importer@lorry> | 2013-12-13 13:30:36 +0000 |
---|---|---|
committer | Lorry Tar Creator <lorry-tar-importer@lorry> | 2013-12-13 13:30:36 +0000 |
commit | aa2ab3d34edbee7e4fc832394136391fd5f87702 (patch) | |
tree | 0f2332dd7bfe5ee80ce6f8a6efd2739514da9bd4 | |
download | Data-OptList-tarball-master.tar.gz |
Data-OptList-0.109HEADData-OptList-0.109master
-rw-r--r-- | Changes | 47 | ||||
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 14 | ||||
-rw-r--r-- | META.json | 393 | ||||
-rw-r--r-- | META.yml | 289 | ||||
-rw-r--r-- | Makefile.PL | 61 | ||||
-rw-r--r-- | README | 13 | ||||
-rw-r--r-- | dist.ini | 8 | ||||
-rw-r--r-- | lib/Data/OptList.pm | 258 | ||||
-rw-r--r-- | t/000-report-versions-tiny.t | 76 | ||||
-rw-r--r-- | t/hash.t | 87 | ||||
-rw-r--r-- | t/mkopt.t | 183 | ||||
-rw-r--r-- | xt/release/changes_has_content.t | 41 | ||||
-rw-r--r-- | xt/release/pod-syntax.t | 7 |
14 files changed, 1856 insertions, 0 deletions
@@ -0,0 +1,47 @@ +Revision history for Sub-Exporter + +0.109 2013-12-13 08:30:34 America/New_York + update bugtracker and repo links + +0.108 2013-07-05 21:43:56 America/New_York + repackage, new bug tracker + +0.107 2011-05-06 11:24:45 America/New_York + + mkopt now prefers named parameters; docs updated + + added the name_test parameter to mkopt + +0.106 2010-02-14 + correct version style mismatch for Sub::Install (thanks, brian d foy) + +0.105 2010-01-14 + fix a typo in documenation (thanks, Florian Ragwitz) + +0.104 2009-01-16 + add repo info to metadata + +0.103 2007-11-01 + require taint-safe Test::Pod + +0.102 2006-07-04 + improved documentation + tweaked some Perl::Critic-offending code + +0.100 2006-06-05 + broken out of Sub-Exporter into its own dist + renamed routines to be easier to type + +0.040 2006-05-11 + (part of Sub-Exporter) + tweaks to Data::OptList, moving toward its own dist: now it exports + expand_opt_list is now opt_list_as_hash + +0.??? 2006-05-10 + (part of Sub-Exporter) + require Params::Util for craftier opt list validation + +0.??? 2006-04-26 + (part of Sub-Exporter) + broken out of Sub::Exporter module + remove an "optimization" that broke expand_opt_list @@ -0,0 +1,379 @@ +This software is copyright (c) 2006 by Ricardo Signes. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system 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 GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2006 by Ricardo Signes. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Suite 500, Boston, MA 02110-1335 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our 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. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, 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 a 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 tell them 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. + + 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 Agreement 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 work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 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 +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual 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 General + Public License. + + d) 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. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 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 + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying 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. + + 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. + + 7. 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 the 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 +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. 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 + + 9. 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. + + 10. 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 + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2006 by Ricardo Signes. + +This is free software, licensed under: + + The Artistic License 1.0 + +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 + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..a846135 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,14 @@ +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +dist.ini +lib/Data/OptList.pm +t/000-report-versions-tiny.t +t/hash.t +t/mkopt.t +xt/release/changes_has_content.t +xt/release/pod-syntax.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..bbdc0a7 --- /dev/null +++ b/META.json @@ -0,0 +1,393 @@ +{ + "abstract" : "parse and validate simple name/value option pairs", + "author" : [ + "Ricardo Signes <rjbs@cpan.org>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 5.006, CPAN::Meta::Converter version 2.132830", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Data-OptList", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "6.30" + } + }, + "develop" : { + "requires" : { + "Test::Pod" : "1.41", + "version" : "0.9901" + } + }, + "runtime" : { + "requires" : { + "List::Util" : "0", + "Params::Util" : "0", + "Sub::Install" : "0.921", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "requires" : { + "Test::More" : "0.96" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/rjbs/Data-OptList/issues" + }, + "homepage" : "https://github.com/rjbs/Data-OptList", + "repository" : { + "type" : "git", + "url" : "https://github.com/rjbs/Data-OptList.git", + "web" : "https://github.com/rjbs/Data-OptList" + } + }, + "version" : "0.109", + "x_Dist_Zilla" : { + "perl" : { + "version" : "5.018001" + }, + "plugins" : [ + { + "class" : "Dist::Zilla::Plugin::Git::GatherDir", + "name" : "@RJBS/Git::GatherDir", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::CheckPrereqsIndexed", + "name" : "@RJBS/CheckPrereqsIndexed", + "version" : "0.009" + }, + { + "class" : "Dist::Zilla::Plugin::CheckExtraTests", + "name" : "@RJBS/CheckExtraTests", + "version" : "0.016" + }, + { + "class" : "Dist::Zilla::Plugin::PromptIfStale", + "config" : { + "Dist::Zilla::Plugin::PromptIfStale" : { + "check_all_plugins" : 0, + "check_all_prereqs" : 0, + "modules" : [ + "Dist::Zilla::PluginBundle::RJBS" + ], + "phase" : "build", + "skip" : [] + } + }, + "name" : "@RJBS/RJBS-Outdated", + "version" : "0.015" + }, + { + "class" : "Dist::Zilla::Plugin::PromptIfStale", + "config" : { + "Dist::Zilla::Plugin::PromptIfStale" : { + "check_all_plugins" : "1", + "check_all_prereqs" : 0, + "modules" : [], + "phase" : "release", + "skip" : [] + } + }, + "name" : "@RJBS/CPAN-Outdated", + "version" : "0.015" + }, + { + "class" : "Dist::Zilla::Plugin::PruneCruft", + "name" : "@RJBS/@Filter/PruneCruft", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::ManifestSkip", + "name" : "@RJBS/@Filter/ManifestSkip", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::MetaYAML", + "name" : "@RJBS/@Filter/MetaYAML", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::License", + "name" : "@RJBS/@Filter/License", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::Readme", + "name" : "@RJBS/@Filter/Readme", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::ExecDir", + "name" : "@RJBS/@Filter/ExecDir", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::ShareDir", + "name" : "@RJBS/@Filter/ShareDir", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::MakeMaker", + "name" : "@RJBS/@Filter/MakeMaker", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::Manifest", + "name" : "@RJBS/@Filter/Manifest", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::TestRelease", + "name" : "@RJBS/@Filter/TestRelease", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::ConfirmRelease", + "name" : "@RJBS/@Filter/ConfirmRelease", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::UploadToCPAN", + "name" : "@RJBS/@Filter/UploadToCPAN", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::AutoPrereqs", + "name" : "@RJBS/AutoPrereqs", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::Git::NextVersion", + "name" : "@RJBS/Git::NextVersion", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::PkgVersion", + "name" : "@RJBS/PkgVersion", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::MetaConfig", + "name" : "@RJBS/MetaConfig", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::MetaJSON", + "name" : "@RJBS/MetaJSON", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::NextRelease", + "name" : "@RJBS/NextRelease", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::Test::ChangesHasContent", + "name" : "@RJBS/Test::ChangesHasContent", + "version" : "0.006" + }, + { + "class" : "Dist::Zilla::Plugin::PodSyntaxTests", + "name" : "@RJBS/PodSyntaxTests", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::ReportVersions::Tiny", + "name" : "@RJBS/ReportVersions::Tiny", + "version" : "1.10" + }, + { + "class" : "Dist::Zilla::Plugin::Prereqs", + "config" : { + "Dist::Zilla::Plugin::Prereqs" : { + "phase" : "test", + "type" : "requires" + } + }, + "name" : "@RJBS/TestMoreWithSubtests", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::PodWeaver", + "config" : { + "Dist::Zilla::Plugin::PodWeaver" : { + "config_plugin" : "@RJBS", + "finder" : [ + ":InstallModules", + ":ExecFiles" + ], + "plugins" : [ + { + "class" : "Pod::Weaver::Plugin::EnsurePod5", + "name" : "@CorePrep/EnsurePod5", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Plugin::H1Nester", + "name" : "@CorePrep/H1Nester", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Plugin::SingleEncoding", + "name" : "@RJBS/SingleEncoding", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Name", + "name" : "@RJBS/Name", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Version", + "name" : "@RJBS/Version", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Region", + "name" : "@RJBS/Prelude", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Synopsis", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Description", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Overview", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Stability", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Attributes", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Methods", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Functions", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Leftovers", + "name" : "@RJBS/Leftovers", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Region", + "name" : "@RJBS/postlude", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Authors", + "name" : "@RJBS/Authors", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Section::Legal", + "name" : "@RJBS/Legal", + "version" : "4.004" + }, + { + "class" : "Pod::Weaver::Plugin::Transformer", + "name" : "@RJBS/List", + "version" : "4.004" + } + ] + } + }, + "name" : "@RJBS/PodWeaver", + "version" : "4.002" + }, + { + "class" : "Dist::Zilla::Plugin::GithubMeta", + "name" : "@RJBS/GithubMeta", + "version" : "0.42" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Check", + "name" : "@RJBS/@Git/Check", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Commit", + "name" : "@RJBS/@Git/Commit", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Tag", + "name" : "@RJBS/@Git/Tag", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Push", + "name" : "@RJBS/@Git/Push", + "version" : "2.019" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":InstallModules", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":IncModules", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":TestFiles", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":ExecFiles", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":ShareFiles", + "version" : "5.006" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":MainModule", + "version" : "5.006" + } + ], + "zilla" : { + "class" : "Dist::Zilla::Dist::Builder", + "config" : { + "is_trial" : "0" + }, + "version" : "5.006" + } + } +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..8659b0f --- /dev/null +++ b/META.yml @@ -0,0 +1,289 @@ +--- +abstract: 'parse and validate simple name/value option pairs' +author: + - 'Ricardo Signes <rjbs@cpan.org>' +build_requires: + Test::More: 0.96 +configure_requires: + ExtUtils::MakeMaker: 6.30 +dynamic_config: 0 +generated_by: 'Dist::Zilla version 5.006, CPAN::Meta::Converter version 2.132830' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +name: Data-OptList +requires: + List::Util: 0 + Params::Util: 0 + Sub::Install: 0.921 + strict: 0 + warnings: 0 +resources: + bugtracker: https://github.com/rjbs/Data-OptList/issues + homepage: https://github.com/rjbs/Data-OptList + repository: https://github.com/rjbs/Data-OptList.git +version: 0.109 +x_Dist_Zilla: + perl: + version: 5.018001 + plugins: + - + class: Dist::Zilla::Plugin::Git::GatherDir + name: '@RJBS/Git::GatherDir' + version: 2.019 + - + class: Dist::Zilla::Plugin::CheckPrereqsIndexed + name: '@RJBS/CheckPrereqsIndexed' + version: 0.009 + - + class: Dist::Zilla::Plugin::CheckExtraTests + name: '@RJBS/CheckExtraTests' + version: 0.016 + - + class: Dist::Zilla::Plugin::PromptIfStale + config: + Dist::Zilla::Plugin::PromptIfStale: + check_all_plugins: 0 + check_all_prereqs: 0 + modules: + - Dist::Zilla::PluginBundle::RJBS + phase: build + skip: [] + name: '@RJBS/RJBS-Outdated' + version: 0.015 + - + class: Dist::Zilla::Plugin::PromptIfStale + config: + Dist::Zilla::Plugin::PromptIfStale: + check_all_plugins: 1 + check_all_prereqs: 0 + modules: [] + phase: release + skip: [] + name: '@RJBS/CPAN-Outdated' + version: 0.015 + - + class: Dist::Zilla::Plugin::PruneCruft + name: '@RJBS/@Filter/PruneCruft' + version: 5.006 + - + class: Dist::Zilla::Plugin::ManifestSkip + name: '@RJBS/@Filter/ManifestSkip' + version: 5.006 + - + class: Dist::Zilla::Plugin::MetaYAML + name: '@RJBS/@Filter/MetaYAML' + version: 5.006 + - + class: Dist::Zilla::Plugin::License + name: '@RJBS/@Filter/License' + version: 5.006 + - + class: Dist::Zilla::Plugin::Readme + name: '@RJBS/@Filter/Readme' + version: 5.006 + - + class: Dist::Zilla::Plugin::ExecDir + name: '@RJBS/@Filter/ExecDir' + version: 5.006 + - + class: Dist::Zilla::Plugin::ShareDir + name: '@RJBS/@Filter/ShareDir' + version: 5.006 + - + class: Dist::Zilla::Plugin::MakeMaker + name: '@RJBS/@Filter/MakeMaker' + version: 5.006 + - + class: Dist::Zilla::Plugin::Manifest + name: '@RJBS/@Filter/Manifest' + version: 5.006 + - + class: Dist::Zilla::Plugin::TestRelease + name: '@RJBS/@Filter/TestRelease' + version: 5.006 + - + class: Dist::Zilla::Plugin::ConfirmRelease + name: '@RJBS/@Filter/ConfirmRelease' + version: 5.006 + - + class: Dist::Zilla::Plugin::UploadToCPAN + name: '@RJBS/@Filter/UploadToCPAN' + version: 5.006 + - + class: Dist::Zilla::Plugin::AutoPrereqs + name: '@RJBS/AutoPrereqs' + version: 5.006 + - + class: Dist::Zilla::Plugin::Git::NextVersion + name: '@RJBS/Git::NextVersion' + version: 2.019 + - + class: Dist::Zilla::Plugin::PkgVersion + name: '@RJBS/PkgVersion' + version: 5.006 + - + class: Dist::Zilla::Plugin::MetaConfig + name: '@RJBS/MetaConfig' + version: 5.006 + - + class: Dist::Zilla::Plugin::MetaJSON + name: '@RJBS/MetaJSON' + version: 5.006 + - + class: Dist::Zilla::Plugin::NextRelease + name: '@RJBS/NextRelease' + version: 5.006 + - + class: Dist::Zilla::Plugin::Test::ChangesHasContent + name: '@RJBS/Test::ChangesHasContent' + version: 0.006 + - + class: Dist::Zilla::Plugin::PodSyntaxTests + name: '@RJBS/PodSyntaxTests' + version: 5.006 + - + class: Dist::Zilla::Plugin::ReportVersions::Tiny + name: '@RJBS/ReportVersions::Tiny' + version: 1.10 + - + class: Dist::Zilla::Plugin::Prereqs + config: + Dist::Zilla::Plugin::Prereqs: + phase: test + type: requires + name: '@RJBS/TestMoreWithSubtests' + version: 5.006 + - + class: Dist::Zilla::Plugin::PodWeaver + config: + Dist::Zilla::Plugin::PodWeaver: + config_plugin: '@RJBS' + finder: + - ':InstallModules' + - ':ExecFiles' + plugins: + - + class: Pod::Weaver::Plugin::EnsurePod5 + name: '@CorePrep/EnsurePod5' + version: 4.004 + - + class: Pod::Weaver::Plugin::H1Nester + name: '@CorePrep/H1Nester' + version: 4.004 + - + class: Pod::Weaver::Plugin::SingleEncoding + name: '@RJBS/SingleEncoding' + version: 4.004 + - + class: Pod::Weaver::Section::Name + name: '@RJBS/Name' + version: 4.004 + - + class: Pod::Weaver::Section::Version + name: '@RJBS/Version' + version: 4.004 + - + class: Pod::Weaver::Section::Region + name: '@RJBS/Prelude' + version: 4.004 + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Synopsis' + version: 4.004 + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Description' + version: 4.004 + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Overview' + version: 4.004 + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Stability' + version: 4.004 + - + class: Pod::Weaver::Section::Collect + name: Attributes + version: 4.004 + - + class: Pod::Weaver::Section::Collect + name: Methods + version: 4.004 + - + class: Pod::Weaver::Section::Collect + name: Functions + version: 4.004 + - + class: Pod::Weaver::Section::Leftovers + name: '@RJBS/Leftovers' + version: 4.004 + - + class: Pod::Weaver::Section::Region + name: '@RJBS/postlude' + version: 4.004 + - + class: Pod::Weaver::Section::Authors + name: '@RJBS/Authors' + version: 4.004 + - + class: Pod::Weaver::Section::Legal + name: '@RJBS/Legal' + version: 4.004 + - + class: Pod::Weaver::Plugin::Transformer + name: '@RJBS/List' + version: 4.004 + name: '@RJBS/PodWeaver' + version: 4.002 + - + class: Dist::Zilla::Plugin::GithubMeta + name: '@RJBS/GithubMeta' + version: 0.42 + - + class: Dist::Zilla::Plugin::Git::Check + name: '@RJBS/@Git/Check' + version: 2.019 + - + class: Dist::Zilla::Plugin::Git::Commit + name: '@RJBS/@Git/Commit' + version: 2.019 + - + class: Dist::Zilla::Plugin::Git::Tag + name: '@RJBS/@Git/Tag' + version: 2.019 + - + class: Dist::Zilla::Plugin::Git::Push + name: '@RJBS/@Git/Push' + version: 2.019 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':InstallModules' + version: 5.006 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':IncModules' + version: 5.006 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':TestFiles' + version: 5.006 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':ExecFiles' + version: 5.006 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':ShareFiles' + version: 5.006 + - + class: Dist::Zilla::Plugin::FinderCode + name: ':MainModule' + version: 5.006 + zilla: + class: Dist::Zilla::Dist::Builder + config: + is_trial: 0 + version: 5.006 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..5455d52 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,61 @@ + +use strict; +use warnings; + + + +use ExtUtils::MakeMaker 6.30; + + + +my %WriteMakefileArgs = ( + "ABSTRACT" => "parse and validate simple name/value option pairs", + "AUTHOR" => "Ricardo Signes <rjbs\@cpan.org>", + "BUILD_REQUIRES" => {}, + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => "6.30" + }, + "DISTNAME" => "Data-OptList", + "EXE_FILES" => [], + "LICENSE" => "perl", + "NAME" => "Data::OptList", + "PREREQ_PM" => { + "List::Util" => 0, + "Params::Util" => 0, + "Sub::Install" => "0.921", + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Test::More" => "0.96" + }, + "VERSION" => "0.109", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "List::Util" => 0, + "Params::Util" => 0, + "Sub::Install" => "0.921", + "Test::More" => "0.96", + "strict" => 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); + + + @@ -0,0 +1,13 @@ + + +This archive contains the distribution Data-OptList, +version 0.109: + + parse and validate simple name/value option pairs + +This software is copyright (c) 2006 by Ricardo Signes. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + + diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..7419635 --- /dev/null +++ b/dist.ini @@ -0,0 +1,8 @@ +name = Data-OptList +author = Ricardo Signes <rjbs@cpan.org> +license = Perl_5 +copyright_holder = Ricardo Signes +copyright_year = 2006 + +[@RJBS] + diff --git a/lib/Data/OptList.pm b/lib/Data/OptList.pm new file mode 100644 index 0000000..4f7ba35 --- /dev/null +++ b/lib/Data/OptList.pm @@ -0,0 +1,258 @@ +use strict; +use warnings; +package Data::OptList; +{ + $Data::OptList::VERSION = '0.109'; +} +# ABSTRACT: parse and validate simple name/value option pairs + +use List::Util (); +use Params::Util (); +use Sub::Install 0.921 (); + + +my %test_for; +BEGIN { + %test_for = ( + CODE => \&Params::Util::_CODELIKE, ## no critic + HASH => \&Params::Util::_HASHLIKE, ## no critic + ARRAY => \&Params::Util::_ARRAYLIKE, ## no critic + SCALAR => \&Params::Util::_SCALAR0, ## no critic + ); +} + +sub __is_a { + my ($got, $expected) = @_; + + return List::Util::first { __is_a($got, $_) } @$expected if ref $expected; + + return defined ( + exists($test_for{$expected}) + ? $test_for{$expected}->($got) + : Params::Util::_INSTANCE($got, $expected) ## no critic + ); +} + +sub mkopt { + my ($opt_list) = shift; + + my ($moniker, $require_unique, $must_be); # the old positional args + my $name_test; + + if (@_ == 1 and Params::Util::_HASHLIKE($_[0])) { + my $arg = $_[0]; + ($moniker, $require_unique, $must_be, $name_test) + = @$arg{ qw(moniker require_unique must_be name_test) }; + } else { + ($moniker, $require_unique, $must_be) = @_; + } + + $moniker = 'unnamed' unless defined $moniker; + + return [] unless $opt_list; + + $name_test ||= sub { ! ref $_[0] }; + + $opt_list = [ + map { $_ => (ref $opt_list->{$_} ? $opt_list->{$_} : ()) } keys %$opt_list + ] if ref $opt_list eq 'HASH'; + + my @return; + my %seen; + + for (my $i = 0; $i < @$opt_list; $i++) { ## no critic + my $name = $opt_list->[$i]; + my $value; + + if ($require_unique) { + Carp::croak "multiple definitions provided for $name" if $seen{$name}++; + } + + if ($i == $#$opt_list) { $value = undef; } + elsif (not defined $opt_list->[$i+1]) { $value = undef; $i++ } + elsif ($name_test->($opt_list->[$i+1])) { $value = undef; } + else { $value = $opt_list->[++$i] } + + if ($must_be and defined $value) { + unless (__is_a($value, $must_be)) { + my $ref = ref $value; + Carp::croak "$ref-ref values are not valid in $moniker opt list"; + } + } + + push @return, [ $name => $value ]; + } + + return \@return; +} + + +sub mkopt_hash { + my ($opt_list, $moniker, $must_be) = @_; + return {} unless $opt_list; + + $opt_list = mkopt($opt_list, $moniker, 1, $must_be); + my %hash = map { $_->[0] => $_->[1] } @$opt_list; + return \%hash; +} + + +BEGIN { + *import = Sub::Install::exporter { + exports => [qw(mkopt mkopt_hash)], + }; +} + +1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Data::OptList - parse and validate simple name/value option pairs + +=head1 VERSION + +version 0.109 + +=head1 SYNOPSIS + + use Data::OptList; + + my $options = Data::OptList::mkopt([ + qw(key1 key2 key3 key4), + key5 => { ... }, + key6 => [ ... ], + key7 => sub { ... }, + key8 => { ... }, + key8 => [ ... ], + ]); + +...is the same thing, more or less, as: + + my $options = [ + [ key1 => undef, ], + [ key2 => undef, ], + [ key3 => undef, ], + [ key4 => undef, ], + [ key5 => { ... }, ], + [ key6 => [ ... ], ], + [ key7 => sub { ... }, ], + [ key8 => { ... }, ], + [ key8 => [ ... ], ], + ]); + +=head1 DESCRIPTION + +Hashes are great for storing named data, but if you want more than one entry +for a name, you have to use a list of pairs. Even then, this is really boring +to write: + + $values = [ + foo => undef, + bar => undef, + baz => undef, + xyz => { ... }, + ]; + +Just look at all those undefs! Don't worry, we can get rid of those: + + $values = [ + map { $_ => undef } qw(foo bar baz), + xyz => { ... }, + ]; + +Aaaauuugh! We've saved a little typing, but now it requires thought to read, +and thinking is even worse than typing... and it's got a bug! It looked right, +didn't it? Well, the C<< xyz => { ... } >> gets consumed by the map, and we +don't get the data we wanted. + +With Data::OptList, you can do this instead: + + $values = Data::OptList::mkopt([ + qw(foo bar baz), + xyz => { ... }, + ]); + +This works by assuming that any defined scalar is a name and any reference +following a name is its value. + +=head1 FUNCTIONS + +=head2 mkopt + + my $opt_list = Data::OptList::mkopt($input, \%arg); + +Valid arguments are: + + moniker - a word used in errors to describe the opt list; encouraged + require_unique - if true, no name may appear more than once + must_be - types to which opt list values are limited (described below) + name_test - a coderef used to test whether a value can be a name + (described below, but you probably don't want this) + +This produces an array of arrays; the inner arrays are name/value pairs. +Values will be either "undef" or a reference. + +Positional parameters may be used for compatibility with the old C<mkopt> +interface: + + my $opt_list = Data::OptList::mkopt($input, $moniker, $req_uni, $must_be); + +Valid values for C<$input>: + + undef -> [] + hashref -> [ [ key1 => value1 ] ... ] # non-ref values become undef + arrayref -> every name followed by a non-name becomes a pair: [ name => ref ] + every name followed by undef becomes a pair: [ name => undef ] + otherwise, it becomes [ name => undef ] like so: + [ "a", "b", [ 1, 2 ] ] -> [ [ a => undef ], [ b => [ 1, 2 ] ] ] + +By default, a I<name> is any defined non-reference. The C<name_test> parameter +can be a code ref that tests whether the argument passed it is a name or not. +This should be used rarely. Interactions between C<require_unique> and +C<name_test> are not yet particularly elegant, as C<require_unique> just tests +string equality. B<This may change.> + +The C<must_be> parameter is either a scalar or array of scalars; it defines +what kind(s) of refs may be values. If an invalid value is found, an exception +is thrown. If no value is passed for this argument, any reference is valid. +If C<must_be> specifies that values must be CODE, HASH, ARRAY, or SCALAR, then +Params::Util is used to check whether the given value can provide that +interface. Otherwise, it checks that the given value is an object of the kind. + +In other words: + + [ qw(SCALAR HASH Object::Known) ] + +Means: + + _SCALAR0($value) or _HASH($value) or _INSTANCE($value, 'Object::Known') + +=head2 mkopt_hash + + my $opt_hash = Data::OptList::mkopt_hash($input, $moniker, $must_be); + +Given valid C<L</mkopt>> input, this routine returns a reference to a hash. It +will throw an exception if any name has more than one value. + +=head1 EXPORTS + +Both C<mkopt> and C<mkopt_hash> may be exported on request. + +=head1 AUTHOR + +Ricardo Signes <rjbs@cpan.org> + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2006 by Ricardo Signes. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut diff --git a/t/000-report-versions-tiny.t b/t/000-report-versions-tiny.t new file mode 100644 index 0000000..a60111e --- /dev/null +++ b/t/000-report-versions-tiny.t @@ -0,0 +1,76 @@ +use strict; +use warnings; +use Test::More 0.88; +# This is a relatively nice way to avoid Test::NoWarnings breaking our +# expectations by adding extra tests, without using no_plan. It also helps +# avoid any other test module that feels introducing random tests, or even +# test plans, is a nice idea. +our $success = 0; +END { $success && done_testing; } + +# List our own version used to generate this +my $v = "\nGenerated by Dist::Zilla::Plugin::ReportVersions::Tiny v1.10\n"; + +eval { # no excuses! + # report our Perl details + my $want = "any version"; + $v .= "perl: $] (wanted $want) on $^O from $^X\n\n"; +}; +defined($@) and diag("$@"); + +# Now, our module version dependencies: +sub pmver { + my ($module, $wanted) = @_; + $wanted = " (want $wanted)"; + my $pmver; + eval "require $module;"; + if ($@) { + if ($@ =~ m/Can't locate .* in \@INC/) { + $pmver = 'module not found.'; + } else { + diag("${module}: $@"); + $pmver = 'died during require.'; + } + } else { + my $version; + eval { $version = $module->VERSION; }; + if ($@) { + diag("${module}: $@"); + $pmver = 'died during VERSION check.'; + } elsif (defined $version) { + $pmver = "$version"; + } else { + $pmver = '<undef>'; + } + } + + # So, we should be good, right? + return sprintf('%-45s => %-10s%-15s%s', $module, $pmver, $wanted, "\n"); +} + +eval { $v .= pmver('ExtUtils::MakeMaker','6.30') }; +eval { $v .= pmver('List::Util','any version') }; +eval { $v .= pmver('Params::Util','any version') }; +eval { $v .= pmver('Sub::Install','0.921') }; +eval { $v .= pmver('Test::More','0.96') }; +eval { $v .= pmver('strict','any version') }; +eval { $v .= pmver('warnings','any version') }; + + +# All done. +$v .= <<'EOT'; + +Thanks for using my code. I hope it works for you. +If not, please try and include this output in the bug report. +That will help me reproduce the issue and solve your problem. + +EOT + +diag($v); +ok(1, "we really didn't test anything, just reporting data"); +$success = 1; + +# Work around another nasty module on CPAN. :/ +no warnings 'once'; +$Template::Test::NO_FLUSH = 1; +exit 0; diff --git a/t/hash.t b/t/hash.t new file mode 100644 index 0000000..22b25e1 --- /dev/null +++ b/t/hash.t @@ -0,0 +1,87 @@ +#!/usr/bin/perl +use strict; +use warnings; + +=head1 TEST PURPOSE + +These tests test option list expansion (from an option list into a hashref). + +=cut + +use Sub::Install; +use Test::More tests => 13; + +BEGIN { use_ok('Data::OptList'); } + +# let's get a convenient copy to use: +Sub::Install::install_sub({ + code => 'mkopt_hash', + from => 'Data::OptList', + as => 'OPTH', +}); + +is_deeply( + OPTH(), + {}, + "empty opt list expands properly", +); + +is_deeply( + OPTH(undef), + {}, + "undef opt list expands properly", +); + +is_deeply( + OPTH([]), + {}, + "empty arrayref opt list expands properly", +); + +is_deeply( + OPTH({}), + {}, + "empty hashref opt list expands properly", +); + +is_deeply( + OPTH([ qw(foo bar baz) ]), + { foo => undef, bar => undef, baz => undef }, + "opt list of just names expands", +); + +is_deeply( + OPTH([ qw(foo :bar baz) ]), + { foo => undef, ':bar' => undef, baz => undef }, + "opt list of names expands with :group names", +); + +is_deeply( + OPTH([ foo => { a => 1 }, ':bar', 'baz' ]), + { foo => { a => 1 }, ':bar' => undef, baz => undef }, + "opt list of names and values expands", +); + +is_deeply( + OPTH([ foo => { a => 1 }, ':bar' => undef, 'baz' ]), + { foo => { a => 1 }, ':bar' => undef, baz => undef }, + "opt list of names and values expands, ignoring undef", +); + +is_deeply( + OPTH({ foo => { a => 1 }, -bar => undef, baz => undef }, 0, 'HASH'), + { foo => { a => 1 }, -bar => undef, baz => undef }, + "opt list of names and values expands with must_be", +); + +is_deeply( + OPTH({ foo => { a => 1 }, -bar => undef, baz => undef }, 0, ['HASH']), + { foo => { a => 1 }, -bar => undef, baz => undef }, + "opt list of names and values expands with [must_be]", +); + +eval { OPTH({ foo => { a => 1 }, -bar => undef, baz => undef }, 0, 'ARRAY'); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +eval { OPTH({ foo => { a => 1 }, -bar => undef, baz => undef }, 0, ['ARRAY']); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); diff --git a/t/mkopt.t b/t/mkopt.t new file mode 100644 index 0000000..6f9a20c --- /dev/null +++ b/t/mkopt.t @@ -0,0 +1,183 @@ +#!perl -T +use strict; +use warnings; + +=head1 TEST PURPOSE + +These tests test option list cannonization (from an option list into a aref). + +=cut + +use Data::OptList; +use Sub::Install; +use Test::More 0.88; + + +# let's get a convenient copy to use: +Sub::Install::install_sub({ + code => 'mkopt', + from => 'Data::OptList', +}); + +sub OPT { + # specifying moniker is tedious (also, these tests predate them) + splice @_, 1, 0, 'test' if @_ > 1; + mkopt(@_); +} + +is_deeply( + OPT([]), + [], + "empty opt list expands properly", +); + +is_deeply( + OPT(), + [], + "undef expands into []", +); + +is_deeply( + OPT([ qw(foo bar baz) ]), + [ [ foo => undef ], [ bar => undef ], [ baz => undef ] ], + "opt list of just names expands", +); + +{ + my $options = OPT({ foo => undef, bar => 10, baz => [] }); + $options = [ sort { $a->[0] cmp $b->[0] } @$options ]; + + is_deeply( + $options, + [ [ bar => undef ], [ baz => [] ], [ foo => undef ] ], + "hash opt list expands properly" + ); +} + +is_deeply( + OPT([ qw(foo bar baz) ], 0, "ARRAY"), + [ [ foo => undef ], [ bar => undef ], [ baz => undef ] ], + "opt list of just names expands with must_be", +); + +is_deeply( + OPT([ qw(foo :bar baz) ]), + [ [ foo => undef ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names expands with :group names", +); + +is_deeply( + OPT([ foo => { a => 1 }, ':bar', 'baz' ]), + [ [ foo => { a => 1 } ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands", +); + +is_deeply( + OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, 'HASH'), + [ [ foo => { a => 1 } ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands with must_be", +); + +is_deeply( + OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, ['HASH']), + [ [ foo => { a => 1 } ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands with [must_be]", +); + +{ + bless((my $object = {}), 'Test::DOL::Obj'); + is_deeply( + OPT([ foo => $object, ':bar', 'baz' ], 0, 'Test::DOL::Obj'), + [ [ foo => $object ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands with must_be, must_be object", + ); + + is_deeply( + OPT([ foo => $object, ':bar', 'baz' ], 0, ['Test::DOL::Obj']), + [ [ foo => $object ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands with [must_be], must_be object", + ); +} + +eval { OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, 'ARRAY'); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +eval { OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, ['ARRAY']); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +eval { + mkopt( + [ foo => { a => 1 }, ':bar', 'baz' ], + { + moniker => 'test', + must_be => ['ARRAY'], + } + ); +}; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +eval { OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, 'Test::DOL::Obj'); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +eval { OPT([ foo => { a => 1 }, ':bar', 'baz' ], 0, ['Test::DOL::Obj']); }; +like($@, qr/HASH-ref values are not/, "exception tossed on invaild ref value"); + +is_deeply( + OPT([ foo => { a => 1 }, ':bar' => undef, 'baz' ]), + [ [ foo => { a => 1 } ], [ ':bar' => undef ], [ baz => undef ] ], + "opt list of names and values expands, ignoring undef", +); + +eval { OPT([ foo => { a => 1 }, ':bar' => undef, ':bar' ], 1); }; +like($@, qr/multiple definitions/, "require_unique constraint catches repeat"); + +is_deeply( + OPT([ foo => { a => 1 }, ':bar' => undef, 'baz' ], 1), + [ [ foo => { a => 1 } ], [ ':bar' => undef ], [ baz => undef ] ], + "previously tested expansion OK with require_unique", +); + +# This one is complicated. We defined name values as only non-references (the +# default) or arrayrefs, so arrayrefs are not turned into values as they +# usually are. (The subsequent test shows the default expectation.) +# -- rjbs, 2011-04-08 +my @input =( + foo => { a => 1 }, + bar => undef, + baz => + xyz => [ 1, 2, 3 ], +); + +is_deeply( + mkopt( + [ @input ], + { + moniker => 'test', + name_test => sub { ! ref $_[0] or Params::Util::_ARRAYLIKE($_[0]) }, + }, + ), + [ + [ foo => { a => 1 } ], + [ bar => undef ], + [ baz => undef ], + [ xyz => undef ], + [ [ 1, 2, 3 ], undef ], + ], +); + +is_deeply( + mkopt( + [ @input ], + { + moniker => 'test', + }, + ), + [ + [ foo => { a => 1 } ], + [ bar => undef ], + [ baz => undef ], + [ xyz => [ 1, 2, 3 ] ], + ], +); + +done_testing; diff --git a/xt/release/changes_has_content.t b/xt/release/changes_has_content.t new file mode 100644 index 0000000..725b4fa --- /dev/null +++ b/xt/release/changes_has_content.t @@ -0,0 +1,41 @@ +#!perl + +use Test::More tests => 2; + +note 'Checking Changes'; +my $changes_file = 'Changes'; +my $newver = '0.109'; +my $trial_token = '-TRIAL'; + +SKIP: { + ok(-e $changes_file, "$changes_file file exists") + or skip 'Changes is missing', 1; + + ok(_get_changes($newver), "$changes_file has content for $newver"); +} + +done_testing; + +# _get_changes copied and adapted from Dist::Zilla::Plugin::Git::Commit +# by Jerome Quelin +sub _get_changes +{ + my $newver = shift; + + # parse changelog to find commit message + open(my $fh, '<', $changes_file) or die "cannot open $changes_file: $!"; + my $changelog = join('', <$fh>); + close $fh; + + my @content = + grep { /^$newver(?:$trial_token)?(?:\s+|$)/ ... /^\S/ } # from newver to un-indented + split /\n/, $changelog; + shift @content; # drop the version line + + # drop unindented last line and trailing blank lines + pop @content while ( @content && $content[-1] =~ /^(?:\S|\s*$)/ ); + + # return number of non-blank lines + return scalar @content; +} + diff --git a/xt/release/pod-syntax.t b/xt/release/pod-syntax.t new file mode 100644 index 0000000..8a22900 --- /dev/null +++ b/xt/release/pod-syntax.t @@ -0,0 +1,7 @@ +#!perl +use Test::More; + +eval "use Test::Pod 1.41"; +plan skip_all => "Test::Pod 1.41 required for testing POD" if $@; + +all_pod_files_ok(); |