String-Formatter-1.234/000755 000765 000024 00000000000 14112525165 015037 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/misc/000755 000765 000024 00000000000 14112525165 015772 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/LICENSE000644 000765 000024 00000043524 14112525165 016054 0ustar00rjbsstaff000000 000000 This software is Copyright (c) 2021 by Ricardo Signes . This is free software, licensed under: The GNU General Public License, Version 2, June 1991 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, 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 licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS 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 the public, 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) 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 2 of the License, 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) year 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 is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. String-Formatter-1.234/Changes000644 000765 000024 00000003000 14112525165 016323 0ustar00rjbsstaff000000 000000 Revision history for String-Formatter 1.234 2021-08-28 17:28:18-04:00 America/New_York - move bench.pl from dist root so it won't get installed to @INC - fix some problems with doc layout 0.102084 2013-11-08 22:30:46 America/New_York - typo fixes - update repo and bugtracker links 0.102082 2010-10-19 14:34:34 America/New_York add missing prereq for Test::More 0.102081 2010-10-17 13:40:26 America/New_York allow subclasses to provide default_codes implement %% in a simpler, but not quite perl-like, way 0.102080 2010-07-27 22:07:11 America/New_York input hunkers have been tweaked and more fully documented 0.101620 2010-06-11 21:31:26 America/New_York add indexed_replace, require_arrayref_input, and indexed_stringf 0.100720 2010-03-13 09:36:03 America/New_York fix an ancillary file that brought in a bunch of bogus prereqs 0.100690 2010-03-10 21:09:36 America/New_York fix a 5.10-ism that slipped in 0.100680 2010-03-09 20:54:11 America/New_York bug fix: newlines no longer end formatting, but not allowed in braces (thanks for bug report, Christopher J. Madsen) 0.093221 2009-11-18 08:13:22 America/New_York remove stupidly left-in hardcoded version! 0.093220 2009-11-18 08:12:10 America/New_York fix a problem with prereqs and tests 0.093210 2009-11-17 add the cookbook add method importer 0.093200 2009-11-16 first release! String-Formatter-1.234/MANIFEST000644 000765 000024 00000000574 14112525165 016176 0ustar00rjbsstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.024. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README dist.ini lib/String/Formatter.pm lib/String/Formatter/Cookbook.pm misc/bench.pl t/00-report-prereqs.dd t/00-report-prereqs.t t/basic.t t/braces.t t/method.t t/params.t t/stringf.t xt/author/pod-syntax.t xt/release/changes_has_content.t String-Formatter-1.234/t/000755 000765 000024 00000000000 14112525165 015302 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/xt/000755 000765 000024 00000000000 14112525165 015472 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/README000644 000765 000024 00000000544 14112525165 015722 0ustar00rjbsstaff000000 000000 This archive contains the distribution String-Formatter, version 1.234: build sprintf-like functions of your own This software is Copyright (c) 2021 by Ricardo Signes . This is free software, licensed under: The GNU General Public License, Version 2, June 1991 This README file was generated by Dist::Zilla::Plugin::Readme v6.024. String-Formatter-1.234/META.yml000644 000765 000024 00000027475 14112525165 016327 0ustar00rjbsstaff000000 000000 --- abstract: 'build sprintf-like functions of your own' author: - 'Ricardo Signes ' - 'Darren Chamberlain ' build_requires: ExtUtils::MakeMaker: '0' File::Spec: '0' Test::More: '0.96' configure_requires: ExtUtils::MakeMaker: '6.78' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.024, CPAN::Meta::Converter version 2.150010' license: gpl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: String-Formatter requires: Params::Util: '0' Sub::Exporter: '0' perl: '5.012' strict: '0' warnings: '0' resources: bugtracker: https://github.com/rjbs/String-Formatter/issues homepage: https://github.com/rjbs/String-Formatter repository: https://github.com/rjbs/String-Formatter.git version: '1.234' x_Dist_Zilla: perl: version: '5.035002' plugins: - class: Dist::Zilla::Plugin::Git::GatherDir config: Dist::Zilla::Plugin::GatherDir: exclude_filename: [] exclude_match: [] follow_symlinks: 0 include_dotfiles: 0 prefix: '' prune_directory: [] root: . Dist::Zilla::Plugin::Git::GatherDir: include_untracked: 0 name: '@RJBS/Git::GatherDir' version: '2.048' - class: Dist::Zilla::Plugin::CheckPrereqsIndexed name: '@RJBS/CheckPrereqsIndexed' version: '0.021' - class: Dist::Zilla::Plugin::CheckExtraTests name: '@RJBS/CheckExtraTests' version: '0.029' - class: Dist::Zilla::Plugin::PromptIfStale config: Dist::Zilla::Plugin::PromptIfStale: check_all_plugins: 0 check_all_prereqs: 0 modules: - Dist::Zilla::PluginBundle::RJBS phase: build run_under_travis: 0 skip: [] name: '@RJBS/RJBS-Outdated' version: '0.057' - class: Dist::Zilla::Plugin::PromptIfStale config: Dist::Zilla::Plugin::PromptIfStale: check_all_plugins: 1 check_all_prereqs: 0 modules: [] phase: release run_under_travis: 0 skip: - Dist::Zilla::Plugin::RJBSMisc name: '@RJBS/CPAN-Outdated' version: '0.057' - class: Dist::Zilla::Plugin::PruneCruft name: '@RJBS/@Filter/PruneCruft' version: '6.024' - class: Dist::Zilla::Plugin::ManifestSkip name: '@RJBS/@Filter/ManifestSkip' version: '6.024' - class: Dist::Zilla::Plugin::MetaYAML name: '@RJBS/@Filter/MetaYAML' version: '6.024' - class: Dist::Zilla::Plugin::License name: '@RJBS/@Filter/License' version: '6.024' - class: Dist::Zilla::Plugin::Readme name: '@RJBS/@Filter/Readme' version: '6.024' - class: Dist::Zilla::Plugin::ExecDir name: '@RJBS/@Filter/ExecDir' version: '6.024' - class: Dist::Zilla::Plugin::ShareDir name: '@RJBS/@Filter/ShareDir' version: '6.024' - class: Dist::Zilla::Plugin::Manifest name: '@RJBS/@Filter/Manifest' version: '6.024' - class: Dist::Zilla::Plugin::TestRelease name: '@RJBS/@Filter/TestRelease' version: '6.024' - class: Dist::Zilla::Plugin::ConfirmRelease name: '@RJBS/@Filter/ConfirmRelease' version: '6.024' - class: Dist::Zilla::Plugin::UploadToCPAN name: '@RJBS/@Filter/UploadToCPAN' version: '6.024' - class: Dist::Zilla::Plugin::MakeMaker config: Dist::Zilla::Role::TestRunner: default_jobs: 9 name: '@RJBS/MakeMaker' version: '6.024' - class: Dist::Zilla::Plugin::AutoPrereqs name: '@RJBS/AutoPrereqs' version: '6.024' - class: Dist::Zilla::Plugin::Git::NextVersion config: Dist::Zilla::Plugin::Git::NextVersion: first_version: '0.001' version_by_branch: 1 version_regexp: (?^:^([0-9]+\.[0-9]+)$) Dist::Zilla::Role::Git::Repo: git_version: '2.30.1 (Apple Git-130)' repo_root: . name: '@RJBS/Git::NextVersion' version: '2.048' - class: Dist::Zilla::Plugin::PkgVersion name: '@RJBS/PkgVersion' version: '6.024' - class: Dist::Zilla::Plugin::MetaConfig name: '@RJBS/MetaConfig' version: '6.024' - class: Dist::Zilla::Plugin::MetaJSON name: '@RJBS/MetaJSON' version: '6.024' - class: Dist::Zilla::Plugin::NextRelease name: '@RJBS/NextRelease' version: '6.024' - class: Dist::Zilla::Plugin::Test::ChangesHasContent name: '@RJBS/Test::ChangesHasContent' version: '0.011' - class: Dist::Zilla::Plugin::PodSyntaxTests name: '@RJBS/PodSyntaxTests' version: '6.024' - class: Dist::Zilla::Plugin::Test::ReportPrereqs name: '@RJBS/Test::ReportPrereqs' version: '0.028' - class: Dist::Zilla::Plugin::Git::Remote::Check name: '@RJBS/Git::Remote::Check' version: 0.1.2 - class: Dist::Zilla::Plugin::Prereqs config: Dist::Zilla::Plugin::Prereqs: phase: test type: requires name: '@RJBS/TestMoreWithSubtests' version: '6.024' - class: Dist::Zilla::Plugin::PodWeaver config: Dist::Zilla::Plugin::PodWeaver: config_plugins: - '@RJBS' finder: - ':InstallModules' - ':ExecFiles' plugins: - class: Pod::Weaver::Plugin::EnsurePod5 name: '@CorePrep/EnsurePod5' version: '4.018' - class: Pod::Weaver::Plugin::H1Nester name: '@CorePrep/H1Nester' version: '4.018' - class: Pod::Weaver::Plugin::SingleEncoding name: '@RJBS/SingleEncoding' version: '4.018' - class: Pod::Weaver::Section::Name name: '@RJBS/Name' version: '4.018' - class: Pod::Weaver::Section::Version name: '@RJBS/Version' version: '4.018' - class: Pod::Weaver::Section::Region name: '@RJBS/Prelude' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Synopsis' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Description' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Overview' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Stability' version: '4.018' - class: Pod::Weaver::Section::GenerateSection name: '@RJBS/PerlSupport' version: '4.018' - class: Pod::Weaver::Section::Collect name: Attributes version: '4.018' - class: Pod::Weaver::Section::Collect name: Methods version: '4.018' - class: Pod::Weaver::Section::Collect name: Functions version: '4.018' - class: Pod::Weaver::Section::Leftovers name: '@RJBS/Leftovers' version: '4.018' - class: Pod::Weaver::Section::Region name: '@RJBS/postlude' version: '4.018' - class: Pod::Weaver::Section::Authors name: '@RJBS/Authors' version: '4.018' - class: Pod::Weaver::Section::Contributors name: '@RJBS/Contributors' version: '0.009' - class: Pod::Weaver::Section::Legal name: '@RJBS/Legal' version: '4.018' - class: Pod::Weaver::Plugin::Transformer name: '@RJBS/List' version: '4.018' name: '@RJBS/PodWeaver' version: '4.009' - class: Dist::Zilla::Plugin::RJBSMisc name: '@RJBS/RJBSMisc' version: '5.020' - class: Dist::Zilla::Plugin::GithubMeta name: '@RJBS/GithubMeta' version: '0.58' - class: Dist::Zilla::Plugin::Git::Check config: Dist::Zilla::Plugin::Git::Check: untracked_files: die Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: '2.30.1 (Apple Git-130)' repo_root: . name: '@RJBS/@Git/Check' version: '2.048' - class: Dist::Zilla::Plugin::Git::Commit config: Dist::Zilla::Plugin::Git::Commit: add_files_in: [] commit_msg: v%V%n%n%c signoff: '0' Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: '2.30.1 (Apple Git-130)' repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@RJBS/@Git/Commit' version: '2.048' - class: Dist::Zilla::Plugin::Git::Tag config: Dist::Zilla::Plugin::Git::Tag: branch: ~ changelog: Changes signed: 0 tag: '1.234' tag_format: '%v' tag_message: v%V Dist::Zilla::Role::Git::Repo: git_version: '2.30.1 (Apple Git-130)' repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@RJBS/@Git/Tag' version: '2.048' - class: Dist::Zilla::Plugin::Git::Push config: Dist::Zilla::Plugin::Git::Push: push_to: - 'github :' remotes_must_exist: 0 Dist::Zilla::Role::Git::Repo: git_version: '2.30.1 (Apple Git-130)' repo_root: . name: '@RJBS/@Git/Push' version: '2.048' - class: Dist::Zilla::Plugin::Git::Contributors config: Dist::Zilla::Plugin::Git::Contributors: git_version: '2.30.1 (Apple Git-130)' include_authors: 0 include_releaser: 1 order_by: name paths: [] name: '@RJBS/Git::Contributors' version: '0.036' - class: Dist::Zilla::Plugin::FinderCode name: ':InstallModules' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':IncModules' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':TestFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':ExtraTestFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':ExecFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':PerlExecFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':ShareFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':MainModule' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':AllFiles' version: '6.024' - class: Dist::Zilla::Plugin::FinderCode name: ':NoFiles' version: '6.024' zilla: class: Dist::Zilla::Dist::Builder config: is_trial: '0' version: '6.024' x_contributors: - 'Darren Chamberlain ' - 'David Steinbrunner ' - 'dlc ' x_generated_by_perl: v5.35.2 x_rjbs_perl_window: long-term x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: GPL-2.0-only String-Formatter-1.234/lib/000755 000765 000024 00000000000 14112525165 015605 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/Makefile.PL000644 000765 000024 00000002506 14112525165 017014 0ustar00rjbsstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.024. use strict; use warnings; use 5.012; use ExtUtils::MakeMaker 6.78; my %WriteMakefileArgs = ( "ABSTRACT" => "build sprintf-like functions of your own", "AUTHOR" => "Ricardo Signes , Darren Chamberlain ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.78" }, "DISTNAME" => "String-Formatter", "LICENSE" => "gpl", "MIN_PERL_VERSION" => "5.012", "NAME" => "String::Formatter", "PREREQ_PM" => { "Params::Util" => 0, "Sub::Exporter" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Test::More" => "0.96" }, "VERSION" => "1.234", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Params::Util" => 0, "Sub::Exporter" => 0, "Test::More" => "0.96", "strict" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); String-Formatter-1.234/META.json000644 000765 000024 00000044652 14112525165 016473 0ustar00rjbsstaff000000 000000 { "abstract" : "build sprintf-like functions of your own", "author" : [ "Ricardo Signes ", "Darren Chamberlain " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.024, CPAN::Meta::Converter version 2.150010", "license" : [ "gpl_2" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "String-Formatter", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.78" } }, "develop" : { "requires" : { "Encode" : "0", "Test::More" : "0", "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "Params::Util" : "0", "Sub::Exporter" : "0", "perl" : "5.012", "strict" : "0", "warnings" : "0" } }, "test" : { "recommends" : { "CPAN::Meta" : "2.120900" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec" : "0", "Test::More" : "0.96" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/rjbs/String-Formatter/issues" }, "homepage" : "https://github.com/rjbs/String-Formatter", "repository" : { "type" : "git", "url" : "https://github.com/rjbs/String-Formatter.git", "web" : "https://github.com/rjbs/String-Formatter" } }, "version" : "1.234", "x_Dist_Zilla" : { "perl" : { "version" : "5.035002" }, "plugins" : [ { "class" : "Dist::Zilla::Plugin::Git::GatherDir", "config" : { "Dist::Zilla::Plugin::GatherDir" : { "exclude_filename" : [], "exclude_match" : [], "follow_symlinks" : 0, "include_dotfiles" : 0, "prefix" : "", "prune_directory" : [], "root" : "." }, "Dist::Zilla::Plugin::Git::GatherDir" : { "include_untracked" : 0 } }, "name" : "@RJBS/Git::GatherDir", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::CheckPrereqsIndexed", "name" : "@RJBS/CheckPrereqsIndexed", "version" : "0.021" }, { "class" : "Dist::Zilla::Plugin::CheckExtraTests", "name" : "@RJBS/CheckExtraTests", "version" : "0.029" }, { "class" : "Dist::Zilla::Plugin::PromptIfStale", "config" : { "Dist::Zilla::Plugin::PromptIfStale" : { "check_all_plugins" : 0, "check_all_prereqs" : 0, "modules" : [ "Dist::Zilla::PluginBundle::RJBS" ], "phase" : "build", "run_under_travis" : 0, "skip" : [] } }, "name" : "@RJBS/RJBS-Outdated", "version" : "0.057" }, { "class" : "Dist::Zilla::Plugin::PromptIfStale", "config" : { "Dist::Zilla::Plugin::PromptIfStale" : { "check_all_plugins" : 1, "check_all_prereqs" : 0, "modules" : [], "phase" : "release", "run_under_travis" : 0, "skip" : [ "Dist::Zilla::Plugin::RJBSMisc" ] } }, "name" : "@RJBS/CPAN-Outdated", "version" : "0.057" }, { "class" : "Dist::Zilla::Plugin::PruneCruft", "name" : "@RJBS/@Filter/PruneCruft", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::ManifestSkip", "name" : "@RJBS/@Filter/ManifestSkip", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::MetaYAML", "name" : "@RJBS/@Filter/MetaYAML", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::License", "name" : "@RJBS/@Filter/License", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::Readme", "name" : "@RJBS/@Filter/Readme", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::ExecDir", "name" : "@RJBS/@Filter/ExecDir", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::ShareDir", "name" : "@RJBS/@Filter/ShareDir", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::Manifest", "name" : "@RJBS/@Filter/Manifest", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::TestRelease", "name" : "@RJBS/@Filter/TestRelease", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::ConfirmRelease", "name" : "@RJBS/@Filter/ConfirmRelease", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::UploadToCPAN", "name" : "@RJBS/@Filter/UploadToCPAN", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::MakeMaker", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 9 } }, "name" : "@RJBS/MakeMaker", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::AutoPrereqs", "name" : "@RJBS/AutoPrereqs", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::Git::NextVersion", "config" : { "Dist::Zilla::Plugin::Git::NextVersion" : { "first_version" : "0.001", "version_by_branch" : 1, "version_regexp" : "(?^:^([0-9]+\\.[0-9]+)$)" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.30.1 (Apple Git-130)", "repo_root" : "." } }, "name" : "@RJBS/Git::NextVersion", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::PkgVersion", "name" : "@RJBS/PkgVersion", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::MetaConfig", "name" : "@RJBS/MetaConfig", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::MetaJSON", "name" : "@RJBS/MetaJSON", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::NextRelease", "name" : "@RJBS/NextRelease", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::Test::ChangesHasContent", "name" : "@RJBS/Test::ChangesHasContent", "version" : "0.011" }, { "class" : "Dist::Zilla::Plugin::PodSyntaxTests", "name" : "@RJBS/PodSyntaxTests", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::Test::ReportPrereqs", "name" : "@RJBS/Test::ReportPrereqs", "version" : "0.028" }, { "class" : "Dist::Zilla::Plugin::Git::Remote::Check", "name" : "@RJBS/Git::Remote::Check", "version" : "0.1.2" }, { "class" : "Dist::Zilla::Plugin::Prereqs", "config" : { "Dist::Zilla::Plugin::Prereqs" : { "phase" : "test", "type" : "requires" } }, "name" : "@RJBS/TestMoreWithSubtests", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::PodWeaver", "config" : { "Dist::Zilla::Plugin::PodWeaver" : { "config_plugins" : [ "@RJBS" ], "finder" : [ ":InstallModules", ":ExecFiles" ], "plugins" : [ { "class" : "Pod::Weaver::Plugin::EnsurePod5", "name" : "@CorePrep/EnsurePod5", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::H1Nester", "name" : "@CorePrep/H1Nester", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::SingleEncoding", "name" : "@RJBS/SingleEncoding", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Name", "name" : "@RJBS/Name", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Version", "name" : "@RJBS/Version", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Region", "name" : "@RJBS/Prelude", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Synopsis", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Description", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Overview", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Stability", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::GenerateSection", "name" : "@RJBS/PerlSupport", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Attributes", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Methods", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Functions", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Leftovers", "name" : "@RJBS/Leftovers", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Region", "name" : "@RJBS/postlude", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Authors", "name" : "@RJBS/Authors", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Contributors", "name" : "@RJBS/Contributors", "version" : "0.009" }, { "class" : "Pod::Weaver::Section::Legal", "name" : "@RJBS/Legal", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::Transformer", "name" : "@RJBS/List", "version" : "4.018" } ] } }, "name" : "@RJBS/PodWeaver", "version" : "4.009" }, { "class" : "Dist::Zilla::Plugin::RJBSMisc", "name" : "@RJBS/RJBSMisc", "version" : "5.020" }, { "class" : "Dist::Zilla::Plugin::GithubMeta", "name" : "@RJBS/GithubMeta", "version" : "0.58" }, { "class" : "Dist::Zilla::Plugin::Git::Check", "config" : { "Dist::Zilla::Plugin::Git::Check" : { "untracked_files" : "die" }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.30.1 (Apple Git-130)", "repo_root" : "." } }, "name" : "@RJBS/@Git/Check", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Commit", "config" : { "Dist::Zilla::Plugin::Git::Commit" : { "add_files_in" : [], "commit_msg" : "v%V%n%n%c", "signoff" : 0 }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.30.1 (Apple Git-130)", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@RJBS/@Git/Commit", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Tag", "config" : { "Dist::Zilla::Plugin::Git::Tag" : { "branch" : null, "changelog" : "Changes", "signed" : 0, "tag" : "1.234", "tag_format" : "%v", "tag_message" : "v%V" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.30.1 (Apple Git-130)", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@RJBS/@Git/Tag", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Push", "config" : { "Dist::Zilla::Plugin::Git::Push" : { "push_to" : [ "github :" ], "remotes_must_exist" : 0 }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.30.1 (Apple Git-130)", "repo_root" : "." } }, "name" : "@RJBS/@Git/Push", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Contributors", "config" : { "Dist::Zilla::Plugin::Git::Contributors" : { "git_version" : "2.30.1 (Apple Git-130)", "include_authors" : 0, "include_releaser" : 1, "order_by" : "name", "paths" : [] } }, "name" : "@RJBS/Git::Contributors", "version" : "0.036" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":InstallModules", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":IncModules", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":TestFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExtraTestFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExecFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":PerlExecFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ShareFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":MainModule", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":AllFiles", "version" : "6.024" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":NoFiles", "version" : "6.024" } ], "zilla" : { "class" : "Dist::Zilla::Dist::Builder", "config" : { "is_trial" : 0 }, "version" : "6.024" } }, "x_contributors" : [ "Darren Chamberlain ", "David Steinbrunner ", "dlc " ], "x_generated_by_perl" : "v5.35.2", "x_rjbs_perl_window" : "long-term", "x_serialization_backend" : "Cpanel::JSON::XS version 4.26", "x_spdx_expression" : "GPL-2.0-only" } String-Formatter-1.234/dist.ini000644 000765 000024 00000000400 14112525165 016475 0ustar00rjbsstaff000000 000000 name = String-Formatter author = Ricardo Signes author = Darren Chamberlain license = GPL_2 ; inherited this from darren@cpan copyright_holder = Ricardo Signes [@RJBS] perl-window = long-term String-Formatter-1.234/lib/String/000755 000765 000024 00000000000 14112525165 017053 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/lib/String/Formatter.pm000644 000765 000024 00000100721 14112525165 021355 0ustar00rjbsstaff000000 000000 use v5.8.0; use strict; use warnings; package String::Formatter 1.234; # ABSTRACT: build sprintf-like functions of your own #pod =head1 SYNOPSIS #pod #pod use String::Formatter stringf => { #pod -as => 'str_rf', #pod codes => { #pod f => sub { $_ }, #pod b => sub { scalar reverse $_ }, #pod o => 'Okay?', #pod }, #pod }; #pod #pod print str_rf('This is %10f and this is %-15b, %o', 'forward', 'backward'); #pod #pod ...prints... #pod #pod This is forward and this is drawkcab , okay? #pod #pod =head1 DESCRIPTION #pod #pod String::Formatter is a tool for building sprintf-like formatting routines. #pod It supports named or positional formatting, custom conversions, fixed string #pod interpolation, and simple width-matching out of the box. It is easy to alter #pod its behavior to write new kinds of format string expanders. For most cases, it #pod should be easy to build all sorts of formatters out of the options built into #pod String::Formatter. #pod #pod Normally, String::Formatter will be used to import a sprintf-like routine #pod referred to as "C", but which can be given any name you like. This #pod routine acts like sprintf in that it takes a string and some inputs and returns #pod a new string: #pod #pod my $output = stringf "Some %a format %s for you to %u.\n", { ... }; #pod #pod This routine is actually a wrapper around a String::Formatter object created by #pod importing stringf. In the following code, the entire hashref after "stringf" #pod is passed to String::Formatter's constructor (the C method), save for the #pod C<-as> key and any other keys that start with a dash. #pod #pod use String::Formatter #pod stringf => { #pod -as => 'fmt_time', #pod codes => { ... }, #pod format_hunker => ..., #pod input_processor => ..., #pod }, #pod stringf => { #pod -as => 'fmt_date', #pod codes => { ... }, #pod string_replacer => ..., #pod hunk_formatter => ..., #pod }, #pod ; #pod #pod As you can see, this will generate two stringf routines, with different #pod behaviors, which are installed with different names. Since the behavior of #pod these routines is based on the C method of a String::Formatter object, #pod the rest of the documentation will describe the way the object behaves. #pod #pod There's also a C export, which behaves just like the C #pod export, but defaults to the C and C #pod arguments. There's a C export, which defaults #pod C and C. Finally, a C, #pod which defaults to C and C. For more #pod on these, keep reading, and check out the cookbook. #pod #pod L provides a number of recipes for ways to put #pod String::Formatter to use. #pod #pod =head1 FORMAT STRINGS #pod #pod Format strings are generally assumed to look like Perl's sprintf's format #pod strings: #pod #pod There's a bunch of normal strings and then %s format %1.4c with %% signs. #pod #pod The exact semantics of the format codes are not totally settled yet -- and they #pod can be replaced on a per-formatter basis. Right now, they're mostly a subset #pod of Perl's astonishingly large and complex system. That subset looks like this: #pod #pod % - a percent sign to begin the format #pod ... - (optional) various modifiers to the format like "-5" or "#" or "2$" #pod {..} - (optional) a string inside braces #pod s - a short string (usually one character) identifying the conversion #pod #pod Not all format modifiers found in Perl's C are yet supported. #pod Currently the only format modifiers must match: #pod #pod (-)? # left-align, rather than right #pod (\d*)? # (optional) minimum field width #pod (?:\.(\d*))? # (optional) maximum field width #pod #pod Some additional format semantics may be added, but probably nothing exotic. #pod Even things like C<2$> and C<*> are probably not going to appear in #pod String::Formatter's default behavior. #pod #pod Another subtle difference, introduced intentionally, is in the handling of #pod C<%%>. With the default String::Formatter behavior, string C<%%> is not #pod interpreted as a formatting code. This is different from the behavior of #pod Perl's C, which interprets it as a special formatting character that #pod doesn't consume input and always acts like the fixed string C<%>. The upshot #pod of this is: #pod #pod sprintf "%%"; # ==> returns "%" #pod stringf "%%"; # ==> returns "%%" #pod #pod sprintf "%10%"; # ==> returns " %" #pod stringf "%10%"; # ==> dies: unknown format code % #pod #pod =cut use Params::Util (); use Sub::Exporter -setup => { exports => { stringf => sub { my ($class, $name, $arg, $col) = @_; my $formatter = $class->new($arg); return sub { $formatter->format(@_) }; }, method_stringf => sub { my ($class, $name, $arg, $col) = @_; my $formatter = $class->new({ input_processor => 'require_single_input', string_replacer => 'method_replace', %$arg, }); return sub { $formatter->format(@_) }; }, named_stringf => sub { my ($class, $name, $arg, $col) = @_; my $formatter = $class->new({ input_processor => 'require_named_input', string_replacer => 'named_replace', %$arg, }); return sub { $formatter->format(@_) }; }, indexed_stringf => sub { my ($class, $name, $arg, $col) = @_; my $formatter = $class->new({ input_processor => 'require_arrayref_input', string_replacer => 'indexed_replace', %$arg, }); return sub { $formatter->format(@_) }; }, }, }; my %METHODS; BEGIN { %METHODS = ( format_hunker => 'hunk_simply', input_processor => 'return_input', string_replacer => 'positional_replace', hunk_formatter => 'format_simply', ); no strict 'refs'; for my $method (keys %METHODS) { *$method = sub { $_[0]->{ $method } }; my $default = "default_$method"; *$default = sub { $METHODS{ $method } }; } } #pod =method new #pod #pod my $formatter = String::Formatter->new({ #pod codes => { ... }, #pod format_hunker => ..., #pod input_processor => ..., #pod string_replacer => ..., #pod hunk_formatter => ..., #pod }); #pod #pod This returns a new formatter. The C argument contains the formatting #pod codes for the formatter in the form: #pod #pod codes => { #pod s => 'fixed string', #pod S => 'different string', #pod c => sub { ... }, #pod } #pod #pod Code values (or "conversions") should either be strings or coderefs. This #pod hashref can be accessed later with the C method. #pod #pod The other four arguments change how the formatting occurs. Formatting happens #pod in five phases: #pod #pod =for :list #pod 1. format_hunker - format string is broken down into fixed and %-code hunks #pod 2. input_processor - the other inputs are validated and processed #pod 3. string_replacer - replacement strings are generated by using conversions #pod 4. hunk_formatter - replacement strings in hunks are formatted #pod 5. all hunks, now strings, are recombined; this phase is just C #pod #pod The defaults are found by calling C for each helper that #pod isn't given. Values must be either strings (which are interpreted as method #pod names) or coderefs. The semantics for each method are described in the #pod methods' sections, below. #pod #pod =cut sub default_codes { return {}; } sub new { my ($class, $arg) = @_; my $_codes = { %{ $class->default_codes }, %{ $arg->{codes} || {} }, }; my $self = bless { codes => $_codes } => $class; for (keys %METHODS) { $self->{ $_ } = $arg->{ $_ } || do { my $default_method = "default_$_"; $class->$default_method; }; $self->{$_} = $self->can($self->{$_}) unless ref $self->{$_}; } my $codes = $self->codes; return $self; } sub codes { $_[0]->{codes} } #pod =method format #pod #pod my $result = $formatter->format( $format_string, @input ); #pod #pod print $formatter->format("My %h is full of %e.\n", 'hovercraft', 'eels'); #pod #pod This does the actual formatting, calling the methods described above, under #pod C> and returning the result. #pod #pod =cut sub format { my $self = shift; my $format = shift; Carp::croak("not enough arguments for stringf-based format") unless defined $format; my $hunker = $self->format_hunker; my $hunks = $self->$hunker($format); my $processor = $self->input_processor; my $input = $self->$processor([ @_ ]); my $replacer = $self->string_replacer; $self->$replacer($hunks, $input); my $formatter = $self->hunk_formatter; ref($_) and $_ = $self->$formatter($_) for @$hunks; my $string = join q{}, @$hunks; return $string; } #pod =method format_hunker #pod #pod Format hunkers are passed strings and return arrayrefs containing strings (for #pod fixed content) and hashrefs (for formatting code sections). #pod #pod The hashref hunks should contain at least two entries: C for the #pod conversion code (the s, d, or u in %s, %d, or %u); and C for the #pod complete original text of the hunk. For example, a bare minimum hunker should #pod turn the following: #pod #pod I would like to buy %d %s today. #pod #pod ...into... #pod #pod [ #pod 'I would like to buy ', #pod { conversion => 'd', literal => '%d' }, #pod ' ', #pod { conversion => 's', literal => '%d' }, #pod ' today.', #pod ] #pod #pod Another common entry is C. In the format strings expected by #pod C, for example, these are free strings inside of curly braces. #pod These are used extensively other existing helpers for things liked accessing #pod named arguments or providing method names. #pod #pod =method hunk_simply #pod #pod This is the default format hunker. It implements the format string semantics #pod L. #pod #pod This hunker will produce C and C and C. Its #pod other entries are not yet well-defined for public consumption. #pod #pod =cut my $regex = qr/ (% # leading '%' (-)? # left-align, rather than right ([0-9]+)? # (optional) minimum field width (?:\.([0-9]*))? # (optional) maximum field width (?:{(.*?)})? # (optional) stuff inside (\S) # actual format character ) /x; sub hunk_simply { my ($self, $string) = @_; my @to_fmt; my $pos = 0; while ($string =~ m{\G(.*?)$regex}gs) { push @to_fmt, $1, { alignment => $3, min_width => $4, max_width => $5, literal => $2, argument => $6, conversion => $7, }; $to_fmt[-1] = '%' if $to_fmt[-1]{literal} eq '%%'; $pos = pos $string; } push @to_fmt, substr $string, $pos if $pos < length $string; return \@to_fmt; } #pod =method input_processor #pod #pod The input processor is responsible for inspecting the post-format-string #pod arguments, validating them, and returning them in a possibly-transformed form. #pod The processor is passed an arrayref containing the arguments and should return #pod a scalar value to be used as the input going forward. #pod #pod =method return_input #pod #pod This input processor, the default, simply returns the input it was given with #pod no validation or transformation. #pod #pod =cut sub return_input { return $_[1]; } #pod =method require_named_input #pod #pod This input processor will raise an exception unless there is exactly one #pod post-format-string argument to the format call, and unless that argument is a #pod hashref. It will also replace the arrayref with the given hashref so #pod subsequent phases of the format can avoid lots of needless array dereferencing. #pod #pod =cut sub require_named_input { my ($self, $args) = @_; Carp::croak("routine must be called with exactly one hashref arg") if @$args != 1 or ! Params::Util::_HASHLIKE($args->[0]); return $args->[0]; } #pod =method require_arrayref_input #pod #pod This input processor will raise an exception unless there is exactly one #pod post-format-string argument to the format call, and unless that argument is a #pod arrayref. It will also replace the input with that single arrayref it found so #pod subsequent phases of the format can avoid lots of needless array dereferencing. #pod #pod =cut sub require_arrayref_input { my ($self, $args) = @_; Carp::croak("routine must be called with exactly one arrayref arg") if @$args != 1 or ! Params::Util::_ARRAYLIKE($args->[0]); return $args->[0]; } #pod =method require_single_input #pod #pod This input processor will raise an exception if more than one input is given. #pod After input processing, the single element in the input will be used as the #pod input itself. #pod #pod =cut sub require_single_input { my ($self, $args) = @_; Carp::croak("routine must be called with exactly one argument after string") if @$args != 1; return $args->[0]; } #pod =method forbid_input #pod #pod This input processor will raise an exception if any input is given. In other #pod words, formatters with this input processor accept format strings and nothing #pod else. #pod #pod =cut sub forbid_input { my ($self, $args) = @_; Carp::croak("routine must be called with no arguments after format string") if @$args; return $args; } #pod =method string_replacer #pod #pod The string_replacer phase is responsible for adding a C entry to #pod format code hunks. This should be a string-value entry that will be formatted #pod and concatenated into the output string. String replacers can also replace the #pod whole hunk with a string to avoid any subsequent formatting. #pod #pod =method positional_replace #pod #pod This replacer matches inputs to the hunk's position in the format string. This #pod is the default replacer, used in the L, which should #pod make its behavior clear. At present, fixed-string conversions B affect #pod the position of arg matched, meaning that given the following: #pod #pod my $formatter = String::Formatter->new({ #pod codes => { #pod f => 'fixed string', #pod s => sub { ... }, #pod } #pod }); #pod #pod $formatter->format("%s %f %s", 1, 2); #pod #pod The subroutine is called twice, once for the input C<1> and once for the input #pod C<2>. B after some more experimental use. #pod #pod =method named_replace #pod #pod This replacer should be used with the C input processor. #pod It expects the input to be a hashref and it finds values to be interpolated by #pod looking in the hashref for the brace-enclosed name on each format code. Here's #pod an example use: #pod #pod $formatter->format("This was the %{adj}s day in %{num}d weeks.", { #pod adj => 'best', #pod num => 6, #pod }); #pod #pod =method indexed_replace #pod #pod This replacer should be used with the C input #pod processor. It expects the input to be an arrayref and it finds values to be #pod interpolated by looking in the arrayref for the brace-enclosed index on each #pod format code. Here's an example use: #pod #pod $formatter->format("This was the %{1}s day in %{0}d weeks.", [ 6, 'best' ]); #pod #pod =cut sub __closure_replace { my ($closure) = @_; return sub { my ($self, $hunks, $input) = @_; my $heap = {}; my $code = $self->codes; for my $i (grep { ref $hunks->[$_] } 0 .. $#$hunks) { my $hunk = $hunks->[ $i ]; my $conv = $code->{ $hunk->{conversion} }; Carp::croak("Unknown conversion in stringf: $hunk->{conversion}") unless defined $conv; if (ref $conv) { $hunks->[ $i ]->{replacement} = $self->$closure({ conv => $conv, hunk => $hunk, heap => $heap, input => $input, }); } else { $hunks->[ $i ]->{replacement} = $conv; } } }; } # $self->$string_replacer($hunks, $input); BEGIN { *positional_replace = __closure_replace(sub { my ($self, $arg) = @_; local $_ = $arg->{input}->[ $arg->{heap}{nth}++ ]; return $arg->{conv}->($self, $_, $arg->{hunk}{argument}); }); *named_replace = __closure_replace(sub { my ($self, $arg) = @_; local $_ = $arg->{input}->{ $arg->{hunk}{argument} }; return $arg->{conv}->($self, $_, $arg->{hunk}{argument}); }); *indexed_replace = __closure_replace(sub { my ($self, $arg) = @_; local $_ = $arg->{input}->[ $arg->{hunk}{argument} ]; return $arg->{conv}->($self, $_, $arg->{hunk}{argument}); }); } #pod =method method_replace #pod #pod This string replacer method expects the input to be a single value on which #pod methods can be called. If a value was given in braces to the format code, it #pod is passed as an argument. #pod #pod =cut # should totally be rewritten with commonality with keyed_replace factored out sub method_replace { my ($self, $hunks, $input) = @_; my $heap = {}; my $code = $self->codes; for my $i (grep { ref $hunks->[$_] } 0 .. $#$hunks) { my $hunk = $hunks->[ $i ]; my $conv = $code->{ $hunk->{conversion} }; Carp::croak("Unknown conversion in stringf: $hunk->{conversion}") unless defined $conv; if (ref $conv) { local $_ = $input; $hunks->[ $i ]->{replacement} = $input->$conv($hunk->{argument}); } else { local $_ = $input; $hunks->[ $i ]->{replacement} = $input->$conv( defined $hunk->{argument} ? $hunk->{argument} : () ); } } } #pod =method keyed_replace #pod #pod This string replacer method expects the input to be a single hashref. Coderef #pod code values are used as callbacks, but strings are used as hash keys. If a #pod value was given in braces to the format code, it is ignored. #pod #pod For example if the codes contain C<< i => 'ident' >> then C<%i> in the format #pod string will be replaced with C<< $input->{ident} >> in the output. #pod #pod =cut # should totally be rewritten with commonality with method_replace factored out sub keyed_replace { my ($self, $hunks, $input) = @_; my $heap = {}; my $code = $self->codes; for my $i (grep { ref $hunks->[$_] } 0 .. $#$hunks) { my $hunk = $hunks->[ $i ]; my $conv = $code->{ $hunk->{conversion} }; Carp::croak("Unknown conversion in stringf: $hunk->{conversion}") unless defined $conv; if (ref $conv) { local $_ = $input; $hunks->[ $i ]->{replacement} = $input->$conv($hunk->{argument}); } else { local $_ = $input; $hunks->[ $i ]->{replacement} = $input->{$conv}; } } } #pod =method hunk_formatter #pod #pod The hunk_formatter processes each the hashref hunks left after string #pod replacement and returns a string. When it is called, it is passed a hunk #pod hashref and must return a string. #pod #pod =method format_simply #pod #pod This is the default hunk formatter. It deals with minimum and maximum width #pod cues as well as left and right alignment. Beyond that, it does no formatting #pod of the replacement string. #pod #pod =cut sub format_simply { my ($self, $hunk) = @_; my $replacement = $hunk->{replacement}; my $replength = length $replacement; my $alignment = $hunk->{alignment} || ''; my $min_width = $hunk->{min_width} || 0; my $max_width = $hunk->{max_width} || $replength; $min_width ||= $replength > $min_width ? $min_width : $replength; $max_width ||= $max_width > $replength ? $max_width : $replength; return sprintf "%$alignment${min_width}.${max_width}s", $replacement; } 1; #pod =begin :postlude #pod #pod =head1 HISTORY #pod #pod String::Formatter is based on L, written by #pod Darren Chamberlain. For a history of the code, check the project's source code #pod repository. All bugs should be reported to Ricardo Signes and #pod String::Formatter. Very little of the original code remains. #pod #pod =end :postlude #pod #pod =for Pod::Coverage #pod codes #pod default_format_hunker #pod default_input_processor #pod default_string_replacer #pod default_hunk_formatter #pod __END__ =pod =encoding UTF-8 =head1 NAME String::Formatter - build sprintf-like functions of your own =head1 VERSION version 1.234 =head1 SYNOPSIS use String::Formatter stringf => { -as => 'str_rf', codes => { f => sub { $_ }, b => sub { scalar reverse $_ }, o => 'Okay?', }, }; print str_rf('This is %10f and this is %-15b, %o', 'forward', 'backward'); ...prints... This is forward and this is drawkcab , okay? =head1 DESCRIPTION String::Formatter is a tool for building sprintf-like formatting routines. It supports named or positional formatting, custom conversions, fixed string interpolation, and simple width-matching out of the box. It is easy to alter its behavior to write new kinds of format string expanders. For most cases, it should be easy to build all sorts of formatters out of the options built into String::Formatter. Normally, String::Formatter will be used to import a sprintf-like routine referred to as "C", but which can be given any name you like. This routine acts like sprintf in that it takes a string and some inputs and returns a new string: my $output = stringf "Some %a format %s for you to %u.\n", { ... }; This routine is actually a wrapper around a String::Formatter object created by importing stringf. In the following code, the entire hashref after "stringf" is passed to String::Formatter's constructor (the C method), save for the C<-as> key and any other keys that start with a dash. use String::Formatter stringf => { -as => 'fmt_time', codes => { ... }, format_hunker => ..., input_processor => ..., }, stringf => { -as => 'fmt_date', codes => { ... }, string_replacer => ..., hunk_formatter => ..., }, ; As you can see, this will generate two stringf routines, with different behaviors, which are installed with different names. Since the behavior of these routines is based on the C method of a String::Formatter object, the rest of the documentation will describe the way the object behaves. There's also a C export, which behaves just like the C export, but defaults to the C and C arguments. There's a C export, which defaults C and C. Finally, a C, which defaults to C and C. For more on these, keep reading, and check out the cookbook. L provides a number of recipes for ways to put String::Formatter to use. =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 METHODS =head2 new my $formatter = String::Formatter->new({ codes => { ... }, format_hunker => ..., input_processor => ..., string_replacer => ..., hunk_formatter => ..., }); This returns a new formatter. The C argument contains the formatting codes for the formatter in the form: codes => { s => 'fixed string', S => 'different string', c => sub { ... }, } Code values (or "conversions") should either be strings or coderefs. This hashref can be accessed later with the C method. The other four arguments change how the formatting occurs. Formatting happens in five phases: =over 4 =item 1 format_hunker - format string is broken down into fixed and %-code hunks =item 2 input_processor - the other inputs are validated and processed =item 3 string_replacer - replacement strings are generated by using conversions =item 4 hunk_formatter - replacement strings in hunks are formatted =item 5 all hunks, now strings, are recombined; this phase is just C =back The defaults are found by calling C for each helper that isn't given. Values must be either strings (which are interpreted as method names) or coderefs. The semantics for each method are described in the methods' sections, below. =head2 format my $result = $formatter->format( $format_string, @input ); print $formatter->format("My %h is full of %e.\n", 'hovercraft', 'eels'); This does the actual formatting, calling the methods described above, under C> and returning the result. =head2 format_hunker Format hunkers are passed strings and return arrayrefs containing strings (for fixed content) and hashrefs (for formatting code sections). The hashref hunks should contain at least two entries: C for the conversion code (the s, d, or u in %s, %d, or %u); and C for the complete original text of the hunk. For example, a bare minimum hunker should turn the following: I would like to buy %d %s today. ...into... [ 'I would like to buy ', { conversion => 'd', literal => '%d' }, ' ', { conversion => 's', literal => '%d' }, ' today.', ] Another common entry is C. In the format strings expected by C, for example, these are free strings inside of curly braces. These are used extensively other existing helpers for things liked accessing named arguments or providing method names. =head2 hunk_simply This is the default format hunker. It implements the format string semantics L. This hunker will produce C and C and C. Its other entries are not yet well-defined for public consumption. =head2 input_processor The input processor is responsible for inspecting the post-format-string arguments, validating them, and returning them in a possibly-transformed form. The processor is passed an arrayref containing the arguments and should return a scalar value to be used as the input going forward. =head2 return_input This input processor, the default, simply returns the input it was given with no validation or transformation. =head2 require_named_input This input processor will raise an exception unless there is exactly one post-format-string argument to the format call, and unless that argument is a hashref. It will also replace the arrayref with the given hashref so subsequent phases of the format can avoid lots of needless array dereferencing. =head2 require_arrayref_input This input processor will raise an exception unless there is exactly one post-format-string argument to the format call, and unless that argument is a arrayref. It will also replace the input with that single arrayref it found so subsequent phases of the format can avoid lots of needless array dereferencing. =head2 require_single_input This input processor will raise an exception if more than one input is given. After input processing, the single element in the input will be used as the input itself. =head2 forbid_input This input processor will raise an exception if any input is given. In other words, formatters with this input processor accept format strings and nothing else. =head2 string_replacer The string_replacer phase is responsible for adding a C entry to format code hunks. This should be a string-value entry that will be formatted and concatenated into the output string. String replacers can also replace the whole hunk with a string to avoid any subsequent formatting. =head2 positional_replace This replacer matches inputs to the hunk's position in the format string. This is the default replacer, used in the L, which should make its behavior clear. At present, fixed-string conversions B affect the position of arg matched, meaning that given the following: my $formatter = String::Formatter->new({ codes => { f => 'fixed string', s => sub { ... }, } }); $formatter->format("%s %f %s", 1, 2); The subroutine is called twice, once for the input C<1> and once for the input C<2>. B after some more experimental use. =head2 named_replace This replacer should be used with the C input processor. It expects the input to be a hashref and it finds values to be interpolated by looking in the hashref for the brace-enclosed name on each format code. Here's an example use: $formatter->format("This was the %{adj}s day in %{num}d weeks.", { adj => 'best', num => 6, }); =head2 indexed_replace This replacer should be used with the C input processor. It expects the input to be an arrayref and it finds values to be interpolated by looking in the arrayref for the brace-enclosed index on each format code. Here's an example use: $formatter->format("This was the %{1}s day in %{0}d weeks.", [ 6, 'best' ]); =head2 method_replace This string replacer method expects the input to be a single value on which methods can be called. If a value was given in braces to the format code, it is passed as an argument. =head2 keyed_replace This string replacer method expects the input to be a single hashref. Coderef code values are used as callbacks, but strings are used as hash keys. If a value was given in braces to the format code, it is ignored. For example if the codes contain C<< i => 'ident' >> then C<%i> in the format string will be replaced with C<< $input->{ident} >> in the output. =head2 hunk_formatter The hunk_formatter processes each the hashref hunks left after string replacement and returns a string. When it is called, it is passed a hunk hashref and must return a string. =head2 format_simply This is the default hunk formatter. It deals with minimum and maximum width cues as well as left and right alignment. Beyond that, it does no formatting of the replacement string. =head1 FORMAT STRINGS Format strings are generally assumed to look like Perl's sprintf's format strings: There's a bunch of normal strings and then %s format %1.4c with %% signs. The exact semantics of the format codes are not totally settled yet -- and they can be replaced on a per-formatter basis. Right now, they're mostly a subset of Perl's astonishingly large and complex system. That subset looks like this: % - a percent sign to begin the format ... - (optional) various modifiers to the format like "-5" or "#" or "2$" {..} - (optional) a string inside braces s - a short string (usually one character) identifying the conversion Not all format modifiers found in Perl's C are yet supported. Currently the only format modifiers must match: (-)? # left-align, rather than right (\d*)? # (optional) minimum field width (?:\.(\d*))? # (optional) maximum field width Some additional format semantics may be added, but probably nothing exotic. Even things like C<2$> and C<*> are probably not going to appear in String::Formatter's default behavior. Another subtle difference, introduced intentionally, is in the handling of C<%%>. With the default String::Formatter behavior, string C<%%> is not interpreted as a formatting code. This is different from the behavior of Perl's C, which interprets it as a special formatting character that doesn't consume input and always acts like the fixed string C<%>. The upshot of this is: sprintf "%%"; # ==> returns "%" stringf "%%"; # ==> returns "%%" sprintf "%10%"; # ==> returns " %" stringf "%10%"; # ==> dies: unknown format code % =for Pod::Coverage codes default_format_hunker default_input_processor default_string_replacer default_hunk_formatter =head1 HISTORY String::Formatter is based on L, written by Darren Chamberlain. For a history of the code, check the project's source code repository. All bugs should be reported to Ricardo Signes and String::Formatter. Very little of the original code remains. =head1 AUTHORS =over 4 =item * Ricardo Signes =item * Darren Chamberlain =back =head1 CONTRIBUTORS =for stopwords Darren Chamberlain David Steinbrunner dlc =over 4 =item * Darren Chamberlain =item * David Steinbrunner =item * dlc =back =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2021 by Ricardo Signes . This is free software, licensed under: The GNU General Public License, Version 2, June 1991 =cut String-Formatter-1.234/lib/String/Formatter/000755 000765 000024 00000000000 14112525165 021016 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/lib/String/Formatter/Cookbook.pm000644 000765 000024 00000023067 14112525165 023132 0ustar00rjbsstaff000000 000000 use strict; use warnings; package String::Formatter::Cookbook 1.234; # ABSTRACT: ways to put String::Formatter to use 1; #pod =encoding utf-8 #pod #pod =head1 OVERVIEW #pod #pod String::Formatter is a pretty simple system for building formatting routines, #pod but it can be hard to get started without an idea of the sort of things that #pod are possible. #pod #pod =head1 BASIC RECIPES #pod #pod =head2 constants only #pod #pod The simplest stringf interface you can provide is one that just formats #pod constant strings, allowing the user to put them inside other fixed strings with #pod alignment: #pod #pod use String::Formatter stringf => { #pod input_processor => 'forbid_input', #pod codes => { #pod a => 'apples', #pod b => 'bananas', #pod w => 'watermelon', #pod }, #pod }; #pod #pod print stringf('I eat %a and %b but never %w.'); #pod #pod # Output: #pod # I eat apples and bananas but never watermelon. #pod #pod If the user tries to parameterize the string by passing arguments after the #pod format string, an exception will be raised. #pod #pod =head2 sprintf-like conversions #pod #pod Another common pattern is to create a routine that behaves like Perl's #pod C, but with a different set of conversion routines. (It will also #pod almost certainly have much simpler semantics than Perl's wildly complex #pod behavior.) #pod #pod use String::Formatter stringf => { #pod codes => { #pod s => sub { $_ }, # string itself #pod l => sub { length }, # length of input string #pod e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness #pod }, #pod }; #pod #pod print stringf( #pod "My name is %s. I am about %l feet tall. I use an %e alphabet.\n", #pod 'Ricardo', #pod 'ffffff', #pod 'abcchdefghijklllmnñopqrrrstuvwxyz', #pod ); #pod #pod # Output: #pod # My name is Ricardo. I am about 6 feet tall. I use an 8bit alphabet. #pod #pod B: The behavior of positional string replacement when the conversion #pod codes mix constant strings and code references is currently poorly nailed-down. #pod Do not rely on it yet. #pod #pod =head2 named conversions #pod #pod This recipe acts a bit like Python's format operator when given a dictionary. #pod Rather than matching format code position with input ordering, inputs can be #pod chosen by name. #pod #pod use String::Formatter stringf => { #pod input_processor => 'require_named_input', #pod string_replacer => 'named_replace', #pod #pod codes => { #pod s => sub { $_ }, # string itself #pod l => sub { length }, # length of input string #pod e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness #pod }, #pod }; #pod #pod print stringf( #pod "My %{which}s name is %{name}s. My name is %{name}l letters long.", #pod { #pod which => 'first', #pod name => 'Marvin', #pod }, #pod ); #pod #pod # Output: #pod # My first name is Marvin. My name is 6 letters long. #pod #pod Because this is a useful recipe, there is a shorthand for it: #pod #pod use String::Formatter named_stringf => { #pod codes => { #pod s => sub { $_ }, # string itself #pod l => sub { length }, # length of input string #pod e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness #pod }, #pod }; #pod #pod =head2 method calls #pod #pod Some objects provide methods to stringify them flexibly. For example, many #pod objects that represent timestamps allow you to call C or something #pod similar. The C string replacer comes in handy here: #pod #pod use String::Formatter stringf => { #pod input_processor => 'require_single_input', #pod string_replacer => 'method_replace', #pod #pod codes => { #pod f => 'strftime', #pod c => 'format_cldr', #pod s => sub { "$_[0]" }, #pod }, #pod }; #pod #pod print stringf( #pod "%{%Y-%m-%d}f is also %{yyyy-MM-dd}c. Default string is %s.", #pod DateTime->now, #pod ); #pod #pod # Output: #pod # 2009-11-17 is also 2009-11-17. Default string is 2009-11-17T15:35:11. #pod #pod This recipe is available as the export C: #pod #pod use String::Formatter method_stringf => { #pod codes => { #pod f => 'strftime', #pod c => 'format_cldr', #pod s => sub { "$_[0]" }, #pod }, #pod }; #pod #pod You can easily use this to implement an actual stringf-like method: #pod #pod package MyClass; #pod #pod use String::Formatter method_stringf => { #pod -as => '_stringf', #pod codes => { #pod f => 'strftime', #pod c => 'format_cldr', #pod s => sub { "$_[0]" }, #pod }, #pod }; #pod #pod sub format { #pod my ($self, $format) = @_; #pod return _stringf($format, $self); #pod } #pod #pod =cut __END__ =pod =encoding utf-8 =head1 NAME String::Formatter::Cookbook - ways to put String::Formatter to use =head1 VERSION version 1.234 =head1 OVERVIEW String::Formatter is a pretty simple system for building formatting routines, but it can be hard to get started without an idea of the sort of things that are possible. =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 BASIC RECIPES =head2 constants only The simplest stringf interface you can provide is one that just formats constant strings, allowing the user to put them inside other fixed strings with alignment: use String::Formatter stringf => { input_processor => 'forbid_input', codes => { a => 'apples', b => 'bananas', w => 'watermelon', }, }; print stringf('I eat %a and %b but never %w.'); # Output: # I eat apples and bananas but never watermelon. If the user tries to parameterize the string by passing arguments after the format string, an exception will be raised. =head2 sprintf-like conversions Another common pattern is to create a routine that behaves like Perl's C, but with a different set of conversion routines. (It will also almost certainly have much simpler semantics than Perl's wildly complex behavior.) use String::Formatter stringf => { codes => { s => sub { $_ }, # string itself l => sub { length }, # length of input string e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness }, }; print stringf( "My name is %s. I am about %l feet tall. I use an %e alphabet.\n", 'Ricardo', 'ffffff', 'abcchdefghijklllmnñopqrrrstuvwxyz', ); # Output: # My name is Ricardo. I am about 6 feet tall. I use an 8bit alphabet. B: The behavior of positional string replacement when the conversion codes mix constant strings and code references is currently poorly nailed-down. Do not rely on it yet. =head2 named conversions This recipe acts a bit like Python's format operator when given a dictionary. Rather than matching format code position with input ordering, inputs can be chosen by name. use String::Formatter stringf => { input_processor => 'require_named_input', string_replacer => 'named_replace', codes => { s => sub { $_ }, # string itself l => sub { length }, # length of input string e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness }, }; print stringf( "My %{which}s name is %{name}s. My name is %{name}l letters long.", { which => 'first', name => 'Marvin', }, ); # Output: # My first name is Marvin. My name is 6 letters long. Because this is a useful recipe, there is a shorthand for it: use String::Formatter named_stringf => { codes => { s => sub { $_ }, # string itself l => sub { length }, # length of input string e => sub { /[^\x00-\x7F]/ ? '8bit' : '7bit' }, # ascii-safeness }, }; =head2 method calls Some objects provide methods to stringify them flexibly. For example, many objects that represent timestamps allow you to call C or something similar. The C string replacer comes in handy here: use String::Formatter stringf => { input_processor => 'require_single_input', string_replacer => 'method_replace', codes => { f => 'strftime', c => 'format_cldr', s => sub { "$_[0]" }, }, }; print stringf( "%{%Y-%m-%d}f is also %{yyyy-MM-dd}c. Default string is %s.", DateTime->now, ); # Output: # 2009-11-17 is also 2009-11-17. Default string is 2009-11-17T15:35:11. This recipe is available as the export C: use String::Formatter method_stringf => { codes => { f => 'strftime', c => 'format_cldr', s => sub { "$_[0]" }, }, }; You can easily use this to implement an actual stringf-like method: package MyClass; use String::Formatter method_stringf => { -as => '_stringf', codes => { f => 'strftime', c => 'format_cldr', s => sub { "$_[0]" }, }, }; sub format { my ($self, $format) = @_; return _stringf($format, $self); } =head1 AUTHORS =over 4 =item * Ricardo Signes =item * Darren Chamberlain =back =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2021 by Ricardo Signes . This is free software, licensed under: The GNU General Public License, Version 2, June 1991 =cut String-Formatter-1.234/xt/author/000755 000765 000024 00000000000 14112525165 016774 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/xt/release/000755 000765 000024 00000000000 14112525165 017112 5ustar00rjbsstaff000000 000000 String-Formatter-1.234/xt/release/changes_has_content.t000644 000765 000024 00000002101 14112525165 023266 0ustar00rjbsstaff000000 000000 use Test::More tests => 2; note 'Checking Changes'; my $changes_file = 'Changes'; my $newver = '1.234'; my $trial_token = '-TRIAL'; my $encoding = 'UTF-8'; SKIP: { ok(-e $changes_file, "$changes_file file exists") or skip 'Changes is missing', 1; ok(_get_changes($newver), "$changes_file has content for $newver"); } done_testing; sub _get_changes { my $newver = shift; # parse changelog to find commit message open(my $fh, '<', $changes_file) or die "cannot open $changes_file: $!"; my $changelog = join('', <$fh>); if ($encoding) { require Encode; $changelog = Encode::decode($encoding, $changelog, Encode::FB_CROAK()); } close $fh; my @content = grep { /^$newver(?:$trial_token)?(?:\s+|$)/ ... /^\S/ } # from newver to un-indented split /\n/, $changelog; shift @content; # drop the version line # drop unindented last line and trailing blank lines pop @content while ( @content && $content[-1] =~ /^(?:\S|\s*$)/ ); # return number of non-blank lines return scalar @content; } String-Formatter-1.234/xt/author/pod-syntax.t000644 000765 000024 00000000252 14112525165 021266 0ustar00rjbsstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use strict; use warnings; use Test::More; use Test::Pod 1.41; all_pod_files_ok(); String-Formatter-1.234/t/params.t000644 000765 000024 00000001530 14112525165 016751 0ustar00rjbsstaff000000 000000 #!perl use strict; use Test::More tests => 2; use String::Formatter; { my $fmt = String::Formatter->new({ input_processor => 'require_named_input', string_replacer => 'named_replace', codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, }); { my $have = $fmt->format( q(do it %{alfa}f way and %{beta}r way), { alfa => 'this', beta => 'that' }, ); my $want = 'do it this way and taht way'; is($have, $want, "named args via conversions"); } } { my $fmt = String::Formatter->new({ codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, }); { my $have = $fmt->format( q(do it %f way and %r way), qw(this that), ); my $want = 'do it this way and taht way'; is($have, $want, "positional args via conversions"); } } String-Formatter-1.234/t/method.t000644 000765 000024 00000002054 14112525165 016750 0ustar00rjbsstaff000000 000000 #!perl use strict; use Test::More tests => 2; use String::Formatter; { package Zombie; sub new { bless {} } sub groan { 'nnnnngh' } sub request { "Send... more... $_[1]!" } } { my $fmt = String::Formatter->new({ input_processor => 'require_single_input', string_replacer => 'method_replace', codes => { g => 'groan', r => 'request', i => sub { 0 + $_[0] }, }, }); { my $zombie = Zombie->new; my $have = $fmt->format(q(%g... zombie number %i say: %{cops}r), $zombie); my $zid = 0 + $zombie; my $want = "nnnnngh... zombie number $zid say: Send... more... cops!"; is($have, $want, "method_replace GOOD. fire BAD"); } } { my $coderef = String::Formatter->new({ input_processor => 'require_single_input', string_replacer => 'method_replace', codes => { f => sub { $_->{foo} }, r => sub { $_->{bar} }, }, }); is( $coderef->format('%f => %r', { foo => 'FOO', bar => 'BAR' }), 'FOO => BAR', 'topicalized method replace', ) } String-Formatter-1.234/t/braces.t000644 000765 000024 00000000536 14112525165 016732 0ustar00rjbsstaff000000 000000 #!perl use strict; use warnings; use Test::More tests => 1; use String::Formatter; my $formatter = String::Formatter->new({ codes => { s => sub { return $_[2] } } }); my $unknown_fmt = "We know that %{nested {braces} rule}s."; is( $formatter->format($unknown_fmt), "We know that nested {braces} rule.", "we allow braces inside braces", ); String-Formatter-1.234/t/basic.t000644 000765 000024 00000004666 14112525165 016564 0ustar00rjbsstaff000000 000000 #!perl use strict; use Test::More tests => 12; use String::Formatter; my $fmt = String::Formatter->new({ codes => { a => "apples", b => "bananas", g => "grapefruits", m => "melons", w => "watermelons", '*' => 'brussel sprouts', }, }); { my $have = $fmt->format(qq(please have some %w\n)); my $want = "please have some watermelons\n"; is($have, $want, "formatting with no text after last code"); } { my $have = $fmt->format(qq(w: %w\nb: %b\n)); my $want = "w: watermelons\nb: bananas\n"; is($have, $want, "format with multiple newlines"); } { my $have = $fmt->format(q(10%% discount on %w)); my $want = '10% discount on watermelons'; is($have, $want, "%% -> %"); } { my $have = $fmt->format(q(I like %a, %b, and %g, but not %m or %w.)); my $want = 'I like apples, bananas, and grapefruits, ' . 'but not melons or watermelons.'; is($have, $want, "formatting with text after last code"); } { my $have = $fmt->format(q(This has no stuff.)); my $want = 'This has no stuff.'; is($have, $want, "formatting with no %codes"); } { my $ok = eval { $fmt->format(q(What is %z for?)); 1 }; my $error = $@; like($error, qr/Unknown conversion/i, 'unknown conversions are fatal'); } { my $have = $fmt->format("We have %.5w."); my $want = "We have water."; is($have, $want, "truncate at max_chars"); } { my $have = $fmt->format("We have %10a."); my $want = "We have apples."; is($have, $want, "left-pad to reach min_chars"); } { my $have = $fmt->format("We have %10.a."); my $want = "We have apples."; is($have, $want, "left-pad to reach min_chars (with dot)"); } { my $have = $fmt->format("We have %-10a."); my $want = "We have apples ."; is($have, $want, "right-pad to reach min_chars (-10)"); } { my $have = $fmt->format('Please do not mention the %*.'); my $want = 'Please do not mention the brussel sprouts.'; is($have, $want, "non-identifier format characters"); } { my $fmt = String::Formatter->new({ input_processor => 'require_single_input', string_replacer => 'keyed_replace', codes => { g => 'groan', r => 'request', }, }); { my $zombie = { groan => 'nnnnngh', request => "Send... more...brainz...", }; my $have = $fmt->format(q(%g... zombie says: %r), $zombie); my $want = "nnnnngh... zombie says: Send... more...brainz..."; is($have, $want, "keyed_replace GOOD. fire BAD"); } } String-Formatter-1.234/t/00-report-prereqs.t000644 000765 000024 00000013452 14112525165 020703 0ustar00rjbsstaff000000 000000 #!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.028 use Test::More tests => 1; use ExtUtils::MakeMaker; use File::Spec; # from $version::LAX my $lax_version_re = qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? | (?:\.[0-9]+) (?:_[0-9]+)? ) | (?: v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? | (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? ) )/x; # hide optional CPAN::Meta modules from prereq scanner # and check if they are available my $cpan_meta = "CPAN::Meta"; my $cpan_meta_pre = "CPAN::Meta::Prereqs"; my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic # Verify requirements? my $DO_VERIFY_PREREQS = 1; sub _max { my $max = shift; $max = ( $_ > $max ) ? $_ : $max for @_; return $max; } sub _merge_prereqs { my ($collector, $prereqs) = @_; # CPAN::Meta::Prereqs object if (ref $collector eq $cpan_meta_pre) { return $collector->with_merged_prereqs( CPAN::Meta::Prereqs->new( $prereqs ) ); } # Raw hashrefs for my $phase ( keys %$prereqs ) { for my $type ( keys %{ $prereqs->{$phase} } ) { for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; } } } return $collector; } my @include = qw( ); my @exclude = qw( ); # Add static prereqs to the included modules list my $static_prereqs = do './t/00-report-prereqs.dd'; # Merge all prereqs (either with ::Prereqs or a hashref) my $full_prereqs = _merge_prereqs( ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), $static_prereqs ); # Add dynamic prereqs to the included modules list (if we can) my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; my $cpan_meta_error; if ( $source && $HAS_CPAN_META && (my $meta = eval { CPAN::Meta->load_file($source) } ) ) { $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); } else { $cpan_meta_error = $@; # capture error from CPAN::Meta->load_file($source) $source = 'static metadata'; } my @full_reports; my @dep_errors; my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; # Add static includes into a fake section for my $mod (@include) { $req_hash->{other}{modules}{$mod} = 0; } for my $phase ( qw(configure build test runtime develop other) ) { next unless $req_hash->{$phase}; next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); for my $type ( qw(requires recommends suggests conflicts modules) ) { next unless $req_hash->{$phase}{$type}; my $title = ucfirst($phase).' '.ucfirst($type); my @reports = [qw/Module Want Have/]; for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { next if $mod eq 'perl'; next if grep { $_ eq $mod } @exclude; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; my $want = $req_hash->{$phase}{$type}{$mod}; $want = "undef" unless defined $want; $want = "any" if !$want && $want == 0; my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; if ($prefix) { my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); $have = "undef" unless defined $have; push @reports, [$mod, $want, $have]; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { if ( $have !~ /\A$lax_version_re\z/ ) { push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; } elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { push @dep_errors, "$mod version '$have' is not in required range '$want'"; } } } else { push @reports, [$mod, $want, "missing"]; if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { push @dep_errors, "$mod is not installed ($req_string)"; } } } if ( @reports ) { push @full_reports, "=== $title ===\n\n"; my $ml = _max( map { length $_->[0] } @reports ); my $wl = _max( map { length $_->[1] } @reports ); my $hl = _max( map { length $_->[2] } @reports ); if ($type eq 'modules') { splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; } else { splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; } push @full_reports, "\n"; } } } if ( @full_reports ) { diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; } if ( $cpan_meta_error || @dep_errors ) { diag "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n"; } if ( $cpan_meta_error ) { my ($orig_source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; diag "\nCPAN::Meta->load_file('$orig_source') failed with: $cpan_meta_error\n"; } if ( @dep_errors ) { diag join("\n", "\nThe following REQUIRED prerequisites were not satisfied:\n", @dep_errors, "\n" ); } pass('Reported prereqs'); # vim: ts=4 sts=4 sw=4 et: String-Formatter-1.234/t/00-report-prereqs.dd000644 000765 000024 00000002525 14112525165 021026 0ustar00rjbsstaff000000 000000 do { my $x = { 'configure' => { 'requires' => { 'ExtUtils::MakeMaker' => '6.78' } }, 'develop' => { 'requires' => { 'Encode' => '0', 'Test::More' => '0', 'Test::Pod' => '1.41' } }, 'runtime' => { 'requires' => { 'Params::Util' => '0', 'Sub::Exporter' => '0', 'perl' => '5.012', 'strict' => '0', 'warnings' => '0' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '2.120900' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec' => '0', 'Test::More' => '0.96' } } }; $x; }String-Formatter-1.234/t/stringf.t000644 000765 000024 00000003027 14112525165 017145 0ustar00rjbsstaff000000 000000 #!perl use strict; use Test::More 0.88; use String::Formatter stringf => { -as => 'pos_stringf', codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, }, stringf => { -as => 'named_stringf', input_processor => 'require_named_input', string_replacer => 'named_replace', codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, }, named_stringf => { -as => 'ns2', codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, }, indexed_stringf => { codes => { f => sub { $_ }, r => sub { scalar reverse $_ }, }, } ; { my $have = pos_stringf( q(do it %f way and %r way), qw(this that), ); my $want = 'do it this way and taht way'; is($have, $want, "positional args via conversions"); } { my $have = named_stringf( q(do it %{alfa}f way and %{beta}r way), { alfa => 'this', beta => 'that' }, ); my $want = 'do it this way and taht way'; is($have, $want, "named args via conversions"); } { my $have = ns2( q(do it %{alfa}f way and %{beta}r way), { alfa => 'this', beta => 'that' }, ); my $want = 'do it this way and taht way'; is($have, $want, "named args via conversions (named_stringf import)"); } { my $have = indexed_stringf( q(do it %{1}f way and %{0}r way), [ qw(that this) ], ); my $want = 'do it this way and taht way'; is($have, $want, "named args via conversions (indexed_stringf import)"); } done_testing; String-Formatter-1.234/misc/bench.pl000644 000765 000024 00000001577 14112525165 017420 0ustar00rjbsstaff000000 000000 #!perl -l use strict; use lib 'lib'; use String::Formatter; # Ha ha ha. I am avoiding AutoPrereq from the following. die $@ unless eval " use Benchmark; use Template; use String::Format; "; my $hash = { a => 'apples', b => 'bananas', }; my $fmt = String::Formatter->new({ codes => $hash, }); my $index_format = String::Format->stringfactory($hash); my $tt2 = Template->new; print $index_format->("I like to eat %a and %b."); print $fmt->format("I like to eat %a and %b."); $tt2->process(\'I like to eat [%a%] and [%b%].', $hash, \my $str); print $str; timethese(100_000, { dlc => sub { $index_format->("I like to eat %a and %b.") }, rjbs => sub { $fmt->format("I like to eat %a and %b.") }, # tt2 => sub { # $tt2->process(\'I like to eat [%a%] and [%b%].', $hash, \my $str); # }, perl => sub { sprintf("I like to eat %s and %s.", qw(apples bananas)) }, });