MooseX-App-1.43000755000765000024 014514737355 12461 5ustar00mkostaff000000000000TODO100644000765000024 12314514737355 13206 0ustar00mkostaff000000000000MooseX-App-1.43https://github.com/maros/MooseX-App/issues?q=is%3Aissue+is%3Aopen+label%3AWhishlistChanges100644000765000024 2000714514737355 14054 0ustar00mkostaff000000000000MooseX-App-1.43Release history for Perl module MooseX::App 1.43 2023-10-21 - Remove duplicate license - Require Config::Any - Fix cmd_aliases for flags (fixed by William Barker) - Remove smartmatch (implemented by Petr Pisar) - Allow to override build date with SOURCE_DATE_EPOCH (implemented by Bernhard M. Wiedemann) 1.42 2021-08-15 - Documentation - Fix failing tests with new Moose versions (implemented by Frank Schreiner) - Sort option in bash completion plugin (implemented by Frank Schreiner) - Fixed term plugin warning (implemented by J.R. Mash) 1.41 2019-05-13 - Switch to Dist::Zilla 1.40 2019-05-13 - Disable 11_process.t on NetBSD since fork is failing (forking is only done during testing and not by the actual module) - Sort keys operations to get a predictable order of keys (implemented by Jose Luis Martinez) - Simplify dependencies: No need for Path::Class. File::Spec and File::Basename that are loaded via Module::Pluggable::Object are sufficient 1.39 2017-09-24 - APP_DEVELOPER environment for extended module checks - Improved command checks: Die on single letter flags without Bool type constraints 1.38 2017-06-20 - Cleanups (get rid of smartmatch, inentation, documentation, tests) - Also handle =head[2-4] tags when processing pod (#47) - Subcommands (based on work by Yanick Champoux) 1.37 2016-11-13 - Refactor the way values are parsed from @ARGV - Rework boolean negation - Add developer checks 1.36 2016-10-11 - Documentation - Set correct encoding on STDERR - Fix order of options (fixed by J.R. Mash) - Replace dashes in variable names with underscores in bash completion (implemented byTina Müller) - Do not autocomplete autocomplete itself (implemented by Lisa Hare) - Create correct documentation for options with cmd_split - Rename hints key to clarify purpose - Add ability to negate boolean options (implemented by Marc Logghe) - Spelling fixes github#39 (fixed by Gregor Herrmann) - Retain original order of elements from @ARGV 1.35 2016-04-02 - Spelling fixes RT112234 (fixed by Gregor Herrmann) - Documentation - Allow to pass ARGV directly to constructor - use namespace::autoclean (reported by Mohammad S Anwar) - Dist housekeeping 1.34 2016-02-21 - Do not accept invalid character in Term plugin - Fix RT112156: Command class lacking attribute metarole (reported by Marc Logghe) - Apply Spelling fixes RT105717 (fixed by Gregor Herrmann) - Add permute option to specify multiple values with one attribute key - Fix imports (fixed by Alexander Stoddard) - Documentation 1.33 2015-04-17 - Fix failing tests - Fix manifest 1.32 2015-03-21 - Improved Term Plugin (History, Delete, Pasting, Pos1/End, Cursors) - Documentation - Added app_command_register - Errors are now printed on STDERR - Disable fuzzy match for single letter parameters - Use proper exit codes if errors occur - Add tests for subprocesses - Add MutexGroup plugin (implemented by Hunter McMillen) - Add Depends plugin (implemented by Hunter McMillen) 1.31 2015-02-08 - Dist cleanup (done by Sergey Romanov) - Moose cleanups (done by Sawyer X) - Fixed TERM plugin input - Coercion for ENV variables (implemented by Roman F.) - Refactor handling of boolean values - Allow for empty values - Add cmd_count option for counter attributes 1.30 2014-08-24 - Better error message if command was not specified - Help improved - Term plugin - Deprecate Env plugin; Now in core - Fix broken usage in M::A::Simple - Fix documentation being parsed called multiple times 1.29 2014-08-05 - Documentation improvements and fixups - Better error messages if type constraints fail - Better suggestions in case of errors - Handle enum type constraints in usage info - Display application documentation 1.28 2014-03-25 - Fix failing tests (reported by Michael Greb and Dagfinn Ilmari Mannsåker) 1.27 2014-03-02 - Fix warnings on warnings on 5.18 again - Documentation - Fix spelling (fixed by Gregor Herrmann) 1.26 2014-02-24 - Fix failing tests 1.25 2014-02-23 - Allow multiple command namespaces (implemented by Thilo Fester) - Documentation 1.24 2014-02-14 - Fix POD warnings (fixed by David Golden) - Always reuse existing MooseX::App::ParsedArgv instances - Parse @ARGV as soon as possible - Fix Win32 colorisation issues (fixed by J.R. Mash) - Add app_prefer_commandline option 1.23 2014-01-27 - Documentation - Manual plugin - More inheritance tests - Cleanup deprecated code 1.22 2013-05-24 - Silence experimental::smartmatch warnings on 5.18 (fixed by Mike Doherty) 1.21 2013-04-13 - Fix option sorting - Fix parsing of positional parameters 1.20 2013-04-08 - Add cmd_split and cmd_position option - Fixed parameter position (fixed by Yanick Champoux) - app_strict option to set if app should terminate when unknown parameters or options are supplied 1.19 2013-03-28 - Fixed failing tests - Fixed bug that was triggered by Moose 2.0800 - Fixed on MSWin 1.18 2013-03-24 - Added positional parameters with 'parameter' keyword (Attention: this change might break things if you used to work with @extra) - Parameters are handled in the meta class - Usage meta class methods refactored 1.17 2013-03-06 - Fix failing tests 1.16 2013-02-27 - Better license parsing - Fix failing tests - Use Class::Load instead of Class::MOP to load classes - Remove MooseX::Getopt dependency. Parse @ARGV ourself - Renamed meta class methods to use single prefix - Moved meta class methods to attribute meta class - Much more tests (95% statement and 90% total coverage) - Better error handling for Environment plugin 1.15 2013-01-18 - Fix wrong attribute initialisation order 1.14 2013-01-15 - Fix failing test - Update documentation - Optional usage information from POD (implemented by Yanick Champoux) - app_fuzzy now defaults to true - Version plugin prints license and copyright 1.13 2013-01-11 - Fix failing test - Update documentation 1.12 2013-01-10 - Fix failing test - Fix pod (Andrew Jones) 1.11 2013-01-08 - Parse DistZilla ABSTRACT for documentation - Improve tutorial and fix typo (fixed by George Hartzell) - Saner bash completion and version plugin - Fix fuzzy command and attribute matching - Deprecate fuzzy plugin, use typo plugin instead - Handle shell character encodings - More tests 1.10 2013-01-07 - Fix bash completion plugin (fixed by Steve Nolte) 1.09 2012-11-22 - Fix failing load test 1.08 2012-11-17 - Refactor object initialisation - Fix missing bash-completion prefix (fixed by Steve Nolte) - Require latest MooseX::Getopt (fixed by Steve Nolte) - Fix Plugin::Version docs RT81186 (fixed by Michael G) - Update documentation 1.07 2012-08-22 - Fix failing load tests 1.06 2012-08-20 - Single command interface (MooseX::App::Simple) - Fuzzy command matching plugin - Only lowercase command names - Environment plugin - Version plugin - Various cleanups 1.05 2012-06-04 - Fix broken load tests - Join M::A::Meta::Attribute::Base and M::A::Meta::Attribute::Option 1.04 2012-06-02 - Fix bugs in BashCompletion plugin - Remove code duplication - Fix --help flag in command classes - Fix pod to text conversion 1.03 2012-06-02 - Do not expose all attributes as options but only those defined via 'option' keyword - More tests - Internal changes (move methods to meta class, calculate loadable commands only once, ...) - Fix various bugs 1.02 2012-04-15 - Fix command usage generation bug - Automatically apply MooseX-Getopt attribute traits - Rename command_tag to cmd_tag attribute 1.01 2012-04-12 - Fix text failures - Fix Pod - Add missing tutorials to manifest 1.00 2012-04-07 - Initial version LICENSE100644000765000024 4643514514737355 13603 0ustar00mkostaff000000000000MooseX-App-1.43This software is copyright (c) 2023 by Maroš Kollár. 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) 2023 by Maroš Kollár. 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 Perl Artistic License 1.0 --- This software is Copyright (c) 2023 by Maroš Kollár. This is free software, licensed under: The Perl 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 as specified below. "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 uunet.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) give non-standard executables non-standard names, and clearly document 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. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded. 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 whoever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package. 7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. 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 cpanfile100644000765000024 152614514737355 14252 0ustar00mkostaff000000000000MooseX-App-1.43requires 'Moose', '2.00'; requires 'namespace::autoclean'; requires 'Module::Pluggable'; requires 'File::Basename'; requires 'File::Spec'; requires 'List::Util', '1.44'; requires 'Pod::Elemental'; requires 'Config::Any'; feature 'config', 'Config plugins' => sub { requires 'File::HomeDir'; }; feature 'colour', 'Colourful output' => sub { requires 'IO::Interactive'; requires 'Term::ANSIColor'; requires 'Win32::Console::ANSI'; }; feature 'term', 'Term plugin' => sub { requires 'IO::Interactive'; requires 'Term::ANSIColor'; }; feature 'typo', 'Typo plugin' => sub { requires 'Text::WagnerFischer'; }; on test => sub { requires 'Test::Most'; requires 'Test::NoWarnings'; }; on develop => sub { requires 'Test::Pod', '1.14'; requires 'Test::Pod::Coverage', '1.04'; requires 'Test::Perl::Critic'; }; dist.ini100644000765000024 111714514737355 14206 0ustar00mkostaff000000000000MooseX-App-1.43name = MooseX-App author = Maroš Kollár license = Perl_5 copyright_holder = Maroš Kollár copyright_year = 2023 main_module = lib/MooseX/App.pm [Git::GatherDir] exclude_match=Makefile exclude_match=LICENSE [MakeMaker] [VersionFromMainModule] [MetaYAML] [MetaJSON] [MinimumPerlFast] [MetaResources] repository.web = https://github.com/maros/MooseX-App repository.url = git://github.com/maros/MooseX-App.git repository.type = git bugtracker.web = https://github.com/maros/MooseX-App/issues [License] [RunExtraTests] [TestRelease] [Manifest] [Prereqs::FromCPANfile] xt000755000765000024 014514737355 13035 5ustar00mkostaff000000000000MooseX-App-1.43pod.t100644000765000024 35614514737355 14130 0ustar00mkostaff000000000000MooseX-App-1.43/xt# -*- perl -*- use strict; use warnings; use Test::More; eval "use Test::Pod 1.14"; plan skip_all => 'Test::Pod 1.14 required' if $@; plan skip_all => 'set TEST_AUTHOR to enable this test' unless $ENV{TEST_AUTHOR}; all_pod_files_ok(); META.yml100644000765000024 252214514737355 14014 0ustar00mkostaff000000000000MooseX-App-1.43--- abstract: 'Write user-friendly command line apps with even less suffering' author: - 'Maroš Kollár ' build_requires: Test::Most: '0' Test::NoWarnings: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.030, 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: MooseX-App optional_features: colour: description: 'Colourful output' requires: IO::Interactive: '0' Term::ANSIColor: '0' Win32::Console::ANSI: '0' config: description: 'Config plugins' requires: File::HomeDir: '0' term: description: 'Term plugin' requires: IO::Interactive: '0' Term::ANSIColor: '0' typo: description: 'Typo plugin' requires: Text::WagnerFischer: '0' requires: Config::Any: '0' File::Basename: '0' File::Spec: '0' List::Util: '1.44' Module::Pluggable: '0' Moose: '2.00' Pod::Elemental: '0' namespace::autoclean: '0' perl: '5.010' resources: bugtracker: https://github.com/maros/MooseX-App/issues repository: git://github.com/maros/MooseX-App.git version: '1.43' x_generated_by_perl: v5.30.3 x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' MANIFEST100644000765000024 634714514737355 13705 0ustar00mkostaff000000000000MooseX-App-1.43# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.030. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README.md TODO cpanfile dist.ini lib/MooseX/App.pm lib/MooseX/App/Command.pm lib/MooseX/App/Exporter.pm lib/MooseX/App/Message/Block.pm lib/MooseX/App/Message/BlockColor.pm lib/MooseX/App/Message/Envelope.pm lib/MooseX/App/Meta/Role/Attribute/Option.pm lib/MooseX/App/Meta/Role/Class/Base.pm lib/MooseX/App/Meta/Role/Class/Command.pm lib/MooseX/App/Meta/Role/Class/Documentation.pm lib/MooseX/App/Meta/Role/Class/Simple.pm lib/MooseX/App/ParsedArgv.pm lib/MooseX/App/ParsedArgv/Element.pm lib/MooseX/App/ParsedArgv/Value.pm lib/MooseX/App/Plugin/BashCompletion.pm lib/MooseX/App/Plugin/BashCompletion/Command.pm lib/MooseX/App/Plugin/BashCompletion/Meta/Class.pm lib/MooseX/App/Plugin/Color.pm lib/MooseX/App/Plugin/Color/Meta/Class.pm lib/MooseX/App/Plugin/Config.pm lib/MooseX/App/Plugin/Config/Meta/Class.pm lib/MooseX/App/Plugin/ConfigHome.pm lib/MooseX/App/Plugin/ConfigHome/Meta/Class.pm lib/MooseX/App/Plugin/Depends.pm lib/MooseX/App/Plugin/Depends/Meta/Attribute.pm lib/MooseX/App/Plugin/Depends/Meta/Class.pm lib/MooseX/App/Plugin/Env.pm lib/MooseX/App/Plugin/Fuzzy.pm lib/MooseX/App/Plugin/Man.pm lib/MooseX/App/Plugin/Man/Command.pm lib/MooseX/App/Plugin/Man/Meta/Class.pm lib/MooseX/App/Plugin/MutexGroup.pm lib/MooseX/App/Plugin/MutexGroup/Meta/Attribute.pm lib/MooseX/App/Plugin/MutexGroup/Meta/Class.pm lib/MooseX/App/Plugin/Term.pm lib/MooseX/App/Plugin/Term/Meta/Attribute.pm lib/MooseX/App/Plugin/Term/Meta/Class.pm lib/MooseX/App/Plugin/Typo.pm lib/MooseX/App/Plugin/Typo/Meta/Class.pm lib/MooseX/App/Plugin/Version.pm lib/MooseX/App/Plugin/Version/Command.pm lib/MooseX/App/Plugin/Version/Meta/Class.pm lib/MooseX/App/Role.pm lib/MooseX/App/Role/Base.pm lib/MooseX/App/Role/Common.pm lib/MooseX/App/Simple.pm lib/MooseX/App/Tutorial.pod lib/MooseX/App/Utils.pm lib/MooseX/App/WritingPlugins.pod meta/argv.pl t/00_load.t t/01_basic.t t/02_meta.t t/03_utils.t t/04_plugin_config.t t/05_extended.t t/06_env.t t/07_single.t t/08_plugin_various.t t/09_classes.t t/10_plugin_mutexgroup.t t/11_process.t t/12_plugin_depends.t t/13_rt_112156.t t/14_gh_45.t t/15_subcommands.t t/16_rt122946.t t/config.pl t/example/test01.pl t/example/test02.pl t/example/test03.pl t/example/test04.pl t/example/test05.pl t/example/test06.pl t/example/test07.pl t/example/test08.pl t/example/test_synopsis.pl t/testlib/Test01.pm t/testlib/Test01/CommandA.pm t/testlib/Test01/CommandB.pm t/testlib/Test01/CommandC1.pm t/testlib/Test01/CommandD.pm t/testlib/Test02.pm t/testlib/Test02/Command/Error.pm t/testlib/Test02/Command/Record.pm t/testlib/Test02/Command/Required.pm t/testlib/Test02/MoreCommands/Test.pm t/testlib/Test03.pm t/testlib/Test03/AnotherCommand.pm t/testlib/Test03/BrokenCommand.pm t/testlib/Test03/DifferentCommand.pm t/testlib/Test03/ExtraCommand.pm t/testlib/Test03/Role/TestRole.pm t/testlib/Test03/SomeCommand.pm t/testlib/Test03/YetAnotherCommand.pm t/testlib/Test03CommandBase.pm t/testlib/Test04.pm t/testlib/Test04Base.pm t/testlib/Test05.pm t/testlib/Test06.pm t/testlib/Test06/CommandA.pm t/testlib/Test06/CommandB.pm t/testlib/Test06/CommandD.pm t/testlib/Test07.pm t/testlib/Test08.pm xt/perlcritic.t xt/pod.t xt/podcoverage.t xt/podstyle.t README.md100644000765000024 4242614514737355 14051 0ustar00mkostaff000000000000MooseX-App-1.43# NAME MooseX::App - Write user-friendly command line apps with even less suffering # SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Color); option 'global_option' => ( is => 'rw', isa => 'Bool', documentation => q[Enable this to do fancy stuff], ); # Global option has 'private' => ( is => 'rw', ); # not exposed Write multiple command classes (If you have only a single command class you should use [MooseX::App::Simple](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ASimple) instead). Packackes in the namespace may be deeply nested. package MyApp::SomeCommand; use MooseX::App::Command; # important (also imports Moose) extends qw(MyApp); # optional, only if you want to use global options from base class # Positional parameter parameter 'some_parameter' => ( is => 'rw', isa => 'Str', required => 1, documentation => q[Some parameter that you need to supply], ); option 'some_option' => ( is => 'rw', isa => 'Int', required => 1, documentation => q[Very important option!], ); # Option sub run { my ($self) = @_; # Do something } And then you need a simple wrapper script (called eg. myapp): #!/usr/bin/env perl use MyApp; MyApp->new_with_command->run; On the command line: bash$ myapp help usage: myapp [long options...] myapp help global options: --global_option Enable this to do fancy stuff [Flag] --help --usage -? Prints this usage information. [Flag] available commands: some_command Description of some command another_command Description of another command help Prints this usage information or bash$ myapp some_command --help usage: myapp some_command [long options...] myapp help myapp some_command --help parameters: some_parameter Some parameter that you need to supply [Required] options: --global_option Enable this to do fancy stuff [Flag] --some_option Very important option! [Int,Required] --help --usage -? Prints this usage information. [Flag] # DESCRIPTION MooseX-App is a highly customisable helper to write user-friendly command line applications without having to worry about most of the annoying things usually involved. Just take any existing [Moose](https://metacpan.org/pod/Moose) class, add a single line (`use MooseX-App qw(PluginA PluginB ...);`) and create one class for each command in an underlying namespace. Options and positional parameters can be defined as simple [Moose](https://metacpan.org/pod/Moose) accessors using the `option` and `parameter` keywords respectively. MooseX-App will then - Find, load and initialise the command classes (see [MooseX::App::Simple](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ASimple) for single class/command applications) - Create automated help and documentation from modules POD as well as attributes metadata and type constraints - Read, encode and validate the command line options and positional parameters entered by the user from @ARGV and %ENV (and possibly prompt the user for additional parameters see [MooseX::App::Plugin::Term](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3ATerm)) - Provide helpful error messages if user input cannot be validated (either missing or wrong attributes or Moose type constraints not satisfied) or if the user requests help. Commandline options are defined using the 'option' keyword which accepts the same attributes as Moose' 'has' keyword. option 'some_option' => ( is => 'rw', isa => 'Str', ); This is equivalent to has 'some_option' => ( is => 'rw', isa => 'Str', traits => ['AppOption'], # Load extra metaclass cmd_type => 'option', # Set attribute type ); Single letter options are treated as flags and may be combined with each other. However such options must have a Boolean type constraint. option 'verbose' => ( is => 'rw', isa => 'Bool', cmd_flag => 'v', ); Positional parameters are defined with the 'parameter' keyword parameter 'some_option' => ( is => 'rw', isa => 'Str', ); This is equivalent to has 'some_option' => ( is => 'rw', isa => 'Str', traits => ['AppOption'], cmd_type => 'parameter', ); All keywords are imported by [Moosex::App](https://metacpan.org/pod/Moosex%3A%3AApp) (in the app base class) and [MooseX::App::Command](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ACommand) (in the command class) or [MooseX::App::Simple](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ASimple) (single class application). Furthermore, all options and parameters can also be supplied via %ENV option 'some_option' => ( is => 'rw', isa => 'Str', cmd_env => 'SOME_OPTION', # sets the env key ); Moose type constraints help MooseX::App to construct helpful error messages and parse @ARGV in a meaningful way. The following type constraints are supported: - ArrayRef: Specify multiple values ('--opt value1 --opt value2', also see [app\_permute](https://metacpan.org/pod/app_permute) and [cmd\_split](https://metacpan.org/pod/cmd_split)) - HashRef: Specify multiple key value pairs ('--opt key=value --opt key2=value2', also see [app\_permute](https://metacpan.org/pod/app_permute)) - Enum: Display all possibilities - Bool: Flags that do not require values - Int, Num: Used for proper error messages Read the [Tutorial](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ATutorial) for getting started with a simple MooseX::App command line application. # METHODS ## new\_with\_command my $myapp_command = MyApp->new_with_command(); This constructor reads the command line arguments and tries to create a command class instance. If it fails it returns a [MooseX::App::Message::Envelope](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3AMessage%3A%3AEnvelope) object holding an error message. You can pass a hash of default/fallback params to new\_with\_command my $obj = MyApp->new_with_command(%default); Optionally you can pass a custom ARGV to this constructor my $obj = MyApp->new_with_command( ARGV => \@myARGV ); However, if you do so you must take care of propper @ARGV encoding yourself. ## initialize\_command\_class my $obj = MyApp->initialize_command_class($command_name,%default); Helper method to instantiate the command class for the given command. # GLOBAL OPTIONS These options may be used to alter the default behaviour of MooseX-App. ## app\_base app_base 'my_script'; # Defaults to $0 Usually MooseX::App will take the name of the calling wrapper script to construct the program name in various help messages. This name can be changed via the app\_base function. ## app\_fuzzy app_fuzzy 1; # default OR app_fuzzy 0; Enables fuzzy matching of commands and attributes. Is turned on by default. ## app\_strict app_strict 0; # default OR app_strict 1; If strict is enabled the program will terminate with an error message if superfluous/unknown positional parameters are supplied. If disabled all extra parameters will be copied to the [extra\_argv](https://metacpan.org/pod/extra_argv) attribute. Unknown options (with leading dashes) will always yield an error message. The command\_strict config in the command classes allows one to set this option individually for each command in the respective command class. ## app\_prefer\_commandline app_prefer_commandline 0; # default or app_prefer_commandline 1; Specifies if parameters/options supplied via @ARGV,%ENV should take precedence over arguments passed directly to new\_with\_command. ## app\_namespace app_namespace 'MyApp::Commands', 'YourApp::MoreCommands'; OR app_namespace(); Usually MooseX::App will take the package name of the base class as the namespace for commands. This namespace can be changed and you can add multiple extra namespaces. If app\_namespace is called with no arguments then autoloading of command classes will be disabled entirely. ## app\_exclude app_exclude 'MyApp::Commands::Roles','MyApp::Commands::Utils'; A sub namespace included via [app\_namespace](https://metacpan.org/pod/app_namespace) (or the default behaviour) can be excluded using app\_exclude. ## app\_command\_name app_command_name { my ($package_short,$package_full) = @_; # munge package name; return $command_name; }; This coderef can be used to control how autoloaded package names should be translated to command names. If this command returns nothing the respective command class will be skipped and not loaded. ## app\_command\_register app_command_register do => 'MyApp::Commands::DoSomething', undo => 'MyApp::Commands::UndoSomething'; This keyword can be used to register additional commands. Especially useful in conjunction with [app\_namespace](https://metacpan.org/pod/app_namespace) and disabled autoloading. ## app\_description app_description qq[Description text]; Set the app description text. If not set this information will be taken from the Pod DESCRIPTION or OVERVIEW sections. (see command\_description to set usage per command) ## app\_usage app_usage qq[myapp --option ...]; Set a custom usage text. If not set this will be taken from the Pod SYNOPSIS or USAGE section. If both sections are not available, the usage information will be autogenerated. (see command\_usage to set usage per command) ## app\_permute app_permute 0; # default OR app_permute 1; Allows one to specify multiple values with one key. So instead of writing `--list element1 --list element2 --list element3` one might write `--list element1 element2 element3` for ArrayRef elements. HashRef elements may be expressed as `--hash key=value key2=value2`. # GLOBAL ATTRIBUTES All MooseX::App classes will have two extra attributes ## extra\_argv Carries all parameters from @ARGV that were not consumed (only if app\_strict is turned off, otherwise superfluous parameters will raise an exception). ## help\_flag Help flag that is set when help was requested. # ATTRIBUTE OPTIONS Options and parameters accept extra attributes for customisation: - cmd\_tags - Extra tags (as used by the help) - cmd\_flag - Override option/parameter name - cmd\_aliases - Additional option/parameter name aliases - cmd\_split - Split values into ArrayRefs on this token or RegEx - cmd\_position - Specify option/parameter order in help - cmd\_env - Read options/parameters from %ENV - cmd\_count - Value of option equals to number of occurrences in @ARGV - cmd\_negate - Adds an option to negate boolean flags Refer to [MooseX::App::Meta::Role::Attribute::Option](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3AMeta%3A%3ARole%3A%3AAttribute%3A%3AOption) for detailed documentation. # METADATA MooseX::App will use your class metadata and POD to construct the commands and helpful error- or usage-messages. These bits of information are utilised and should be provided if possible: - Package names - [required](https://metacpan.org/pod/Moose#required----1-0) options for Moose attributes - [documentation](https://metacpan.org/pod/Moose#documentation-string) options for Moose attributes - Moose type constraints (Bool, ArrayRef, HashRef, Int, Num, and Enum) - Documentation set via app\_description, app\_usage, command\_short\_description, command\_long\_description and command\_usage - POD (NAME, ABSTRACT, DESCRIPTION, USAGE, SYNOPSIS, OVERVIEW, COPYRIGHT, LICENSE, COPYRIGHT AND LICENSE, AUTHOR and AUTHORS sections) - [Dist::Zilla](https://metacpan.org/pod/Dist%3A%3AZilla) ABSTRACT tag if no POD is available yet # PLUGINS The behaviour of MooseX-App can be customised with plugins. To load a plugin just pass a list of plugin names after the `use MooseX-App` statement. (Attention: order sometimes matters) use MooseX::App qw(PluginA PluginB); Currently the following plugins are shipped with MooseX::App - [MooseX::App::Plugin::BashCompletion](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3ABashCompletion) Adds a command that generates a bash completion script for your application. See third party [MooseX::App::Plugin::ZshCompletion](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AZshCompletion) for Z shell completion. - [MooseX::App::Plugin::Color](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AColor) Colorful output for your MooseX::App applications. - [MooseX::App::Plugin::Config](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AConfig) Config files for MooseX::App applications. - [MooseX::App::Plugin::ConfigHome](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AConfigHome) Try to find config files in users home directory. - [MooseX::App::Plugin::Term](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3ATerm) Prompt user for options and parameters that were not provided via options or params. Prompt offers basic editing capabilities and non-persistent history. - [MooseX::App::Plugin::Typo](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3ATypo) Handle typos in command names and provide suggestions. - [MooseX::App::Plugin::Version](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AVersion) Adds a command to display the version and license of your application. - [MooseX::App::Plugin::Man](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AMan) Display full manpage of application and commands. - [MooseX::App::Plugin::MutexGroup](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3AMutexGroup) Allow for mutally exclusive options. - [MooseX::App::Plugin::Depends](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3APlugin%3A%3ADepends) Adds dependent options. Refer to [Writing MooseX-App Plugins](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3AWritingPlugins) for documentation on how to create your own plugins. # DEVELOPMENT Make sure to invoke your script with APP\_DEVELOPER=1 ser during development. This will come with a starup penalty but perform additional checks for detecting wrong attribute/type constraint combinations, name clashes, ... # CAVEATS & KNOWN BUGS Startup time may be an issue - escpecially if you load many plugins. If you do not require the functionality of plugins and ability for fine grained customisation (or Moose for that matter) then you should probably use [MooX::Options](https://metacpan.org/pod/MooX%3A%3AOptions) or [MooX::Cmd](https://metacpan.org/pod/MooX%3A%3ACmd). In some cases - especially when using non-standard class inheritance - you may end up with command classes lacking the help attribute. In this case you need to include the following line in your base class or command classes. with qw(MooseX::App::Role::Common); When manually registering command classes (eg. via app\_command\_register) in multiple base classes with different sets of plugins (why would you ever want to do that?), then meta attributes may lack some attribute metaclasses. In this case you need to load the missing attribute traits explicitly: option 'argument' => ( depends => 'otherargument', trait => ['MooseX::App::Plugin::Depends::Meta::Attribute'], # load trait ); # SEE ALSO Read the [Tutorial](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ATutorial) for getting started with a simple MooseX::App command line application. For alternatives you can check out [MooseX::App::Cmd](https://metacpan.org/pod/MooseX%3A%3AApp%3A%3ACmd), [MooseX::Getopt](https://metacpan.org/pod/MooseX%3A%3AGetopt), [MooX::Options](https://metacpan.org/pod/MooX%3A%3AOptions), [MooX::Cmd](https://metacpan.org/pod/MooX%3A%3ACmd) and [App::Cmd](https://metacpan.org/pod/App%3A%3ACmd) # SUPPORT Please report any bugs or feature requests via [https://github.com/maros/MooseX-App/issues/new](https://github.com/maros/MooseX-App/issues/new). I will be notified, and then you'll automatically be notified of progress on your report as I make changes. # AUTHOR Maroš Kollár CPAN ID: MAROS maros [at] k-1.com http://www.k-1.com # CONTRIBUTORS Special thanks to all contributors. In no particular order: Andrew Jones, George Hartzell, Steve Nolte, Michael G, Thomas Klausner, Yanick Champoux, Edward Baudrez, David Golden, J.R. Mash, Thilo Fester, Gregor Herrmann, Sergey Romanov, Sawyer X, Roman F., Hunter McMillen, Maik Hentsche, Alexander Stoddard, Marc Logghe, Tina Müller, Lisa Hare, Jose Luis Martinez, Frank Schreiner, Bernhard M. Wiedemann You are more than welcome to contribute to MooseX-App. Please have a look at the [https://github.com/maros/MooseX-App/issues?q=is%3Aissue+is%3Aopen+label%3AWishlist](https://github.com/maros/MooseX-App/issues?q=is%3Aissue+is%3Aopen+label%3AWishlist) list of open wishlist issues for ideas. # COPYRIGHT MooseX::App is Copyright (c) 2012-21 Maroš Kollár. This library is free software and may be distributed under the same terms as perl itself. The full text of the licence can be found in the LICENCE file included with this module. META.json100644000765000024 545314514737355 14172 0ustar00mkostaff000000000000MooseX-App-1.43{ "abstract" : "Write user-friendly command line apps with even less suffering", "author" : [ "Maro\u0161 Koll\u00e1r " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.030, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "MooseX-App", "optional_features" : { "colour" : { "description" : "Colourful output", "prereqs" : { "runtime" : { "requires" : { "IO::Interactive" : "0", "Term::ANSIColor" : "0", "Win32::Console::ANSI" : "0" } } } }, "config" : { "description" : "Config plugins", "prereqs" : { "runtime" : { "requires" : { "File::HomeDir" : "0" } } } }, "term" : { "description" : "Term plugin", "prereqs" : { "runtime" : { "requires" : { "IO::Interactive" : "0", "Term::ANSIColor" : "0" } } } }, "typo" : { "description" : "Typo plugin", "prereqs" : { "runtime" : { "requires" : { "Text::WagnerFischer" : "0" } } } } }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "develop" : { "requires" : { "Test::Perl::Critic" : "0", "Test::Pod" : "1.14", "Test::Pod::Coverage" : "1.04" } }, "runtime" : { "requires" : { "Config::Any" : "0", "File::Basename" : "0", "File::Spec" : "0", "List::Util" : "1.44", "Module::Pluggable" : "0", "Moose" : "2.00", "Pod::Elemental" : "0", "namespace::autoclean" : "0", "perl" : "5.010" } }, "test" : { "requires" : { "Test::Most" : "0", "Test::NoWarnings" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/maros/MooseX-App/issues" }, "repository" : { "type" : "git", "url" : "git://github.com/maros/MooseX-App.git", "web" : "https://github.com/maros/MooseX-App" } }, "version" : "1.43", "x_generated_by_perl" : "v5.30.3", "x_serialization_backend" : "JSON::XS version 4.02", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } t000755000765000024 014514737355 12645 5ustar00mkostaff000000000000MooseX-App-1.4306_env.t100644000765000024 317014514737355 14270 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/06_plugin_env.t - Test env use Test::Most tests => 5+1; use Test::NoWarnings; use lib 't/testlib'; use Test01; subtest 'Command with argv' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --command_local1 11 --global 1)]); my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandA'); is($test01->command_local1,'11','Arg from command config'); }; subtest 'Command only with env' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --global 1)]); local $ENV{LOCAL1} = 12; my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandA'); is($test01->command_local1,'12','Arg from command env'); }; subtest 'Command with env and argv' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --command_local1 13 --global 1)]); local $ENV{LOCAL1} = 12; my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandA'); is($test01->command_local1,'13','Arg from command argv'); }; subtest 'Env not passing type constraint' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --global 1)]); local $ENV{LOCAL1} = 'aa'; my $test01 = Test01->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); is($test01->blocks->[0]->header,"Invalid environment value for 'LOCAL1'","Message ok"); }; subtest 'Coerce env value' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_d --global 1)]); local $ENV{LOCAL1} = 42; my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandD'); is_deeply($test01->command_local1,[42],'Arg coerced from command env'); };00_load.t100755000765000024 601614514737355 14416 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/00_load.t - check module loading and create testing directory use Test::Most tests => 43; use_ok( 'MooseX::App' ); use_ok( 'MooseX::App::ParsedArgv' ); use_ok( 'MooseX::App::Command' ); #use_ok( 'MooseX::App::Role' ); # cannot test since it can only be loaded into a Moose::Role use_ok( 'MooseX::App::Utils' ); use_ok( 'MooseX::App::Message::Block' ); use_ok( 'MooseX::App::Message::Envelope' ); use_ok( 'MooseX::App::Meta::Role::Attribute::Option' ); use_ok( 'MooseX::App::Meta::Role::Class::Base' ); use_ok( 'MooseX::App::Meta::Role::Class::Command' ); use_ok( 'MooseX::App::Meta::Role::Class::Simple' ); use_ok( 'MooseX::App::Meta::Role::Class::Documentation'); use_ok( 'MooseX::App::Plugin::BashCompletion' ); use_ok( 'MooseX::App::Plugin::BashCompletion::Command'); use_ok( 'MooseX::App::Plugin::BashCompletion::Meta::Class'); use_ok( 'MooseX::App::Plugin::Config' ); use_ok( 'MooseX::App::Plugin::Config::Meta::Class'); use_ok( 'MooseX::App::Plugin::Version' ); use_ok( 'MooseX::App::Plugin::Version::Command'); use_ok( 'MooseX::App::Plugin::Version::Meta::Class'); use_ok( 'MooseX::App::Plugin::Man' ); use_ok( 'MooseX::App::Plugin::Man::Command'); use_ok( 'MooseX::App::Plugin::Man::Meta::Class'); use_ok( 'MooseX::App::Plugin::Depends' ); use_ok( 'MooseX::App::Plugin::Depends::Meta::Attribute'); use_ok( 'MooseX::App::Plugin::Depends::Meta::Class'); use_ok( 'MooseX::App::Plugin::MutexGroup' ); use_ok( 'MooseX::App::Plugin::MutexGroup::Meta::Attribute'); use_ok( 'MooseX::App::Plugin::MutexGroup::Meta::Class'); use_ok( 'MooseX::App::Utils'); use_ok( 'MooseX::App::Simple'); use_ok( 'MooseX::App::Exporter'); use_ok( 'MooseX::App::Role::Base'); use_ok( 'MooseX::App::Role::Common'); SKIP :{ my $ok = eval { Class::Load::load_class('Term::ReadKey'); Class::Load::load_class('IO::Interactive'); use_ok( 'MooseX::App::Plugin::Term' ); use_ok( 'MooseX::App::Plugin::Term::Meta::Class'); use_ok( 'MooseX::App::Plugin::Term::Meta::Attribute'); }; unless ($ok) { skip "Term::ReadKey and/or IO::Interactive are not installed",3; } } SKIP :{ my $ok = eval { Class::Load::load_class('Term::ANSIColor'); Class::Load::load_class('IO::Interactive'); use_ok( 'MooseX::App::Plugin::Color' ); use_ok( 'MooseX::App::Message::BlockColor' ); use_ok( 'MooseX::App::Plugin::Color::Meta::Class'); }; unless ($ok) { skip "Term::ANSIColor and/or IO::Interactive are not installed",3; } } SKIP :{ my $ok = eval { Class::Load::load_class('File::HomeDir'); use_ok( 'MooseX::App::Plugin::ConfigHome' ); use_ok( 'MooseX::App::Plugin::ConfigHome::Meta::Class'); }; unless ($ok) { skip "File::HomeDir is not installed",2; } } SKIP :{ my $ok = eval { Class::Load::load_class('Text::WagnerFischer'); use_ok( 'MooseX::App::Plugin::Typo' ); use_ok( 'MooseX::App::Plugin::Typo::Meta::Class'); }; unless ($ok) { skip "Text::WagnerFischer is not installed",2; } }02_meta.t100644000765000024 624014514737355 14423 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/02_meta.t - MOP tests use Test::Most tests => 28+1; use Test::NoWarnings; use lib 't/testlib'; use Test01; my $meta = Test01->meta; my $commands = $meta->app_commands; is(join(',',sort keys %{$commands}),'command_a,command_b,command_c1,command_d','Commands found'); is(join(',',sort values %{$commands}),'Test01::CommandA,Test01::CommandB,Test01::CommandC1,Test01::CommandD','Commands found'); cmp_deeply($meta->app_namespace,[qw(Test01)],'Command namespace ok'); is($meta->app_base,'02_meta.t','Command base ok'); is($meta->app_messageclass,'MooseX::App::Message::Block','Message class'); ok(Test01->can('new_with_command'),'Role applied to base class'); ok(Test01->can('initialize_command_class'),'Role applied to base class'); is(scalar keys %{$commands},4,'Found three commands'); is($commands->{command_a},'Test01::CommandA','Command A found'); is($meta->command_find('COMMAND_a'),'command_a','Command A matched'); cmp_deeply($meta->command_candidates('COmmand'),['command_a','command_b','command_c1','command_d'],'Command A,B,C1 and D matched'); cmp_deeply($meta->command_candidates('command_C'),['command_c1'],'Command C1 matched fuzzy'); is($meta->command_candidates('command_c1'),'command_c1','Command C1 matched exactly'); my @attributes = $meta->command_usage_attributes; is(scalar(@attributes),3,'Has three attributes'); is($attributes[0]->cmd_usage_name,'--global','Usage name ok'); is($attributes[0]->cmd_usage_description,'test [Required; Integer; Important!]','Usage description ok'); is($attributes[1]->cmd_usage_name,'--config','Usage name ok'); is($attributes[2]->cmd_usage_name,'--help -h --usage -?','Usage name ok'); is($attributes[2]->cmd_usage_description,'Prints this usage information. [Flag]','Usage description ok'); my $meta_attribute = $meta->find_attribute_by_name('global'); is(join(',',$meta_attribute->cmd_tags_list($meta_attribute)),'Required,Integer,Important!','Tags ok'); $meta_attribute->cmd_tags(['Use with care']); is(join(',',$meta_attribute->cmd_tags_list()),'Required,Integer,Use with care','Changed tags ok'); require Test01::CommandA; my $description = $meta->command_usage_description(Test01::CommandA->meta); isa_ok($description,'MooseX::App::Message::Block'); like($description->body,qr/varius nec iaculis vitae/,'Description body ok'); require Test01::CommandB; is(Test01::CommandB->meta->command_short_description,'Test class command B for test 01','Pod short description parsed ok'); is(Test01::CommandB->meta->command_long_description,'Some description of *command B* some code some code SUB HEADLINE some more desc * item 1 * item 2 * item 2.1 * item 2.2 hase ist so super and this is a very long sentence witch breaks after i have written some bla bla. another interesting paragraph.','Pod long description parsed ok'); require Test01::CommandC1; is(Test01::CommandB->meta->command_usage,'use with care','Command usage parsed ok'); is(Test01::CommandC1->meta->find_attribute_by_name('param_internal_name')->cmd_name_primary,'external_name','Attribute name ok'); is(join(',',Test01::CommandB->meta->find_attribute_by_name('param_b')->cmd_tags_list),'Required,Possible values: aaa, bbb, ccc, ddd, eee, fff','Check attributes tags');config.pl100644000765000024 23214514737355 14564 0ustar00mkostaff000000000000MooseX-App-1.43/t{ global => { global => 123, }, command_a => { global => 234, command_local1 => 22, }, }Makefile.PL100644000765000024 272414514737355 14521 0ustar00mkostaff000000000000MooseX-App-1.43# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.030. use strict; use warnings; use 5.010; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Write user-friendly command line apps with even less suffering", "AUTHOR" => "Maro\x{161} Koll\x{e1}r ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "MooseX-App", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.010", "NAME" => "MooseX::App", "PREREQ_PM" => { "Config::Any" => 0, "File::Basename" => 0, "File::Spec" => 0, "List::Util" => "1.44", "Module::Pluggable" => 0, "Moose" => "2.00", "Pod::Elemental" => 0, "namespace::autoclean" => 0 }, "TEST_REQUIRES" => { "Test::Most" => 0, "Test::NoWarnings" => 0 }, "VERSION" => "1.43", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Config::Any" => 0, "File::Basename" => 0, "File::Spec" => 0, "List::Util" => "1.44", "Module::Pluggable" => 0, "Moose" => "2.00", "Pod::Elemental" => 0, "Test::Most" => 0, "Test::NoWarnings" => 0, "namespace::autoclean" => 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); meta000755000765000024 014514737355 13330 5ustar00mkostaff000000000000MooseX-App-1.43argv.pl100755000765000024 40614514737355 14747 0ustar00mkostaff000000000000MooseX-App-1.43/meta#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib ("$FindBin::Bin/../lib"); use MooseX::App::ParsedArgv; use Data::Dumper; my $inst = MooseX::App::ParsedArgv->instance(); say Dumper($inst); $inst->options; say Dumper($inst); 01_basic.t100755000765000024 1336114514737355 14602 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/01_basic.t - Basic tests use Test::Most tests => 12+1; use Test::NoWarnings; use FindBin qw(); use lib 't/testlib'; use Test01; subtest 'Excact command with option' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --global 10)]); my $test01 = Test01->new_with_command(); isa_ok($test01,'Test01::CommandA'); is($test01->global,10,'Param is set'); }; subtest 'Fuzzy command with option' => sub { my $test02 = Test01->new_with_command( ARGV => [qw(Command_A --globa 11)]); isa_ok($test02,'Test01::CommandA'); is($test02->global,11,'Param is set'); }; subtest 'Wrong command' => sub { MooseX::App::ParsedArgv->new(argv => [qw(xxxx --global 10)]); my $test03 = Test01->new_with_command; isa_ok($test03,'MooseX::App::Message::Envelope'); is($test03->blocks->[0]->header,"Unknown command 'xxxx'",'Message is set'); is($test03->blocks->[0]->type,"error",'Message is of type error'); is($test03->blocks->[1]->header,"usage:",'Usage set'); is($test03->blocks->[1]->body," 01_basic.t [long options...] 01_basic.t help 01_basic.t --help",'Usage body set'); is($test03->blocks->[3]->header,"global options:",'Global options set'); is($test03->blocks->[3]->body," --global test [Required; Integer; Important!] --config Path to command config file --help -h --usage -? Prints this usage information. [Flag]",'Global options body set'); is($test03->blocks->[4]->header,"available commands:",'Available commands set'); is($test03->blocks->[4]->body," command_a Command A! command_b Test class command B for test 01 command_c1 Test C1 command_d Command A! help Prints this usage information",'Available commands body set'); }; subtest 'Help for command' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --help)]); my $test04 = Test01->new_with_command; isa_ok($test04,'MooseX::App::Message::Envelope'); is($test04->blocks->[0]->header,"usage:",'Usage is set'); is($test04->blocks->[0]->body," 01_basic.t command_a [long options...] 01_basic.t help 01_basic.t command_a --help",'Usage body set'); is($test04->blocks->[1]->header,"description:",'Description is set'); is($test04->blocks->[1]->body," Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras dui velit, varius nec iaculis vitae, elementum eget mi. * bullet1 * bullet2 * bullet3 Cras eget mi nisi. In hac habitasse platea dictumst.",'Description body set'); is($test04->blocks->[2]->header,"options:",'Options header is set'); is($test04->blocks->[2]->body," --global test [Required; Integer; Important!] --command_local1 some docs about the long texts that seem to occur randomly [Integer; Env: LOCAL1; Important] --command_local2 Verylongwordwithoutwhitespacestotestiftextformating worksproperly [Env: LOCAL2] --config Path to command config file --help -h --usage -? Prints this usage information. [Flag]",'Options body is set'); }; subtest 'With extra args' => sub { MooseX::App::ParsedArgv->new(argv => [qw(Command_b --global 10 --param_b aaa)]); my $test02 = Test01->new_with_command( 'param_b' => 'bbb', 'global' => 20, 'private'=>5 ); isa_ok($test02,'Test01::CommandB'); is($test02->global,20,'Param global is set'); is($test02->param_b,'bbb','Param param_b is set'); is($test02->private,5,'Param private is set'); }; subtest 'Wrapper script' => sub { my $output = `$^X $FindBin::Bin/example/test01.pl command_a --command_local2 test --global 10`; is($output,'RUN COMMAND-A:test','Output is ok'); }; subtest 'Custom help text' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_b --help)]); my $test06 = Test01->new_with_command; isa_ok($test06,'MooseX::App::Message::Envelope'); is($test06->blocks->[0]->header,"usage:",'Usage is set'); is($test06->blocks->[0]->body," use with care",'Usage is ok'); is($test06->blocks->[1]->header,"description:",'description is set'); like($test06->blocks->[1]->body,qr/ Some description of \*command B\*/,'Description is ok'); }; subtest 'Input errors missing' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --command_local1)]); my $test07 = Test01->new_with_command; isa_ok($test07,'MooseX::App::Message::Envelope'); is($test07->blocks->[0]->header,"Missing value for 'command_local1'",'Error message ok'); }; subtest 'Input errors type' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --command_local1 sss)]); my $test08 = Test01->new_with_command; isa_ok($test08,'MooseX::App::Message::Envelope'); is($test08->blocks->[0]->header,"Invalid value for 'command_local1'",'Error message ok'); is($test08->blocks->[0]->body,"Value must be an integer (not 'sss')",'Error message ok'); }; subtest 'Global help requested' => sub { MooseX::App::ParsedArgv->new(argv => [qw(help)]); my $test09 = Test01->new_with_command; isa_ok($test09,'MooseX::App::Message::Envelope'); like($test09->blocks->[0]->body,qr/ 01_basic\.t \[long options\.\.\.\]/,'Help message ok'); }; subtest 'Missing command' => sub { MooseX::App::ParsedArgv->new(argv => []); my $test10 = Test01->new_with_command; isa_ok($test10,'MooseX::App::Message::Envelope'); is($test10->blocks->[0]->header,'Missing command','Error message ok'); }; subtest 'Extra params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a something else)]); my $test11 = Test01->new_with_command; isa_ok($test11,'MooseX::App::Message::Envelope'); is($test11->blocks->[0]->header,"Unknown parameter 'else'",'Error message ok'); }; 03_utils.t100755000765000024 756114514737355 14650 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/03_utils.t use Test::Most tests => 4+1; use Test::NoWarnings; use MooseX::App::Utils; use MooseX::App::ParsedArgv; subtest 'Class to command' => sub { is(MooseX::App::Utils::class_to_command('Command'),'command','Command ok'); is(MooseX::App::Utils::class_to_command('CommandSuper'),'command_super','Command ok'); is(MooseX::App::Utils::class_to_command('CommandBA'),'command_ba','Command ok'); is(MooseX::App::Utils::class_to_command('CommandBA12'),'command_ba12','Command ok'); is(MooseX::App::Utils::class_to_command('CommandBALow'),'command_ba_low','Command ok'); }; subtest 'Format text' => sub { is( MooseX::App::Utils::format_text('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae lectus purus, quis dapibus orci. Proin mollis est in nisl congue vel ornare felis imperdiet.'), ' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae lectus purus, quis dapibus orci. Proin mollis est in nisl congue vel ornare felis imperdiet.', 'Format text ok'); is( MooseX::App::Utils::format_text('Loremipsumdolorsitamet,consecteturadipiscingelit.Namegetarcunecdolorbibendumblanditsitametnonipsum.'), ' Loremipsumdolorsitamet,consecteturadipiscingelit. Namegetarcunecdolorbibendumblanditsitametnonipsum.', 'Format text ok'); is( MooseX::App::Utils::format_text('LoremipsumdolorsitametconsecteturadipiscingelitNamegetarcunecdolorbibendumblanditsitametnonipsum.'), ' LoremipsumdolorsitametconsecteturadipiscingelitNamegetarcunecdolorbibendum blanditsitametnonipsum.', 'Format text ok'); }; subtest 'Formater' => sub { my $list = MooseX::App::Utils::format_list( ['part1','Lorem ipsum dolor sit amet, consectetur adipiscing elit. vitae lectus purus, quis dapibus orci.'], ['part2_something','Lorem ipsum dolor sit amet, consectetur adipiscing elit.'], ['part3',''], ); is( $list, ' part1 Lorem ipsum dolor sit amet, consectetur adipiscing elit. vitae lectus purus, quis dapibus orci. part2_something Lorem ipsum dolor sit amet, consectetur adipiscing elit. part3 ', 'Format list ok' ); }; subtest 'Parser' => sub { my $parser = MooseX::App::ParsedArgv->new({ argv => ['hello','--bool','mellow','-hui','--help','--help','--test','1','baer','--test','2','--xxx','x1','x2','--key=value1','--key=value2','-u','--','hase','--luchs'], hints_novalue => ['bool'], hints_permute => ['xxx'], }); is(scalar(@{$parser->elements}),13,'Has 13 elements'); is($parser->elements->[0]->key,'hello','Parameter parsed ok'); is($parser->elements->[0]->type,'parameter','Parameter type ok'); is($parser->elements->[1]->key,'bool','Flag parsed ok'); is($parser->elements->[1]->type,'option','Flag type ok'); is($parser->elements->[2]->key,'mellow','Parameter parsed ok'); is($parser->elements->[3]->key,'h','Flag parsed ok'); is($parser->elements->[4]->key,'u','Flag parsed ok'); is($parser->elements->[5]->key,'i','Flag parsed ok'); is($parser->elements->[6]->key,'help','Flag parsed ok'); is($parser->elements->[7]->key,'test','Option parsed ok'); cmp_deeply([$parser->elements->[7]->all_scalar_values],[1,2], 'Option value ok'); is($parser->elements->[8]->key,'baer','Parameter parsed ok'); is($parser->elements->[9]->key,'xxx','Parameter parsed ok'); cmp_deeply([$parser->elements->[9]->all_scalar_values],['x1','x2'],'Option value ok'); is($parser->elements->[10]->key,'key','Option parsed ok'); is($parser->elements->[10]->key,'key','Extra parsed ok'); cmp_deeply([$parser->elements->[10]->all_scalar_values],['value1','value2'],'Option value ok'); is($parser->elements->[11]->key,'hase','Extra parsed ok'); is($parser->elements->[12]->key,'--luchs','Extra parsed ok'); }; 14_gh_45.t100644000765000024 341214514737355 14404 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/14_gh_45.t - Boolean negation use Test::Most tests => 3+1; use Test::NoWarnings; use lib 't/testlib'; { package Test14; use MooseX::App::Simple; option 'b1' => ( is => 'rw', isa => 'Bool', cmd_negate => ['not-b1'] ); option 'not_b1' => ( is => 'rw', isa => 'Bool', ); option 'b2yes' => ( is => 'rw', isa => 'Bool', cmd_negate => ['no_b2','unb2'] ); sub run { my ($self) = @_; return "ok"; } } subtest 'boolean negation' => sub { plan tests => 4; Test14->meta->app_fuzzy(0); { MooseX::App::ParsedArgv->new(argv => [qw(--not-b1 --not_b1 --b2yes)]); my $test01 = Test14->new_with_options(); isa_ok($test01,'Test14'); is($test01->b1,0,'Did not set b1'); is($test01->not_b1,1,'Did set not_b1'); is($test01->b2yes,1,'Did set b2'); } }; subtest 'boolean fuzzy negation' => sub { plan tests => 4; Test14->meta->app_fuzzy(1); { MooseX::App::ParsedArgv->new(argv => [qw(--not-b --not_b --b2)]); my $test01 = Test14->new_with_options(); isa_ok($test01,'Test14'); is($test01->b1,0,'Did not set b1'); is($test01->not_b1,1,'Did set not_b1'); is($test01->b2yes,1,'Did set b2'); } }; subtest 'ambiguous negation' => sub { plan tests => 3; Test14->meta->app_fuzzy(1); { MooseX::App::ParsedArgv->new(argv => [qw(--not-b1 --b1 --b2yes --no_b2 --unb2 --b2 --un)]); my $test01 = Test14->new_with_options(); isa_ok($test01,'Test14'); is($test01->b1,1,'Did set b1'); is($test01->b2yes,0,'Did not set b2'); } };07_single.t100644000765000024 201014514737355 14752 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/07_single.t- Test MooseX::App::Single use Test::Most tests => 3+1; use Test::NoWarnings; use lib 't/testlib'; use Test05; subtest 'Single command' => sub { MooseX::App::ParsedArgv->new(argv => [qw()]); my $test05 = Test05->new_with_options; isa_ok($test05,'MooseX::App::Message::Envelope'); is($test05->blocks->[0]->header,"Required option 'another_option' missing","Check for error message"); }; subtest 'Single command' => sub { MooseX::App::ParsedArgv->new(argv => [qw(--another_option 123)]); my $test05 = Test05->new_with_options({ some_option => 1 }); isa_ok($test05,'Test05'); is($test05->another_option,'123','Arg from command ARGV'); is($test05->some_option,1,'Arg from new_with_options'); }; subtest 'Single command help' => sub { MooseX::App::ParsedArgv->new(argv => [qw(--help)]); my $test05 = Test05->new_with_options(); isa_ok($test05,'MooseX::App::Message::Envelope'); is($test05->blocks->[0]->header,"usage:","Usage header is first"); }; podstyle.t100644000765000024 175514514737355 15235 0ustar00mkostaff000000000000MooseX-App-1.43/xt# -*- perl -*- use strict; use warnings; use Test::More; eval "use Pod::Simple::SimpleTree"; plan skip_all => 'Pod::Simple::SimpleTree required' if $@; eval "use Test::Pod"; plan skip_all => 'Test::Pod required' if $@; plan skip_all => 'set TEST_AUTHOR to enable this test' unless $ENV{TEST_AUTHOR}; my @files; foreach (all_pod_files()) { next if /Schema\//; next if /\.pl$/; push @files,$_; } my @required_heads=qw(NAME SYNOPSIS DESCRIPTION METHODS AUTHOR); plan tests => scalar @files * scalar @required_heads; foreach my $file (@files) { my $parser=Pod::Simple::SimpleTree->new; $parser->accept_targets('*'); my $root=$parser->parse_file($file)->root; shift(@$root);shift(@$root); my @heads; my %heads; foreach my $node (@$root) { next unless $node->[0] eq 'head1'; push(@heads,$node->[2]); $heads{$node->[2]}=1; } foreach my $heading (@required_heads) { ok($heads{$heading},"$file has $heading"); } } 09_classes.t100644000765000024 502714514737355 15143 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/09_classes.t - Test classes use Test::Most tests => 6+1; use Test::NoWarnings; use lib 't/testlib'; use Test04; use Test03; subtest 'Extend base class' => sub { MooseX::App::ParsedArgv->new(argv => [qw()]); my $test01 = Test04->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); like($test01->blocks->[2]->body,qr/--test1\s+\[Integer\]/,'--test1 included'); like($test01->blocks->[2]->body,qr/--test2\s+\[Flag\]/,'--test2 included'); unlike($test01->blocks->[2]->body,qr/--test3/,'--test3 not included'); }; subtest 'Wrong usage' => sub { throws_ok { Test03->new->new_with_command } qr/new_with_command is a class method/, 'Only callable as class method'; use Test03::SomeCommand; throws_ok { Test03::SomeCommand->new_with_command } qr/new_with_command may only be called from the application base package/, 'new_with_command may only be called from the application base package'; throws_ok { Test03->new_with_command(1,2,3) } qr/new_with_command got invalid extra arguments/, 'Wrong default args'; }; subtest 'Conflicts' => sub { MooseX::App::ParsedArgv->new(argv => [qw(broken --conflict a)]); throws_ok { Test03->new_with_command; } qr/Command line option conflict/, 'Conflict detected'; }; subtest 'Default args available with extra inheritance' => sub { MooseX::App::ParsedArgv->new(argv => [qw(yetanothercommand --help)]); my $another = Test03->new_with_command; isa_ok($another,'MooseX::App::Message::Envelope'); like($another->blocks->[0]->body,qr/test03\syetanothercommand/,'Help ok'); is($another->blocks->[0]->header,'usage:','Help ok'); MooseX::App::ParsedArgv->new(argv => [qw(yetanothercommand -ab --bool3)]); my $yetanother = Test03->new_with_command(private => 'test'); isa_ok($yetanother,'Test03::YetAnotherCommand'); is($yetanother->private,'test','Option has been passed on'); }; subtest 'Attributes from role' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand --roleattr a --another b)]); my $test03 = Test03->new_with_command(); isa_ok($test03,'Test03::SomeCommand'); is($test03->roleattr,'a','Attribute from role ok'); }; subtest 'Correct order from role ' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand a1 b2 ccc --another b)]); my $test03 = Test03->new_with_command; isa_ok($test03,'Test03::SomeCommand'); is($test03->param_c,'a1','First from role'); is($test03->param_a,'b2','Second from role'); is($test03->param_b,'ccc','Third from role'); }; 11_process.t100644000765000024 647214514737355 15162 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/11_process.t - Test via subprocesses use Test::Most tests => 1+1; use Test::NoWarnings; use FindBin qw(); use IPC::Open3 qw(open3); use Symbol qw(gensym); my $BASE = "$^X $FindBin::Bin/example"; subtest 'Test basic exit codes' => sub { SKIP: { skip "Cannot test on MSWin",7 if $^O =~ /^MSWin/; skip "Cannot test on *BSD",7 if $^O =~ /bsd$/; test_subprocess( bin => 'test02.pl', exit => 127, out => '', err => qr/Missing command/, ); test_subprocess( bin => 'test02.pl error', exit => 25, err => qr/XXX/, ); test_subprocess( bin => 'test02.pl version', exit => 0, out => qr/VERSION/, err => '', ); test_subprocess( bin => 'test02.pl version', exit => 0, out => qr/VERSION/, err => '', ); test_subprocess( bin => 'test02.pl record --help', exit => 0, out => qr/usage:/, err => '', ); test_subprocess( bin => 'test02.pl record', exit => 0, out => qr/RAN/, err => '', ); test_subprocess( bin => 'test02.pl record --notthere', exit => 1, out => '', err => qr/Unknown option 'notthere'/, ); } }; sub test_subprocess { my (%params) = @_; $params{args} ||= []; my($in_fh, $out_fh, $err_fh, $out, $err, $pid, $exit); eval { # Set timeout local $SIG{ALRM} = sub { die('timeout') }; alarm(3); $err_fh = gensym(); $pid = open3( $in_fh, $out_fh, $err_fh, $BASE.'/'.$params{bin}, ); if (defined $pid) { waitpid($pid,0); $pid = undef; $exit = $? >> 8; $out = ''; while(<$out_fh>) { $out .= $_; } $err = ''; while(<$err_fh>) { $err .= $_; } # Compare exitcode if (exists $params{exit}) { is($exit,$params{exit},'Exitcode '.$params{bin}.' ok'); } # Comare STDOUT if (exists $params{out}) { if (ref $params{out} eq 'Regexp') { like($out,$params{out},'Output '.$params{bin}.' ok'); } else { is($out,$params{out},'Output '.$params{bin}.' ok'); } } # Compare STDERR if (exists $params{err}) { if (ref $params{err} eq 'Regexp') { like($err,$params{err},'Error '.$params{bin}.' ok'); } else { is($err,$params{err},'Error '.$params{bin}.' ok'); } } } else { fail('Could not start process :'.$!); } }; alarm(0); kill 'KILL', $pid if defined $pid; if ($@ ) { # Kill pid if still there fail('Error running '.$params{bin}.' :'.($@ || 'unknown')); return; } return; }05_extended.t100755000765000024 3032414514737355 15323 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/05_extended.t - Extended tests use Test::Most tests => 29+1; use Test::NoWarnings; use FindBin qw(); use lib 't/testlib'; use Test03; Test03->meta->app_fuzzy(0); Test03->meta->app_strict(1); subtest 'Non-Fuzzy command matching' => sub { MooseX::App::ParsedArgv->new(argv => [qw(some --private 1)]); my $test01 = Test03->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); is($test01->blocks->[0]->header,"Unknown command 'some'","Message ok"); }; subtest 'Non-Fuzzy attribute matching' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand --private 1)]); my $test01 = Test03->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); is($test01->blocks->[0]->header,"Unknown option 'private'","Message ok"); }; Test03->meta->app_fuzzy(1); subtest 'Private option is not exposed' => sub { MooseX::App::ParsedArgv->new(argv => [qw(some --private 1)]); my $test01 = Test03->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); is($test01->blocks->[0]->header,"Unknown option 'private'","Message ok"); is($test01->blocks->[0]->type,"error",'Message is of type error'); }; subtest 'Options from role' => sub { MooseX::App::ParsedArgv->new(argv => [qw(some --another 10 --role 15)]); my $test02 = Test03->new_with_command; isa_ok($test02,'Test03::SomeCommand'); is($test02->another_option,'10','Param is set'); is($test02->roleattr,'15','Role param is set'); }; subtest 'Missing attribute value' => sub { MooseX::App::ParsedArgv->new(argv => [qw(some --another)]); my $test03 = Test03->new_with_command; isa_ok($test03,'MooseX::App::Message::Envelope'); is($test03->blocks->[0]->header,"Missing value for 'another'","Message ok"); is($test03->blocks->[0]->type,"error",'Message is of type error'); }; subtest 'All options available & no description' => sub { MooseX::App::ParsedArgv->new(argv => [qw(some --help)]); my $test04 = Test03->new_with_command; isa_ok($test04,'MooseX::App::Message::Envelope'); is($test04->blocks->[2]->header,'options:','No description'); is($test04->blocks->[2]->body," --global_option Enable this to do fancy stuff [Flag] --roleattr [Role] --some_option Very important option! --another [Required; Not important] --list [Multiple] --help -h --usage -? Prints this usage information. [Flag]","Message ok"); }; # Not working on cpan testers #subtest 'Test wrapper script encoding' => sub { # my $output = `LANG=en_US.UTF-8 $^X $FindBin::Bin/example/test03.pl some_command --another töst\\ möre --some_option "anöther täst"`; # is($output,'RUN:anöther täst:töst möre','Encoded output'); #} subtest 'Test type constraints integer' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --int 1a)]); my $test05 = Test03->new_with_command; isa_ok($test05,'MooseX::App::Message::Envelope'); is($test05->blocks->[0]->header,"Invalid value for 'integer'","Message ok"); }; subtest 'Test type constraints hash' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --hash xx)]); my $test06 = Test03->new_with_command; isa_ok($test06,'MooseX::App::Message::Envelope'); is($test06->blocks->[0]->header,"Invalid value for 'hash'","Message ok"); }; subtest 'Test type constraints number' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --number 2a)]); my $test07 = Test03->new_with_command; isa_ok($test07,'MooseX::App::Message::Envelope'); is($test07->blocks->[0]->header,"Invalid value for 'number'","Message ok"); }; subtest 'Test type constraints custom1' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --custom1 9)]); my $test08 = Test03->new_with_command; isa_ok($test08,'MooseX::App::Message::Envelope'); is($test08->blocks->[0]->header,"Invalid value for 'custom1'","Message ok"); }; subtest 'Test pass type constraints' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --hash key1=value1 --split a;b --split c --hash key2=value2 --integer 10 --number 10.10 --custom1 11 --custom2 test --extra1 wurtsch --count --count --cou)]); my $test09 = Test03->new_with_command; isa_ok($test09,'Test03::AnotherCommand'); is($test09->hash->{key1},"value1","Hash ok"); is($test09->hash->{key2},"value2","Hash ok"); is($test09->integer,10,"Integer ok"); is($test09->custom1,11,"Custom type 1 ok"); is(ref($test09->custom2),'SCALAR',"Custom type 2 ok"); is(${$test09->custom2},'test',"Custom type 2 ok"); is($test09->extra1,'wurtsch',"Attr set ok"); is($test09->count,3,"Count set ok"); cmp_deeply($test09->split,[qw(a b c)],'Split ok'); }; subtest 'Test ambiguous options' => sub { MooseX::App::ParsedArgv->new(argv => [qw(another --custom 1 --custom 2)]); my $test10 = Test03->new_with_command; isa_ok($test10,'MooseX::App::Message::Envelope'); is($test10->blocks->[0]->header,"Ambiguous option 'custom'","Message ok"); like($test10->blocks->[0]->body,qr/Could be custom1 custom2/,"Message ok"); }; subtest 'Test flags & defaults' => sub { MooseX::App::ParsedArgv->new(argv => [qw(yet --bool3)]); my $test11 = Test03->new_with_command; isa_ok($test11,'Test03::YetAnotherCommand'); is($test11->bool1,undef,'Bool1 flag is undef'); is($test11->bool2,1,'Bool2 flag is set'); is($test11->bool3,1,'Bool3 flag is set'); is($test11->value,'hase','Value is default'); }; subtest 'Test more flags & defaults' => sub { MooseX::App::ParsedArgv->new(argv => [qw(yet --bool3 -ab --value baer)]); my $test11 = Test03->new_with_command; isa_ok($test11,'Test03::YetAnotherCommand'); is($test11->bool1,1,'Bool1 flag is undef'); is($test11->bool2,1,'Bool2 flag is unset'); is($test11->bool3,1,'Bool3 flag is set'); is($test11->value,'baer','Value is set'); }; subtest 'Test Negate boolean options' => sub { MooseX::App::ParsedArgv->new(argv => [qw(yet --no-bool3)]); my $test11 = Test03->new_with_command; isa_ok($test11,'Test03::YetAnotherCommand'); is($test11->bool3,0,'Bool3 flag is negated'); }; subtest 'Test positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra hui --value baer)]); my $test12 = Test03->new_with_command; isa_ok($test12,'Test03::ExtraCommand'); is($test12->extra1,'hui','Extra1 value is "hui"'); is($test12->extra2, undef,'Extra2 value is undef'); is($test12->alpha, undef,'alpha value is undef'); is($test12->value,'baer','Value is set'); }; subtest 'Test positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra --value baer hui)]); my $test12 = Test03->new_with_command; isa_ok($test12,'Test03::ExtraCommand'); is($test12->extra1,'hui','Extra1 value is "hui"'); is($test12->extra2, undef,'Extra2 value is undef'); is($test12->alpha, undef,'alpha value is undef'); is($test12->value,'baer','Value is set'); }; subtest 'Test optional positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra hui 11 --value baer)]); my $test12 = Test03->new_with_command; isa_ok($test12,'Test03::ExtraCommand'); is($test12->extra1,'hui','Extra1 value is "hui"'); is($test12->extra2,11,'Extra2 value is "11"'); is($test12->alpha, undef,'alpha value is undef'); is($test12->value,'baer','Value is set'); }; subtest 'Test wrong positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra hui aa --value baer)]); my $test13 = Test03->new_with_command; isa_ok($test13,'MooseX::App::Message::Envelope'); is($test13->blocks->[0]->header,"Invalid value for 'extra2'","Error message ok"); is($test13->blocks->[2]->header,"parameters:","Usage header ok"); is($test13->blocks->[2]->body," extra1 Important extra parameter [Required] extra2 [Integer] alpha [Integer]","Usage body ok"); }; subtest 'Test missing positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra --value baer)]); my $test14 = Test03->new_with_command; isa_ok($test14,'MooseX::App::Message::Envelope'); is($test14->blocks->[0]->header,"Required parameter 'extra1' missing","Message ok"); }; Test03->meta->app_fuzzy(1); Test03->meta->app_strict(0); subtest 'Test extra positional params' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra p1 22 33 marder dachs --value 44 --flag luchs --flagg fuchs -- baer --hase)]); my $test15 = Test03->new_with_command; isa_ok($test15,'Test03::ExtraCommand'); is($test15->extra1,'p1','Param 1 ok'); is($test15->extra2,'22','Param 2 ok'); is($test15->alpha,'33','Param 3 ok'); cmp_deeply($test15->extra_argv,[qw(marder dachs luchs fuchs baer --hase)],'Uncomsumed option ok'); }; subtest 'Test parameter preference' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra extra1 22 --value 13 --flag)]); my $test16 = Test03->new_with_command(extra1 => 'extra1man', value => 14, flag => 0, flaggo => 1); isa_ok($test16,'Test03::ExtraCommand'); is($test16->extra1,"extra1man","Extra param from new_with_command ok"); is($test16->extra2,22,"Extra param from argv ok"); is($test16->value,14,"value option from argv ok"); is($test16->flag,0,"Flag from new_with_command ok"); is($test16->flaggo,1,"Flago from new_with_command ok"); }; Test03->meta->app_prefer_commandline(1); subtest 'Test parameter preference reverse' => sub { MooseX::App::ParsedArgv->new(argv => [qw(extra extra1 22 --value 13 --flag)]); my $test17 = Test03->new_with_command(extra1 => 'extra1man', value => 14, flag => 0, flaggo => 1); isa_ok($test17,'Test03::ExtraCommand'); is($test17->extra1,"extra1","Extra param from new_with_command ok"); is($test17->extra2,22,"Extra param from argv ok"); is($test17->value,13,"value option from argv ok"); is($test17->flag,1,"Flag from new_with_command ok"); is($test17->flaggo,1,"Flago from new_with_command ok"); }; subtest 'Test enum error message' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand --another hase hh h ggg)]); my $test18 = Test03->new_with_command(); isa_ok($test18,'MooseX::App::Message::Envelope'); like($test18->blocks->[0]->body, qr{(Value must be one of these values: aaa, bbb, ccc, ddd, eee, fff \(not 'ggg'\)|Validation failed for '__ANON__' with value "?ggg"?. Value must be equal to "aaa", "bbb", "ccc", "ddd", "eee", or "fff".)}, "Check enum error message"); }; subtest 'Test empty multi' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand --another hase --list val1 --list val2 --list)]); my $test19 = Test03->new_with_command(); isa_ok($test19,'Test03::SomeCommand'); is(scalar(@{$test19->list}),3,'Has three list items'); is($test19->list->[0],'val1','First value ok'); is($test19->list->[1],'val2','Second value ok'); is($test19->list->[2],undef,'First value empty'); }; subtest 'Test permute' => sub { MooseX::App::ParsedArgv->new(argv => [qw(differentcommand --list elem1 elem2 --list elem3 --int 10 --hash key1=val1 key2=val2)]); my $test20 = Test03->new_with_command(); cmp_deeply($test20->list,[qw(elem1 elem2 elem3)],'Permute array ok'); cmp_deeply($test20->hash,{ key1 => 'val1', key2 => 'val2' },'Permute hash ok'); }; subtest 'Test permute off' => sub { Test03->meta->app_permute(0); MooseX::App::ParsedArgv->new(argv => [qw(differentcommand --list elem1 elem2 --list elem3 --int 10 --hash key1=val1 key2=val2)]); my $test20 = Test03->new_with_command(); cmp_deeply($test20->list,[qw(elem1 elem3)],'No permute array ok'); cmp_deeply($test20->hash,{ key1 => 'val1' },'No permute hash ok'); Test03->meta->app_permute(1); }; subtest 'Test parameter order' => sub { MooseX::App::ParsedArgv->new(argv => [qw(somecommand cc1 --another dd aa1 bbb)]); my $test21 = Test03->new_with_command(); is($test21->param_a,'aa1','Param a ok'); is($test21->param_b,'bbb','Param b ok'); is($test21->param_c,'cc1','Param c ok'); }; subtest 'Test mixed multi' => sub { my $x = MooseX::App::ParsedArgv->new(argv => [qw(somecommand --another hase --li val1 --lis val2 --list val3 --lis val4)]); my $test22 = Test03->new_with_command(); isa_ok($test22,'Test03::SomeCommand'); cmp_deeply($test22->list,[qw(val1 val2 val3 val4)],'List ok'); }; 16_rt122946.t100644000765000024 127214514737355 14617 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/16_rt122946.t use strict; use warnings; use Test::More tests => 1+1; use Test::NoWarnings; use Test::Exception; use lib 't/testlib'; { package Test16; use MooseX::App::Simple; option 'parama' => ( is => 'rw', isa => 'Int', cmd_aliases => ['a'] ); option 'paramb' => ( is => 'rw', isa => 'Bool', cmd_aliases => ['b'] ); option 'paramab' => ( is => 'rw', isa => 'Int', cmd_aliases => ['ab'] ); } subtest 'Option flags' => sub { throws_ok { Test16->new_with_options( ARGV => [ '-ab' ] ) } qr/Option param[ab] has a single letter flag but no Bool/; }; perlcritic.t100644000765000024 101514514737355 15517 0ustar00mkostaff000000000000MooseX-App-1.43/xt# -*- perl -*- use strict; use warnings; use File::Spec; use Test::More; use English qw(-no_match_vars); if ( not $ENV{TEST_AUTHOR} ) { my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.'; plan( skip_all => $msg ); } eval " use Test::Perl::Critic (-severity => 4, -exclude => ['ProhibitSubroutinePrototypes','ProhibitMultiplePackages'] ); "; if ( $EVAL_ERROR ) { my $msg = 'Test::Perl::Critic required to criticise code'; plan( skip_all => $msg ); } Test::Perl::Critic::all_critic_ok(); 13_rt_112156.t100644000765000024 457614514737355 14755 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/13_rt_112156.t - RT112156 inheritance use Test::Most tests => 2+1; use Test::NoWarnings; use lib 't/testlib'; { package Test13; use MooseX::App qw(Depends); option 'unrelated' => ( is => 'rw', isa => 'Int', documentation => 'One thing', ); } { package Test13::SomeCommand; use MooseX::App::Command; # no inheritance option 'one' => ( is => 'rw', isa => 'Int', documentation => 'One thing', depends => ['other'], ); option 'other' => ( is => 'rw', isa => 'Int', documentation => 'Other thing', ); sub run { my ($self) = @_; return "ok"; } } { package Test13::AnotherCommand; use MooseX::App::Command; extends qw(Test13); option 'one' => ( is => 'rw', isa => 'Int', documentation => 'One thing', depends => ['other'], ); option 'other' => ( is => 'rw', isa => 'Int', documentation => 'Other thing', ); sub run { my ($self) = @_; return "ok"; } } subtest 'no inheritance' => sub { plan tests => 8; { MooseX::App::ParsedArgv->new(argv => [qw(some --one 1 --other 2)]); my $test01 = Test13->new_with_command(); isa_ok($test01,'Test13::SomeCommand'); is($test01->one,1,'Option ok'); is($test01->other,2,'Option ok'); ok(! $test01->can('unrelated'),'No option'); } { MooseX::App::ParsedArgv->new(argv => [qw(another --one 1 --other 2 --unrelated 3)]); my $test02 = Test13->new_with_command(); isa_ok($test02,'Test13::AnotherCommand'); is($test02->one,1,'Option ok'); is($test02->other,2,'Option ok'); is($test02->unrelated,3,'Option ok'); } }; subtest 'check plugin functionality' => sub { plan tests => 2; { MooseX::App::ParsedArgv->new(argv => [qw(some --one 1)]); my $test03 = Test13->new_with_command(); isa_ok( $test03, 'MooseX::App::Message::Envelope' ); } { MooseX::App::ParsedArgv->new(argv => [qw(another --one 1)]); my $test03 = Test13->new_with_command(); isa_ok( $test03, 'MooseX::App::Message::Envelope' ); } }; podcoverage.t100644000765000024 51414514737355 15640 0ustar00mkostaff000000000000MooseX-App-1.43/xt# -*- perl -*- use strict; use warnings; use Test::More; eval "use Test::Pod::Coverage 1.04"; plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@; plan skip_all => 'set TEST_AUTHOR to enable this test' unless $ENV{TEST_AUTHOR}; all_pod_coverage_ok({ also_private => [qw(init_meta plugin_metaroles BUILD DEMOLISH)] }); MooseX000755000765000024 014514737355 14362 5ustar00mkostaff000000000000MooseX-App-1.43/libApp.pm100644000765000024 4761614514737355 15636 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX# ============================================================================« package MooseX::App; # ============================================================================« use 5.010; use utf8; use strict; use warnings; our $AUTHORITY = 'cpan:MAROS'; our $VERSION = '1.43'; use MooseX::App::Meta::Role::Attribute::Option; use MooseX::App::Exporter qw(app_usage app_description app_base app_fuzzy app_strict app_prefer_commandline app_permute option parameter); use MooseX::App::Message::Envelope; use Moose::Exporter; use Scalar::Util qw(blessed); my ($IMPORT,$UNIMPORT,$INIT_META) = Moose::Exporter->build_import_methods( with_meta => [ qw(app_usage app_description app_namespace app_exclude app_base app_fuzzy app_command_name app_command_register app_strict app_prefer_commandline option parameter app_permute) ], also => [ 'Moose' ], as_is => [ 'new_with_command' ], install => [ 'unimport','init_meta' ], ); sub import { my ( $class, @plugins ) = @_; # Get caller my ($caller_class) = caller(); # Process plugins MooseX::App::Exporter->process_plugins($caller_class,@plugins); # Call Moose-Exporter generated importer return $class->$IMPORT( { into => $caller_class } ); } sub init_meta { my ($class,%args) = @_; # Get required roles and metaroles $args{roles} = ['MooseX::App::Role::Base']; $args{metaroles} = { class => [ 'MooseX::App::Meta::Role::Class::Base', 'MooseX::App::Meta::Role::Class::Documentation' ], attribute => [ 'MooseX::App::Meta::Role::Attribute::Option' ], }; return MooseX::App::Exporter->process_init_meta(%args); } sub app_command_name(&) { my ( $meta, $namesub ) = @_; return $meta->app_command_name($namesub); } sub app_command_register(%) { my ( $meta, %commands ) = @_; foreach my $command (keys %commands) { $meta->command_register($command,$commands{$command}); } return; } sub app_namespace(@) { my ( $meta, @namespaces ) = @_; return $meta->app_namespace( \@namespaces ); } sub app_exclude(@) { my ( $meta, @namespaces ) = @_; return $meta->app_exclude( \@namespaces ); } sub new_with_command { my ($class,@args) = @_; Moose->throw_error('new_with_command is a class method') if ! defined $class || blessed($class); my $meta = $class->meta; my $metameta = $meta->meta; # Sanity check Moose->throw_error('new_with_command may only be called from the application base package:'.$class) if $metameta->does_role('MooseX::App::Meta::Role::Class::Command') || ! $metameta->does_role('MooseX::App::Meta::Role::Class::Base'); $meta->command_check() if $ENV{APP_DEVELOPER} || $ENV{HARNESS_ACTIVE}; # Extra args my %args; if (scalar @args == 1 && ref($args[0]) eq 'HASH' ) { %args = %{$args[0]}; } elsif (scalar @args % 2 == 0) { %args = @args; } else { Moose->throw_error('new_with_command got invalid extra arguments'); } # Get ARGV my $argv = delete $args{ARGV}; my $parsed_argv; if (defined $argv) { $parsed_argv = MooseX::App::ParsedArgv->new( argv => $argv ); } else { $parsed_argv = MooseX::App::ParsedArgv->instance(); } my $first_argv = $parsed_argv->first_argv; # Requested help if (defined $first_argv && lc($first_argv) =~ m/^(help|h|\?|usage|-h|--help|-\?|--usage)$/) { return MooseX::App::Message::Envelope->new( $meta->command_usage_global(), ); # No args } elsif (! defined $first_argv || $first_argv =~ m/^\s*$/ || $first_argv =~ m/^-{1,2}\w/) { return MooseX::App::Message::Envelope->new( $meta->command_message( header => "Missing command", # LOCALIZE type => "error", ), $meta->command_usage_global(), 127, # exitcode ); # Looks like a command } else { my $return = $meta->command_find(); # Nothing found if (blessed $return && $return->isa('MooseX::App::Message::Block')) { return MooseX::App::Message::Envelope->new( $return, $meta->command_usage_global(), 127, # exitcode ); # One command found } else { my $command_class = $meta->command_get($return); return $class->initialize_command_class($command_class,%args); } } } no Moose; 1; __END__ =encoding utf8 =head1 NAME MooseX::App - Write user-friendly command line apps with even less suffering =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Color); option 'global_option' => ( is => 'rw', isa => 'Bool', documentation => q[Enable this to do fancy stuff], ); # Global option has 'private' => ( is => 'rw', ); # not exposed Write multiple command classes (If you have only a single command class you should use L instead). Packackes in the namespace may be deeply nested. package MyApp::SomeCommand; use MooseX::App::Command; # important (also imports Moose) extends qw(MyApp); # optional, only if you want to use global options from base class # Positional parameter parameter 'some_parameter' => ( is => 'rw', isa => 'Str', required => 1, documentation => q[Some parameter that you need to supply], ); option 'some_option' => ( is => 'rw', isa => 'Int', required => 1, documentation => q[Very important option!], ); # Option sub run { my ($self) = @_; # Do something } And then you need a simple wrapper script (called eg. myapp): #!/usr/bin/env perl use MyApp; MyApp->new_with_command->run; On the command line: bash$ myapp help usage: myapp [long options...] myapp help global options: --global_option Enable this to do fancy stuff [Flag] --help --usage -? Prints this usage information. [Flag] available commands: some_command Description of some command another_command Description of another command help Prints this usage information or bash$ myapp some_command --help usage: myapp some_command [long options...] myapp help myapp some_command --help parameters: some_parameter Some parameter that you need to supply [Required] options: --global_option Enable this to do fancy stuff [Flag] --some_option Very important option! [Int,Required] --help --usage -? Prints this usage information. [Flag] =head1 DESCRIPTION MooseX-App is a highly customisable helper to write user-friendly command line applications without having to worry about most of the annoying things usually involved. Just take any existing L class, add a single line (C) and create one class for each command in an underlying namespace. Options and positional parameters can be defined as simple L accessors using the C and C keywords respectively. MooseX-App will then =over =item * Find, load and initialise the command classes (see L for single class/command applications) =item * Create automated help and documentation from modules POD as well as attributes metadata and type constraints =item * Read, encode and validate the command line options and positional parameters entered by the user from @ARGV and %ENV (and possibly prompt the user for additional parameters see L) =item * Provide helpful error messages if user input cannot be validated (either missing or wrong attributes or Moose type constraints not satisfied) or if the user requests help. =back Commandline options are defined using the 'option' keyword which accepts the same attributes as Moose' 'has' keyword. option 'some_option' => ( is => 'rw', isa => 'Str', ); This is equivalent to has 'some_option' => ( is => 'rw', isa => 'Str', traits => ['AppOption'], # Load extra metaclass cmd_type => 'option', # Set attribute type ); Single letter options are treated as flags and may be combined with each other. However such options must have a Boolean type constraint. option 'verbose' => ( is => 'rw', isa => 'Bool', cmd_flag => 'v', ); Positional parameters are defined with the 'parameter' keyword parameter 'some_option' => ( is => 'rw', isa => 'Str', ); This is equivalent to has 'some_option' => ( is => 'rw', isa => 'Str', traits => ['AppOption'], cmd_type => 'parameter', ); All keywords are imported by L (in the app base class) and L (in the command class) or L (single class application). Furthermore, all options and parameters can also be supplied via %ENV option 'some_option' => ( is => 'rw', isa => 'Str', cmd_env => 'SOME_OPTION', # sets the env key ); Moose type constraints help MooseX::App to construct helpful error messages and parse @ARGV in a meaningful way. The following type constraints are supported: =over =item * ArrayRef: Specify multiple values ('--opt value1 --opt value2', also see L and L) =item * HashRef: Specify multiple key value pairs ('--opt key=value --opt key2=value2', also see L) =item * Enum: Display all possibilities =item * Bool: Flags that do not require values =item * Int, Num: Used for proper error messages =back Read the L for getting started with a simple MooseX::App command line application. =head1 METHODS =head2 new_with_command my $myapp_command = MyApp->new_with_command(); This constructor reads the command line arguments and tries to create a command class instance. If it fails it returns a L object holding an error message. You can pass a hash of default/fallback params to new_with_command my $obj = MyApp->new_with_command(%default); Optionally you can pass a custom ARGV to this constructor my $obj = MyApp->new_with_command( ARGV => \@myARGV ); However, if you do so you must take care of propper @ARGV encoding yourself. =head2 initialize_command_class my $obj = MyApp->initialize_command_class($command_name,%default); Helper method to instantiate the command class for the given command. =head1 GLOBAL OPTIONS These options may be used to alter the default behaviour of MooseX-App. =head2 app_base app_base 'my_script'; # Defaults to $0 Usually MooseX::App will take the name of the calling wrapper script to construct the program name in various help messages. This name can be changed via the app_base function. =head2 app_fuzzy app_fuzzy 1; # default OR app_fuzzy 0; Enables fuzzy matching of commands and attributes. Is turned on by default. =head2 app_strict app_strict 0; # default OR app_strict 1; If strict is enabled the program will terminate with an error message if superfluous/unknown positional parameters are supplied. If disabled all extra parameters will be copied to the L attribute. Unknown options (with leading dashes) will always yield an error message. The command_strict config in the command classes allows one to set this option individually for each command in the respective command class. =head2 app_prefer_commandline app_prefer_commandline 0; # default or app_prefer_commandline 1; Specifies if parameters/options supplied via @ARGV,%ENV should take precedence over arguments passed directly to new_with_command. =head2 app_namespace app_namespace 'MyApp::Commands', 'YourApp::MoreCommands'; OR app_namespace(); Usually MooseX::App will take the package name of the base class as the namespace for commands. This namespace can be changed and you can add multiple extra namespaces. If app_namespace is called with no arguments then autoloading of command classes will be disabled entirely. =head2 app_exclude app_exclude 'MyApp::Commands::Roles','MyApp::Commands::Utils'; A sub namespace included via L (or the default behaviour) can be excluded using app_exclude. =head2 app_command_name app_command_name { my ($package_short,$package_full) = @_; # munge package name; return $command_name; }; This coderef can be used to control how autoloaded package names should be translated to command names. If this command returns nothing the respective command class will be skipped and not loaded. =head2 app_command_register app_command_register do => 'MyApp::Commands::DoSomething', undo => 'MyApp::Commands::UndoSomething'; This keyword can be used to register additional commands. Especially useful in conjunction with L and disabled autoloading. =head2 app_description app_description qq[Description text]; Set the app description text. If not set this information will be taken from the Pod DESCRIPTION or OVERVIEW sections. (see command_description to set usage per command) =head2 app_usage app_usage qq[myapp --option ...]; Set a custom usage text. If not set this will be taken from the Pod SYNOPSIS or USAGE section. If both sections are not available, the usage information will be autogenerated. (see command_usage to set usage per command) =head2 app_permute app_permute 0; # default OR app_permute 1; Allows one to specify multiple values with one key. So instead of writing C<--list element1 --list element2 --list element3> one might write C<--list element1 element2 element3> for ArrayRef elements. HashRef elements may be expressed as C<--hash key=value key2=value2>. =head1 GLOBAL ATTRIBUTES All MooseX::App classes will have two extra attributes =head2 extra_argv Carries all parameters from @ARGV that were not consumed (only if app_strict is turned off, otherwise superfluous parameters will raise an exception). =head2 help_flag Help flag that is set when help was requested. =head1 ATTRIBUTE OPTIONS Options and parameters accept extra attributes for customisation: =over =item * cmd_tags - Extra tags (as used by the help) =item * cmd_flag - Override option/parameter name =item * cmd_aliases - Additional option/parameter name aliases =item * cmd_split - Split values into ArrayRefs on this token or RegEx =item * cmd_position - Specify option/parameter order in help =item * cmd_env - Read options/parameters from %ENV =item * cmd_count - Value of option equals to number of occurrences in @ARGV =item * cmd_negate - Adds an option to negate boolean flags =back Refer to L for detailed documentation. =head1 METADATA MooseX::App will use your class metadata and POD to construct the commands and helpful error- or usage-messages. These bits of information are utilised and should be provided if possible: =over =item * Package names =item * L-(1|0)"> options for Moose attributes =item * L $string"> options for Moose attributes =item * Moose type constraints (Bool, ArrayRef, HashRef, Int, Num, and Enum) =item * Documentation set via app_description, app_usage, command_short_description, command_long_description and command_usage =item * POD (NAME, ABSTRACT, DESCRIPTION, USAGE, SYNOPSIS, OVERVIEW, COPYRIGHT, LICENSE, COPYRIGHT AND LICENSE, AUTHOR and AUTHORS sections) =item * L ABSTRACT tag if no POD is available yet =back =head1 PLUGINS The behaviour of MooseX-App can be customised with plugins. To load a plugin just pass a list of plugin names after the C statement. (Attention: order sometimes matters) use MooseX::App qw(PluginA PluginB); Currently the following plugins are shipped with MooseX::App =over =item * L Adds a command that generates a bash completion script for your application. See third party L for Z shell completion. =item * L Colorful output for your MooseX::App applications. =item * L Config files for MooseX::App applications. =item * L Try to find config files in users home directory. =item * L Prompt user for options and parameters that were not provided via options or params. Prompt offers basic editing capabilities and non-persistent history. =item * L Handle typos in command names and provide suggestions. =item * L Adds a command to display the version and license of your application. =item * L Display full manpage of application and commands. =item * L Allow for mutally exclusive options. =item * L Adds dependent options. =back Refer to L for documentation on how to create your own plugins. =head1 DEVELOPMENT Make sure to invoke your script with APP_DEVELOPER=1 ser during development. This will come with a starup penalty but perform additional checks for detecting wrong attribute/type constraint combinations, name clashes, ... =head1 CAVEATS & KNOWN BUGS Startup time may be an issue - escpecially if you load many plugins. If you do not require the functionality of plugins and ability for fine grained customisation (or Moose for that matter) then you should probably use L or L. In some cases - especially when using non-standard class inheritance - you may end up with command classes lacking the help attribute. In this case you need to include the following line in your base class or command classes. with qw(MooseX::App::Role::Common); When manually registering command classes (eg. via app_command_register) in multiple base classes with different sets of plugins (why would you ever want to do that?), then meta attributes may lack some attribute metaclasses. In this case you need to load the missing attribute traits explicitly: option 'argument' => ( depends => 'otherargument', trait => ['MooseX::App::Plugin::Depends::Meta::Attribute'], # load trait ); =head1 SEE ALSO Read the L for getting started with a simple MooseX::App command line application. For alternatives you can check out L, L, L, L and L =head1 SUPPORT Please report any bugs or feature requests via L. I will be notified, and then you'll automatically be notified of progress on your report as I make changes. =head1 AUTHOR Maroš Kollár CPAN ID: MAROS maros [at] k-1.com http://www.k-1.com =head1 CONTRIBUTORS Special thanks to all contributors. In no particular order: Andrew Jones, George Hartzell, Steve Nolte, Michael G, Thomas Klausner, Yanick Champoux, Edward Baudrez, David Golden, J.R. Mash, Thilo Fester, Gregor Herrmann, Sergey Romanov, Sawyer X, Roman F., Hunter McMillen, Maik Hentsche, Alexander Stoddard, Marc Logghe, Tina Müller, Lisa Hare, Jose Luis Martinez, Frank Schreiner, Bernhard M. Wiedemann, Petr Pisar, William Barker You are more than welcome to contribute to MooseX-App. Please have a look at the L list of open wishlist issues for ideas. =head1 COPYRIGHT MooseX::App is Copyright (c) 2012-23 Maroš Kollár. This library is free software and may be distributed under the same terms as perl itself. The full text of the licence can be found in the LICENCE file included with this module. =cut 15_subcommands.t100644000765000024 336414514737355 16020 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/15_subcommands.t use strict; use warnings; use Test::More tests => 3+1; use Test::NoWarnings; use lib 't/testlib'; { package Test15; use MooseX::App; } { package Test15::Foo; use MooseX::App::Command; sub run { "running foo" } command_short_description "Toplevel command"; } { package Test15::Foo::Bar; use MooseX::App::Command; sub run { "running bar" } command_short_description "Bar subcommand"; } { package Test15::Foo::Baz; use MooseX::App::Command; sub run { "running baz" } command_short_description "Baz subcommand"; } subtest 'Basic Subcommands' => sub { isa_ok(Test15->new_with_command( ARGV => [ 'foo' ] ),'Test15::Foo'); isa_ok(Test15->new_with_command( ARGV => [ 'foo','bar' ] ),'Test15::Foo::Bar'); isa_ok(Test15->new_with_command( ARGV => [ 'foo','baz' ] ),'Test15::Foo::Baz'); isa_ok(Test15->new_with_command( ARGV => [ 'foo','qux' ] ),'Test15::Foo'); }; subtest 'Help Subcommand' => sub { my $help = Test15->new_with_command( ARGV => [ 'help' ] ); isa_ok($help,'MooseX::App::Message::Envelope'); is($help->blocks->[2]->header,'available commands:','Command headline set'); is($help->blocks->[2]->body," foo Toplevel command foo bar Bar subcommand foo baz Baz subcommand help Prints this usage information",'Command body set'); }; subtest 'Help Parent' => sub { my $help = Test15->new_with_command( ARGV => [ 'foo','--help' ] ); isa_ok($help,'MooseX::App::Message::Envelope'); is($help->blocks->[3]->header,'available subcommands:','Command headline set'); is($help->blocks->[3]->body," bar Bar subcommand baz Baz subcommand help Prints this usage information",'Command body set'); };example000755000765000024 014514737355 14300 5ustar00mkostaff000000000000MooseX-App-1.43/ttest01.pl100755000765000024 25414514737355 16101 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test01; Test01->new_with_command( global => 1 )->run;test02.pl100755000765000024 23514514737355 16101 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test02; Test02->new_with_command->run;test03.pl100755000765000024 23514514737355 16102 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test03; Test03->new_with_command->run;test04.pl100755000765000024 23514514737355 16103 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test04; Test04->new_with_command->run;test05.pl100755000765000024 23514514737355 16104 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test05; Test05->new_with_options->run;test06.pl100755000765000024 23514514737355 16105 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test06; Test06->new_with_command->run;test07.pl100755000765000024 23514514737355 16106 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test07; Test07->new_with_options->run;test08.pl100755000765000024 23514514737355 16107 0ustar00mkostaff000000000000MooseX-App-1.43/t/example#!/usr/bin/env perl use strict; use warnings; use 5.010; use FindBin qw(); use lib $FindBin::Bin.'/../testlib'; use Test08; Test08->new_with_options->run;testlib000755000765000024 014514737355 14313 5ustar00mkostaff000000000000MooseX-App-1.43/tTest01.pm100644000765000024 61314514737355 16051 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test01; use Moose; use MooseX::App qw(Config); app_strict 1; app_prefer_commandline 0; app_description "Huissasa"; option 'global' => ( isa => 'Int', is => 'rw', required => 1, documentation => q[test], cmd_tags => ['Important!'], ); has 'private' => ( isa => 'Int', is => 'rw', ); 1; Test02.pm100644000765000024 70614514737355 16055 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test02; use Moose; use MooseX::App (qw(BashCompletion Version Man), ($ENV{HARNESS_ACTIVE} ? ():qw(ConfigHome Color Typo Term) )); our $VERSION = 1.01; app_namespace "Test02::Command","Test02::MoreCommands"; #app_fuzzy; sub run { print "RAN"; } 1; =encoding utf8 =head1 NAME Test02 - Test 02 =head1 SYNOPSIS do something =head1 LICENSE This library is free software and may be distributed under the same terms as perl itself. =cutTest03.pm100644000765000024 115114514737355 16071 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test03; use MooseX::App qw(BashCompletion Version); our $VERSION = '22.02'; app_permute 1; app_base 'test03'; app_command_name { my ($package) = @_; return lc($package); }; app_exclude qw(Test03::Role); option 'global_option' => ( is => 'rw', isa => 'Bool', #default => 0, #required => 1, documentation => q[Enable this to do fancy stuff], ); has 'hidden_option' => ( is => 'rw', ); sub run { print "RAN"; } 1; =head1 LICENSE This library is free software and may be distributed under the same terms as perl itself. =cutTest04.pm100644000765000024 26414514737355 16056 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test04; #use Moose; use MooseX::App; extends qw(Test04Base); option 'test1' => ( is => 'rw', isa => 'Int', ); option '+test2' => (); 1;Test05.pm100644000765000024 103414514737355 16073 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test05; #use Moose; use MooseX::App::Simple qw(Config); app_fuzzy 1; option 'some_option' => ( is => 'rw', isa => 'Bool', documentation => q[Enable this to do fancy stuff], ); option 'another_option' => ( is => 'rw', isa => 'Str', documentation => q[Enable this to do fancy stuff], required => 1, cmd_env => 'ANOTHER', ); sub run { my ($self) = @_; warn $self->dump; } 1; =head1 DESCRIPTION this is how we use this command =cut Test06.pm100644000765000024 67414514737355 16065 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test06; use MooseX::App qw(Config); app_fuzzy(1); #app_namespace(); app_command_name { my @parts = split( /[_\s]+|\b|(? 'Test03::ExtraCommand'; app_permute 1; option 'some_option' => ( is => 'rw', isa => 'Bool', documentation => q[Enable this to do fancy stuff], ); 1;Test07.pm100644000765000024 65314514737355 16063 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test07; use MooseX::App::Simple qw(MutexGroup); option 'UseAmmonia' => ( is => 'ro', isa => 'Bool', mutexgroup => 'NonMixableCleaningChemicals', ); option 'UseChlorine' => ( is => 'ro', isa => 'Bool', mutexgroup => 'NonMixableCleaningChemicals' ); has 'private_option' => ( is => 'ro', isa => 'Int', default => 0, ); sub run { print "ok"; } 1; Test08.pm100644000765000024 104714514737355 16102 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test08; use MooseX::App::Simple qw(MutexGroup Depends); use Moose::Util::TypeConstraints; option 'FileFormat' => ( is => 'ro', isa => enum([qw(csv tsv xml)]), ); option 'WriteToFile' => ( is => 'ro', isa => 'Bool', mutexgroup => 'FileOp', depends => [qw(FileFormat)], ); option 'ReadFromFile' => ( is => 'ro', isa => 'Bool', mutexgroup => 'FileOp', depends => [qw(FileFormat)], ); has 'private_option' => ( is => 'ro', isa => 'Int', default => 0, ); 1; 04_plugin_config.t100644000765000024 300014514737355 16311 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/04_role_config.t - Test config role use Test::Most tests => 4+1; use Test::NoWarnings; use lib 't/testlib'; use Test01; subtest 'Command with config' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --config t/config.pl)]); my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandA'); is($test01->global,'234','Arg from command config'); is($test01->command_local1,'22','Arg from command config'); ok($test01->config,'Config file is set'); is($test01->_config_data->{global}{global},'123','Config loaded'); }; subtest 'Another command with config' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_b --config t/config.pl --param_b bbb)]); my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandB'); is($test01->global,'123','Arg from command config'); }; subtest 'Command with config and argv' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --config t/config.pl --global 1234)]); my $test01 = Test01->new_with_command; isa_ok($test01,'Test01::CommandA'); is($test01->global,'1234','Arg from command config'); is($test01->command_local1,'22','Arg from command config'); }; subtest 'Missing config' => sub { MooseX::App::ParsedArgv->new(argv => [qw(command_a --config t/nosuchfile.pl --global 1234)]); my $test01 = Test01->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); like($test01->blocks->[0]->header,qr/Could not find/,'Error message set'); }; 08_plugin_various.t100644000765000024 223514514737355 16551 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/08_plugin_various.t - Test various plugin use strict; use Test::Most tests => 2+1; use Test::NoWarnings; use lib 't/testlib'; use Test03; subtest 'Bash completion' => sub { MooseX::App::ParsedArgv->new(argv => [qw(bash_completion)]); my $test01 = Test03->new_with_command; isa_ok($test01,'MooseX::App::Message::Envelope'); my $bash_completion = $test01->stringify; like($bash_completion,qr/_test03_macc_somecommand\(\)\s\{/,'some_command present'); like($bash_completion,qr/--global_option/,'global_option present'); like($bash_completion,qr/--roleattr/,'roleattr present'); unlike($bash_completion,qr/bash_completion/,'bash_completion is not included'); }; subtest 'Version' => sub { MooseX::App::ParsedArgv->new(argv => [qw(version)]); my $test02 = Test03->new_with_command; isa_ok($test02,'MooseX::App::Message::Envelope'); my $version = $test02->stringify; like($version,qr/\s*test03\s+version\s+22\.02/s,'Check for app version'); like($version,qr/\s*MooseX::App\sversion\s\d+\.\d+/s,'Check for MooseX::App version'); like($version,qr/This library is free software/s,'License included'); }; 12_plugin_depends.t100644000765000024 312014514737355 16470 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/12_plugin_depends.t - Test Depends use Test::Most tests => 1+1; use Test::NoWarnings; use lib 't/testlib'; use Test08; subtest 'Depends' => sub { plan tests => 8; { my $test01 = Test08->new_with_options( WriteToFile => 1 ); isa_ok( $test01, 'MooseX::App::Message::Envelope' ); my @errors = grep { $_->type eq 'error' } @{ $test01->blocks }; is( scalar @errors, 1, 'only returned a single error' ); is( $errors[0]->header, 'Option \'WriteToFile\' requires \'FileFormat\' to be defined', 'generated an error when an option dependency was not present' ); } { my $test02 = Test08->new_with_options( ReadFromFile => 1 ); isa_ok( $test02, 'MooseX::App::Message::Envelope' ); my @errors = grep { $_->type eq 'error' } @{ $test02->blocks }; is( scalar @errors, 1, 'only returned a single error' ); is( $errors[0]->header, 'Option \'ReadFromFile\' requires \'FileFormat\' to be defined', 'generated an error when an option dependency was not present' ); } { my $test03 = Test08->new_with_options( WriteToFile => 1, FileFormat => 'tsv' ); ok( ! $test03->can('blocks'), 'generated no errors when both an option and its dependencies are defined' ); } { my $test04 = Test08->new_with_options( ReadFromFile => 1, FileFormat => 'tsv' ); ok( ! $test04->can('blocks'), 'generated no errors when both an option and its dependencies are defined' ); } }; App000755000765000024 014514737355 15102 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseXRole.pm100644000765000024 256314514737355 16507 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App# ============================================================================ package MooseX::App::Role; # ============================================================================ use 5.010; use utf8; use strict; use warnings; use Moose::Role (); use MooseX::App::Exporter qw(option parameter); use Moose::Exporter; Moose::Exporter->setup_import_methods( also => 'Moose::Role', with_meta => [qw(option parameter)], ); sub init_meta { my (undef,%args) = @_; my $meta = Moose::Role->init_meta( %args ); Moose::Util::MetaRole::apply_metaroles( for => $meta, role_metaroles => { applied_attribute => ['MooseX::App::Meta::Role::Attribute::Option'], }, ); return $meta; } 1; __END__ =pod =head1 NAME MooseX::App::Role - Define attributes in a role =head1 SYNOPSIS package MyApp::Role::SomeRole; use MooseX::App::Role; # Alo loads Moose::Role option 'testattr' => ( isa => 'rw', cmd_tags => [qw(Important! Nice))], ); =head1 DESCRIPTION Enables the 'option' and 'parameter' keywords in your roles. Alternatively you can also just use attribute traits: has 'testattr' => ( isa => 'rw', traits => ['AppOption'], # required cmd_type => 'option', # required cmd_tags => [qw(Important! Nice))], ); =cutUtils.pm100644000765000024 1767114514737355 16734 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/Apppackage MooseX::App::Utils; use 5.010; use utf8; use strict; use warnings; use List::Util qw(max); our $SCREEN_WIDTH = 78; our $INDENT = 4; use Moose::Util::TypeConstraints; subtype 'MooseX::App::Types::List' => as 'ArrayRef'; coerce 'MooseX::App::Types::List' => from 'Str' => via { [$_] }; subtype 'MooseX::App::Types::CmdTypes' => as enum([qw(proto option parameter)]); subtype 'MooseX::App::Types::MessageString' => as 'Str'; coerce 'MooseX::App::Types::MessageString' => from 'ArrayRef' => via { sprintf(@{$_}) }; subtype 'MooseX::App::Types::Env' => as 'Str' => where { m/^[A-Z0-9_]+$/ }; subtype 'MooseX::App::Types::Identifier' => as 'Str' => where { $_ eq '?' || (m/^[A-Za-z0-9][A-Za-z0-9_-]*$/ && m/[^-_]$/) }; subtype 'MooseX::App::Types::IdentifierList' => as 'ArrayRef[MooseX::App::Types::Identifier]'; coerce 'MooseX::App::Types::IdentifierList' => from 'MooseX::App::Types::Identifier' => via { [$_] }; no Moose::Util::TypeConstraints; # Default package name to command name translation function sub class_to_command { my ($class) = @_; return unless defined $class; my @commands; foreach my $part (split /\s+/,$class) { my @parts = split( /_+|\b|(?[0]) } @list); my $description_length = $SCREEN_WIDTH - $max_length - 7; my $prefix_length = $max_length + $INDENT + 2; my @return; # Loop all items foreach my $command (@list) { my $description = $command->[1] // ''; my @lines = split_string($description_length,$description); push (@return,(' 'x$INDENT).sprintf('%-*s %s',$max_length,$command->[0],shift(@lines))); while (my $line = shift (@lines)) { push(@return,' 'x $prefix_length.$line); } } return join("\n",@return); } # Simple splitting of long sentences on whitespaces or punctuation sub split_string { my ($maxlength, $string) = @_; return unless defined $string; return $string if length $string <= $maxlength; my (@lines,$line); $line = ''; foreach my $word (split(m/(\p{IsPunct}|\p{IsSpace})/,$string)) { if (length($line.$word) <= $maxlength) { $line .= $word; } else { push(@lines,$line) if ($line ne ''); $line = ''; if (length($word) > $maxlength) { my (@parts) = grep { $_ ne '' } split(/(.{$maxlength})/,$word); my $lastline = pop(@parts); push(@lines,@parts); if (defined $lastline && $lastline ne '') { $line = $lastline; } } else { $line = $word; } } } push(@lines,$line) if ($line ne ''); @lines = map { m/^\s*(.+?)\s*$/ ? $1 : $_ } @lines; return @lines; } # Try to get filename for a given package name sub package_to_filename { my ($package) = @_; # Package to filename my $package_filename = $package; $package_filename =~ s/::/\//g; $package_filename .= '.pm'; my $package_filepath; if (defined $INC{$package_filename}) { $package_filepath = $INC{$package_filename}; $package_filepath =~ s/\/{2,}/\//g; } # No filename available return unless defined $package_filepath && -e $package_filepath; return $package_filepath; } # Parse pod sub parse_pod { my ($package) = @_; my $package_filepath = package_to_filename($package); return unless $package_filepath; # Parse pod my $document = Pod::Elemental->read_file($package_filepath); Pod::Elemental::Transformer::Pod5->new->transform_node($document); my $nester_head = Pod::Elemental::Transformer::Nester->new({ top_selector => Pod::Elemental::Selectors::s_command('head1'), content_selectors => [ Pod::Elemental::Selectors::s_command([ qw(head2 head3 head4 over back item) ]), Pod::Elemental::Selectors::s_flat() ], }); $document = $nester_head->transform_node($document); # Process pod my %pod; foreach my $element (@{$document->children}) { # Distzilla ABSTRACT tag if ($element->isa('Pod::Elemental::Element::Pod5::Nonpod')) { if ($element->content =~ m/^\s*#+\s*ABSTRACT:\s*(.+)$/m) { $pod{ABSTRACT} ||= $1; } # Pod head1 sections } elsif ($element->isa('Pod::Elemental::Element::Nested') && $element->command eq 'head1') { if ($element->content eq 'NAME') { my $content = _pod_node_to_text($element->children); next unless defined $content; $content =~ s/^$package(\s-)?\s//; chomp($content); $pod{NAME} = $content; } else { my $content = _pod_node_to_text($element->children); next unless defined $content; chomp($content); $pod{uc($element->content)} = $content; } } } return %pod; } # Transform POD to simple markup sub _pod_node_to_text { my ($node,$indent) = @_; unless (defined $indent) { my $indent_init = 0; $indent = \$indent_init; } my (@lines); if (ref $node eq 'ARRAY') { foreach my $element (@$node) { push (@lines,_pod_node_to_text($element,$indent)); } } else { my $class = ref($node); if ($class eq 'Pod::Elemental::Element::Pod5::Ordinary') { my $content = $node->content; return if $content =~ m/^=cut/; $content =~ s/\n/ /g; $content =~ s/\s+/ /g; push (@lines,$content."\n"); } elsif ($class eq 'Pod::Elemental::Element::Pod5::Verbatim') { push (@lines,$node->content."\n"); } elsif ($class eq 'Pod::Elemental::Element::Pod5::Command') { my $command = $node->command; if ($command eq 'over') { ${$indent}++; } elsif ($command eq 'item') { push (@lines,(' ' x ($$indent-1)) . $node->content); } elsif ($command eq 'back') { push (@lines,"\n"); ${$indent}--; } elsif ($command =~ qr/head\d/) { push (@lines,"\n",$node->content,"\n"); } } } return unless scalar @lines; # Convert text markup my $return = join ("\n", grep { defined $_ } @lines); $return =~ s/\n\n\n+/\n\n/g; # Max one empty line $return =~ s/I<([^>]+)>/_$1_/g; $return =~ s/B<([^>]+)>/*$1*/g; $return =~ s/[LCBI]<([^>]+)>/$1/g; $return =~ s/[LCBI]<([^>]+)>/$1/g; return $return; } 1; =pod =head1 NAME MooseX::App::Utils - Utility functions =head1 DESCRIPTION This package holds various utility functions used by MooseX-App internally. Unless you develop plugins you will not need to interact with this class. =head1 FUNCTIONS =head2 class_to_command =head2 package_to_filename Tries to determine the filename containing the given package name. =head2 format_list =head2 format_text =head2 parse_pod =head2 split_string =head1 GLOBALS =head2 $MooseX::App::Utils::SCREEN_WIDTH Screen width for printing help and error messages =head2 $MooseX::App::Utils::INDENT Indent for printing help and error messages =cut Test04Base.pm100644000765000024 46214514737355 16651 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlibpackage Test04Base; use Moose; has 'test1' => ( is => 'rw', isa => 'Str', ); has 'test2' => ( is => 'rw', isa => 'Bool', ); has 'test3' => ( is => 'rw', isa => 'Str', ); sub run { print "RAN"; } 1;Simple.pm100644000765000024 1175214514737355 17057 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App# ============================================================================« package MooseX::App::Simple; # ============================================================================« use 5.010; use utf8; use strict; use warnings; our $AUTHORITY = 'cpan:MAROS'; our $VERSION = '1.42'; use Moose::Exporter; use MooseX::App::Exporter qw(app_usage app_description app_base app_fuzzy app_strict app_prefer_commandline app_permute option parameter command_short_description command_long_description command_usage command_strict); use MooseX::App::Meta::Role::Attribute::Option; use MooseX::App::Message::Envelope; use Scalar::Util qw(blessed); my ($IMPORT,$UNIMPORT,$INIT_META) = Moose::Exporter->build_import_methods( with_meta => [ qw(app_usage app_description app_base app_fuzzy app_strict app_permute option parameter command_short_description command_long_description command_usage command_strict) ], also => [ 'Moose' ], as_is => [ 'new_with_options' ], install => [ 'unimport', 'init_meta' ], ); sub import { my ( $class, @plugins ) = @_; # Get caller my ($caller_class) = caller(); # Process plugins MooseX::App::Exporter->process_plugins($caller_class,@plugins); # Call Moose-Exporter generated importer return $class->$IMPORT( { into => $caller_class } ); } sub init_meta { my ($class,%args) = @_; # Get required roles and metaroles $args{roles} = ['MooseX::App::Role::Base' ]; $args{metaroles} = { class => [ 'MooseX::App::Meta::Role::Class::Base', 'MooseX::App::Meta::Role::Class::Simple', 'MooseX::App::Meta::Role::Class::Documentation' ], attribute => [ 'MooseX::App::Meta::Role::Attribute::Option' ], }; my $meta = MooseX::App::Exporter->process_init_meta(%args); # Register only one command $meta->app_commands({ 'self' => $args{for_class} }); return $meta; } sub new_with_options { my ($class,@args) = @_; # Sanity check Moose->throw_error('new_with_options is a class method') if ! defined $class || blessed($class); my %args; if (scalar @args == 1 && ref($args[0]) eq 'HASH' ) { %args = %{$args[0]}; } elsif (scalar @args % 2 == 0) { %args = @args; } else { Moose->throw_error('new_with_command got invalid extra arguments'); } $class->meta->command_check() if $ENV{APP_DEVELOPER} || $ENV{HARNESS_ACTIVE}; # Get ARGV my $argv = delete $args{ARGV}; my $parsed_argv; if (defined $argv) { $parsed_argv = MooseX::App::ParsedArgv->new( argv => $argv ); } else { $parsed_argv = MooseX::App::ParsedArgv->instance(); } return $class->initialize_command_class($class,%args); } no Moose; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Simple - Single command applications =head1 SYNOPSIS package MyApp; use MooseX::App::Simple qw(Config Color); parameter 'param' => ( is => 'rw', isa => 'Str', documentation => q[First parameter], required => 1, ); # Positional parameter option 'my_option' => ( is => 'rw', isa => 'Bool', documentation => q[Enable this to do fancy stuff], ); # Option (--my_option) has 'private' => ( is => 'rw', ); # not exposed sub run { my ($self) = @_; # Do something } And then in some simple wrapper script: #!/usr/bin/env perl use MyApp; MyApp->new_with_options->run; =head1 DESCRIPTION MooseX::App::Simple works basically just as MooseX::App, however it does not search for commands and assumes that you have all options and parameters defined in the current class. Read the L for getting started with a simple MooseX::App command line application. =head1 METHODS =head2 new_with_options my $myapp_command = MyApp->new_with_options(); This method reads the command line arguments from the user and tries to create instantiate the current class with the ARGV-input. If it fails it returns a L object holding an error message. You can pass a hash or hashref of default params to new_with_options MyApp->new_with_options( %default ); Optionally you can pass a custom ARGV to this constructor my $obj = MyApp->new_with_options( ARGV => \@myARGV ); However, if you do so you must take care of propper @ARGV encoding yourself. =head1 OPTIONS Same as in L, however all options regarding command loading such as L and L are not available. =head1 PLUGINS Same as in L. However plugings adding additional commands (eg. version) will have no effect with MooseX::App::Simple. =head1 SEE ALSO Read the L for getting started with a simple MooseX::App command line application. See L and L for alternatives =cut 10_plugin_mutexgroup.t100644000765000024 253614514737355 17275 0ustar00mkostaff000000000000MooseX-App-1.43/t# -*- perl -*- # t/10_plugin_mutexgroup.t - Test MutexGroup use Test::Most tests => 1+1; use Test::NoWarnings; use lib 't/testlib'; use Test07; subtest 'MutexGroup' => sub { plan tests => 7; { my $test01 = Test07->new_with_options( UseAmmonia => 1, UseChlorine => 1 ); isa_ok( $test01, 'MooseX::App::Message::Envelope' ); my @errors = grep { $_->type eq 'error' } @{ $test01->blocks }; is( scalar @errors, 1, 'only returned a single error' ); is( $errors[0]->header, 'Options UseAmmonia and UseChlorine are mutally exclusive', 'generated an error when more than one option in the same mutexgroup is initialized' ); } { my $test02 = Test07->new_with_options(); isa_ok( $test02, 'MooseX::App::Message::Envelope' ); my @errors = grep { $_->type eq 'error' } @{ $test02->blocks }; is( scalar @errors, 1, 'only returned a single error' ); is( $errors[0]->header, 'Either UseAmmonia or UseChlorine must be specified', 'generated an error when no options in the same mutexgroup are initialized' ); } { my $test03 = Test07->new_with_options( UseAmmonia => 1 ); ok( $test03->isa('Test07'), 'generated no errors when only a single option from the same mutexgroup is initialized' ); } }; Command.pm100644000765000024 673414514737355 17170 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App# ============================================================================ package MooseX::App::Command; # ============================================================================ use 5.010; use utf8; use strict; use warnings; use Moose (); use MooseX::App::Meta::Role::Attribute::Option; use MooseX::App::Exporter qw(option parameter command_short_description command_long_description command_usage command_strict); use Moose::Exporter; Moose::Exporter->setup_import_methods( with_meta => [qw(command_short_description command_long_description command_strict command_usage option parameter extends)], also => 'Moose', ); sub init_meta { my ($class,%args) = @_; my $meta = Moose->init_meta( %args ); init_class($meta); return $meta; } sub extends { my $meta = shift; $meta->superclasses(@_); # Need to re-init meta class, just in case init_class($meta); } sub init_class { my $meta = shift; Moose::Util::MetaRole::apply_metaroles( for => $meta, class_metaroles => { class => [ 'MooseX::App::Meta::Role::Class::Documentation', 'MooseX::App::Meta::Role::Class::Command' ], attribute => [ 'MooseX::App::Meta::Role::Attribute::Option' ], }, ); unless ($meta->DOES('MooseX::App::Role::Common')) { Moose::Util::MetaRole::apply_base_class_roles( for => $meta->name, roles => ['MooseX::App::Role::Common'], ); } } 1; __END__ =pod =head1 NAME MooseX::App::Command - Load command class metaclasses =head1 SYNOPSIS package MyApp::SomeCommand; use MooseX::App::Command; # Also loads Moose option 'testattr' => ( isa => 'rw', cmd_tags => [qw(Important! Nice))], ); command_short_description 'This is a short description'; command_long_description 'This is a much longer description yadda yadda'; command_usage 'script some_command --testattr 123'; =head1 DESCRIPTION By loading this class into your command classes you import all required symbols, and enable all documentation features such as: =over =item * Parsing command documentation from Pod =item * Setting the command documentation manually via C and C =item * Overriding the automated usage header with custom usage from Pod or via C =item * Adding the C, C, C and C attributes to options =back =head1 FUNCTIONS =head2 command_short_description Set the short description. If not set this information will be taken from the Pod NAME or ABSTRACT section. Alternative this will be taken from the DistZilla ABSTRACT tag. =head2 command_long_description Set the long description. If not set this information will be taken from the Pod DESCRIPTION or OVERVIEW sections. =head2 command_usage Set custom usage. If not set this will be taken from the Pod SYNOPSIS or USAGE section. If those sections are not available, the usage information will be autogenerated. =head2 command_strict command_strict(0); # default OR command_strict(1); If strict is enabled the program will terminate with an error message if superfluous/unknown positional parameters are supplied. If disabled all extra parameters will be copied to the L attribute. The app_strict function in the app classes allows one to set this option globally. =cut 1; Exporter.pm100644000765000024 1574114514737355 17440 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App# ============================================================================ package MooseX::App::Exporter; # ============================================================================ use 5.010; use utf8; use strict; use warnings; use Moose::Exporter; use MooseX::App::Utils; use MooseX::App::ParsedArgv; use List::Util qw(first); my %PLUGIN_SPEC; sub import { my ( $class, @imports ) = @_; my $caller_class = caller(); my $caller_stash = Package::Stash->new($caller_class); my $exporter_stash = Package::Stash->new(__PACKAGE__); foreach my $import (@imports) { my $symbol = $exporter_stash->get_symbol('&'.$import); Carp::confess(sprintf('Symbol %s not defined in %s',$import,__PACKAGE__)) unless defined $symbol; $caller_stash->add_symbol('&'.$import, $symbol); } return; } sub parameter { my ($meta,$name,@rest) = @_; return _handle_attribute($meta,$name,'parameter',@rest); } sub option { my ($meta,$name,@rest) = @_; return _handle_attribute($meta,$name,'option',@rest); } sub _handle_attribute { my ($meta,$name,$type,@rest) = @_; Moose->throw_error('Usage: option \'name\' => ( key => value, ... )') if @rest % 2 == 1; my %info; @info{qw(package file line)} = caller(2); my %attributes = ( definition_context => \%info, @rest ); my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; # We are in a command class if (! $meta->isa('Moose::Meta::Role') && $meta->meta->does_role('MooseX::App::Meta::Role::Class::Command')) { # Get required extra traits for this class on first attrubute unless ($meta->has_app_attribute_metaroles) { # Find MooseX::App::Meta::Role::Class::Base in ISA foreach my $parent ($meta->linearized_isa) { if ($parent->meta->does_role('MooseX::App::Meta::Role::Class::Base')) { $meta->app_attribute_metaroles([]); last; } } # Apply missing meta roles if required to do so unless ($meta->has_app_attribute_metaroles) { my @extra_classes; my $name = $meta->name; foreach my $class (keys %PLUGIN_SPEC) { my @commands = $class->meta->command_classes; if (first { $name eq $_ } @commands) { my $attribute_metaclass = $class->meta->attribute_metaclass; push @extra_classes, map { $_->name } grep { $_->name ne 'MooseX::App::Meta::Role::Attribute::Option' } grep { ! $_->isa('Moose::Meta::Role::Composite') } map { $_->isa('Moose::Meta::Role::Composite') ? $_->calculate_all_roles : $_ } $attribute_metaclass->meta->calculate_all_roles_with_inheritance; } } $meta->app_attribute_metaroles_add(@extra_classes); } } $attributes{traits} ||= []; push(@{$attributes{traits}},$meta->app_attribute_metaroles_uniq); } $attributes{'cmd_type'} = $type; # Loop all attributes and check attribute traits foreach my $attr (@$attrs) { my %local_attributes = %attributes; if ($attr =~ m/^\+(.+)/) { my $meta_attribute = $meta->find_attribute_by_name($1); unless ($meta_attribute->does('MooseX::App::Meta::Role::Attribute::Option')) { $local_attributes{traits} ||= []; push @{$local_attributes{traits}},'MooseX::App::Meta::Role::Attribute::Option' unless (first { $_ eq 'AppOption' || $_ eq 'MooseX::App::Meta::Role::Attribute::Option' } @{$local_attributes{traits}}); } } $meta->add_attribute($attr, %local_attributes); } return; } sub app_prefer_commandline($) { my ( $meta, $value ) = @_; return $meta->app_prefer_commandline($value); } sub app_strict($) { my ( $meta, $value ) = @_; return $meta->app_strict($value); } sub app_fuzzy($) { my ( $meta, $value ) = @_; return $meta->app_fuzzy($value); } sub app_permute($) { my ( $meta, $value ) = @_; return $meta->app_permute($value); } sub app_base($) { my ( $meta, $name ) = @_; return $meta->app_base($name); } sub process_plugins { my ($self,$caller_class,@plugins) = @_; # Loop all requested plugins my @plugin_classes; foreach my $plugin (@plugins) { my $plugin_class = 'MooseX::App::Plugin::'.$plugin; # TODO eval plugin class Class::Load::load_class($plugin_class); push (@plugin_classes,$plugin_class); } # Store plugin spec $PLUGIN_SPEC{$caller_class} = \@plugin_classes; return; } sub process_init_meta { my ($self,%args) = @_; Moose->init_meta( %args ); my $plugins = $PLUGIN_SPEC{$args{for_class}} || []; my $apply_metaroles = delete $args{metaroles} || {}; my $apply_roles = delete $args{roles} || []; # Add plugin roles foreach my $plugin (@$plugins) { push(@{$apply_roles},$plugin,{ -excludes => [ 'plugin_metaroles' ] } ) } # Add common role push(@{$apply_roles},'MooseX::App::Role::Common') unless first { $_ eq 'MooseX::App::Role::Common' } @{$apply_roles}; # Process all plugins in the given order foreach my $plugin_class (@{$plugins}) { if ($plugin_class->can('plugin_metaroles')) { my ($metaroles) = $plugin_class->plugin_metaroles($args{for_class}); if (ref $metaroles eq 'HASH') { foreach my $type (keys %$metaroles) { $apply_metaroles->{$type} ||= []; push (@{$apply_metaroles->{$type}},@{$metaroles->{$type}}); } } } } # Add meta roles Moose::Util::MetaRole::apply_metaroles( for => $args{for_class}, class_metaroles => $apply_metaroles ); # Add class roles Moose::Util::apply_all_roles($args{for_class},@{$apply_roles}); # Init plugins foreach my $plugin_class (@{$plugins}) { if ($plugin_class->can('init_plugin')) { $plugin_class->init_plugin($args{for_class}); } } # Return meta my $meta = $args{for_class}->meta; return $meta; } sub command_short_description($) { my ( $meta, $description ) = @_; return $meta->command_short_description($description); } sub command_long_description($) { my ( $meta, $description ) = @_; return $meta->command_long_description($description); } sub command_usage($) { my ( $meta, $usage ) = @_; return $meta->command_usage($usage); } *app_description = \&command_long_description; *app_usage = \&command_usage; sub command_strict($) { my ( $meta, $value ) = @_; return $meta->command_strict($value); } 1; test_synopsis.pl100755000765000024 65314514737355 17712 0ustar00mkostaff000000000000MooseX-App-1.43/t/examplepackage MyApp { use MooseX::App qw(Term); }; package MyApp::SomeCommand { use 5.020; use MooseX::App::Command; extends qw(MyApp); option 'some_option' => ( is => 'rw', isa => 'Int', documentation => 'Something', cmd_term => 1, ); sub run { my ($self) = @_; say "Some option is ".$self->some_option; } }; MyApp->new_with_command->run; Role000755000765000024 014514737355 16003 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/AppBase.pm100644000765000024 505714514737355 17362 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Role# ============================================================================ package MooseX::App::Role::Base; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub initialize_command_class { my ($class,$command_class,%args) = @_; my $meta = $class->meta; Moose->throw_error('initialize_command_class is a class method') if blessed($class); my ($ok,$error) = Class::Load::try_load_class($command_class); unless ($ok) { Moose->throw_error($error); } my $command_meta = $command_class->meta || $meta; # Build MooseX::App::ParsedArgv and set hints my $parsed_argv = MooseX::App::ParsedArgv->instance(); my $hints = $meta->command_parser_hints($command_meta); $parsed_argv->hints_fixedvalue($hints->{fixedvalue}); $parsed_argv->hints_novalue($hints->{novalue}); if ($meta->app_permute) { $parsed_argv->hints_permute($hints->{permute}); } my ($proto_result,$proto_errors) = $meta->command_proto($command_meta); # TODO return some kind of null class object return unless defined $proto_result; my @errors = @{$proto_errors}; # Return user-requested help if ($proto_result->{help_flag}) { return MooseX::App::Message::Envelope->new( $meta->command_usage_command($command_class->meta), ); } my ($result,$errors) = $meta->command_args($command_meta); push(@errors,@{$errors}); my %params; if ($meta->app_prefer_commandline) { %params = ( %args, # configs passed to new %{ $proto_result }, # config params %{ $result }, # params from CLI ); } else { %params = ( %{ $proto_result }, # config params %{ $result }, # params from CLI %args, # configs passed to new ); } $meta->command_check_attributes($command_meta,\@errors,\%params); if (scalar @errors) { return MooseX::App::Message::Envelope->new( @errors, $meta->command_usage_command($command_meta), 1, # exitcode ); } my $command_object = $command_class->new( %params, extra_argv => [ $parsed_argv->extra ], ); if (scalar @errors) { return MooseX::App::Message::Envelope->new( @errors, $meta->command_usage_command($command_meta), 1, # exitcode ); } return $command_object; } 1;Tutorial.pod100644000765000024 2016314514737355 17573 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App=pod =head1 NAME MooseX::App::Tutorial - getting started with MooseX::App =head1 GETTING STARTED To create a simple command-line application with MooseX::App you need =over =item * A base class =item * Multiple command classes (unless you use L) =item * and an invocation script =back =head1 BASE CLASS The simplest possible base class just contains a single use statement which loads all roles and metaclasses you need to get started as well as Moose and hence strictures as well as warnings. package MyApp; use MooseX::App; 1; The base class can be customized by =over =item * adding MooseX-App plugins =item * changing the command-class namespace =item * defining global options/parameters used by all command classes (only if command classes inherit from the base class) =item * add documentation (either POD or via the app_usage and app_description functions) =item * and changing MooseX-App flags (eg. turn fuzzy matching off) =item * Adding Moose attribute documentation and type constraints. =back It is also possible to add global options and parameters to your base class and inherit your command classes from the base class (inheriting your command classes from your base class is purely optional). package MyApp; use MooseX::App qw(Config Color); # Loads the Config and Color plugin # This attribute will be available at the command line option 'some_global_option' => ( is => 'rw', isa => 'Str', required => 1, documentation => q[Some important global option], ); # This attribute will not be exposed has 'private_option' => ( is => 'rw', isa => 'Str', ); 1; When adding attributes make sure to include a documentation and possibly a type constraint. MooseX-App will use this information to build a user documentation for each attribute and command. The attribute documentation can be customized by providing additional options (see L) =head1 COMMAND CLASSES After you created a base class it is time to create one class for each command you want to provide (unless you are using L). The command classes must reside in the namespace of the base class (eg. 'MyApp::SomeCommand'). You can also deeply nest classes in the main namespace to create subcommand. The namespace for the command classes however can be changed via the 'app_namespace' function in the base class, or by simply registering command classes manually via 'app_command_register'. Use 'app_exclude' to exclude certain sub namespaces. All command classes must use MooseX::App::Command, which will also load Moose. package MyApp::SomeCommand; use MooseX::App::Command; If you want to use global options defined in the base class you can optionally extend the base class with your command class. package MyApp::SomeCommand; use MooseX::App::Command; extends qw(MyApp); To provide a description for each command you need to set the C, C and optionally C information. The command descriptions may contain linebreaks. command_short_description q[This command is awesome]; command_long_description q[This command is so awesome, yadda yadda yadda]; If not provided, MooseX-App will try to parse the command description from the POD. The NAME or ABSTRACT section will become the short description and the DESCRIPTION or OVERVIEW section the long description. The usage header can either be set by adding C command_usage q[script some_command --some_option NUMBER]; or by adding a SYNOPSIS or USAGE section to the module' POD. If neither command_usage nor SYNOPSIS/USAGE are set, then the usage header will be autogenerated. Attributes can be documented using the Moose built-in C option as well as C, C and C which are defined by MooseX-App (see L) option 'some_option' => ( is => 'rw', isa => 'Integer', required => 1, documentation => q[Some important option], cmd_tags => [qw(Important!)], # Extra tags. Displayed in square brackets cmd_aliases => [qw(any)], # Alternative option name cmd_flag => 'some', # Option should be called 'some' instead of 'some_option' ); It is also possible to define positional parameters with the 'parameter' keyword # This attribute will become a positional parameter parameter 'id' => ( is => 'rw', isa => 'Int', documentation => q[Some ID], required => 1, ); The help for this command would look something like this (with autogenerated usage headers): usage: my_app some_command [long options...] my_app help my_app some_command --help description: This command is awesome, yadda yadda yadda parameter: ID Some ID [Integer; Required] options: --config Path to command config file --some -s Some important option [Required; Integer; Important!] --help --usage -? Prints this usage information. [Flag] In case you want to include an attribute not defined with the 'option' or 'parameter' keyword (eg from a Role) you can use the 'AppOption' trait and 'cmd_type' attribute. (see L). has 'myoption' => ( is => 'rw', traits => ['AppOption'], # only required if not definded in base or command class cmd_type => 'option', # or 'parameter' ); Finally your command classes will need a method which should be called if the command is invoked by the user. sub run { my ($self) = @_; # do something } If you need to implement only a single command you should use L instead of L, and omit command classes. In this case of course you have to declare all options and implement the application logic in the base class: package MyApp; use MooseX::App::Simple qw(Config); # Loads the Config plugin option 'some_option' => ( is => 'rw', isa => 'Str', documentation => q[Some important option], ); sub run { my ($self) = @_; # do something } 1; =head1 INVOCATION SCRIPT Once you have the base and command classes ready, you need to write a small invocation script: #!/usr/bin/env perl use MyApp; MyApp->new_with_command->run(); Cnew_with_command> will try to instantiate a command class. If it fails it will return a L object possibly containing an error message and a usage message. Since L follows the Null object pattern you can call any method on it without checking the object type. Note that MooseX::App::Message::Envelope objects may also have an exitcode set. In this case whenever the object gets stringified, it prints on STDERR/STDOUT and exits the program using the specified exitcode. Don't use the ovleroaded stingification if you don't want this behaviour. You can also pass default/fallback values to the constructor #!/usr/bin/env perl use MyApp; MyApp->new_with_command( some_global_option => 'something' )->run(); If using L your invocation script needs some modification and call C instead of C. #!/usr/bin/env perl use MyApp; MyApp->new_with_options->run(); =head1 HOW TO CONTINUE Once you have a basic working application you can make it more user friendly by adding documentation (either by using the app_description, app_usage, command_short_description, ... functions or by writing POD), Moose type constraints and additional plugins (eg. colorise the output). Make sure to invoke your script with APP_DEVELOPER=1 during development. This will come with a starup penalty but perform additional checks for detecting wrong attribute/type constraint combinations, name clashes, ... If you want custom behaviour you could start writing your own L. =cutParsedArgv.pm100644000765000024 2422214514737355 17660 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App# ============================================================================ package MooseX::App::ParsedArgv; # ============================================================================ use 5.010; use utf8; use Moose; use Encode qw(decode); use MooseX::App::ParsedArgv::Element; use MooseX::App::ParsedArgv::Value; use List::Util qw(first); my $SINGLETON; has 'argv' => ( is => 'ro', isa => 'ArrayRef[Str]', traits => ['Array'], handles => { length_argv => 'count', elements_argv => 'elements', _shift_argv => 'shift', }, default => sub { my @argv; @argv = eval { require I18N::Langinfo; I18N::Langinfo->import(qw(langinfo CODESET)); my $codeset = langinfo(CODESET()); # TODO Not sure if this is the right place? if ($codeset =~ m/^UTF-?8$/i) { binmode(STDOUT, ":encoding(UTF-8)"); binmode(STDERR, ":encoding(UTF-8)"); } return map { decode($codeset,$_) } @ARGV; }; # Fallback to standard if ($@) { @argv = @ARGV; } return \@argv; }, ); has 'hints_novalue' => ( is => 'rw', isa => 'ArrayRef[Str]', default => sub { [] }, ); # No value hints for the parser (such as for flags) has 'hints_permute' => ( is => 'rw', isa => 'ArrayRef[Str]', default => sub { [] }, ); # Permute hints for the parser has 'hints_fixedvalue' => ( is => 'rw', isa => 'HashRef[Str]', default => sub { {} }, ); # fixed value hints for the parser has 'elements' => ( is => 'ro', isa => 'ArrayRef[MooseX::App::ParsedArgv::Element]', lazy => 1, builder => '_build_elements', clearer => 'reset_elements', ); sub BUILD { my ($self) = @_; # Register singleton $SINGLETON = $self; return $self; } sub DEMOLISH { my ($self) = @_; # Unregister singleton if it is stll the same $SINGLETON = undef if defined $SINGLETON && $SINGLETON == $self; return; } sub instance { my ($class) = @_; unless (defined $SINGLETON) { return $class->new(); } return $SINGLETON; } sub first_argv { my ($self) = @_; return ($self->elements_argv)[0]; } sub shift_argv { my ($self) = @_; $self->reset_elements; return $self->_shift_argv; } sub _build_elements { my ($self) = @_; my (@elements); my %options; my $lastkey; my $lastelement; my $stopprocessing = 0; # Flag that is set after ' -- ' and inticated end of processing my $position = 0; # Argument position my $expecting = 0; # Flag that indicates that a value is expected # Loop all elements of our ARGV copy foreach my $element ($self->elements_argv) { # We are behind first ' -- ' occurrence: Do not process further if ($stopprocessing) { push (@elements,MooseX::App::ParsedArgv::Element->new( key => $element, type => 'extra', )); # Process element } else { # Flags with only one leading dash (-h or -vh) if ($element =~ m/^-([^-][[:alnum:]]*)$/) { undef $lastkey; undef $lastelement; $expecting = 0; # Split into single letter flags foreach my $flag (split(//,$1)) { unless (defined $options{$flag}) { $options{$flag} = MooseX::App::ParsedArgv::Element->new( key => $flag, type => 'option', raw => $element, ); push(@elements,$options{$flag}); } $options{$flag}->add_value( 1, $position, $element, ); $lastkey = $options{$flag}; $lastelement = $element; } } # Key-value combined (--key=value) elsif ($element =~ m/^--([^-=][^=]+)=(.+)$/) { undef $lastkey; undef $lastelement; $expecting = 0; my ($key,$value) = ($1,$2); unless (defined $options{$key}) { $options{$key} = MooseX::App::ParsedArgv::Element->new( key => $key, type => 'option', raw => $element, ); push(@elements,$options{$key}); } $options{$key}->add_value( $value, $position, $element, ); } # Ordinary key elsif ($element =~ m/^--?([^-].+)/) { my $key = $1; unless (defined $options{$key} ) { $options{$key} = MooseX::App::ParsedArgv::Element->new( key => $key, type => 'option', raw => $element, ); push(@elements,$options{$key}); } # This is a boolean or counter key that does not expect a value if (first {$key eq $_} @{$self->hints_novalue}) { $options{$key}->add_value( ($self->hints_fixedvalue->{$key} // 1), $position, $element ); $expecting = 0; # We are expecting a value } else { $expecting = 1; $lastelement = $element; $lastkey = $options{$key}; } } # Extra values - stop processing after this token elsif ($element eq '--') { undef $lastkey; undef $lastelement; $stopprocessing = 1; $expecting = 0; } # Value else { if (defined $lastkey) { # This is a parameter - last key was a flag if (first {$lastkey->key eq $_} @{$self->hints_novalue}) { push(@elements,MooseX::App::ParsedArgv::Element->new( key => $element, type => 'parameter' )); undef $lastkey; undef $lastelement; $expecting = 0; # Permute values } elsif (first {$lastkey->key eq $_} @{$self->hints_permute}) { $expecting = 0; $lastkey->add_value( $element, $position, $lastelement ); # Has value } else { $expecting = 0; $lastkey->add_value($element,$position); undef $lastkey; undef $lastelement; } } else { push(@elements,MooseX::App::ParsedArgv::Element->new( key => $element, type => 'parameter' )); } } } $position++; } # Fill up last value if (defined $lastkey && $expecting) { $lastkey->add_value(undef,$position,$lastelement); $position++; } return \@elements; } sub available { my ($self,$type) = @_; my @elements; foreach my $element (@{$self->elements}) { next if $element->consumed; next if defined $type && $element->type ne $type; push(@elements,$element); } return @elements; } sub consume { my ($self,$type) = @_; foreach my $element (@{$self->elements}) { next if $element->consumed; next if defined $type && $element->type ne $type; $element->consume; return $element; } return; } sub extra { my ($self) = @_; my @extra; foreach my $element (@{$self->elements}) { next if $element->consumed; next unless $element->type eq 'parameter' || $element->type eq 'extra'; push(@extra,$element->key); } return @extra; } __PACKAGE__->meta->make_immutable; 1; __END__ =pod =head1 NAME MooseX::App::ParsedArgv - Parses @ARGV =head1 SYNOPSIS use MooseX::App::ParsedArgv; my $argv = MooseX::App::ParsedArgv->instance; foreach my $option ($argv->available('option')) { say "Parsed ".$option->key; } =head1 DESCRIPTION This is a helper class that holds all options parsed from @ARGV. It is implemented as a singleton. Unless you are developing a MooseX::App plugin you usually do not need to interact with this class. =head1 METHODS =head2 new Create a new MooseX::App::ParsedArgv instance. Needs to be called as soon as possible. =head2 instance Get the current MooseX::App::ParsedArgv instance. If there is no instance a new one will be created. =head2 argv Accessor for the initinal @ARGV. =head2 hints ArrayRef of attributes that tells the parser which attributes should be regarded as flags without values. =head2 first_argv Shifts the current first element from @ARGV. =head2 available my @options = $self->available($type); OR my @options = $self->available(); Returns an array of all parsed options or parameters that have not yet been consumed. The array elements will be L objects. =head2 consume my $option = $self->consume($type); OR my $option = $self->consume(); Returns the first option/parameter of the local @ARGV that has not yet been consumed as a L object. =head2 elements Returns all parsed options and parameters. =head2 extra Returns an array reference of unconsumed positional parameters and extra values. =cut Plugin000755000765000024 014514737355 16340 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/AppEnv.pm100644000765000024 62514514737355 17551 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Env; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; warn "MooseX::App Env plugin is deprecated. Functionality moved to core"; return; } 1;Man.pm100644000765000024 177414514737355 17562 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Man; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Man::Meta::Class'], } } around 'initialize_command_class' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); if (blessed $return && $return->isa('MooseX::App::Plugin::Man::Command')) { return $return->man($self); } return $return; }; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Man - Adds a command to display the full manual =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Man); In your shell bash$ myapp man somecommand =head1 DESCRIPTION This plugin adds a command to display the full manpage/perldoc of your application. =cut Test01000755000765000024 014514737355 15373 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlibCommandA.pm100644000765000024 176414514737355 17560 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test01package Test01::CommandA; use Moose; use MooseX::App::Command; extends qw(Test01); option 'command_local1' => ( isa => 'Int', is => 'rw', documentation => 'some docs about the long texts that seem to occur randomly', cmd_tags => [qw(Important)], cmd_env => 'LOCAL1', ); option 'command_local2' => ( isa => 'Str', is => 'rw', documentation => q[Verylongwordwithoutwhitespacestotestiftextformatingworksproperly], cmd_env => 'LOCAL2', ); has 'anotherprivate' => ( is => 'rw', isa => 'Str', ); command_long_description "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras dui velit, varius nec iaculis vitae, elementum eget mi. * bullet1 * bullet2 * bullet3 Cras eget mi nisi. In hac habitasse platea dictumst."; command_short_description "Command A!"; sub run { my ($self) = @_; print "RUN COMMAND-A:".($self->command_local2 // 'undef'); } 1;CommandB.pm100644000765000024 160114514737355 17547 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test01package Test01::CommandB; use Moose; use MooseX::App::Command; extends qw(Test01); use Moose::Util::TypeConstraints; has 'param_a' => ( isa => 'Str', is => 'rw', ); option 'param_b' => ( isa => enum([qw(aaa bbb ccc ddd eee fff)]), is => 'rw', required => 1, ); sub run { print "RUN COMMAND-B"; } =encoding utf8 =head1 NAME Test01::CommandB - Test class command B for test 01 =head1 SYNOPSIS use with care =head1 DESCRIPTION Some description of B some code some code =head2 SUB HEADLINE some more desc =over =item * item 1 =item * item 2 =over =item * item 2.1 =item * item 2.2 =back =back hase ist so super and this is a very long sentence witch breaks after i have written some bla bla. another interesting paragraph. =head1 METHODS hase =head2 SUB A bär =head1 SUB B some methods =cut 1;CommandD.pm100644000765000024 160214514737355 17552 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test01package Test01::CommandD; use Moose; use MooseX::App::Command; extends qw(Test01); use Moose::Util::TypeConstraints; subtype 'ArrayRefOfInts', as 'ArrayRef[Int]'; coerce 'ArrayRefOfInts', from 'Int', via { [ $_ ] }; option 'command_local1' => ( isa => 'ArrayRefOfInts', coerce => 1, is => 'rw', documentation => 'some docs about the long texts that seem to occur randomly', cmd_tags => [qw(Important)], cmd_env => 'LOCAL1', ); command_long_description "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras dui velit, varius nec iaculis vitae, elementum eget mi. * bullet1 * bullet2 * bullet3 Cras eget mi nisi. In hac habitasse platea dictumst."; command_short_description "Command A!"; sub run { my ($self) = @_; print "RUN COMMAND-D:".($self->command_local1 // 'undef'); } 1;Test06000755000765000024 014514737355 15400 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlibCommandA.pm100644000765000024 126014514737355 17554 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test06package Test06::CommandA; use Moose; use MooseX::App::Command; extends qw(Test06); use Moose::Util::TypeConstraints; subtype 'Test06::local2' => as 'Str' => where { $_ =~ /^[aA]/ }; #=> message { "Must start with an 'A'" }; no Moose::Util::TypeConstraints; option 'command_local2' => ( isa => 'Test06::local2', is => 'rw', documentation => q[Verylongwordwithoutwhitespacestotestiftextformatingworksproperly], cmd_env => 'LOCAL2', ); sub run { my ($self) = @_; print "NEW WITH A"; ref($self)->initialize_command_class('Test06::CommandB')->run; #$self->initialize_command_class('Test06::CommandB'); } 1;CommandB.pm100644000765000024 32214514737355 17533 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test06package Test06::CommandB; use Moose; #use MooseX::App::Command; extends qw(Test06); has 'email' => ( isa => 'Str', is => 'rw', ); sub run { my ($self) = @_; warn $self; } 1;CommandD.pm100644000765000024 64314514737355 17543 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test06package Test06::CommandD; use Moose; use MooseX::App::Command; extends qw(Test06); option 'list' => ( isa => 'ArrayRef[Str]', is => 'rw', ); option 'hash' => ( isa => 'HashRef[Str]', is => 'rw', ); sub run { my ($self) = @_; use Data::Dumper; { local $Data::Dumper::Maxdepth = 2; warn __FILE__.':line'.__LINE__.':'.Dumper($self); } } 1;Term.pm100644000765000024 310714514737355 17746 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Term; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Term::Meta::Class'], attribute => ['MooseX::App::Plugin::Term::Meta::Attribute'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Term - Allows one to specify options/parameters via terminal prompts =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Term); In your command class: package MyApp::SomeCommand; use MooseX::App::Command; option 'some_option' => ( is => 'rw', isa => 'Int', documentation => 'Something', cmd_term => 1, ); sub run { my ($self) = @_; say "Some option is ".$self->some_option; } In your shell bash$ myapp some_command Something (Required, an integer): test Value must be an integer (not 'test') 1 Some option is 1 =head1 DESCRIPTION This plugin can prompt the user for missing options/parameters on the terminal. The user will only be promted if the parameter were not provided by different means (parameter and option or config files and environment values if the respectice plugins have been loaded before this plugin) and if the script is connected to an interactive terminal. Term input has basic editing capabilities (cursor, del, backspace and history) =cut Typo.pm100644000765000024 137114514737355 17773 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Typo; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Typo::Meta::Class'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Typo - Handle typos in command names =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Typo); In your shell bash$ myapp pusl Ambiguous command 'pusl' Which command did you mean? * push * pull =head1 DESCRIPTION This plugin tries to handle typos in command names =cutCommon.pm100644000765000024 126714514737355 17737 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Role# ============================================================================ package MooseX::App::Role::Common; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; has extra_argv => ( is => 'rw', isa => 'ArrayRef', ); has 'help_flag' => ( is => 'ro', isa => 'Bool', traits => ['MooseX::App::Meta::Role::Attribute::Option'], cmd_flag => 'help', cmd_aliases => [ qw(h usage ?) ], # LOCALIZE cmd_type => 'proto', cmd_position => 99999, documentation => 'Prints this usage information.', # LOCALIZE ); 1;CommandC1.pm100644000765000024 40114514737355 17606 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test01package Test01::CommandC1 ; use Moose; use MooseX::App::Command; extends qw(Test01); option 'param_internal_name' => ( isa => 'Str', is => 'rw', cmd_flag => 'external_name', required => 1, ); # ABSTRACT: Test C1 1;Color.pm100644000765000024 124214514737355 20113 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Color; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Color::Meta::Class'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Color - Colorful output for your MooseX::App applications =head1 SYNOPSIS package MyApp; use MooseX::App qw(Color); =head1 DESCRIPTION This plugin enables colors for messages generated by MooseX::App. =cutFuzzy.pm100644000765000024 62014514737355 20143 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Fuzzy; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; warn "MooseX::App Fuzzy plugin is deprecated. Use Typo instead"; return; } 1; Test03CommandBase.pm100644000765000024 54114514737355 20145 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib# ============================================================================ package Test03CommandBase; # ============================================================================ use utf8; use namespace::autoclean; use Moose; has 'private' => ( is => 'rw', isa => 'Str', ); __PACKAGE__->meta->make_immutable; 1;Message000755000765000024 014514737355 16466 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/AppBlock.pm100644000765000024 255714514737355 20227 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Message# ============================================================================ package MooseX::App::Message::Block; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; use MooseX::App::Utils; use overload '""' => "stringify"; has 'header' => ( is => 'ro', isa => 'MooseX::App::Types::MessageString', predicate => 'has_header', ); has 'type' => ( is => 'ro', isa => 'Str', default => sub {'default'}, ); has 'body' => ( is => 'ro', isa => 'MooseX::App::Types::MessageString', predicate => 'has_body', ); sub stringify { my ($self) = @_; my $message = ''; $message .= $self->header."\n" if $self->has_header; $message .= $self->body."\n\n" if $self->has_body; return $message; } __PACKAGE__->meta->make_immutable; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Message::Block - Message block =head1 DESCRIPTION A simple message block with a header and body =head1 METHODS =head2 header Read/set a header string =head2 has_header Check if a header is set =head2 body Read/set a body string =head2 has_body Check if a body is set =head2 type Read/set an arbitrary block type. Defaults to 'default' =head2 stringify Stringify a message blockConfig.pm100644000765000024 334614514737355 20251 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Config; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use MooseX::App::Role; use Config::Any; has 'config' => ( is => 'ro', predicate => 'has_config', documentation => q[Path to command config file], traits => ['MooseX::App::Meta::Role::Attribute::Option'], cmd_type => 'proto', cmd_position => 99990, ); has '_config_data' => ( is => 'ro', isa => 'HashRef', predicate => 'has_config_data', ); sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Config::Meta::Class'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Config - Config files your MooseX::App applications =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Config); option 'global_option' => ( is => 'rw', isa => 'Int', ); In your command class: package MyApp::Some_Command; use MooseX::App::Command; extends qw(MyApp); option 'some_option' => ( is => 'rw', isa => 'Str', ); Now create a config file (see L) eg. a yaml file: --- global: global_option: 123 some_command: global_option: 234 some_option: "hello world" The user can now call the program with a config file: bash$ myapp some_command --config /path/to/config.yml =head1 METHODS =head2 config Read the config filename =head2 _config_data The full content of the loaded config file =head1 SEE ALSO L =cut Test03000755000765000024 014514737355 15375 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlibSomeCommand.pm100644000765000024 166514514737355 20305 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::SomeCommand; use MooseX::App::Command; extends qw(Test03); with qw(Test03::Role::TestRole); use Moose::Util::TypeConstraints; parameter 'param_a' => ( is => 'rw', isa => 'Str', ); parameter 'param_b' => ( is => 'rw', isa => enum([qw(aaa bbb ccc ddd eee fff)]), ); option 'some_option' => ( is => 'rw', isa => 'Str', documentation => q[Very important option!], ); option 'another_option' => ( is => 'rw', isa => 'Str', required => 1, cmd_flag => 'another', cmd_tags => ['Not important'], ); option 'list' => ( is => 'rw', isa => 'ArrayRef[Maybe[Str]]', ); has 'private' => ( is => 'rw', isa => 'Str', ); sub run { my ($self) = @_; print "RUN:".($self->some_option||'').":".($self->another_option||''); } 1;Depends.pm100644000765000024 250214514737355 20417 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Pluginpackage MooseX::App::Plugin::Depends; use Moose::Role; use namespace::autoclean; sub plugin_metaroles { my ($self, $class) = @_; return { attribute => ['MooseX::App::Plugin::Depends::Meta::Attribute'], class => ['MooseX::App::Plugin::Depends::Meta::Class'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Depends - Adds dependent options =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Depends); use Moose::Util::TypeConstraints; option 'FileFormat' => ( is => 'ro', isa => enum( [qw(tsv csv xml)] ), ); option 'WriteToFile' => ( is => 'ro', isa => 'Bool', depends => [qw(FileFormat)], ); In your script: #!/usr/bin/env perl use strict; use warnings; use MyApp; MyApp->new_with_options( WriteToFile => 1 ); # generates Error # Option 'WriteToFile' requires 'FileFormat' to be defined MyApp->new_with_options( WriteToFile => 1, FileFormat => 'tsv ); # generates no errors MyApp->new_with_options(); # generates no errors =head1 DESCRIPTION In many real-world scenarios, sets of options are, by design, needed to be specified together. This plugin adds the ability to create dependent options to your application, options that require one or more other options for your application to perform properly. =cut Version.pm100644000765000024 254414514737355 20470 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::Version; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::Version::Meta::Class'], } } around 'initialize_command_class' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); if (blessed $return && $return->isa('MooseX::App::Plugin::Version::Command')) { return $return->version($self); } return $return; }; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::Version - Adds a command to display the version and license of your application =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(Version); In your shell bash$ myapp version VERSION MyApp version 2.1 MooseX::App version 1.08 Perl version 5.16.2 LICENSE This library is free software and may be distributed under the same terms as perl itself. =head1 DESCRIPTION This plugin adds a command to display the version of your application, MooseX::App and perl. Furthermore it tries to parse the Pod of the base class and extract LICENSE, AUTHOR and COPYRIGHT sections =cut ExtraCommand.pm100644000765000024 153114514737355 20455 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::ExtraCommand; use MooseX::App::Command; parameter 'extra1' => ( is => 'rw', isa => 'Str', required => 1, documentation => q[Important extra parameter], ); parameter 'extra2' => ( is => 'rw', isa => 'Int', ); parameter 'alpha' => ( is => 'rw', isa => 'Int', ); option 'value' => ( is => 'rw', isa => 'Str', required => 1, default => sub { return "hase" }, ); option 'flag' => ( is => 'rw', isa => 'Bool', ); option 'flaggo' => ( is => 'rw', isa => 'Bool', ); sub run { my ($self) = @_; use Data::Dumper; { local $Data::Dumper::Maxdepth = 2; warn __FILE__.':line'.__LINE__.':'.Dumper($self); } } 1; WritingPlugins.pod100644000765000024 331014514737355 20730 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App=encoding utf8 =pod =head1 NAME MooseX::App::WritingPlugins - Writing plugins for MooseX::App =head1 SYNOPSIS package MooseX::App::Plugin::MyPlugin; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::MyPlugin::Meta::Class'], } } around 'initialize_command_class' => sub { ... }; =head1 DESCRIPTION Plugins are implemented as Moose roles and must reside in the MooseX::App::Plugin::* namespace. Metaclasses can be altered via the 'plugin_metaroles' callback method. Furthermore Moose method modifiers (around, after, before) can be used to alter the behaviour of MooseX::App or its meta classes. =head1 CALLBACKS =head2 plugin_metaroles Optional callback method that should return a hash reference specifying which metaroles will be applied to the class metaclass and its contained metaclasses and helper classes. Each key should in turn point to an array reference of role names. It accepts the following keys: =over =item * class =item * attribute =item * method =item * wrapped_method =item * instance =item * constructor =item * destructor =item * error =back =head1 METACLASSES Most of MooseX-App behaviour is implemented in metaclass roles. When writing plugins you will most likely need to alter/augument the behaviour of these roles. Implementation details can be found in the respective packages. =over =item * L is applied to the base metaclass =item * L is applied to the command metaclass =item * L is applied to all attributes in the base and command meta classes =back =cut Command000755000765000024 014514737355 16752 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02Error.pm100644000765000024 53314514737355 20522 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02/Commandpackage Test02::Command::Error; use Moose; use MooseX::App::Command; extends qw(Test02); sub BUILD { warn('XXX'); exit 25; } sub run { warn('YYY'); exit 77; } command_usage "Use me not"; command_long_description "A very long description about a command that will always fail"; command_short_description "Short description"; 1;BrokenCommand.pm100644000765000024 54114514737355 20572 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::BrokenCommand; use MooseX::App::Command; option 'conflict1' => ( is => 'rw', isa => 'Bool', cmd_flag => 'conflict', ); option 'conflict2' => ( is => 'rw', isa => 'Bool', cmd_flag => 'conflict', default => 1, ); sub run { my ($self) = @_; } 1;Role000755000765000024 014514737355 16276 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03TestRole.pm100644000765000024 71014514737355 20513 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03/Role# ============================================================================ package Test03::Role::TestRole; # ============================================================================ use utf8; use namespace::autoclean; use MooseX::App::Role; option 'roleattr' => ( is => 'rw', isa => 'Str', cmd_tags => ['Role'], ); parameter 'param_c' => ( is => 'rw', isa => 'Str', ); 1;Envelope.pm100644000765000024 765114514737355 20752 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Message# ============================================================================ package MooseX::App::Message::Envelope; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; use MooseX::App::Message::Block; use overload '""' => "overload"; has 'blocks' => ( is => 'ro', isa => 'ArrayRef[MooseX::App::Message::Block]', traits => ['Array'], handles => { add_block => 'push', list_blocks => 'elements', }, ); has 'exitcode' => ( is => 'ro', isa => 'Int', predicate => 'has_exitcode', ); around 'BUILDARGS' => sub { my $orig = shift; my $self = shift; my @args = @_; my $params; if (scalar @args == 1 && ref($args[0]) eq 'HASH') { $params = $args[0]; } else { $params = { blocks => [], }; my @blocks; foreach my $element (@args) { next unless defined $element; if (blessed $element && $element->isa('MooseX::App::Message::Block')) { push(@{$params->{blocks}},$element); } elsif ($element =~ /^\d+$/ && $element <= 255 && $element >= 0) { $params->{exitcode} = $element; } else { push(@{$params->{blocks}},MooseX::App::Message::Block->new( header => $element, )); } } } return $self->$orig($params); }; sub overload { my ($self) = @_; if ($self->has_exitcode) { my $exitcode = $self->exitcode; if ($exitcode == 0) { print $self->stringify; } else { print STDERR $self->stringify; } exit $exitcode; } else { print $self->stringify; } return; } sub stringify { my ($self) = @_; my $message = ''; foreach my $block ($self->list_blocks) { $message .= $block->stringify; } return $message; } sub AUTOLOAD { my ($self) = @_; $self->overload; return $MooseX::App::Null::NULL; } { package MooseX::App::Null; use strict; use warnings; use overload 'bool' => sub { 0 }, '""' => sub { '' }, '0+' => sub { 0 }; our $NULL = bless {}, __PACKAGE__; sub AUTOLOAD { return $NULL } } __PACKAGE__->meta->make_immutable; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Message::Envelope - Message presented to the user =head1 DESCRIPTION Whenever MooseX::App needs to pass a message to the user, it does so by generating a MooseX::App::Message::Envelope object. The object usually contains one or more blocks (L) and can be easily stringified. Usually a MooseX::App::Message::Envelope object is generated and returned by the L if there is an error or if the user requests help. To avoid useless object type checks when working with this method, MooseX::App::Message::Envelope follows the Null-class pattern. So you can do this, no matter if new_with_command fails or not: MyApp->new_with_command->some_method->only_called_if_successful; If =head1 METHODS =head2 stringify Stringifies the messages =head2 overload This method is called whenever the object is stringified via overload. In this case it prints the message on either STDERR or STDOUT, and exits the process with the given exitcode (if any). =head2 add_block Adds a new message block. Param must be a L =head2 list_blocks Returns a list on message blocks. =head2 blocks Message block accessor. =head2 exitcode Exitcode accessor. =head2 has_exitcode Check if exitcode is set. =head2 OVERLOAD Stringification of this object is overloaded. =head2 AUTOLOAD You can call any method on the message class. ParsedArgv000755000765000024 014514737355 17140 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/AppValue.pm100644000765000024 154414514737355 20716 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/ParsedArgv# ============================================================================ package MooseX::App::ParsedArgv::Value; # ============================================================================ use 5.010; use utf8; use Moose; has 'raw' => ( is => 'ro', isa => 'Str', predicate => 'has_raw', ); has 'value' => ( is => 'ro', required => 1, ); has 'position' => ( is => 'ro', isa => 'Int', default => 999, ); __PACKAGE__->meta->make_immutable(); 1; =pod =head1 NAME MooseX::App::ParsedArgv::Value - Parsed value from @ARGV =head1 DESCRIPTION Every instance of this class represents a value from @ARGV =head1 METHODS =head2 key Parameter value or option key =head2 value Scalar value =head2 raw Raw value as supplied by the user =cutRecord.pm100644000765000024 13714514737355 20647 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02/Commandpackage Test02::Command::Record; use Moose; use MooseX::App::Command; extends qw(Test02); 1;AnotherCommand.pm100644000765000024 217714514737355 21001 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::AnotherCommand; use MooseX::App::Command; extends qw(Test03CommandBase); use Moose::Util::TypeConstraints; subtype 'Test03::Type::Custom1', as 'Int', where { $_ > 10 }, message { "Must be greater than 10" }; subtype 'Test03::Type::Custom2', as 'ScalarRef'; coerce 'Test03::Type::Custom2', from 'Str', via { \$_ }; no Moose::Util::TypeConstraints; option 'hash' => ( is => 'rw', isa => 'HashRef', ); option 'integer' => ( is => 'rw', isa => 'Int', ); option 'number' => ( is => 'rw', isa => 'Num', ); option 'custom1' => ( is => 'rw', isa => 'Test03::Type::Custom1', ); option 'custom2' => ( is => 'rw', isa => 'Test03::Type::Custom2', coerce => 1, ); option 'split' => ( is => 'rw', isa => 'ArrayRef[Str]', cmd_split => qr/;/i, ); option 'count' => ( is => 'rw', cmd_count => 1, ); option ['extra1','extra2'] => ( is => 'rw', ); sub run { my ($self) = @_; } 1;ConfigHome.pm100644000765000024 162714514737355 21062 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::ConfigHome; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; with qw(MooseX::App::Plugin::Config); sub plugin_metaroles { my ($self,$class) = @_; return { class => [ 'MooseX::App::Plugin::Config::Meta::Class', 'MooseX::App::Plugin::ConfigHome::Meta::Class' ], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::ConfigHome - Config files in users home directory =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(ConfigHome); =head1 DESCRIPTION Works just like L but assumes that the config file always resides in the user's home directory. ~/.${app-base}/config.(yml|xml|ini|...) =cutMutexGroup.pm100644000765000024 312714514737355 21160 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Pluginpackage MooseX::App::Plugin::MutexGroup; use Moose::Role; use namespace::autoclean; sub plugin_metaroles { my ($self, $class) = @_; return { attribute => ['MooseX::App::Plugin::MutexGroup::Meta::Attribute'], class => ['MooseX::App::Plugin::MutexGroup::Meta::Class'], } } 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::MutexGroup - Adds mutually exclusive options =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(MutexGroup); option 'UseAmmonia' => ( is => 'ro', isa => 'Bool', mutexgroup => 'NonMixableCleaningChemicals', ); option 'UseChlorine' => ( is => 'ro', isa => 'Bool', mutexgroup => 'NonMixableCleaningChemicals' ); In your script: #!/usr/bin/env perl use strict; use warnings; use MyApp; MyApp->new_with_options( UseAmmonia => 1, UseChlorine => 1 ); # generates Error # More than one attribute from mutexgroup NonMixableCleaningChemicals('UseAmmonia','UseChlorine') *cannot* be specified MyApp->new_with_options(); # generates Error # One attribute from mutexgroup NonMixableCleaningChemicals('UseAmmonia','UseChlorine') *must* be specified MyApp->new_with_options( UseAmmonia => 1 ); # generates no errors MyApp->new_with_options( UseChlorine => 1 ); # generates no errors =head1 DESCRIPTION This plugin adds mutually exclusive options to your application. In the current implementation, all defined MutexGroups *must* have exactly one initialized option. This means that there is an implicit requiredness of one option from each MutexGroup. =cut BlockColor.pm100644000765000024 251114514737355 21214 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Message# ============================================================================ package MooseX::App::Message::BlockColor; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; extends qw(MooseX::App::Message::Block); use Term::ANSIColor qw(); use IO::Interactive qw(is_interactive); BEGIN { if ($^O eq 'MSWin32') { Class::Load::try_load_class('Win32::Console::ANSI'); } }; sub stringify { my ($self) = @_; my $header_color; my $body_color; my $type = $self->type; if($type eq 'error') { $header_color = 'bright_red bold'; $body_color = 'bright_red'; } elsif($type eq 'default') { $header_color = 'bold'; } else { $header_color = $type; } my $message = ''; if ($self->has_header) { $message .= $self->_wrap_color($header_color,$self->header)."\n"; } if ($self->has_body) { $message .= $self->_wrap_color($body_color,$self->body)."\n\n"; } return $message; } sub _wrap_color { my ($self,$color,$string) = @_; return $string unless is_interactive() && defined $color; return Term::ANSIColor::color($color) .$string .Term::ANSIColor::color('reset'); } __PACKAGE__->meta->make_immutable; 1; Element.pm100644000765000024 643514514737355 21237 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/ParsedArgv# ============================================================================ package MooseX::App::ParsedArgv::Element; # ============================================================================ use 5.010; use utf8; use Moose; has 'key' => ( is => 'ro', isa => 'Str', required => 1, ); has 'value' => ( is => 'ro', isa => 'ArrayRef[MooseX::App::ParsedArgv::Value]', traits => ['Array'], default => sub { [] }, handles => { push_value => 'push', count_values => 'count', list_values => 'elements', } ); has 'consumed' => ( is => 'rw', isa => 'Bool', default => sub {0}, ); has 'type' => ( is => 'ro', isa => 'Str', required => 1, ); sub original { my ($self) = @_; # TODO fixthis if ($self->count_values && $self->value->[-1]->has_raw) { return $self->value->[-1]->has_raw; } else { return $self->key; } } sub add_value { my ($self,$value,$position,$raw) = @_; $self->push_value(MooseX::App::ParsedArgv::Value->new( value => $value, (defined $position ? (position => $position):()), (defined $raw ? (raw => $raw):()), )); return $value; } sub all_scalar_values { ## no perlcritic(RequireArgUnpacking) return map { $_->value } $_[0]->all_values; } sub all_values { ## no perlcritic(RequireArgUnpacking) return sort { $a->position <=> $b->position } $_[0]->list_values; } sub last_value { my ($self) = @_; return ($self->all_values)[-1]; } sub consume { my ($self,$attribute) = @_; Moose->throw_error('Element '.$self->type.' '.$self->key.' is already consumed') if $self->consumed; $self->consumed(1); return $self; } sub serialize { my ($self) = @_; my $type = $self->type; if ($type eq 'extra') { return $self->key; } elsif ($type eq 'parameter') { return $self->key; } elsif ($type eq 'option') { my $key = (length $self->key == 1 ? '-':'--').$self->key; return join(' ',map { $key.' '.$_->value } $self->all_values); } return; } __PACKAGE__->meta->make_immutable(); 1; =pod =head1 NAME MooseX::App::ParsedArgv::Element - Parsed logical element from @ARGV =head1 DESCRIPTION Every instance of this class represents a logical entity from @ARGV =head1 METHODS =head2 key Parameter value or option key =head2 value Arrayref of values. A value is represented by a L object. =head2 add_value Append a value =head2 all_scalar_values All values as scalars (in supplied order) =head2 all_values All values as L objects (in supplied order) =head2 last_value Last value as L object (as given by supplied order) =head2 type Type of element. Can be 'option', 'parameter' or 'extra' =head2 consumed Flag that indicates if element was already consumed =head2 consume Consumes element. Dies if element is already consumed =head2 serialize Serializes element (Does not procuce output that is identical with original @ARGV) =head2 original Tries to re-create the original input =cutMan000755000765000024 014514737355 17053 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/PluginCommand.pm100644000765000024 257114514737355 21134 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Man# ============================================================================ package MooseX::App::Plugin::Man::Command; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; use MooseX::App::Command; use Pod::Perldoc; command_short_description q(Full manpage); has 'command' => ( is => 'ro', isa => 'ArrayRef', predicate => 'has_command', documentation => q[Command], traits => ['MooseX::App::Meta::Role::Attribute::Option'], cmd_type => 'parameter', cmd_position => 1, ); sub man { my ($self,$app) = @_; my $meta = $app->meta; my $class; if ($self->has_command) { my $return = $meta->command_find($self->command); # Nothing found if (blessed $return && $return->isa('MooseX::App::Message::Block')) { return MooseX::App::Message::Envelope->new( $return, $meta->command_usage_command($self->meta), ); } $class = $meta->command_get($return); } else { $class = $meta->name; } Class::Load::load_class($class); my $filename = MooseX::App::Utils::package_to_filename($class); exec('perldoc',$filename); #return $MooseX::App::Null::NULL; } __PACKAGE__->meta->make_immutable; 1;Required.pm100644000765000024 56114514737355 21212 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02/Commandpackage Test02::Command::Required; use Moose; use MooseX::App::Command; extends qw(Test02); option 'local1' => ( isa => 'Int', is => 'rw', required => 1, cmd_term => 1, ); option 'local2' => ( isa => 'Bool', is => 'rw', default => 1, cmd_term => 1, ); 1;DifferentCommand.pm100644000765000024 111214514737355 21273 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::DifferentCommand; use MooseX::App::Command; extends qw(Test03CommandBase); option 'hash' => ( is => 'rw', isa => 'HashRef', ); option 'integer' => ( is => 'rw', isa => 'Int', ); option 'list' => ( is => 'rw', isa => 'ArrayRef', ); option 'string' => ( is => 'rw', isa => 'Str', ); sub run { my ($self) = @_; use Data::Dumper; { local $Data::Dumper::Maxdepth = 2; warn __FILE__.':line'.__LINE__.':'.Dumper($self); } } 1;MoreCommands000755000765000024 014514737355 17760 5ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02Test.pm100644000765000024 111514514737355 21373 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test02/MoreCommands# ============================================================================ package Test02::MoreCommands::Test; # ============================================================================ use strict; use warnings; use utf8; use Moose; use MooseX::App::Command; extends qw(Test02); use Moose::Util::TypeConstraints; parameter 'first' => ( isa => enum([qw(a1 b2 b3)]), is => 'rw', required => 1, cmd_term => 1, ); option 'second' => ( isa => 'Int', is => 'rw', cmd_term => 1, ); 1;YetAnotherCommand.pm100644000765000024 146314514737355 21460 0ustar00mkostaff000000000000MooseX-App-1.43/t/testlib/Test03package Test03::YetAnotherCommand; use MooseX::App::Command; extends qw(Test03CommandBase); with qw(MooseX::App::Role::Common); option 'bool1' => ( is => 'rw', isa => 'Bool', cmd_flag => 'a', ); option 'bool2' => ( is => 'rw', isa => 'Bool', cmd_flag => 'b', default => 1, ); option 'bool3' => ( is => 'rw', isa => 'Bool', required => 1, cmd_negate => ['no-bool3'], ); option 'value' => ( is => 'rw', isa => 'Str', required => 1, default => sub { return "hase" }, ); sub run { my ($self) = @_; use Data::Dumper; { local $Data::Dumper::Maxdepth = 2; warn __FILE__.':line'.__LINE__.':'.Dumper($self); } } 1;Class000755000765000024 014514737355 17736 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/RoleBase.pm100644000765000024 10343514514737355 21354 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/Role/Class# ============================================================================ package MooseX::App::Meta::Role::Class::Base; # ============================================================================ use utf8; use 5.010; use List::Util qw(max first); use namespace::autoclean; use Moose::Role; use MooseX::App::Utils; use Module::Pluggable::Object; use File::Basename qw(); has 'app_messageclass' => ( is => 'rw', isa => 'ClassName', lazy => 1, builder => '_build_app_messageclass', ); has 'app_namespace' => ( is => 'rw', isa => 'MooseX::App::Types::List', coerce => 1, lazy => 1, builder => '_build_app_namespace', ); has 'app_exclude' => ( is => 'rw', isa => 'MooseX::App::Types::List', coerce => 1, default => sub { [] }, ); has 'app_base' => ( is => 'rw', isa => 'Str', lazy => 1, default => sub { return File::Basename::basename($0); }, ); has 'app_strict' => ( is => 'rw', isa => 'Bool', default => sub {0}, ); has 'app_fuzzy' => ( is => 'rw', isa => 'Bool', default => sub {1}, ); has 'app_command_name' => ( is => 'rw', isa => 'CodeRef', default => sub { \&MooseX::App::Utils::class_to_command }, ); has 'app_prefer_commandline' => ( is => 'rw', isa => 'Bool', default => sub {0}, ); has 'app_permute' => ( is => 'rw', isa => 'Bool', default => sub {0}, ); has 'app_commands' => ( is => 'rw', isa => 'HashRef[Str]', traits => ['Hash'], handles => { command_register => 'set', command_get => 'get', command_classes => 'values', command_list => 'shallow_clone', }, lazy => 1, builder => '_build_app_commands', ); sub _build_app_messageclass { my ($self) = @_; return 'MooseX::App::Message::Block' } sub _build_app_namespace { my ($self) = @_; return [ $self->name ]; } sub _build_app_commands { my ($self) = @_; my (@list); # Process namespace list foreach my $namespace ( @{ $self->app_namespace } ) { push(@list,$self->command_scan_namespace($namespace)); } my $commands = { @list }; # Process excludes foreach my $exclude ( @{ $self->app_exclude } ) { foreach my $command (keys %{$commands}) { delete $commands->{$command} if $commands->{$command} =~ m/^\Q$exclude\E(::|$)/; } } return $commands; } sub command_check { my ($self) = @_; foreach my $attribute ($self->command_usage_attributes($self,'all')) { $attribute->cmd_check(); } return; } sub command_scan_namespace { my ($self,$namespace) = @_; # Find all packages in namespace my $mpo = Module::Pluggable::Object->new( search_path => [ $namespace ], ); my $commandsub = $self->app_command_name; my %return; # Loop all packages foreach my $command_class ($mpo->plugins) { my $command_class_name = substr($command_class,length($namespace)+2); # subcommands support $command_class_name =~ s/::/ /g; # Extract command name $command_class_name =~ s/^\Q$namespace\E:://; $command_class_name =~ s/^.+::([^:]+)$/$1/; my $command = $commandsub->($command_class_name,$command_class); # Check if command was loaded $return{$command} = $command_class if defined $command; } return %return; } sub command_args { my ($self,$metaclass) = @_; $metaclass ||= $self; my $parsed_argv = MooseX::App::ParsedArgv->instance; unless ($metaclass->does_role('MooseX::App::Role::Common')) { Moose->throw_error('Class '.$metaclass->name.' is not a proper MooseX::App::Command class. You either need to use MooseX::App::Command or exclude this class via app_exclude') } # Process options my @attributes_option = $self->command_usage_attributes($metaclass,'option'); my ($return,$errors) = $self->command_parse_options(\@attributes_option); my %raw_error; # Loop all left over options foreach my $option ($parsed_argv->available('option')) { my $key = $option->key; my $raw = $option->original; my $message; next if defined $raw_error{$raw}; # Get possible options with double dash - might be missing if (length $key == 1 && $raw =~ m/^-(\w+)$/) { POSSIBLE_ATTRIBUTES: foreach my $attribute ($self->command_usage_attributes($metaclass,[qw(option proto)])) { foreach my $name ($attribute->cmd_name_possible) { # TODO fuzzy match if ($name eq $1) { $raw_error{$raw} = 1; $message = "Did you mean '--$name'?"; last POSSIBLE_ATTRIBUTES; } } } } # Handle error messages my $error; if (defined $message) { $error = $self->command_message( header => "Unknown option '".$raw."'", # LOCALIZE body => $message, type => "error", ); } else { $error = $self->command_message( header => "Unknown option '".$option->key."'", # LOCALIZE type => "error", ); } unshift(@{$errors},$error); } # Process positional parameters my @attributes_parameter = $self->command_usage_attributes($metaclass,'parameter'); foreach my $attribute (@attributes_parameter) { my $element = $parsed_argv->consume('parameter'); last unless defined $element; my ($parameter_value,$parameter_errors) = $self->command_process_attribute($attribute, [ $element->key ] ); push(@{$errors},@{$parameter_errors}); $return->{$attribute->name} = $parameter_value; } # Handle all unconsumed parameters and options if ($self->app_strict || $metaclass->command_strict) { foreach my $parameter ($parsed_argv->available('parameter')) { unshift(@{$errors}, $self->command_message( header => "Unknown parameter '".$parameter->key."'", # LOCALIZE type => "error", ) ); } } # Handle ENV foreach my $attribute ($self->command_usage_attributes($metaclass,'all')) { next unless $attribute->can('has_cmd_env') && $attribute->has_cmd_env; my $cmd_env = $attribute->cmd_env; if (exists $ENV{$cmd_env} && ! defined $return->{$attribute->name}) { my $value = $ENV{$cmd_env}; if ($attribute->has_type_constraint) { my $type_constraint = $attribute->type_constraint; if ($attribute->should_coerce && $type_constraint->has_coercion) { my $coercion = $type_constraint->coercion; $value = $coercion->coerce($value) // $value; } } $return->{$attribute->name} = $value; my $error = $attribute->cmd_type_constraint_check($value); if ($error) { push(@{$errors}, $self->command_message( header => "Invalid environment value for '".$cmd_env."'", # LOCALIZE type => "error", body => $error, ) ); } } } return ($return,$errors); } sub command_proto { my ($self,$metaclass) = @_; $metaclass ||= $self; my @attributes; foreach my $attribute ($self->command_usage_attributes($metaclass,'proto')) { next unless $attribute->does('MooseX::App::Meta::Role::Attribute::Option') && $attribute->has_cmd_type; push(@attributes,$attribute); } return $self->command_parse_options(\@attributes); } sub command_parse_options { my ($self,$attributes) = @_; # Build attribute lookup hash my %option_to_attribute; foreach my $attribute (@{$attributes}) { foreach my $name ($attribute->cmd_name_possible) { if (defined $option_to_attribute{$name} && $option_to_attribute{$name} != $attribute) { Moose->throw_error('Command line option conflict: '.$name); } $option_to_attribute{$name} = $attribute; } } my $match = {}; my $return = {}; my @errors; # Get ARGV my $parsed_argv = MooseX::App::ParsedArgv->instance; # Loop all exact matches foreach my $option ($parsed_argv->available('option')) { if (my $attribute = $option_to_attribute{$option->key}) { $option->consume($attribute); $match->{$attribute->name} = [ $option ]; } } # Process fuzzy matches if ($self->app_fuzzy) { # Loop all options (sorted by length) foreach my $option (sort { length($b->key) <=> length($a->key) } $parsed_argv->available('option')) { # No fuzzy matching for one-letter flags my $option_length = length($option->key); next if $option_length == 1; my ($match_attributes) = []; # Try to match attributes foreach my $name (keys %option_to_attribute) { next if ($option_length >= length($name)); my $name_short = lc(substr($name,0,$option_length)); # Partial match if (lc($option->key) eq $name_short) { my $attribute = $option_to_attribute{$name}; unless (grep { $attribute == $_ } @{$match_attributes}) { push(@{$match_attributes},$attribute); } } } # Process matches # No match if(@{$match_attributes} == 0) {} # One match elsif(@{$match_attributes} == 1) { my $attribute = $match_attributes->[0]; $option->consume(); $match->{$attribute->name} ||= []; push(@{$match->{$attribute->name}},$option); } # Multiple matches else { $option->consume(); push(@errors, $self->command_message( header => "Ambiguous option '".$option->key."'", # LOCALIZE type => "error", body => "Could be\n".MooseX::App::Utils::format_list( # LOCALIZE map { [ $_ ] } sort map { $_->cmd_name_primary } @{$match_attributes} ), ) ); } } } # Check all attributes foreach my $attribute (@{$attributes}) { next unless exists $match->{$attribute->name}; my @mapped_values; foreach my $element (@{$match->{$attribute->name}}) { push(@mapped_values,$element->all_values); } my $values = [ map { $_->value } sort { $a->position <=> $b->position } @mapped_values ]; #warn Data::Dumper::Dumper($raw); my ($value,$errors) = $self->command_process_attribute( $attribute, $values ); push(@errors,@{$errors}); $return->{$attribute->name} = $value; } return ($return,\@errors); } sub command_process_attribute { my ($self,$attribute,$raw) = @_; $raw = [ $raw ] unless ref($raw) eq 'ARRAY'; my @errors; my $value; # Attribute with split if ($attribute->has_cmd_split) { my @raw_unfolded; foreach (@{$raw}) { push(@raw_unfolded,split($attribute->cmd_split,$_)); } $raw = \@raw_unfolded; } # Attribute with counter - transform value count into value if ($attribute->cmd_count) { $value = $raw = [ scalar(@$raw) ]; } # Attribute with type constraint if ($attribute->has_type_constraint) { my $type_constraint = $attribute->type_constraint; if ($type_constraint->is_a_type_of('ArrayRef')) { $value = $raw; } elsif ($type_constraint->is_a_type_of('HashRef')) { $value = {}; foreach my $element (@{$raw}) { if ($element =~ m/^([^=]+)=(.+?)$/) { $value->{$1} ||= $2; } else { push(@errors, $self->command_message( header => "Invalid value for '".$attribute->cmd_name_primary."'", # LOCALIZE type => "error", body => "Value must be supplied as 'key=value' (not '$element')", # LOCALIZE ) ); } } } elsif ($type_constraint->is_a_type_of('Bool')) { $value = $raw->[-1]; # if ($self->has_default # && ! $self->is_default_a_coderef # && $self->default == 1) { } else { $value = $raw->[-1]; } unless(defined $value) { push(@errors, $self->command_message( header => "Missing value for '".$attribute->cmd_name_primary."'", # LOCALIZE type => "error", ) ); } else { if ($attribute->should_coerce && $type_constraint->has_coercion) { my $coercion = $type_constraint->coercion; $value = $coercion->coerce($value) // $value; } my $error = $attribute->cmd_type_constraint_check($value); if (defined $error) { push(@errors, $self->command_message( header => "Invalid value for '".$attribute->cmd_name_primary."'", # LOCALIZE type => "error", body => $error, ) ); } } } else { $value = $raw->[-1]; } return ($value,\@errors); } sub command_candidates { my ($self,$command) = @_; my $lc_command = lc($command); my $commands = $self->app_commands; my @candidates; my $candidate_length = length($command); # Compare all commands to find matching candidates foreach my $command_name (keys %$commands) { if ($command_name eq $lc_command) { return $command_name; } elsif ($lc_command eq substr($command_name,0,$candidate_length)) { push(@candidates,$command_name); } } return [ sort @candidates ]; } sub command_find { my ($self,$commands) = @_; my $parsed_argv = MooseX::App::ParsedArgv->instance; my $all_commands = $self->app_commands; # Get parts my (@parts,@command_parts); if (defined $commands) { if (ref($commands) eq 'ARRAY') { @parts = map { lc } @{$commands}; } else { @parts = ( lc($commands) ); } } else { @parts = $parsed_argv->elements_argv; } # Extract possible parts foreach my $part (@parts) { # Anyting staring with a dash cannot be a command last if $part =~ m/^-/; push(@command_parts,lc($part)); } # Shortcut return unless scalar @command_parts; # basically do a longest-match search for my $index (reverse(0..$#command_parts)) { my $command = join ' ', @command_parts[0..$index]; if( $all_commands->{$command} ) { $parsed_argv->shift_argv for 0..$index; return $command; } } # didn't find an exact match, let's go to plan B foreach my $index (reverse(0..$#command_parts)) { my $command = join ' ', @command_parts[0..$index]; my $candidate = $self->command_candidates($command); if (ref $candidate eq '') { $parsed_argv->shift_argv; return $candidate; } if (@{$candidate} == 0) { next; } elsif (@{$candidate} == 1) { if ($self->app_fuzzy) { $parsed_argv->shift_argv; return $candidate->[0]; } else { return $self->command_message( header => "Unknown command '$command'", # LOCALIZE type => "error", body => "Did you mean '".$candidate->[0]."'?", # LOCALIZE ); } } else { return $self->command_message( header => "Ambiguous command '$command'", # LOCALIZE type => "error", body => "Which command did you mean?\n". # LOCALIZE MooseX::App::Utils::format_list(map { [ $_ ] } sort @{$candidate}), ); } } my $command = $command_parts[0]; return $self->command_message( header => "Unknown command '$command'", # LOCALIZE type => "error", ); } sub command_parser_hints { my ($self,$metaclass) = @_; $metaclass ||= $self; my %hints; my %names; my $return = { permute => [], novalue => [], fixedvalue => {} }; foreach my $attribute ($self->command_usage_attributes($metaclass,[qw(option proto)])) { my $permute = 0; my $bool = 0; my $type_constraint = $attribute->type_constraint; if ($type_constraint) { $permute = 1 if $type_constraint->is_a_type_of('ArrayRef') || $type_constraint->is_a_type_of('HashRef'); $bool = 1 if $type_constraint->is_a_type_of('Bool'); } my $hint = { name => $attribute->name, bool => $bool, novalue => $bool || $attribute->cmd_count, permute => $permute, }; foreach my $name ($attribute->cmd_name_list) { $names{$name} = $hints{$name} = $hint; } # Negated values if ($bool) { $hint->{fixedvalue} = 1; if ($attribute->has_cmd_negate) { my $hint_neg = { %{$hint} }; # shallow copy $hint_neg->{fixedvalue} = 0; foreach my $name (@{$attribute->cmd_negate}) { $names{$name} = $hints{$name} = $hint_neg; } } } elsif ($attribute->cmd_count) { $hint->{fixedvalue} = 1; } } if ($self->app_fuzzy) { my $length = max(map { length($_) } keys %names) // 0; foreach my $l (reverse(2..$length)) { my %tmp; foreach my $name (keys %names) { next if length($name) < $l; my $short_name = substr($name,0,$l); next if defined $hints{$short_name}; $tmp{$short_name} ||= []; next if defined $tmp{$short_name}->[0] && $tmp{$short_name}->[0]->{name} eq $names{$name}->{name}; push(@{$tmp{$short_name}},$names{$name}) } foreach my $short_name (keys %tmp) { next if scalar @{$tmp{$short_name}} > 1; $hints{$short_name} = $tmp{$short_name}->[0]; } } } foreach my $name (keys %hints) { if ($hints{$name}->{novalue}) { push(@{$return->{novalue}},$name); } if ($hints{$name}->{permute}) { push(@{$return->{permute}},$name); } if (defined $hints{$name}->{fixedvalue}) { $return->{fixedvalue}{$name} = $hints{$name}->{fixedvalue}; } } #warn Data::Dumper::Dumper($return); return $return; } sub command_message { my ($self,@args) = @_; my $messageclass = $self->app_messageclass; Class::Load::load_class($messageclass); return $messageclass->new(@args); } sub command_check_attributes { my ($self,$command_meta,$errors,$params) = @_; $command_meta ||= $self; # Check required values foreach my $attribute ($self->command_usage_attributes($command_meta,[qw(option proto parameter)])) { if ($attribute->is_required && ! exists $params->{$attribute->name} && ! $attribute->has_default) { push(@{$errors}, $self->command_message( header => "Required ".($attribute->cmd_type eq 'parameter' ? 'parameter':'option')." '".$attribute->cmd_name_primary."' missing", # LOCALIZE type => "error", ) ); } } return $errors; } sub command_usage_attributes { my ($self,$metaclass,$types) = @_; $metaclass ||= $self; $types ||= [qw(option proto)]; if ('' eq ref $types) { $types = [$types]; } unless ($metaclass->does_role('MooseX::App::Role::Common')) { Moose->throw_error('Class '.$metaclass->name.' is not a proper MooseX::App::Command class. You either need to use MooseX::App::Command or exclude this class via app_exclude') } my @return; foreach my $attribute ($metaclass->get_all_attributes) { next unless $attribute->does('MooseX::App::Meta::Role::Attribute::Option') && $attribute->has_cmd_type; next unless first { $attribute->cmd_type eq $_ or 'all' eq $_ } @$types; push(@return,$attribute); } return (sort { $a->cmd_position <=> $b->cmd_position || $a->cmd_usage_name cmp $b->cmd_usage_name } @return); } sub command_usage_options { my ($self,$metaclass,$headline) = @_; $headline ||= 'options:'; # LOCALIZE $metaclass ||= $self; my @options; foreach my $attribute ($self->command_usage_attributes($metaclass,[qw(option proto)])) { push(@options,[ $attribute->cmd_usage_name(), $attribute->cmd_usage_description() ]); } return unless scalar @options > 0; return $self->command_message( header => $headline, body => MooseX::App::Utils::format_list(@options), ); } sub command_usage_parameters { my ($self,$metaclass,$headline) = @_; $headline ||= 'parameter:'; # LOCALIZE $metaclass ||= $self; my @parameters; foreach my $attribute ( sort { $a->cmd_position <=> $b->cmd_position } $self->command_usage_attributes($metaclass,'parameter') ) { push(@parameters,[ $attribute->cmd_usage_name(), $attribute->cmd_usage_description() ]); } return unless scalar @parameters > 0; return $self->command_message( header => $headline, body => MooseX::App::Utils::format_list(@parameters), ); } sub command_usage_header { my ($self,$command_meta_class) = @_; my $caller = $self->app_base; my ($command_name,$usage); if ($command_meta_class) { $command_name = $self->command_class_to_command($command_meta_class->name); } else { $command_name = ''; } $command_meta_class ||= $self; if ($command_meta_class->can('command_usage') && $command_meta_class->command_usage_predicate) { $usage = MooseX::App::Utils::format_text($command_meta_class->command_usage); } unless (defined $usage) { # LOCALIZE $usage = "$caller $command_name "; my @parameter= $self->command_usage_attributes($command_meta_class,'parameter'); foreach my $attribute (@parameter) { if ($attribute->is_required) { $usage .= "<".$attribute->cmd_usage_name.'> '; } else { $usage .= '['.$attribute->cmd_usage_name.'] '; } } $usage .= "[long options...] $caller help $caller $command_name --help"; $usage = MooseX::App::Utils::format_text($usage); } return $self->command_message( header => 'usage:', # LOCALIZE body => $usage, ); } sub command_usage_description { my ($self,$command_meta_class) = @_; $command_meta_class ||= $self; if ($command_meta_class->can('command_long_description') && $command_meta_class->command_long_description_predicate) { return $self->command_message( header => 'description:', # LOCALIZE body => MooseX::App::Utils::format_text($command_meta_class->command_long_description), ); } elsif ($command_meta_class->can('command_short_description') && $command_meta_class->command_short_description_predicate) { return $self->command_message( header => 'short description:', # LOCALIZE body => MooseX::App::Utils::format_text($command_meta_class->command_short_description), ); } return; } sub command_class_to_command { my ($self,$command_class) = @_; my $commands = $self->app_commands; foreach my $element (keys %$commands) { if ($command_class eq $commands->{$element}) { return $element; } } return; } sub command_subcommands { my ($self,$command_meta_class) = @_; $command_meta_class ||= $self; my $command_class = $command_meta_class->name; my $command_name = $self->command_class_to_command($command_class); my $commands = $self->app_commands; my $subcommands = {}; foreach my $command (keys %{$commands}) { next if $command eq $command_name || $command !~ m/^\Q$command_name\E\s(.+)/; $subcommands->{$1} = $commands->{$command}; } return $subcommands; } sub command_usage_command { my ($self,$command_meta_class) = @_; $command_meta_class ||= $self; my @usage; push(@usage,$self->command_usage_header($command_meta_class)); push(@usage,$self->command_usage_description($command_meta_class)); push(@usage,$self->command_usage_parameters($command_meta_class,'parameters:')); # LOCALIZE push(@usage,$self->command_usage_options($command_meta_class,'options:')); # LOCALIZE push(@usage,$self->command_usage_subcommands('available subcommands:',$self->command_subcommands($command_meta_class))); # LOCALIZE return @usage; } sub command_usage_global { my ($self) = @_; my @usage; push(@usage,$self->command_usage_header()); my $description = $self->command_usage_description($self); push(@usage,$description) if $description; push(@usage,$self->command_usage_parameters($self,'global parameters:')); # LOCALIZE push(@usage,$self->command_usage_options($self,'global options:')); # LOCALIZE push(@usage,$self->command_usage_subcommands('available commands:',$self->app_commands)); # LOCALIZE return @usage; } sub command_usage_subcommands { my ($self,$headline,$commands) = @_; my @commands; foreach my $command (keys %$commands) { my $class = $commands->{$command}; Class::Load::load_class($class); } foreach my $command (keys %$commands) { my $class = $commands->{$command}; unless ($class->can('meta') && $class->DOES('MooseX::App::Role::Common')) { Moose->throw_error('Class '.$class.' is not a proper MooseX::App::Command class. You either need to use MooseX::App::Command or exclude this class via app_exclude') } my $command_description; $command_description = $class->meta->command_short_description if $class->meta->can('command_short_description'); $command_description ||= ''; push(@commands,[$command,$command_description]); } @commands = sort { $a->[0] cmp $b->[0] } @commands; push(@commands,['help','Prints this usage information']); # LOCALIZE return $self->command_message( header => $headline, body => MooseX::App::Utils::format_list(@commands), ); } 1; __END__ =pod =encoding utf8 =head1 NAME MooseX::App::Meta::Role::Class::Base - Meta class role for application base class =head1 DESCRIPTION This meta class role will automatically be applied to the application base class. This documentation is only of interest if you intend to write plugins for MooseX-App. =head1 ACCESSORS =head2 app_messageclass Message class for generating error messages. Defaults to MooseX::App::Message::Block. The default can be overwritten by altering the C<_build_app_messageclass> method. Defaults to MooseX::App::Message::Block =head2 app_namespace Usually MooseX::App will take the package name of the base class as the namespace for commands. This namespace can be changed. =head2 app_exclude Exclude namespaces included in app_namespace =head2 app_base Usually MooseX::App will take the name of the calling wrapper script to construct the program name in various help messages. This name can be changed via the app_base accessor. Defaults to the base name of $0 =head2 app_fuzzy Boolean flag that controls if command names and attributes should be matched exactly or fuzzy. Defaults to true. =head2 app_command_name Coderef attribute that controls how package names are translated to command names and attributes. Defaults to &MooseX::App::Utils::class_to_command =head2 app_commands Hashref with command to command class map. =head2 app_strict Boolean flag that controls if an application with superfluous/unknown positional parameters should terminate with an error message or not. If disabled all extra parameters will be copied to the L command class attribute. =head2 app_prefer_commandline By default, arguments passed to new_with_command and new_with_options have a higher priority than the command line options. This boolean flag will give the command line an higher priority. =head2 app_permute Boolean flag that controls if command line arguments that take multiple values (ie ArrayRef or HashRef type constraints) can be permuted. =head1 METHODS =head2 command_check Runs sanity checks on options and parameters. Will usually only be executed if either HARNESS_ACTIVE or APP_DEVELOPER environment are set. =head2 command_register $self->command_register($command_moniker,$command_class); Registers an additional command =head2 command_get my $command_class = $self->command_register($command_moniker); Returns a command class for the given command moniker =head2 command_class_to_command my $command_moniker = $meta->command_class_to_command($command_class); Returns the command moniker for the given command class. =head2 command_message my $message = $meta->command_message( header => $header, type => 'error', body => $message ); Generates a message object (using the class from L) =head2 command_usage_attributes my @attributes = $meta->command_usage_attributes($metaclass); Returns a list of attributes/command options for the given meta class. =head2 command_usage_command my @messages = $meta->command_usage_command($command_metaclass); Returns a list of messages containing the documentation for a given command meta class. =head2 command_usage_description my $message = $meta->command_usage_description($command_metaclass); Returns a messages with the basic command description. =head2 command_usage_global my @messages = $meta->command_usage_global(); Returns a list of messages containing the documentation for the application. =head2 command_usage_header my $message = $meta->command_usage_header(); my $message = $meta->command_usage_header($command_meta_class); Returns a message containing the basic usage documentation =head2 command_find my @commands = $meta->command_find($commands_arrayref); Returns a list of command names matching the user input =head2 command_candidates my $commands = $meta->command_candidates($user_command_input); Returns either a single command or an arrayref of possibly matching commands. =head2 command_proto my ($result,$errors) = $meta->command_proto($command_meta_class); Returns all parsed options (as hashref) and erros (as arrayref) for the proto command. Is a wrapper around L. =head2 command_args my ($options,$errors) = $self->command_args($command_meta_class); Returns all parsed options (as hashref) and erros (as arrayref) for the main command. Is a wrapper around L. =head2 command_parse_options my ($options,$errors) = $self->command_parse_options(\@attribute_metaclasses); Tries to parse the selected attributes from @ARGV. =head2 command_scan_namespace my %namespaces = $self->command_scan_namespace($namespace); Scans a namespace for command classes. Returns a hash with command names as keys and package names as values. =head2 command_process_attribute my @attributes = $self->command_process_attribute($attribute_metaclass,$matches); TODO ###Returns a list of all attributes with the given type =head2 command_usage_options my $usage = $self->command_usage_options($metaclass,$headline); Returns the options usage as a message object =head2 command_usage_parameters my $usage = $self->command_usage_parameters($metaclass,$headline); Returns the positional parameters usage as a message object =head2 command_check_attributes $errors = $self->command_check_attributes($command_metaclass,$errors,$params) Checks all attributes. Returns/alters the $errors arrayref =head2 command_parser_hints $self->command_parser_hints($self,$metaclass) Generates parser hints as required by L =cut BashCompletion.pm100644000765000024 225614514737355 21752 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin# ============================================================================ package MooseX::App::Plugin::BashCompletion; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; sub plugin_metaroles { my ($self,$class) = @_; return { class => ['MooseX::App::Plugin::BashCompletion::Meta::Class'], } } around 'initialize_command_class' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); if (blessed $return && $return->isa('MooseX::App::Plugin::BashCompletion::Command')) { return $return->bash_completion($self); } return $return; }; 1; __END__ =encoding utf8 =head1 NAME MooseX::App::Plugin::BashCompletion - Bash completion for your MooseX::App applications =head1 SYNOPSIS In your base class: package MyApp; use MooseX::App qw(BashCompletion); In your shell bash$ myapp bash_completion > myapp-complete.sh bash$ source myapp-complete.sh =head1 DESCRIPTION This plugin generates a bash completion definition for your application. =head1 SEE ALSO L =cut Meta000755000765000024 014514737355 17741 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/ManClass.pm100644000765000024 100514514737355 21500 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Man/Meta# ============================================================================ package MooseX::App::Plugin::Man::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use MooseX::App::Plugin::Man::Command; around '_build_app_commands' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); $return->{man} ||= 'MooseX::App::Plugin::Man::Command'; return $return; }; 1;Simple.pm100644000765000024 230414514737355 21664 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/Role/Class# ============================================================================ package MooseX::App::Meta::Role::Class::Simple; # ============================================================================ use utf8; use 5.010; use namespace::autoclean; use Moose::Role; around 'command_usage_header' => sub { my ($orig,$self) = @_; my $caller = $self->app_base; my $usage; # Get usage from command if available if ($self->can('command_usage') && $self->command_usage_predicate) { $usage = MooseX::App::Utils::format_text($self->command_usage); } # Autobuild usage unless ($usage) { my $command = $caller; my @parameter= $self->command_usage_attributes($self,'parameter'); foreach my $attribute (@parameter) { if ($attribute->is_required) { $command .= " <".$attribute->cmd_usage_name.'>'; } else { $command .= ' ['.$attribute->cmd_usage_name.']'; } } $usage = MooseX::App::Utils::format_text("$command [long options...] $caller --help") } return $self->command_message( header => 'usage:', body => $usage ); # LOCALIZE }; 1;Meta000755000765000024 014514737355 20135 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/TermClass.pm100644000765000024 262214514737355 21702 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Term/Meta# ============================================================================ package MooseX::App::Plugin::Term::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use IO::Interactive qw(is_interactive); around 'command_check_attributes' => sub { my ($orig,$self,$command_meta,$errors,$params) = @_; $command_meta ||= $self; if (scalar @{$errors} == 0 && is_interactive()) { my $prompt = 1; foreach my $attribute ($self->command_usage_attributes($command_meta,'all')) { if ($attribute->is_required && ! exists $params->{$attribute->name} && (! $attribute->can('cmd_term') || $attribute->cmd_term == 0 )) { $prompt = 0; } } if ($prompt) { foreach my $attribute ($self->command_usage_attributes($command_meta,'all')) { next unless $attribute->can('cmd_term') && $attribute->cmd_term; if (! defined $params->{$attribute->name}) { my $return = $attribute->cmd_term_read(); $params->{$attribute->name} = $return if defined $return; } } } } return $self->$orig($command_meta,$errors,$params); }; 1;Meta000755000765000024 014514737355 20161 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/TypoClass.pm100644000765000024 177114514737355 21732 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Typo/Meta# ============================================================================ package MooseX::App::Plugin::Typo::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use Text::WagnerFischer qw(distance); around 'command_candidates' => sub { my ($orig,$self,$command) = @_; my $lc_command = lc($command); my $commands = $self->app_commands; # Fuzzy match my @candidates; my $candidate_length = length($command); # Compare all commands to find matching candidates foreach my $command_name (keys %$commands) { my $candidate_substr = substr($command_name,0,$candidate_length+1); if ($lc_command eq $command_name) { return $command_name; } elsif ($lc_command eq $candidate_substr || distance($lc_command,$candidate_substr) <= 1) { push(@candidates,$command_name); } } return [ sort @candidates ]; }; 1;Version000755000765000024 014514737355 17765 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/PluginCommand.pm100644000765000024 240214514737355 22037 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Version# ============================================================================ package MooseX::App::Plugin::Version::Command; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; use MooseX::App::Command; command_short_description q(Print the current version); sub version { my ($self,$app) = @_; my $version = ''; $version .= $app->meta->app_base. ' version '.$app->VERSION."\n"; $version .= "MooseX::App version ".$MooseX::App::VERSION."\n"; $version .= "Perl version ".sprintf("%vd", $^V); my $message_class = $app->meta->app_messageclass; my @parts = ($message_class->new({ header => 'VERSION', body => MooseX::App::Utils::format_text($version) })); my %pod_raw = MooseX::App::Utils::parse_pod($app->meta->name); foreach my $part ('COPYRIGHT','LICENSE','COPYRIGHT AND LICENSE','AUTHOR','AUTHORS') { if (defined $pod_raw{$part}) { push(@parts,$message_class->new({ header => $part, body => MooseX::App::Utils::format_text($pod_raw{$part}), })); } } return MooseX::App::Message::Envelope->new(@parts); } __PACKAGE__->meta->make_immutable; 1;Command.pm100644000765000024 110314514737355 22005 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/Role/Class# ============================================================================ package MooseX::App::Meta::Role::Class::Command; # ============================================================================ use utf8; use 5.010; use Moose::Role; has 'app_attribute_metaroles' => ( is => 'rw', isa => 'ArrayRef[Str]', predicate => 'has_app_attribute_metaroles', traits => ['Array'], handles => { app_attribute_metaroles_add => 'push', app_attribute_metaroles_uniq => 'uniq', } ); 1;Meta000755000765000024 014514737355 20304 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/ColorClass.pm100644000765000024 62714514737355 22034 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Color/Meta# ============================================================================ package MooseX::App::Plugin::Color::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use MooseX::App::Message::BlockColor; around '_build_app_messageclass' => sub { return 'MooseX::App::Message::BlockColor' }; 1;Meta000755000765000024 014514737355 20433 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/ConfigClass.pm100644000765000024 403414514737355 22177 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Config/Meta# ============================================================================ package MooseX::App::Plugin::Config::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; around 'command_proto' => sub { my ($orig,$self,$metaclass) = @_; my ($result,$errors) = $self->$orig($metaclass); delete $result->{config} unless defined $result->{config}; return $self->proto_config($metaclass,$result,$errors); }; sub proto_config { my ($self,$metaclass,$result,$errors) = @_; # Check if we have a config return ($result,$errors) unless defined $result->{config}; # Read config my $config_file = $result->{config}; unless (-e $config_file) { push(@{$errors}, $self->command_message( header => "Could not find config file '".$config_file."'", type => "error", ), ); return ($result,$errors); } my $configs = Config::Any->load_files({ files => [ $config_file ], use_ext => 1, }); my $command_name = $self->command_class_to_command($metaclass->name); my ($config_data) = values %{$configs->[0]}; # Merge $config_data->{global} ||= {}; $config_data->{$command_name} ||= {}; # Set config data $result->{config} = $result->{config}; $result->{_config_data} = $config_data; # Lopp all attributes foreach my $attribute ($self->command_usage_attributes($metaclass,'all')) { my $attribute_name = $attribute->name; next if $attribute_name eq 'config' || $attribute_name eq 'help_flag'; $result->{$attribute_name} = $config_data->{global}{$attribute_name} if defined $config_data->{global}{$attribute_name}; $result->{$attribute_name} = $config_data->{$command_name}{$attribute_name} if defined $config_data->{$command_name}{$attribute_name}; } return ($result,$errors); }; 1; Meta000755000765000024 014514737355 20610 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/DependsClass.pm100644000765000024 235314514737355 22356 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Depends/Meta# ============================================================================ package MooseX::App::Plugin::Depends::Meta::Class; # ============================================================================ use Moose::Role; use namespace::autoclean; around 'command_check_attributes' => sub { my ($orig, $self, $command_meta, $errors, $params) = @_; $command_meta ||= $self; ATTR: foreach my $attribute ( $self->command_usage_attributes($command_meta, 'all') ) { next ATTR unless defined $params->{ $attribute->cmd_name_primary }; next ATTR unless $attribute->can('depends') && ref($attribute->depends) eq 'ARRAY' && scalar @{ $attribute->depends } > 0; OPT: foreach my $required_option ( @{ $attribute->depends } ) { next OPT if defined $params->{$required_option}; my $error_msg = "Option " . "'" . $attribute->cmd_name_primary . "'" . " requires '$required_option' to be defined"; push @$errors, $self->command_message( header => $error_msg, type => 'error', ); } } return $self->$orig($command_meta, $errors, $params); }; 1; Meta000755000765000024 014514737355 20653 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/VersionClass.pm100644000765000024 102514514737355 22414 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Version/Meta# ============================================================================ package MooseX::App::Plugin::Version::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use MooseX::App::Plugin::Version::Command; around '_build_app_commands' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); $return->{version} ||= 'MooseX::App::Plugin::Version::Command'; return $return; }; 1;Attribute000755000765000024 014514737355 20634 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/RoleOption.pm100644000765000024 3341714514737355 22632 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/Role/Attribute# ============================================================================ package MooseX::App::Meta::Role::Attribute::Option; # ============================================================================ use utf8; use 5.010; use namespace::autoclean; use Moose::Role; use List::Util qw(uniq first); has 'cmd_type' => ( is => 'rw', isa => 'MooseX::App::Types::CmdTypes', predicate => 'has_cmd_type', ); has 'cmd_tags' => ( is => 'rw', isa => 'MooseX::App::Types::List', coerce => 1, predicate => 'has_cmd_tags', ); has 'cmd_flag' => ( is => 'rw', isa => 'MooseX::App::Types::Identifier', predicate => 'has_cmd_flag', ); has 'cmd_aliases' => ( is => 'rw', isa => 'MooseX::App::Types::IdentifierList', predicate => 'has_cmd_aliases', coerce => 1, ); has 'cmd_split' => ( is => 'rw', isa => Moose::Util::TypeConstraints::union([qw(Str RegexpRef)]), predicate => 'has_cmd_split', ); has 'cmd_count' => ( is => 'rw', isa => 'Bool', default => sub { 0 }, ); has 'cmd_negate' => ( is => 'rw', isa => 'MooseX::App::Types::IdentifierList', coerce => 1, predicate => 'has_cmd_negate', ); has 'cmd_env' => ( is => 'rw', isa => 'MooseX::App::Types::Env', predicate => 'has_cmd_env', ); has 'cmd_position' => ( is => 'rw', isa => 'Int', default => sub { 0 }, ); my $GLOBAL_COUNTER = 1; around 'new' => sub { my $orig = shift; my $class = shift; my $self = $class->$orig(@_); if ($self->has_cmd_type) { if ($self->cmd_position == 0) { $GLOBAL_COUNTER++; $self->cmd_position($GLOBAL_COUNTER); } } return $self; }; sub cmd_check { my ($self) = @_; my $name = $self->name; my $from_constraint; my $type_constraint = $self->type_constraint; $from_constraint = $type_constraint->parameterized_from if $type_constraint && $type_constraint->isa('Moose::Meta::TypeConstraint::Parameterized'); my $cmd_type = ucfirst($self->cmd_type); # Check for useless flags if ($self->cmd_type eq 'parameter') { if ($self->cmd_count) { Moose->throw_error("Parameter $name has 'cmd_count'. This attribute only works with options"); } if ($self->has_cmd_negate) { Moose->throw_error("Parameter $name has 'cmd_negate'. This attribute only works with options"); } if ($self->has_cmd_negate) { Moose->throw_error("Parameter $name has 'cmd_negate'. This attribute only works with options"); } if (defined $type_constraint && $type_constraint->is_a_type_of('Bool')) { Moose->throw_error("Parameter $name has 'cmd_negate'. This attribute only works with options"); } if (($from_constraint && $from_constraint->is_a_type_of('Ref')) || ($type_constraint && $type_constraint->is_a_type_of('Ref'))) { Moose->throw_error("Parameter $name may not have Ref type constraints"); } } else { if ((!$type_constraint || ! $type_constraint->is_a_type_of('Bool')) && first { length($_) == 1 } $self->cmd_name_list) { Moose->throw_error("Option $name has a single letter flag but no Bool type constraint"); } # Check negate if ($self->has_cmd_negate && (!$type_constraint || ! $type_constraint->is_a_type_of('Bool'))) { Moose->throw_error("Option $name has 'cmd_negate' but has no Bool type constraint"); } } # Check type constraints if (defined $type_constraint) { if ($self->cmd_count && ! $type_constraint->is_a_type_of('Num')) { Moose->throw_error("$cmd_type $name has 'cmd_count' but has no Num/Int type constraint"); } if ($self->has_cmd_split && ! ( ($from_constraint && $from_constraint->is_a_type_of('ArrayRef')) || $type_constraint->is_a_type_of('ArrayRef')) ) { Moose->throw_error("$cmd_type $name has 'cmd_split' but has no ArrayRef type constraint"); } } # Check for uniqness my @names = $self->cmd_name_possible; if (scalar(uniq(@names)) != scalar(@names)) { Moose->throw_error("$cmd_type $name has duplicate names/aliases"); } return; } sub cmd_type_constraint_description { my ($self,$type_constraint,$singular) = @_; $type_constraint //= $self->type_constraint; $singular //= 1; if ($type_constraint->isa('Moose::Meta::TypeConstraint::Enum')) { return 'one of these values: '.join(', ',@{$type_constraint->values}); } elsif ($type_constraint->isa('Moose::Meta::TypeConstraint::Parameterized')) { my $from = $type_constraint->parameterized_from; if ($from->is_a_type_of('ArrayRef')) { return $self->cmd_type_constraint_description($type_constraint->type_parameter); } elsif ($from->is_a_type_of('HashRef')) { return 'key-value pairs of '.$self->cmd_type_constraint_description($type_constraint->type_parameter,0); } # TODO union } elsif ($type_constraint->equals('Int')) { return $singular ? 'an integer':'integers'; # LOCALIZE } elsif ($type_constraint->equals('Num')) { return $singular ? 'a number':'numbers'; # LOCALIZE } elsif ($type_constraint->equals('Str')) { return $singular ? 'a string':'strings'; } elsif ($type_constraint->equals('HashRef')) { return 'key-value pairs'; # LOCALIZE } if ($type_constraint->has_parent) { return $self->cmd_type_constraint_description($type_constraint->parent); } return; } sub cmd_type_constraint_check { my ($self,$value) = @_; return unless ($self->has_type_constraint); my $type_constraint = $self->type_constraint; if ($type_constraint->has_coercion) { $value = $type_constraint->coerce($value) } # Check type constraints unless ($type_constraint->check($value)) { if (ref($value) eq 'ARRAY') { $value = join(', ',grep { defined } @$value); } elsif (ref($value) eq 'HASH') { $value = join(', ',map { $_.'='.$value->{$_} } keys %$value) } # We have a custom message if ($type_constraint->has_message) { return $type_constraint->get_message($value); # No message } else { my $message_human = $self->cmd_type_constraint_description($type_constraint); if (defined $message_human) { return "Value must be ". $message_human ." (not '$value')"; } else { return $type_constraint->get_message($value); } } } return; } sub cmd_usage_description { my ($self) = @_; my $description = ($self->has_documentation) ? $self->documentation : ''; my @tags = $self->cmd_tags_list(); if (scalar @tags) { $description .= ' ' if $description; $description .= '['.join('; ',@tags).']'; } return $description } sub cmd_usage_name { my ($self) = @_; if ($self->cmd_type eq 'parameter') { return $self->cmd_name_primary; } else { return join(' ', map { (length($_) == 1) ? "-$_":"--$_" } $self->cmd_name_possible ); } } sub cmd_name_primary { my ($self) = @_; if ($self->has_cmd_flag) { return $self->cmd_flag; } else { return $self->name; } } sub cmd_name_list { my ($self) = @_; my @names = ($self->cmd_name_primary); if ($self->has_cmd_aliases) { push(@names, @{$self->cmd_aliases}); } return @names; } sub cmd_name_possible { my ($self) = @_; if ($self->cmd_type eq 'parameter') { return $self->cmd_name_primary; } my @names = $self->cmd_name_list(); # TODO check boolean type constraint if ($self->has_cmd_negate) { push(@names, @{$self->cmd_negate}); } return @names; } sub cmd_tags_list { my ($self) = @_; my @tags; if ($self->is_required && ! $self->is_lazy_build && ! $self->has_default) { push(@tags,'Required') } if ($self->has_default && ! $self->is_default_a_coderef) { if ($self->has_type_constraint && $self->type_constraint->is_a_type_of('Bool')) { # if ($attribute->default) { # push(@tags,'Default:Enabled'); # } else { # push(@tags,'Default:Disabled'); # } } else { push(@tags,'Default:"'.$self->default.'"'); } } if ($self->has_cmd_split) { my $split = $self->cmd_split; if (ref($split) eq 'Regexp') { $split = "$split"; $split =~ s/^\(\?\^\w*:(.+)\)$/$1/x; } push(@tags,'Multiple','Split by "'.$split.'"'); } if ($self->has_type_constraint) { my $type_constraint = $self->type_constraint; if ($type_constraint->is_a_type_of('ArrayRef')) { if (! $self->has_cmd_split) { push(@tags,'Multiple'); } } elsif ($type_constraint->is_a_type_of('HashRef')) { push(@tags,'Key-Value'); } unless ($self->should_coerce) { if ($type_constraint->is_a_type_of('Int')) { push(@tags,'Integer'); } elsif ($type_constraint->is_a_type_of('Num')) { push(@tags ,'Number'); } elsif ($type_constraint->is_a_type_of('Bool')) { push(@tags ,'Flag'); } elsif ($type_constraint->isa('Moose::Meta::TypeConstraint::Enum')) { push(@tags ,'Possible values: '.join(', ',@{$type_constraint->values})); } } } if ($self->can('has_cmd_env') && $self->has_cmd_env) { push(@tags,'Env: '.$self->cmd_env) } if ($self->can('cmd_tags') && $self->can('cmd_tags') && $self->has_cmd_tags) { push(@tags,@{$self->cmd_tags}); } return @tags; } { package Moose::Meta::Attribute::Custom::Trait::AppOption; use strict; use warnings; sub register_implementation { return 'MooseX::App::Meta::Role::Attribute::Option' } } 1; =pod =encoding utf8 =head1 NAME MooseX::App::Meta::Role::Attribute::Option - Meta attribute role for options =head1 DESCRIPTION This meta attribute role will automatically be applied to all attributes that should be used as options. =head1 ACCESSORS In your app and command classes you can use the following attributes in option or parameter definitions. option 'myoption' => ( is => 'rw', isa => 'ArrayRef[Str]', documentation => 'My special option', cmd_flag => 'myopt', cmd_aliases => [qw(mopt localopt)], cmd_tags => [qw(Important!)], cmd_env => 'MY_OPTION', cmd_position => 1, cmd_split => qr/,/, cmd_negate => 'notoption' ); =head2 cmd_flag Use this name instead of the attribute name as the option name =head2 cmd_type Option to mark if this attribute should be used as an option or parameter value. Allowed values are: =over =item * option - Command line option =item * proto - Command line option that should be processed prior to other options (eg. a config-file option that sets other attribues) Usually only used for plugin developmemt =item * parameter - Positional parameter command line value =back =head2 cmd_env Environment variable name (only uppercase letters, numeric and underscores allowed). If variable was not specified otherwise the value will be taken from %ENV. =head2 cmd_aliases Arrayref of alternative option names =head2 cmd_tags Extra option tags displayed in the usage information (in brackets) =head2 cmd_position Override the order of the parameters in the usage message. =head2 cmd_split Splits multiple values at the given separator string or regular expression. Only works in conjunction with an 'ArrayRef[*]' type constraint. ie. '--myattr value1,value2' with cmd_split set to ',' would produce an arrayref with to elements. =head2 cmd_count Similar to the Getopt::Long '+' modifier, cmd_count turns the attribute into a counter. Every occurrence of the attribute in @ARGV (without any value) would increment the resulting value by one =head2 cmd_negate Sets names for the negated variant of a boolean field. Only works in conjunction with a 'Bool' type constraint. =head1 METHODS These methods are only of interest to plugin authors. =head2 cmd_check Runs sanity checks on options and parameters. Will usually only be executed if either HARNESS_ACTIVE or APP_DEVELOPER environment are set. =head2 cmd_name_possible my @names = $attribute->cmd_name_possible(); Returns a list of all possible option names. =head2 cmd_name_list my @names = $attribute->cmd_name_list(); Similar to cmd_name_possible this method returns a list of option names, except for names set via cmd_negate. =head2 cmd_name_primary my $name = $attribute->cmd_name_primary(); Returns the primary option name =head2 cmd_usage_name my $name = $attribute->cmd_usage_name(); Returns the name as used by the usage text =head2 cmd_usage_description my $name = $attribute->cmd_usage_description(); Returns the description as used by the usage text =head2 cmd_tags_list my @tags = $attribute->cmd_tags_list(); Returns a list of tags =head2 cmd_type_constraint_check $attribute->cmd_type_constraint_check($value) Checks the type constraint. Returns an error message if the check fails =head2 cmd_type_constraint_description $attribute->cmd_type_constraint_description($type_constraint,$singular) Creates a description of the selected type constraint. =cut Attribute.pm100644000765000024 2166514514737355 22630 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Term/Meta# ============================================================================ package MooseX::App::Plugin::Term::Meta::Attribute; # ============================================================================ use utf8; use 5.010; use namespace::autoclean; use Moose::Role; use List::Util qw(first); use Term::ReadKey; has 'cmd_term' => ( is => 'ro', isa => 'Bool', default => sub {0}, ); has 'cmd_term_label' => ( is => 'ro', isa => 'Str', predicate => 'has_cmd_term_label', ); sub cmd_term_label_full { my ($self) = @_; my $label = $self->cmd_term_label_name; my @tags; if ($self->is_required) { push(@tags,'Required'); } else { push(@tags,'Optional'); } if ($self->has_type_constraint) { my $type_constraint = $self->type_constraint; if ($type_constraint->is_a_type_of('Bool')) { push(@tags,'Y/N'); } else { push(@tags,$self->cmd_type_constraint_description($type_constraint)); } } if (scalar @tags) { $label .= ' ('.join(', ',@tags).')'; } return $label; } sub cmd_term_label_name { my ($self) = @_; my $label; if ($self->has_cmd_term_label) { return $self->cmd_term_label; } elsif ($self->has_documentation) { return $self->documentation; } else { return $self->name; } } sub cmd_term_read { my ($self) = @_; if ($self->has_type_constraint && $self->type_constraint->is_a_type_of('Bool')) { return $self->cmd_term_read_bool(); } else { return $self->cmd_term_read_string(); } } sub cmd_term_read_string { my ($self) = @_; my $label = $self->cmd_term_label_full; my ($return,@history,$history_disable,$allowed); binmode STDIN,':encoding(UTF-8)'; # Prefill history with enums if ($self->has_type_constraint) { my $type_constraint = $self->type_constraint; if ($type_constraint->isa('Moose::Meta::TypeConstraint::Enum')) { push(@history,@{$self->type_constraint->values}); $history_disable = 1 } elsif (!$type_constraint->has_coercion) { if ($type_constraint->is_a_type_of('Int')) { $allowed = qr/[0-9]/; } elsif ($type_constraint->is_a_type_of('Num')) { $allowed = qr/[0-9.]/; } } } push(@history,"") unless scalar @history; my $history_index = 0; my $history_add = sub { my $entry = shift; if (! $history_disable && defined $entry && $entry !~ m/^\s*$/ && ! first { $entry eq $_ } @history) { push(@history,$entry); } }; ReadMode('cbreak'); # change input mode TRY_STRING: while (1) { print "\n" if defined $return && $return !~ /^\s*$/; $return = ''; if (defined $Term::ANSIColor::VERSION) { say Term::ANSIColor::color('white bold').$label.' :'.Term::ANSIColor::color('reset'); } else { say $label.": "; } 1 while defined ReadKey -1; # discard any previous input my $cursor = 0; KEY_STRING: while (1) { my $key = ReadKey 0; # read a single character my $length = length($return); my $key_code = ord($key); if ($key_code == 10) { # Enter print "\n"; my $error; if ($return =~ m/^\s*$/) { if ($self->is_required) { $error = 'Value is required'; } else { $return = undef; last TRY_STRING; } } else { $error = $self->cmd_type_constraint_check($return); } if ($error) { if (defined $Term::ANSIColor::VERSION) { say Term::ANSIColor::color('bright_red bold').$error.Term::ANSIColor::color('reset'); } else { say $error; } $history_add->($return); next TRY_STRING; } else { last TRY_STRING; } } elsif ($key_code == 27) { # Escape sequence my $escape; while (1) { # Read rest of escape sequence my $code = ReadKey -1; last unless defined $code; $escape .= $code; } if (defined $escape) { if ($escape eq '[D') { # Cursor left if ($cursor > 0) { print "\b"; $cursor--; } } elsif ($escape eq '[C') { # Cursor right if ($cursor < length($return)) { print substr $return,$cursor,1; $cursor++; } } elsif ($escape eq '[A') { # Cursor up $history_add->($return); print "\b" x $cursor; print " " x length($return); print "\b" x length($return); $history_index ++ if defined $history[$history_index] && $history[$history_index] eq $return; $history_index = 0 unless defined $history[$history_index]; $return = $history[$history_index]; $cursor = length($return); print $return; $history_index++; } elsif ($escape eq '[3~') { # Del if ($cursor != length($return)) { substr $return,$cursor,1,''; print substr $return,$cursor; print " ".(("\b") x (length($return) - $cursor + 1)); } } elsif ($escape eq 'OH') { # Pos 1 print (("\b") x $cursor); $cursor = 0; } elsif ($escape eq 'OF') { # End print substr $return,$cursor; $cursor = length($return); } #else { # print $escape; #} } else { $history_add->($return); next TRY_STRING; } } elsif ($key_code == 127) { # Backspace if ($cursor == 0) { # Ignore first next KEY_STRING; } $cursor--; substr $return,$cursor,1,''; # string print "\b".substr $return,$cursor; # print print " ".(("\b") x (length($return) - $cursor + 1)); # cursor } else { # Character if ($key_code <= 31) { # ignore controll chars print "\a"; next KEY_STRING; } elsif (defined $allowed && $key !~ /$allowed/) { print "\a"; next KEY_STRING; } substr $return,$cursor,0,$key; # string print substr $return,$cursor; # print $cursor++; print (("\b") x (length($return) - $cursor)); # cursor } } } ReadMode 0; return $return; } sub cmd_term_read_bool { my ($self) = @_; my $label = $self->cmd_term_label_full; my $return; if (defined $Term::ANSIColor::VERSION) { say Term::ANSIColor::color('white bold').$label.' :'.Term::ANSIColor::color('reset'); } else { say $label.": "; } ReadMode 4; # change to raw input mode TRY: while (1) { 1 while defined ReadKey -1; # discard any previous input my $key = ReadKey 0; # read a single character if ($key =~ /^[yn]$/i) { say uc($key); $return = uc($key) eq 'Y' ? 1:0; last; } elsif ((ord($key) == 10 || ord($key) == 27) && ! $self->is_required) { last; } elsif (ord($key) == 3) { ReadMode 0; kill INT => $$; # Not sure ? } } ReadMode 0; return $return; } around 'cmd_tags_list' => sub { my $orig = shift; my ($self) = @_; my @tags = $self->$orig(); push(@tags,'Term') if $self->can('cmd_term') && $self->cmd_term; return @tags; }; { package Moose::Meta::Attribute::Custom::Trait::AppTerm; use strict; use warnings; sub register_implementation { return 'MooseX::App::Plugin::Term::Meta::Attribute' } } 1; Meta000755000765000024 014514737355 21244 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/ConfigHomeClass.pm100644000765000024 172514514737355 23014 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/ConfigHome/Meta# ============================================================================ package MooseX::App::Plugin::ConfigHome::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use File::HomeDir qw(); use File::Spec qw(); around 'proto_config' => sub { my $orig = shift; my ($self,$command_class,$result,$errors) = @_; unless (defined $result->{config}) { my $data_dir = File::Spec->catfile( File::HomeDir->my_home, '.'.$self->app_base ); foreach my $extension (Config::Any->extensions) { my $check_file = File::Spec->catfile( $data_dir, 'config.'.$extension ); if (-e $check_file) { $result->{config} = $check_file; last; } } } return $self->$orig($command_class,$result,$errors); }; 1; Meta000755000765000024 014514737355 21345 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/MutexGroupClass.pm100644000765000024 342714514737355 23116 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/MutexGroup/Meta# ============================================================================ package MooseX::App::Plugin::MutexGroup::Meta::Class; # ============================================================================ use Moose::Role; use namespace::autoclean; around 'command_check_attributes' => sub { my ( $orig, $self, $command_meta, $errors, $params ) = @_; $command_meta ||= $self; my %mutex_groups; foreach my $attribute ( $self->command_usage_attributes( $command_meta, 'all' ) ) { push @{ $mutex_groups{ $attribute->mutexgroup } }, $attribute if $attribute->can('mutexgroup') && defined $attribute->mutexgroup; } foreach my $options ( values %mutex_groups ) { my @initialized_options = grep { defined $params->{ $_->name } } @$options; unless ( scalar @initialized_options == 1 ) { my $error_msg; if (scalar @initialized_options == 0) { my $last = pop @$options; $error_msg = "Either ". join(",", map { $_->cmd_name_primary } @$options). " or ". $last->cmd_name_primary. " must be specified"; } else { my @list = map { $_->cmd_name_primary } @initialized_options; my $last = pop(@list); $error_msg = "Options ". join(",",@list). " and ". $last. " are mutally exclusive"; } push @$errors, $self->command_message( header => $error_msg, type => "error", ); } } return $self->$orig( $command_meta, $errors, $params ); }; 1; Documentation.pm100644000765000024 1132714514737355 23271 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Meta/Role/Class# ============================================================================ package MooseX::App::Meta::Role::Class::Documentation; # ============================================================================ use utf8; use 5.010; use namespace::autoclean; use Moose::Role; use Pod::Elemental; use Pod::Elemental::Selectors qw(); use Pod::Elemental::Transformer::Pod5; use Pod::Elemental::Transformer::Nester; has 'command_short_description' => ( is => 'rw', isa => 'Maybe[Str]', lazy => 1, builder => '_build_command_short_description', ); has 'command_long_description' => ( is => 'rw', isa => 'Maybe[Str]', lazy => 1, builder => '_build_command_long_description', ); has 'command_usage' => ( is => 'rw', isa => 'Maybe[Str]', lazy => 1, builder => '_build_command_usage', ); has 'command_strict' => ( is => 'rw', isa => 'Bool', default => sub {0}, ); sub command_short_description_predicate { my ($self) = @_; return $self->_command_pod_predicate('command_short_description'); } sub _build_command_short_description { my ($self) = @_; my %pod = $self->_build_command_pod(); return $pod{'command_short_description'} if defined $pod{'command_short_description'}; return; } sub command_long_description_predicate { my ($self) = @_; return $self->_command_pod_predicate('command_long_description'); } sub _build_command_long_description { my ($self) = @_; my %pod = $self->_build_command_pod(); return $pod{'command_long_description'} if defined $pod{'command_long_description'}; return; } sub command_usage_predicate { my ($self) = @_; return $self->_command_pod_predicate('command_usage'); } sub _build_command_usage { my ($self) = @_; my %pod = $self->_build_command_pod(); return $pod{'command_usage'} if defined $pod{'command_usage'}; return; } sub _command_pod_predicate { my ($self,$field) = @_; my $attribute = $self->meta->find_attribute_by_name($field); unless ($attribute->has_value($self)) { $self->_build_command_pod($field); } my $value = $attribute->get_value($self); return (defined $value && $value ? 1:0); } sub _build_command_pod { my ($self) = @_; my %pod_raw = MooseX::App::Utils::parse_pod($self->name); my %pod = ( command_usage => ($pod_raw{SYNOPSIS} || $pod_raw{USAGE}), command_long_description => ($pod_raw{DESCRIPTION} || $pod_raw{OVERVIEW}), command_short_description => ($pod_raw{NAME} || $pod_raw{ABSTRACT}), ); # Loop sections that need to be extracted from POD foreach my $key (keys %pod) { my $meta_attribute = $self->meta->find_attribute_by_name($key); next unless defined $meta_attribute; next if $meta_attribute->has_value($self); $meta_attribute->set_raw_value($self,$pod{$key}); } return %pod; } #{ # package Moose::Meta::Class::Custom::Trait::AppCommand; # sub register_implementation { return 'MooseX::App::Meta::Role::Class::Documentation' } #} 1; __END__ =pod =encoding utf8 =head1 NAME MooseX::App::Meta::Role::Class::Documentation - Meta class role for command classes =head1 DESCRIPTION This meta class role will automatically be applied to all command classes. This documentation is only of interest if you intend to write plugins for MooseX::App. =head1 ACCESSORS =head2 command_short_description Read/set the short command description. Will be extracted from the Pod NAME or ABSTRACT section if not set. Alternative this will be taken from the DistZilla ABSTRACT tag. =head2 command_long_description Read/set the long command description. Will be extracted from the Pod DESCRIPTION or OVERVIEW section if not set. =head2 command_usage Read/set the long command usage. Will be extracted from the Pod SYNOPSIS or USAGE section if not set. If these Pod sections are not defined the usage will be autogenerated. =head2 command_short_description_predicate Checks if command_short_description is available =head2 command_long_description_predicate Checks if command_long_description is available =head2 command_usage_predicate Checks if command_usage is available =head2 command_strict Read/set the strict command flag. If strict is enabled the command will terminate with an error message if superfluous/unknown positional parameters are supplied. If disabled all extra parameters will be copied to the L attribute. The app_strict function in the app classes allows one to set this option globally. =head1 METHODS =head2 _build_command_pod Parses the Pod from the command class. =cutBashCompletion000755000765000024 014514737355 21247 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/PluginCommand.pm100644000765000024 526214514737355 23330 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/BashCompletion# ============================================================================ package MooseX::App::Plugin::BashCompletion::Command; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose; use MooseX::App::Command; command_short_description q(Bash completion automator); sub bash_completion { my ($self,$app) = @_; my %command_map; my $app_meta = $app->meta; my $commands = $app_meta->app_commands; my @commands_to_complete = grep { $_ ne 'bash_completion' } sort keys %{$commands}; my $command_list = join (' ', @commands_to_complete); my $package = __PACKAGE__; my $prefix = $app_meta->app_base; my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($ENV{SOURCE_DATE_EPOCH} || time); $year += 1900; $mday = sprintf('%02i',$mday); $mon = sprintf('%02i',$mon+1); $prefix =~ tr/./_/; foreach my $command (@commands_to_complete) { my $command_class = $commands->{$command}; Class::Load::load_class($command_class); #my @parameters = $app_meta->command_usage_attributes($command_class->meta,'parameter'); my @options = $app_meta->command_usage_attributes($command_class->meta,[qw(option proto)]); $command_map{$command} = { #parameters => [ map { $_->is_required } @parameters ], options => [ map { $_->cmd_usage_name } @options ], }; } my $syntax = ''; $syntax .= <<"EOT"; #!/bin/bash # Built with $package on $year/$mon/$mday ${prefix}_COMMANDS='help $command_list' _${prefix}_macc_help() { if [ \$COMP_CWORD = 2 ]; then _${prefix}_compreply "\$${prefix}_COMMANDS" else COMPREPLY=() fi } EOT foreach my $command (sort keys %command_map) { $syntax .= "_${prefix}_macc_${command}() {\n _${prefix}_compreply \""; #$syntax .= join(" ", @{$data->{parameters}}); $syntax .= join(" ", sort @{$command_map{$command}->{options}}); $syntax .= "\"\n}\n\n"; } $syntax .= <<"EOT"; _${prefix}_compreply() { COMPREPLY=(\$(compgen -W "\$1" -- \${COMP_WORDS[COMP_CWORD]})) } _${prefix}_macc() { case \$COMP_CWORD in 0) ;; 1) _${prefix}_compreply "\$${prefix}_COMMANDS" ;; *) eval _${prefix}_macc_\${COMP_WORDS[1]} esac } EOT $syntax .= "complete -o default -F _${prefix}_macc ". $app_meta->app_base. "\n"; return MooseX::App::Message::Envelope->new( MooseX::App::Message::Block->new({ body => $syntax }) ); } __PACKAGE__->meta->make_immutable; 1; Attribute.pm100644000765000024 141014514737355 23245 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/Depends/Meta# ============================================================================ package MooseX::App::Plugin::Depends::Meta::Attribute; # ============================================================================ use Moose::Role; use namespace::autoclean; has 'depends' => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [] }, ); around 'cmd_tags_list' => sub { my $orig = shift; my ($self) = @_; my @tags = $self->$orig(); push(@tags,'Depends') if $self->can('depends') && $self->depends; return @tags; }; { package Moose::Meta::Attribute::Custom::Trait::AppDepends; use strict; use warnings; sub register_implementation { return 'MooseX::App::Plugin::Depends::Meta::Attribute' } } 1; Meta000755000765000024 014514737355 22135 5ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/BashCompletionClass.pm100644000765000024 106214514737355 23677 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/BashCompletion/Meta# ============================================================================ package MooseX::App::Plugin::BashCompletion::Meta::Class; # ============================================================================ use 5.010; use utf8; use namespace::autoclean; use Moose::Role; use MooseX::App::Plugin::BashCompletion::Command; around '_build_app_commands' => sub { my $orig = shift; my $self = shift; my $return = $self->$orig(@_); $return->{bash_completion} ||= 'MooseX::App::Plugin::BashCompletion::Command'; return $return; }; 1;Attribute.pm100644000765000024 136014514737355 24006 0ustar00mkostaff000000000000MooseX-App-1.43/lib/MooseX/App/Plugin/MutexGroup/Meta# ============================================================================ package MooseX::App::Plugin::MutexGroup::Meta::Attribute; # ============================================================================ use Moose::Role; use namespace::autoclean; has 'mutexgroup' => ( is => 'ro', isa => 'Str', ); around 'cmd_tags_list' => sub { my $orig = shift; my ($self) = @_; my @tags = $self->$orig(); push(@tags,'MutexGroup') if $self->can('mutexgroup') && $self->mutexgroup; return @tags; }; { package Moose::Meta::Attribute::Custom::Trait::AppMutexGroup; use strict; use warnings; sub register_implementation { return 'MooseX::App::Plugin::MutexGroup::Meta::Attribute' } } 1;