diff --git a/.gitignore b/.gitignore deleted file mode 100644 index e37ead3..0000000 --- a/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -/App-Changeman* -.build -.perl-version -.pls_cache/ -App-Changelord-* diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 3801c8a..0000000 --- a/.travis.yml +++ /dev/null @@ -1,17 +0,0 @@ ---- -before_install: - - export HARNESS_OPTIONS=j10:c HARNESS_TIMER=1 - - git config --global user.name "Dist Zilla Plugin TravisCI" - - git config --global user.email $HOSTNAME":not-for-mail@travis-ci.com" -install: - - cpanm --with-recommends --installdeps -n . -language: perl -matrix: - include: - - perl: '5.22' - - perl: '5.24' - - perl: '5.26' - - perl: '5.28' - - perl: '5.30' -script: - - prove -l t diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..56c6898 --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,11 @@ + +# APP-CHANGELORD CONTRIBUTORS # + +This is the (likely incomplete) list of people who have helped +make this distribution what it is, either via code contributions, +patches, bug reports, help with troubleshooting, etc. A huge +'thank you' to all of them. + + * Yanick Champoux + + diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..9af34d9 --- /dev/null +++ b/INSTALL @@ -0,0 +1,75 @@ +This is the Perl distribution App-Changelord. + +Installing App-Changelord is straightforward. + +## Installation with cpanm + +If you have cpanm, you only need one line: + + % cpanm App::Changelord + +If it does not have permission to install modules to the current perl, cpanm +will automatically set up and install to a local::lib in your home directory. +See the local::lib documentation (https://metacpan.org/pod/local::lib) for +details on enabling it in your environment. + +## Installing with the CPAN shell + +Alternatively, if your CPAN shell is set up, you should just be able to do: + + % cpan App::Changelord + +## Manual installation + +As a last resort, you can manually install it. If you have not already +downloaded the release tarball, you can find the download link on the module's +MetaCPAN page: https://metacpan.org/pod/App::Changelord + +Untar the tarball, install configure prerequisites (see below), then build it: + + % perl Makefile.PL + % make && make test + +Then install it: + + % make install + +On Windows platforms, you should use `dmake` or `nmake`, instead of `make`. + +If your perl is system-managed, you can create a local::lib in your home +directory to install modules to. For details, see the local::lib documentation: +https://metacpan.org/pod/local::lib + +The prerequisites of this distribution will also have to be installed manually. The +prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated +by running the manual build process described above. + +## Configure Prerequisites + +This distribution requires other modules to be installed before this +distribution's installer can be run. They can be found under the +"configure_requires" key of META.yml or the +"{prereqs}{configure}{requires}" key of META.json. + +## Other Prerequisites + +This distribution may require additional modules to be installed after running +Makefile.PL. +Look for prerequisites in the following phases: + +* to run make, PHASE = build +* to use the module code itself, PHASE = runtime +* to run tests, PHASE = test + +They can all be found in the "PHASE_requires" key of MYMETA.yml or the +"{prereqs}{PHASE}{requires}" key of MYMETA.json. + +## Documentation + +App-Changelord documentation is available as POD. +You can run `perldoc` from a shell to read the documentation: + + % perldoc App::Changelord + +For more information on installing Perl modules via CPAN, please see: +https://www.cpan.org/modules/INSTALL.html diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5adb873 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2022 by Yanick Champoux. + +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) 2022 by Yanick Champoux. + +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, Fifth Floor, Boston, MA 02110-1301 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. + + + Copyright (C) 19yy + + 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. + + , 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) 2022 by Yanick Champoux. + +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 +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP deleted file mode 100644 index 1a28462..0000000 --- a/MANIFEST.SKIP +++ /dev/null @@ -1,7 +0,0 @@ -^dist.ini -^MANIFEST.SKIP -App-Changeman.* -^\.gitignore -^\.git -^\.build - diff --git a/META.json b/META.json new file mode 100644 index 0000000..b1c70a5 --- /dev/null +++ b/META.json @@ -0,0 +1,136 @@ +{ + "abstract" : "cli-based changelog manager", + "author" : [ + "Yanick Champoux " + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 6.025, CPAN::Meta::Converter version 2.150010", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "App-Changelord", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "develop" : { + "requires" : { + "Test::More" : "0.96", + "Test::Vars" : "0" + } + }, + "runtime" : { + "requires" : { + "CLI::Osprey" : "0", + "Git::Repository" : "0", + "JSON" : "0", + "JSON::Schema::Modern" : "0", + "List::AllUtils" : "0", + "Moo" : "0", + "Moo::Role" : "0", + "Path::Tiny" : "0", + "PerlX::Maybe" : "0", + "Version::Dotted::Semantic" : "0", + "YAML" : "0", + "YAML::XS" : "0", + "feature" : "0", + "perl" : "v5.36.0", + "warnings" : "0" + } + }, + "test" : { + "recommends" : { + "CPAN::Meta" : "2.120900" + }, + "requires" : { + "ExtUtils::MakeMaker" : "0", + "File::Spec" : "0", + "IO::Handle" : "0", + "IPC::Open3" : "0", + "Test2::V0" : "0", + "Test::More" : "0", + "strict" : "0" + } + } + }, + "provides" : { + "App::Changelord" : { + "file" : "lib/App/Changelord.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Add" : { + "file" : "lib/App/Changelord/Command/Add.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Bump" : { + "file" : "lib/App/Changelord/Command/Bump.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::GitGather" : { + "file" : "lib/App/Changelord/Command/GitGather.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Init" : { + "file" : "lib/App/Changelord/Command/Init.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Print" : { + "file" : "lib/App/Changelord/Command/Print.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Schema" : { + "file" : "lib/App/Changelord/Command/Schema.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Validate" : { + "file" : "lib/App/Changelord/Command/Validate.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Command::Version" : { + "file" : "lib/App/Changelord/Command/Version.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Role::ChangeTypes" : { + "file" : "lib/App/Changelord/Role/ChangeTypes.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Role::Changelog" : { + "file" : "lib/App/Changelord/Role/Changelog.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Role::Render" : { + "file" : "lib/App/Changelord/Role/Render.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Role::Stats" : { + "file" : "lib/App/Changelord/Role/Stats.pm", + "version" : "v0.0.1" + }, + "App::Changelord::Role::Versions" : { + "file" : "lib/App/Changelord/Role/Versions.pm", + "version" : "v0.0.1" + } + }, + "release_status" : "stable", + "version" : "v0.0.1", + "x_author_pledge" : { + "version" : 1 + }, + "x_authority" : "cpan:YANICK", + "x_contributor_covenant" : { + "version" : 0.02 + }, + "x_contributors" : [ + "Yanick Champoux " + ], + "x_generated_by_perl" : "v5.36.0", + "x_serialization_backend" : "Cpanel::JSON::XS version 4.30", + "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..d3ebefa --- /dev/null +++ b/META.yml @@ -0,0 +1,91 @@ +--- +abstract: 'cli-based changelog manager' +author: + - 'Yanick Champoux ' +build_requires: + ExtUtils::MakeMaker: '0' + File::Spec: '0' + IO::Handle: '0' + IPC::Open3: '0' + Test2::V0: '0' + Test::More: '0' + strict: '0' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 6.025, 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: App-Changelord +provides: + App::Changelord: + file: lib/App/Changelord.pm + version: v0.0.1 + App::Changelord::Command::Add: + file: lib/App/Changelord/Command/Add.pm + version: v0.0.1 + App::Changelord::Command::Bump: + file: lib/App/Changelord/Command/Bump.pm + version: v0.0.1 + App::Changelord::Command::GitGather: + file: lib/App/Changelord/Command/GitGather.pm + version: v0.0.1 + App::Changelord::Command::Init: + file: lib/App/Changelord/Command/Init.pm + version: v0.0.1 + App::Changelord::Command::Print: + file: lib/App/Changelord/Command/Print.pm + version: v0.0.1 + App::Changelord::Command::Schema: + file: lib/App/Changelord/Command/Schema.pm + version: v0.0.1 + App::Changelord::Command::Validate: + file: lib/App/Changelord/Command/Validate.pm + version: v0.0.1 + App::Changelord::Command::Version: + file: lib/App/Changelord/Command/Version.pm + version: v0.0.1 + App::Changelord::Role::ChangeTypes: + file: lib/App/Changelord/Role/ChangeTypes.pm + version: v0.0.1 + App::Changelord::Role::Changelog: + file: lib/App/Changelord/Role/Changelog.pm + version: v0.0.1 + App::Changelord::Role::Render: + file: lib/App/Changelord/Role/Render.pm + version: v0.0.1 + App::Changelord::Role::Stats: + file: lib/App/Changelord/Role/Stats.pm + version: v0.0.1 + App::Changelord::Role::Versions: + file: lib/App/Changelord/Role/Versions.pm + version: v0.0.1 +requires: + CLI::Osprey: '0' + Git::Repository: '0' + JSON: '0' + JSON::Schema::Modern: '0' + List::AllUtils: '0' + Moo: '0' + Moo::Role: '0' + Path::Tiny: '0' + PerlX::Maybe: '0' + Version::Dotted::Semantic: '0' + YAML: '0' + YAML::XS: '0' + feature: '0' + perl: v5.36.0 + warnings: '0' +version: v0.0.1 +x_author_pledge: + version: 1 +x_authority: cpan:YANICK +x_contributor_covenant: + version: 0.02 +x_contributors: + - 'Yanick Champoux ' +x_generated_by_perl: v5.36.0 +x_serialization_backend: 'YAML::Tiny version 1.73' +x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..bf759b1 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,88 @@ +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.025. +use strict; +use warnings; + +use 5.036000; + +use ExtUtils::MakeMaker; + +my %WriteMakefileArgs = ( + "ABSTRACT" => "cli-based changelog manager", + "AUTHOR" => "Yanick Champoux ", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "App-Changelord", + "EXE_FILES" => [ + "bin/changelord" + ], + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.036000", + "NAME" => "App::Changelord", + "PREREQ_PM" => { + "CLI::Osprey" => 0, + "Git::Repository" => 0, + "JSON" => 0, + "JSON::Schema::Modern" => 0, + "List::AllUtils" => 0, + "Moo" => 0, + "Moo::Role" => 0, + "Path::Tiny" => 0, + "PerlX::Maybe" => 0, + "Version::Dotted::Semantic" => 0, + "YAML" => 0, + "YAML::XS" => 0, + "feature" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "IO::Handle" => 0, + "IPC::Open3" => 0, + "Test2::V0" => 0, + "Test::More" => 0, + "strict" => 0 + }, + "VERSION" => "v0.0.1", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "CLI::Osprey" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "Git::Repository" => 0, + "IO::Handle" => 0, + "IPC::Open3" => 0, + "JSON" => 0, + "JSON::Schema::Modern" => 0, + "List::AllUtils" => 0, + "Moo" => 0, + "Moo::Role" => 0, + "Path::Tiny" => 0, + "PerlX::Maybe" => 0, + "Test2::V0" => 0, + "Test::More" => 0, + "Version::Dotted::Semantic" => 0, + "YAML" => 0, + "YAML::XS" => 0, + "feature" => 0, + "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); diff --git a/README.mkdn b/README.mkdn new file mode 100644 index 0000000..2f80385 --- /dev/null +++ b/README.mkdn @@ -0,0 +1,34 @@ +# NAME + +App::Changelord - cli-based changelog manager + +# VERSION + +version v0.0.1 + +# DESCRIPTION + +`App::Changelord` offers a collection of cli commands to +interact with a YAML-based CHANGELOG file format, from which +a Markdown CHANGELOG fit for general comsumption can be generated. + +See the original blog entry in the `SEE ALSO` section for the full +motivation. + +For a list of the commands, `changelord --help`, then to +get information on the individual commands `changelord *subcommand* --man`. + +# SEE ALSO + +[Changelord, registrar of deeds extraordinaire](https://techblog.babyl.ca/entry/changelord) - the introducing blog entry. + +# AUTHOR + +Yanick Champoux [![endorse](http://api.coderwall.com/yanick/endorsecount.png)](http://coderwall.com/yanick) + +# COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/SIGNATURE b/SIGNATURE new file mode 100644 index 0000000..e69de29 diff --git a/bin/changelord b/bin/changelord index 37c5b9d..2182641 100755 --- a/bin/changelord +++ b/bin/changelord @@ -5,3 +5,30 @@ use App::Changelord; App::Changelord->new_with_options()->run; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +changelord - cli tool for App::Changelord + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/dist.ini b/dist.ini deleted file mode 100644 index e244dba..0000000 --- a/dist.ini +++ /dev/null @@ -1,20 +0,0 @@ -name = App-Changelord -author = Yanick Champoux -license = Perl_5 -copyright_holder = Yanick Champoux -copyright_year = 2022 -version = v0.0.1 - -homepage=https://git.babyl.ca/yanick/App-Changelord - -[@Filter] --bundle=@YANICK --remove=GithubMeta --remove=ReadmeFromPod --remove=Test::PAUSE::Permissions --remove=PreviousVersion::Changelog --remove=NextVersion::Semantic --remove=ChangeStats::Git --remove=CheckChangesHasContent --remove=RunExtraTests -dev_branch=main diff --git a/doap.xml b/doap.xml new file mode 100644 index 0000000..015fab6 --- /dev/null +++ b/doap.xml @@ -0,0 +1,25 @@ + + + App-Changelord + cli-based changelog manager + + + Yanick Champoux + + + + + + Yanick Champoux + + + + + Perl + diff --git a/lib/App/Changelord.pm b/lib/App/Changelord.pm index 7957e14..26d5029 100644 --- a/lib/App/Changelord.pm +++ b/lib/App/Changelord.pm @@ -1,6 +1,7 @@ package App::Changelord; +our $AUTHORITY = 'cpan:YANICK'; # ABSTRACT: cli-based changelog manager - +$App::Changelord::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -26,6 +27,18 @@ subcommand $_ => 'App::Changelord::Command::' . ucfirst $_ =~ s/-(.)/uc $1/er __END__ +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord - cli-based changelog manager + +=head1 VERSION + +version v0.0.1 + =head1 DESCRIPTION C offers a collection of cli commands to @@ -42,4 +55,15 @@ get information on the individual commands C. L - the introducing blog entry. +=head1 AUTHOR +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Add.pm b/lib/App/Changelord/Command/Add.pm index 1fd3209..89c345f 100644 --- a/lib/App/Changelord/Command/Add.pm +++ b/lib/App/Changelord/Command/Add.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::Add; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::Add::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -70,3 +71,30 @@ sub run ($self) { } 'end of App::Changelog::Command::Add'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Add + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Bump.pm b/lib/App/Changelord/Command/Bump.pm index ddea6ac..75c3659 100644 --- a/lib/App/Changelord/Command/Bump.pm +++ b/lib/App/Changelord/Command/Bump.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::Bump; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::Bump::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -79,3 +80,30 @@ sub run ($self) { } 'end of App::Changelog::Command::Bump'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Bump + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/GitGather.pm b/lib/App/Changelord/Command/GitGather.pm index 94385fa..bff444c 100644 --- a/lib/App/Changelord/Command/GitGather.pm +++ b/lib/App/Changelord/Command/GitGather.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::GitGather; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::GitGather::VERSION = 'v0.0.1'; use v5.36.0; use Moo; @@ -125,3 +126,27 @@ sub run ($self) { __END__ +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::GitGather + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Init.pm b/lib/App/Changelord/Command/Init.pm index a35b47e..1614337 100644 --- a/lib/App/Changelord/Command/Init.pm +++ b/lib/App/Changelord/Command/Init.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::Init; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::Init::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -60,3 +61,30 @@ sub run ($self) { } 'end of App::Changelog::Command::Init'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Init + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Print.pm b/lib/App/Changelord/Command/Print.pm index 54b586e..cdfc7dc 100644 --- a/lib/App/Changelord/Command/Print.pm +++ b/lib/App/Changelord/Command/Print.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::Print; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::Print::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -37,3 +38,30 @@ sub run($self) { } 'end of App::Changelog::Command::Print'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Print + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Schema.pm b/lib/App/Changelord/Command/Schema.pm index a32ccb5..dc7d35a 100644 --- a/lib/App/Changelord/Command/Schema.pm +++ b/lib/App/Changelord/Command/Schema.pm @@ -1,6 +1,7 @@ package App::Changelord::Command::Schema; +our $AUTHORITY = 'cpan:YANICK'; # SYNOPSIS: print out the changelog schema - +$App::Changelord::Command::Schema::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -31,3 +32,30 @@ sub run($self) { } 'end of App::Changelog::Command::Schema'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Schema + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Validate.pm b/lib/App/Changelord/Command/Validate.pm index 9701fac..e928867 100644 --- a/lib/App/Changelord/Command/Validate.pm +++ b/lib/App/Changelord/Command/Validate.pm @@ -1,5 +1,6 @@ package App::Changelord::Command::Validate; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Command::Validate::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -43,3 +44,30 @@ sub run($self) { } 'end of App::Changelog::Command::Validate'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Validate + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Command/Version.pm b/lib/App/Changelord/Command/Version.pm index af58493..81d8354 100644 --- a/lib/App/Changelord/Command/Version.pm +++ b/lib/App/Changelord/Command/Version.pm @@ -1,6 +1,7 @@ package App::Changelord::Command::Version; +our $AUTHORITY = 'cpan:YANICK'; # SYNOPSIS: output the latest / next version - +$App::Changelord::Command::Version::VERSION = 'v0.0.1'; use 5.36.0; use Moo; @@ -36,3 +37,30 @@ sub run($self) { } 'end of App::Changelog::Command::Version'; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Command::Version + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Role/ChangeTypes.pm b/lib/App/Changelord/Role/ChangeTypes.pm index b680539..cc7d849 100644 --- a/lib/App/Changelord/Role/ChangeTypes.pm +++ b/lib/App/Changelord/Role/ChangeTypes.pm @@ -1,5 +1,6 @@ package App::Changelord::Role::ChangeTypes; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Role::ChangeTypes::VERSION = 'v0.0.1'; use v5.36.0; use Moo::Role; @@ -24,3 +25,30 @@ sub _build_change_types($self) { 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Role::ChangeTypes + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Role/Changelog.pm b/lib/App/Changelord/Role/Changelog.pm index cc6d49a..8a28273 100644 --- a/lib/App/Changelord/Role/Changelog.pm +++ b/lib/App/Changelord/Role/Changelog.pm @@ -1,5 +1,6 @@ package App::Changelord::Role::Changelog; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Role::Changelog::VERSION = 'v0.0.1'; use v5.36.0; use Moo::Role; @@ -19,3 +20,30 @@ sub _build_changelog($self) { } 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Role::Changelog + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Role/Render.pm b/lib/App/Changelord/Role/Render.pm index 83fddee..f2ec47f 100644 --- a/lib/App/Changelord/Role/Render.pm +++ b/lib/App/Changelord/Role/Render.pm @@ -1,5 +1,6 @@ package App::Changelord::Role::Render; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Role::Render::VERSION = 'v0.0.1'; use v5.36.0; use Moo::Role; @@ -139,3 +140,30 @@ sub render_change ( $self, $change ) { } 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Role::Render + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Role/Stats.pm b/lib/App/Changelord/Role/Stats.pm index c80b99e..f600955 100644 --- a/lib/App/Changelord/Role/Stats.pm +++ b/lib/App/Changelord/Role/Stats.pm @@ -1,5 +1,6 @@ package App::Changelord::Role::Stats; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Role::Stats::VERSION = 'v0.0.1'; use v5.36.0; use Git::Repository; @@ -46,3 +47,30 @@ sub _get_comparison_data($self) { } 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Role::Stats + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/lib/App/Changelord/Role/Versions.pm b/lib/App/Changelord/Role/Versions.pm index 889d4a4..6c6ea94 100644 --- a/lib/App/Changelord/Role/Versions.pm +++ b/lib/App/Changelord/Role/Versions.pm @@ -1,5 +1,6 @@ package App::Changelord::Role::Versions; - +our $AUTHORITY = 'cpan:YANICK'; +$App::Changelord::Role::Versions::VERSION = 'v0.0.1'; use v5.36.0; use List::AllUtils qw/ first min /; @@ -61,3 +62,30 @@ sub next_release($self) { } 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +App::Changelord::Role::Versions + +=head1 VERSION + +version v0.0.1 + +=head1 AUTHOR + +Yanick Champoux + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2022 by Yanick Champoux. + +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/00-compile.t b/t/00-compile.t new file mode 100644 index 0000000..d85d544 --- /dev/null +++ b/t/00-compile.t @@ -0,0 +1,110 @@ +use 5.006; +use strict; +use warnings; + +# this test was generated with Dist::Zilla::Plugin::Test::Compile 2.058 + +use Test::More; + +plan tests => 15 + ($ENV{AUTHOR_TESTING} ? 1 : 0); + +my @module_files = ( + 'App/Changelord.pm', + 'App/Changelord/Command/Add.pm', + 'App/Changelord/Command/Bump.pm', + 'App/Changelord/Command/GitGather.pm', + 'App/Changelord/Command/Init.pm', + 'App/Changelord/Command/Print.pm', + 'App/Changelord/Command/Schema.pm', + 'App/Changelord/Command/Validate.pm', + 'App/Changelord/Command/Version.pm', + 'App/Changelord/Role/ChangeTypes.pm', + 'App/Changelord/Role/Changelog.pm', + 'App/Changelord/Role/Render.pm', + 'App/Changelord/Role/Stats.pm', + 'App/Changelord/Role/Versions.pm' +); + +my @scripts = ( + 'bin/changelord' +); + +# no fake home requested + +my @switches = ( + -d 'blib' ? '-Mblib' : '-Ilib', +); + +use File::Spec; +use IPC::Open3; +use IO::Handle; + +open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; + +my @warnings; +for my $lib (@module_files) +{ + # see L + my $stderr = IO::Handle->new; + + diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } + $^X, @switches, '-e', "require q[$lib]")) + if $ENV{PERL_COMPILE_TEST_DEBUG}; + + my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-e', "require q[$lib]"); + binmode $stderr, ':crlf' if $^O eq 'MSWin32'; + my @_warnings = <$stderr>; + waitpid($pid, 0); + is($?, 0, "$lib loaded ok"); + + shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ + and not eval { +require blib; blib->VERSION('1.01') }; + + if (@_warnings) + { + warn @_warnings; + push @warnings, @_warnings; + } +} + +foreach my $file (@scripts) +{ SKIP: { + open my $fh, '<', $file or warn("Unable to open $file: $!"), next; + my $line = <$fh>; + + close $fh and skip("$file isn't perl", 1) unless $line =~ /^#!\s*(?:\S*perl\S*)((?:\s+-\w*)*)(?:\s*#.*)?$/; + @switches = (@switches, split(' ', $1)) if $1; + + close $fh and skip("$file uses -T; not testable with PERL5LIB", 1) + if grep { $_ eq '-T' } @switches and $ENV{PERL5LIB}; + + my $stderr = IO::Handle->new; + + diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } + $^X, @switches, '-c', $file)) + if $ENV{PERL_COMPILE_TEST_DEBUG}; + + my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-c', $file); + binmode $stderr, ':crlf' if $^O eq 'MSWin32'; + my @_warnings = <$stderr>; + waitpid($pid, 0); + is($?, 0, "$file compiled ok"); + + shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ + and not eval { +require blib; blib->VERSION('1.01') }; + + # in older perls, -c output is simply the file portion of the path being tested + if (@_warnings = grep { !/\bsyntax OK$/ } + grep { chomp; $_ ne (File::Spec->splitpath($file))[2] } @_warnings) + { + warn @_warnings; + push @warnings, @_warnings; + } +} } + + + +is(scalar(@warnings), 0, 'no warnings found') + or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; + + diff --git a/t/00-report-prereqs.dd b/t/00-report-prereqs.dd new file mode 100644 index 0000000..11ebff8 --- /dev/null +++ b/t/00-report-prereqs.dd @@ -0,0 +1,48 @@ +do { my $x = { + 'configure' => { + 'requires' => { + 'ExtUtils::MakeMaker' => '0' + } + }, + 'develop' => { + 'requires' => { + 'Test::More' => '0.96', + 'Test::Vars' => '0' + } + }, + 'runtime' => { + 'requires' => { + 'CLI::Osprey' => '0', + 'Git::Repository' => '0', + 'JSON' => '0', + 'JSON::Schema::Modern' => '0', + 'List::AllUtils' => '0', + 'Moo' => '0', + 'Moo::Role' => '0', + 'Path::Tiny' => '0', + 'PerlX::Maybe' => '0', + 'Version::Dotted::Semantic' => '0', + 'YAML' => '0', + 'YAML::XS' => '0', + 'feature' => '0', + 'perl' => 'v5.36.0', + 'warnings' => '0' + } + }, + 'test' => { + 'recommends' => { + 'CPAN::Meta' => '2.120900' + }, + 'requires' => { + 'ExtUtils::MakeMaker' => '0', + 'File::Spec' => '0', + 'IO::Handle' => '0', + 'IPC::Open3' => '0', + 'Test2::V0' => '0', + 'Test::More' => '0', + 'strict' => '0' + } + } + }; + $x; + } \ No newline at end of file diff --git a/t/00-report-prereqs.t b/t/00-report-prereqs.t new file mode 100644 index 0000000..c3a94ca --- /dev/null +++ b/t/00-report-prereqs.t @@ -0,0 +1,193 @@ +#!perl + +use strict; +use warnings; + +# This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.028 + +use Test::More tests => 1; + +use ExtUtils::MakeMaker; +use File::Spec; + +# from $version::LAX +my $lax_version_re = + qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? + | + (?:\.[0-9]+) (?:_[0-9]+)? + ) | (?: + v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? + | + (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? + ) + )/x; + +# hide optional CPAN::Meta modules from prereq scanner +# and check if they are available +my $cpan_meta = "CPAN::Meta"; +my $cpan_meta_pre = "CPAN::Meta::Prereqs"; +my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic + +# Verify requirements? +my $DO_VERIFY_PREREQS = 1; + +sub _max { + my $max = shift; + $max = ( $_ > $max ) ? $_ : $max for @_; + return $max; +} + +sub _merge_prereqs { + my ($collector, $prereqs) = @_; + + # CPAN::Meta::Prereqs object + if (ref $collector eq $cpan_meta_pre) { + return $collector->with_merged_prereqs( + CPAN::Meta::Prereqs->new( $prereqs ) + ); + } + + # Raw hashrefs + for my $phase ( keys %$prereqs ) { + for my $type ( keys %{ $prereqs->{$phase} } ) { + for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { + $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; + } + } + } + + return $collector; +} + +my @include = qw( + +); + +my @exclude = qw( + +); + +# Add static prereqs to the included modules list +my $static_prereqs = do './t/00-report-prereqs.dd'; + +# Merge all prereqs (either with ::Prereqs or a hashref) +my $full_prereqs = _merge_prereqs( + ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), + $static_prereqs +); + +# Add dynamic prereqs to the included modules list (if we can) +my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; +my $cpan_meta_error; +if ( $source && $HAS_CPAN_META + && (my $meta = eval { CPAN::Meta->load_file($source) } ) +) { + $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); +} +else { + $cpan_meta_error = $@; # capture error from CPAN::Meta->load_file($source) + $source = 'static metadata'; +} + +my @full_reports; +my @dep_errors; +my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; + +# Add static includes into a fake section +for my $mod (@include) { + $req_hash->{other}{modules}{$mod} = 0; +} + +for my $phase ( qw(configure build test runtime develop other) ) { + next unless $req_hash->{$phase}; + next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); + + for my $type ( qw(requires recommends suggests conflicts modules) ) { + next unless $req_hash->{$phase}{$type}; + + my $title = ucfirst($phase).' '.ucfirst($type); + my @reports = [qw/Module Want Have/]; + + for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { + next if $mod eq 'perl'; + next if grep { $_ eq $mod } @exclude; + + my $file = $mod; + $file =~ s{::}{/}g; + $file .= ".pm"; + my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; + + my $want = $req_hash->{$phase}{$type}{$mod}; + $want = "undef" unless defined $want; + $want = "any" if !$want && $want == 0; + + my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; + + if ($prefix) { + my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); + $have = "undef" unless defined $have; + push @reports, [$mod, $want, $have]; + + if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { + if ( $have !~ /\A$lax_version_re\z/ ) { + push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; + } + elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { + push @dep_errors, "$mod version '$have' is not in required range '$want'"; + } + } + } + else { + push @reports, [$mod, $want, "missing"]; + + if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { + push @dep_errors, "$mod is not installed ($req_string)"; + } + } + } + + if ( @reports ) { + push @full_reports, "=== $title ===\n\n"; + + my $ml = _max( map { length $_->[0] } @reports ); + my $wl = _max( map { length $_->[1] } @reports ); + my $hl = _max( map { length $_->[2] } @reports ); + + if ($type eq 'modules') { + splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; + push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; + } + else { + splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; + push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; + } + + push @full_reports, "\n"; + } + } +} + +if ( @full_reports ) { + diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; +} + +if ( $cpan_meta_error || @dep_errors ) { + diag "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n"; +} + +if ( $cpan_meta_error ) { + my ($orig_source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; + diag "\nCPAN::Meta->load_file('$orig_source') failed with: $cpan_meta_error\n"; +} + +if ( @dep_errors ) { + diag join("\n", + "\nThe following REQUIRED prerequisites were not satisfied:\n", + @dep_errors, + "\n" + ); +} + +pass('Reported prereqs'); + +# vim: ts=4 sts=4 sw=4 et: diff --git a/xt/release/unused-vars.t b/xt/release/unused-vars.t new file mode 100644 index 0000000..e601076 --- /dev/null +++ b/xt/release/unused-vars.t @@ -0,0 +1,14 @@ +#!perl + +use Test::More 0.96 tests => 1; +eval { require Test::Vars }; + +SKIP: { + skip 1 => 'Test::Vars required for testing for unused vars' + if $@; + Test::Vars->import; + + subtest 'unused vars' => sub { +all_vars_ok(); + }; +};