diff options
author | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:27:56 +0100 |
---|---|---|
committer | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:27:56 +0100 |
commit | 5ae35c6f938a77a03efc527ea0a111d66068eba9 (patch) | |
tree | eb8ce028080a9b16d173877914b7b2e11e21fdde |
Import original source of String-Trim 0.005
-rw-r--r-- | Changes | 17 | ||||
-rw-r--r-- | LICENSE | 377 | ||||
-rw-r--r-- | MANIFEST | 33 | ||||
-rw-r--r-- | META.json | 54 | ||||
-rw-r--r-- | META.yml | 29 | ||||
-rw-r--r-- | Makefile.PL | 57 | ||||
-rw-r--r-- | README | 92 | ||||
-rw-r--r-- | lib/String/Trim.pm | 184 | ||||
-rw-r--r-- | t/00-compile.t | 59 | ||||
-rw-r--r-- | t/00-use.t | 6 | ||||
-rw-r--r-- | t/01-string.t | 37 | ||||
-rw-r--r-- | t/02-undef.t | 18 | ||||
-rw-r--r-- | t/03-array.t | 38 | ||||
-rw-r--r-- | t/04-arrayref.t | 38 | ||||
-rw-r--r-- | t/05-default.t | 29 | ||||
-rw-r--r-- | t/06-hash.t | 37 | ||||
-rw-r--r-- | t/07-hashref.t | 31 | ||||
-rw-r--r-- | xt/author/critic.t | 12 | ||||
-rw-r--r-- | xt/release/cpan-changes.t | 7 | ||||
-rw-r--r-- | xt/release/dist-manifest.t | 8 | ||||
-rw-r--r-- | xt/release/distmeta.t | 7 | ||||
-rw-r--r-- | xt/release/eol.t | 8 | ||||
-rw-r--r-- | xt/release/has-version.t | 8 | ||||
-rw-r--r-- | xt/release/kwalitee.t | 8 | ||||
-rw-r--r-- | xt/release/meta-json.t | 6 | ||||
-rw-r--r-- | xt/release/minimum-version.t | 8 | ||||
-rw-r--r-- | xt/release/no-tabs.t | 8 | ||||
-rw-r--r-- | xt/release/pod-coverage.t | 13 | ||||
-rw-r--r-- | xt/release/pod-linkcheck.t | 20 | ||||
-rw-r--r-- | xt/release/pod-syntax.t | 7 | ||||
-rw-r--r-- | xt/release/portability.t | 8 | ||||
-rw-r--r-- | xt/release/synopsis.t | 8 | ||||
-rw-r--r-- | xt/release/unused-vars.t | 8 |
33 files changed, 1280 insertions, 0 deletions
@@ -0,0 +1,17 @@ +Revision history for Perl module String-Trim + +0.005 2011-04-21 + * Added tests + +0.004 2010-12-03 + * Require Exporter 5.57 + * Remove trim2, which was added accidentally + +0.003 2010-11-30 + * Require Test::Buider 0.94 along with Test::More 0.94 + +0.002 2010-11-28 + * Use Perl_5 license: GPL+Artistic + +0.001 2010-11-26 + * Initial release @@ -0,0 +1,377 @@ +This software is copyright (c) 2010 by Mike Doherty. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2010 by Mike Doherty. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software Foundation, + Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2010 by Mike Doherty. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..158934c --- /dev/null +++ b/MANIFEST @@ -0,0 +1,33 @@ +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +lib/String/Trim.pm +t/00-compile.t +t/00-use.t +t/01-string.t +t/02-undef.t +t/03-array.t +t/04-arrayref.t +t/05-default.t +t/06-hash.t +t/07-hashref.t +xt/author/critic.t +xt/release/cpan-changes.t +xt/release/dist-manifest.t +xt/release/distmeta.t +xt/release/eol.t +xt/release/has-version.t +xt/release/kwalitee.t +xt/release/meta-json.t +xt/release/minimum-version.t +xt/release/no-tabs.t +xt/release/pod-coverage.t +xt/release/pod-linkcheck.t +xt/release/pod-syntax.t +xt/release/portability.t +xt/release/synopsis.t +xt/release/unused-vars.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..b09c94f --- /dev/null +++ b/META.json @@ -0,0 +1,54 @@ +{ + "abstract" : "trim whitespace from your strings", + "author" : [ + "Mike Doherty <doherty@cpan.org>", + "Jeff Pinyan <pinyan@cpan.org>", + "Rob Kinyon <rkinyon@cpan.org>", + "\u00ce\u0091\u00cf\u0081\u00ce\u00b9\u00cf\u0083\u00cf\u0084\u00ce\u00bf\u00cf\u0084\u00ce\u00ad\u00ce\u00bb\u00ce\u00b7\u00cf\u0082 \u00ce\u00a0\u00ce\u00b1\u00ce\u00b3\u00ce\u00ba\u00ce\u00b1\u00ce\u00bb\u00cf\u0084\u00ce\u00b6\u00ce\u00ae\u00cf\u0082 (Aristotle Pagaltzis) <aristotle@cpan.org>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 4.200004, CPAN::Meta::Converter version 2.110440", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "String-Trim", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "6.31" + } + }, + "runtime" : { + "requires" : { + "Exporter" : "5.57", + "perl" : "5.006" + } + }, + "test" : { + "requires" : { + "Data::Dumper" : 0, + "File::Find" : 0, + "File::Temp" : 0, + "Test::Builder" : "0.94", + "Test::More" : "0.94" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/doherty/String-Trim/issues" + }, + "repository" : { + "type" : "git", + "url" : "git://github.com/doherty/String-Trim.git", + "web" : "https://github.com/doherty/String-Trim" + } + }, + "version" : "0.005" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..eec059c --- /dev/null +++ b/META.yml @@ -0,0 +1,29 @@ +--- +abstract: 'trim whitespace from your strings' +author: + - 'Mike Doherty <doherty@cpan.org>' + - 'Jeff Pinyan <pinyan@cpan.org>' + - 'Rob Kinyon <rkinyon@cpan.org>' + - 'Αριστοτέλης Παγκαλτζής (Aristotle Pagaltzis) <aristotle@cpan.org>' +build_requires: + Data::Dumper: 0 + File::Find: 0 + File::Temp: 0 + Test::Builder: 0.94 + Test::More: 0.94 +configure_requires: + ExtUtils::MakeMaker: 6.31 +dynamic_config: 0 +generated_by: 'Dist::Zilla version 4.200004, CPAN::Meta::Converter version 2.110440' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +name: String-Trim +requires: + Exporter: 5.57 + perl: 5.006 +resources: + bugtracker: https://github.com/doherty/String-Trim/issues + repository: git://github.com/doherty/String-Trim.git +version: 0.005 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..07e4570 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,57 @@ + +use strict; +use warnings; + +BEGIN { require 5.006; } + +use ExtUtils::MakeMaker 6.31; + + + +my %WriteMakefileArgs = ( + 'ABSTRACT' => 'trim whitespace from your strings', + 'AUTHOR' => 'Mike Doherty <doherty@cpan.org>, Jeff Pinyan <pinyan@cpan.org>, Rob Kinyon <rkinyon@cpan.org>, Αριστοτέλης Παγκαλτζής (Aristotle Pagaltzis) <aristotle@cpan.org>', + 'BUILD_REQUIRES' => { + 'Data::Dumper' => '0', + 'File::Find' => '0', + 'File::Temp' => '0', + 'Test::Builder' => '0.94', + 'Test::More' => '0.94' + }, + 'CONFIGURE_REQUIRES' => { + 'ExtUtils::MakeMaker' => '6.31' + }, + 'DISTNAME' => 'String-Trim', + 'EXE_FILES' => [], + 'LICENSE' => 'perl', + 'NAME' => 'String::Trim', + 'PREREQ_PM' => { + 'Exporter' => '5.57' + }, + 'VERSION' => '0.005', + 'test' => { + 'TESTS' => 't/*.t' + } +); + + +unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { + my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; + my $pp = $WriteMakefileArgs{PREREQ_PM}; + for my $mod ( keys %$br ) { + if ( exists $pp->{$mod} ) { + $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; + } + else { + $pp->{$mod} = $br->{$mod}; + } + } +} + +delete $WriteMakefileArgs{CONFIGURE_REQUIRES} + unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; + +WriteMakefile(%WriteMakefileArgs); + + + @@ -0,0 +1,92 @@ +NAME + String::Trim - trim whitespace from your strings + +VERSION + version 0.005 + +SYNOPSIS + use String::Trim; + + print "Do it? "; + trim(my $response = <>); + print "'$response'\n"; + +DESCRIPTION + "String::Trim" trims whitespace off your strings. chomp trims only $/ + (typically, that's newline), but "trim" will trim all leading and + trailing whitespace. + +FUNCTIONS + trim + Returns the string with all leading and trailing whitespace removed. + Trimming undef gives you undef. Alternatively, you can trim in-place. + + my $var = ' my string '; + my $trimmed = trim($var); + # OR + trim($var); + + "trim" also knows how to trim an array or arrayref: + + my @to_trim = (' one ', ' two ', ' three '); + my @trimmed = trim(@to_trim); + # OR + trim(@to_trim); + # OR + my $trimmed = trim(\@to_trim); + # OR + trim(\@to_trim); + +RATIONALE + "trim" is often used by beginners, who may not understand how to spin + their own. While String::Util does have a "trim" function, it depends on + Debug::ShowStuff, which depends on Taint, which fails the test suite, + and doesn't appear to be maintained. This module installs, is actively + maintained, and has no non-core dependencies. + + Other options include Text::Trim and String::Strip (which is implemented + in XS, and is therefore likely to be very fast, but requires a C + compiler). + +AVAILABILITY + The latest version of this module is available from the Comprehensive + Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a + CPAN site near you, or see <http://search.cpan.org/dist/String-Trim/>. + + The development version lives at <http://github.com/doherty/String-Trim> + and may be cloned from <git://github.com/doherty/String-Trim.git>. + Instead of sending patches, please fork this project using the standard + git and github infrastructure. + +SOURCE + The development version is on github at + <http://github.com/doherty/String-Trim> and may be cloned from + <git://github.com/doherty/String-Trim.git> + +BUGS AND LIMITATIONS + No bugs have been reported. + + Please report any bugs or feature requests through the web interface at + <https://github.com/doherty/String-Trim/issues>. + +CREDITS + This module was inspired by code at + <http://www.perlmonks.org/?node_id=36684> written by japhy (Jeff + Pinyan), dragonchild, and Aristotle. This Perl module was written by + Mike Doherty. + +AUTHORS + * Mike Doherty <doherty@cpan.org> + + * Jeff Pinyan <pinyan@cpan.org> + + * Rob Kinyon <rkinyon@cpan.org> + + * Αριστοτέλης Παγκαλτζής (Aristotle Pagaltzis) <aristotle@cpan.org> + +COPYRIGHT AND LICENSE + This software is copyright (c) 2010 by Mike Doherty. + + This is free software; you can redistribute it and/or modify it under + the same terms as the Perl 5 programming language system itself. + diff --git a/lib/String/Trim.pm b/lib/String/Trim.pm new file mode 100644 index 0000000..c307ddb --- /dev/null +++ b/lib/String/Trim.pm @@ -0,0 +1,184 @@ +package String::Trim; +# ABSTRACT: trim whitespace from your strings +use strict; +use warnings; +our $VERSION = '0.005'; # VERSION + + +use Exporter 5.57 qw(import); +our @EXPORT = qw(trim); + + +sub trim { # Starting point: http://www.perlmonks.org/?node_id=36684 + my $t = qr{^\s+|\s+$}; + if (defined wantarray) { + @_ = (@_ ? @_ : $_); + if (ref $_[0] eq 'ARRAY') { + @_ = @{ $_[0] }; + for (@_) { s{$t}{}g if defined $_ } + return \@_; + } + elsif (ref $_[0] eq 'HASH') { + foreach my $k (keys %{ $_[0] }) { + (my $nk = $k) =~ s{$t}{}g; + if (defined $_[0]->{$k}) { + ($_[0]->{$nk} = $_[0]->{$k}) =~ s{$t}{}g; + } + else { + $_[0]->{$nk} = undef; + } + delete $_[0]->{$k} unless $k eq $nk; + } + } + else { + for (@_ ? @_ : $_) { s{$t}{}g if defined $_ } + } + return wantarray ? @_ : $_[0]; + } + else { + if (ref $_[0] eq 'ARRAY') { + for (@{ $_[0] }) { s{$t}{}g if defined $_ } + } + elsif (ref $_[0] eq 'HASH') { + foreach my $k (keys %{ $_[0] }) { + (my $nk = $k) =~ s{$t}{}g; + if (defined $_[0]->{$k}) { + ($_[0]->{$nk} = $_[0]->{$k}) =~ s{$t}{}g; + } + else { + $_[0]->{$nk} = undef; + } + delete $_[0]->{$k} unless $k eq $nk + } + } + else { + for (@_ ? @_ : $_) { s{$t}{}g if defined $_ } + } + } +} + + +1; + + + +=pod + +=encoding utf-8 + +=head1 NAME + +String::Trim - trim whitespace from your strings + +=head1 VERSION + +version 0.005 + +=head1 SYNOPSIS + + use String::Trim; + + print "Do it? "; + trim(my $response = <>); + print "'$response'\n"; + +=head1 DESCRIPTION + +C<String::Trim> trims whitespace off your strings. L<chomp> trims only C<$/> (typically, +that's newline), but C<trim> will trim all leading and trailing whitespace. + +=head1 FUNCTIONS + +=head2 trim + +Returns the string with all leading and trailing whitespace removed. Trimming +undef gives you undef. Alternatively, you can trim in-place. + + my $var = ' my string '; + my $trimmed = trim($var); + # OR + trim($var); + +C<trim> also knows how to trim an array or arrayref: + + my @to_trim = (' one ', ' two ', ' three '); + my @trimmed = trim(@to_trim); + # OR + trim(@to_trim); + # OR + my $trimmed = trim(\@to_trim); + # OR + trim(\@to_trim); + +=head1 RATIONALE + +C<trim> is often used by beginners, who may not understand how to spin their own. While +L<String::Util> does have a C<trim> function, it depends on L<Debug::ShowStuff>, which +depends on L<Taint>, which fails the test suite, and doesn't appear to be maintained. +This module installs, is actively maintained, and has no non-core dependencies. + +Other options include L<Text::Trim> and L<String::Strip> (which is implemented in XS, +and is therefore likely to be very fast, but requires a C compiler). + +=head1 AVAILABILITY + +The latest version of this module is available from the Comprehensive Perl +Archive Network (CPAN). Visit L<http://www.perl.com/CPAN/> to find a CPAN +site near you, or see L<http://search.cpan.org/dist/String-Trim/>. + +The development version lives at L<http://github.com/doherty/String-Trim> +and may be cloned from L<git://github.com/doherty/String-Trim.git>. +Instead of sending patches, please fork this project using the standard +git and github infrastructure. + +=head1 SOURCE + +The development version is on github at L<http://github.com/doherty/String-Trim> +and may be cloned from L<git://github.com/doherty/String-Trim.git> + +=head1 BUGS AND LIMITATIONS + +No bugs have been reported. + +Please report any bugs or feature requests through the web interface at +L<https://github.com/doherty/String-Trim/issues>. + +=head1 CREDITS + +This module was inspired by code at L<http://www.perlmonks.org/?node_id=36684> written +by japhy (Jeff Pinyan), dragonchild, and Aristotle. This Perl module was written by Mike +Doherty. + +=head1 AUTHORS + +=over 4 + +=item * + +Mike Doherty <doherty@cpan.org> + +=item * + +Jeff Pinyan <pinyan@cpan.org> + +=item * + +Rob Kinyon <rkinyon@cpan.org> + +=item * + +Αριστοτέλης Παγκαλτζής (Aristotle Pagaltzis) <aristotle@cpan.org> + +=back + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2010 by Mike Doherty. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut + + +__END__ diff --git a/t/00-compile.t b/t/00-compile.t new file mode 100644 index 0000000..c6740cc --- /dev/null +++ b/t/00-compile.t @@ -0,0 +1,59 @@ +#!perl + +use strict; +use warnings; + +use Test::More; + + + +use File::Find; +use File::Temp qw{ tempdir }; + +my @modules; +find( + sub { + return if $File::Find::name !~ /\.pm\z/; + my $found = $File::Find::name; + $found =~ s{^lib/}{}; + $found =~ s{[/\\]}{::}g; + $found =~ s/\.pm$//; + # nothing to skip + push @modules, $found; + }, + 'lib', +); + +my @scripts; +if ( -d 'bin' ) { + find( + sub { + return unless -f; + my $found = $File::Find::name; + # nothing to skip + push @scripts, $found; + }, + 'bin', + ); +} + +my $plan = scalar(@modules) + scalar(@scripts); +$plan ? (plan tests => $plan) : (plan skip_all => "no tests to run"); + +{ + # fake home for cpan-testers + # no fake requested ## local $ENV{HOME} = tempdir( CLEANUP => 1 ); + + like( qx{ $^X -Ilib -e "require $_; print '$_ ok'" }, qr/^\s*$_ ok/s, "$_ loaded ok" ) + for sort @modules; + + SKIP: { + eval "use Test::Script 1.05; 1;"; + skip "Test::Script needed to test script compilation", scalar(@scripts) if $@; + foreach my $file ( @scripts ) { + my $script = $file; + $script =~ s!.*/!!; + script_compiles( $file, "$script script compiles" ); + } + } +} diff --git a/t/00-use.t b/t/00-use.t new file mode 100644 index 0000000..8f1b2f0 --- /dev/null +++ b/t/00-use.t @@ -0,0 +1,6 @@ +use strict; +use warnings; +use Test::More tests => 1; +use String::Trim; + +use_ok('String::Trim'); diff --git a/t/01-string.t b/t/01-string.t new file mode 100644 index 0000000..85faeab --- /dev/null +++ b/t/01-string.t @@ -0,0 +1,37 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 2; +use Test::Builder 0.94 qw(); +use String::Trim; + +my $strings = { + 'one' => 'one', + 'tw o' => 'tw o', + ' three' => 'three', + 'four ' => 'four', + ' five ' => 'five', + ' six ' => 'six', + " seven\n" => 'seven', + "\n\neight" => 'eight', + " nine\nten " => "nine\nten", +}; + +subtest 'return' => sub { + plan tests => scalar keys %$strings; + foreach my $key (keys %$strings) { + my $to_trim = $key; + my $ought = $strings->{$key}; + my $trimmed = trim($to_trim); + is($trimmed, $ought, "trim($to_trim) returned '$ought' OK"); + } +}; + +subtest 'in-place' => sub { + plan tests => scalar keys %$strings; + foreach my $key (keys %$strings) { + my $to_trim = $key; + my $ought = $strings->{$key}; + trim($to_trim); + is($to_trim, $ought, "'$to_trim' trimmed to '$ought' in-place OK"); + } +}; diff --git a/t/02-undef.t b/t/02-undef.t new file mode 100644 index 0000000..f9ab7ed --- /dev/null +++ b/t/02-undef.t @@ -0,0 +1,18 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 2; +use Test::Builder 0.94 qw(); +use String::Trim; + +subtest 'return' => sub { + plan tests => 1; + my $trimmed = trim(undef); + is($trimmed, undef, 'trim(undef) returns undef'); +}; + +subtest 'in-place' => sub { + plan tests => 1; + my $to_trim = undef; + trim($to_trim); + is($to_trim, undef, 'undef trims to undef in-place'); +}; diff --git a/t/03-array.t b/t/03-array.t new file mode 100644 index 0000000..412a56a --- /dev/null +++ b/t/03-array.t @@ -0,0 +1,38 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 2; +use Test::Builder 0.94 qw(); +use String::Trim; + +my $tests = { + one => { + before => ['one', ' two ', "three\n", undef], + after => ['one', 'two', 'three', undef], + }, + two => { + before => [' test '], + after => ['test'], + }, +}; + +subtest 'return' => sub { + plan tests => scalar keys %$tests; + foreach my $key (keys %$tests) { + my @to_trim = @{ $tests->{$key}->{before} }; + my @ought = @{ $tests->{$key}->{after} }; + + my @trimmed = trim(@to_trim); + is_deeply(\@trimmed, \@ought, 'trim(@array) returns a trimmed array OK'); + } +}; + +subtest 'in-place' => sub { + plan tests => scalar keys %$tests; + foreach my $key (keys %$tests) { + my @to_trim = @{ $tests->{$key}->{before} }; + my @ought = @{ $tests->{$key}->{after} }; + + trim(@to_trim); + is_deeply(\@to_trim, \@ought, 'trims an array in-place OK'); + } +}; diff --git a/t/04-arrayref.t b/t/04-arrayref.t new file mode 100644 index 0000000..907a37c --- /dev/null +++ b/t/04-arrayref.t @@ -0,0 +1,38 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 2; +use Test::Builder 0.94 qw(); +use String::Trim; + +my $tests = { + one => { + before => ['one', ' two ', "three\n", undef], + after => ['one', 'two', 'three', undef], + }, + two => { + before => [' test '], + after => ['test'], + }, +}; + +subtest 'return' => sub { + plan tests => scalar keys %$tests; + foreach my $key (keys %$tests) { + my $to_trim = $tests->{$key}->{before}; + my $ought = $tests->{$key}->{after}; + + my $trimmed = trim($to_trim); + is_deeply($trimmed, $ought, 'trim($arrayref) returns a trimmed arrayref OK'); + } +}; + +subtest 'in-place' => sub { + plan tests => scalar keys %$tests; + foreach my $key (keys %$tests) { + my $to_trim = $tests->{$key}->{before}; + my $ought = $tests->{$key}->{after}; + + trim($to_trim); + is_deeply($to_trim, $ought, 'trims an arrayref in-place OK'); + } +}; diff --git a/t/05-default.t b/t/05-default.t new file mode 100644 index 0000000..096d899 --- /dev/null +++ b/t/05-default.t @@ -0,0 +1,29 @@ +use strict; +use warnings; +use Test::More 0.88; +use String::Trim; + +my $trimmed; +my $untrimmed; +my $tests = 0; +while(<DATA>) { + $untrimmed .= $_; + trim; + $trimmed .= $_; + unlike($_, qr{^\s|\s$}, "trimmed line $tests OK"); + $tests++; +} +isnt($trimmed, $untrimmed, 'trim has some effect'); +$tests++; +is($trimmed, 'onetwothreefour', 'trims $_ ok'); +$tests++; + +done_testing($tests); + + +__DATA__ + one +two + +three + four
\ No newline at end of file diff --git a/t/06-hash.t b/t/06-hash.t new file mode 100644 index 0000000..fa6fe28 --- /dev/null +++ b/t/06-hash.t @@ -0,0 +1,37 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 1;#2; +use String::Trim; + +my $in = { + "\none" => undef, + 'two' => ' two', + 'three' => 'three ', + ' four' => ' four ', + 'five' => ' five ', +}; +my $out = { + 'one' => undef, + 'two' => 'two', + 'three' => 'three', + 'four' => 'four', + 'five' => 'five', +}; + +# subtest 'return' => sub { + # plan tests => 1; + # my %trimmed = trim(%$in); + # is_deeply(\%trimmed, $out, 'trim(%hash) returns a trimmed hash OK'); +# }; + +subtest 'in-place' => sub { + TODO: { + local $TODO = 'unimplemented'; + plan tests => 1; + use Data::Dumper; + # print STDERR Dumper $in; + trim(%$in); + # print STDERR Dumper $in; + is_deeply($in, $out, 'trim(%hash) trims a hash in-place OK'); + } +}; diff --git a/t/07-hashref.t b/t/07-hashref.t new file mode 100644 index 0000000..1e5369e --- /dev/null +++ b/t/07-hashref.t @@ -0,0 +1,31 @@ +use strict; +use warnings; +use Test::More 0.94 tests => 2; +use String::Trim; + +my $in = { + "\none" => undef, + 'two' => ' two', + 'three' => 'three ', + ' four' => ' four ', + 'five' => ' five ', +}; +my $out = { + 'one' => undef, + 'two' => 'two', + 'three' => 'three', + 'four' => 'four', + 'five' => 'five', +}; + +subtest 'return' => sub { + plan tests => 1; + my $trimmed = trim($in); + is_deeply($trimmed, $out, 'trim(%hash) returns a trimmed hash OK'); +}; + +subtest 'in-place' => sub { + plan tests => 1; + trim($in); + is_deeply($in, $out, 'trim(%hash) trims a hash in-place OK'); +}; diff --git a/xt/author/critic.t b/xt/author/critic.t new file mode 100644 index 0000000..d5b4c96 --- /dev/null +++ b/xt/author/critic.t @@ -0,0 +1,12 @@ +#!perl + +use strict; +use warnings; + +use Test::More; +use English qw(-no_match_vars); + +eval "use Test::Perl::Critic"; +plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; +Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; +all_critic_ok(); diff --git a/xt/release/cpan-changes.t b/xt/release/cpan-changes.t new file mode 100644 index 0000000..0789599 --- /dev/null +++ b/xt/release/cpan-changes.t @@ -0,0 +1,7 @@ +#!perl + +use Test::More; +eval 'use Test::CPAN::Changes'; +plan skip_all => 'Test::CPAN::Changes required for this test' if $@; +changes_file_ok('Changes'); +done_testing(); diff --git a/xt/release/dist-manifest.t b/xt/release/dist-manifest.t new file mode 100644 index 0000000..a567fb7 --- /dev/null +++ b/xt/release/dist-manifest.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::DistManifest"; +plan skip_all => "Test::DistManifest required for testing the manifest" + if $@; +manifest_ok(); diff --git a/xt/release/distmeta.t b/xt/release/distmeta.t new file mode 100644 index 0000000..b46c7fc --- /dev/null +++ b/xt/release/distmeta.t @@ -0,0 +1,7 @@ +#!perl + +use Test::More; + +eval "use Test::CPAN::Meta"; +plan skip_all => "Test::CPAN::Meta required for testing META.yml" if $@; +meta_yaml_ok(); diff --git a/xt/release/eol.t b/xt/release/eol.t new file mode 100644 index 0000000..d13c49d --- /dev/null +++ b/xt/release/eol.t @@ -0,0 +1,8 @@ +use strict; +use warnings; +use Test::More; + +eval 'use Test::EOL'; +plan skip_all => 'Test::EOL required' if $@; + +all_perl_files_ok({ trailing_whitespace => 1 }); diff --git a/xt/release/has-version.t b/xt/release/has-version.t new file mode 100644 index 0000000..2115333 --- /dev/null +++ b/xt/release/has-version.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::HasVersion"; +plan skip_all => "Test::HasVersion required for testing version numbers" + if $@; +all_pm_version_ok(); diff --git a/xt/release/kwalitee.t b/xt/release/kwalitee.t new file mode 100644 index 0000000..d4651a7 --- /dev/null +++ b/xt/release/kwalitee.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::Kwalitee"; +plan skip_all => "Test::Kwalitee required for testing kwalitee" + if $@; + diff --git a/xt/release/meta-json.t b/xt/release/meta-json.t new file mode 100644 index 0000000..4dd2a14 --- /dev/null +++ b/xt/release/meta-json.t @@ -0,0 +1,6 @@ +#!perl + +use Test::More; +eval 'use Test::CPAN::Meta::JSON'; +plan skip_all => 'Test::CPAN::Meta::JSON required for testing META.json' if $@; +meta_json_ok(); diff --git a/xt/release/minimum-version.t b/xt/release/minimum-version.t new file mode 100644 index 0000000..d108c79 --- /dev/null +++ b/xt/release/minimum-version.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::MinimumVersion"; +plan skip_all => "Test::MinimumVersion required for testing minimum versions" + if $@; +all_minimum_version_from_metayml_ok(); diff --git a/xt/release/no-tabs.t b/xt/release/no-tabs.t new file mode 100644 index 0000000..ff70010 --- /dev/null +++ b/xt/release/no-tabs.t @@ -0,0 +1,8 @@ +use strict; +use warnings; +use Test::More; + +eval 'use Test::NoTabs'; +plan skip_all => 'Test::NoTabs required' if $@; + +all_perl_files_ok(); diff --git a/xt/release/pod-coverage.t b/xt/release/pod-coverage.t new file mode 100644 index 0000000..b52218b --- /dev/null +++ b/xt/release/pod-coverage.t @@ -0,0 +1,13 @@ +#!perl + +use Test::More; + +eval "use Test::Pod::Coverage 1.08"; +plan skip_all => "Test::Pod::Coverage 1.08 required for testing POD coverage" + if $@; + +eval "use Pod::Coverage::TrustPod"; +plan skip_all => "Pod::Coverage::TrustPod required for testing POD coverage" + if $@; + +all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); diff --git a/xt/release/pod-linkcheck.t b/xt/release/pod-linkcheck.t new file mode 100644 index 0000000..00602db --- /dev/null +++ b/xt/release/pod-linkcheck.t @@ -0,0 +1,20 @@ +#!perl + +use strict; +use warnings; +use Test::More; + +foreach my $env_skip ( qw( + SKIP_POD_LINKCHECK +) ){ + plan skip_all => "\$ENV{$env_skip} is set, skipping" + if $ENV{$env_skip}; +} + +eval "use Test::Pod::LinkCheck"; +if ( $@ ) { + plan skip_all => 'Test::Pod::LinkCheck required for testing POD'; +} +else { + Test::Pod::LinkCheck->new->all_pod_ok; +} diff --git a/xt/release/pod-syntax.t b/xt/release/pod-syntax.t new file mode 100644 index 0000000..8a22900 --- /dev/null +++ b/xt/release/pod-syntax.t @@ -0,0 +1,7 @@ +#!perl +use Test::More; + +eval "use Test::Pod 1.41"; +plan skip_all => "Test::Pod 1.41 required for testing POD" if $@; + +all_pod_files_ok(); diff --git a/xt/release/portability.t b/xt/release/portability.t new file mode 100644 index 0000000..e57e66e --- /dev/null +++ b/xt/release/portability.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::Portability::Files"; +plan skip_all => "Test::Portability::Files required for testing portability" + if $@; +run_tests(); diff --git a/xt/release/synopsis.t b/xt/release/synopsis.t new file mode 100644 index 0000000..a5f7223 --- /dev/null +++ b/xt/release/synopsis.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::Synopsis"; +plan skip_all => "Test::Synopsis required for testing synopses" + if $@; +all_synopsis_ok('lib'); diff --git a/xt/release/unused-vars.t b/xt/release/unused-vars.t new file mode 100644 index 0000000..edbcb35 --- /dev/null +++ b/xt/release/unused-vars.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::Vars"; +plan skip_all => "Test::Vars required for testing unused vars" + if $@; +all_vars_ok(); |