NAME
List::ToHumanString - write lists in strings like a human would
SYNOPSIS
use List::ToHumanString;
print to_human_string "Report{|s} for |list|\n", qw/March May July/;
## Prints "Reports for March, May, and July";
print to_human_string "Report{|s} for |list|\n", qw/March July/;
## Prints "Reports for March and July";
print to_human_string "Report{|s} {is|are} needed for |list|\n", qw/March/;
## Prints "Report is needed for March";
DESCRIPTION
Provides a way to make it easy to prepare a string containing a list of
items, where that string is meant to be read by a human.
SEE ALSO
Lingua::Conjunction -- You might find Lingua::Conjunction more apt at
joining the list of things, if that's the only thing that you're after.
EXPORTS BY DEFAULT
"to_human_string"
print to_human_string "Report{|s} for |list|\n", qw/March May July/;
## Prints "Reports for March, May, and July";
print to_human_string "Report{|s} for |list|\n", qw/March July/;
## Prints "Reports for March and July";
print to_human_string "Report{|s} {is|are} needed for |list|\n", qw/March/;
## Prints "Report is needed for March";
print to_human_string '|list|', qw/March May July/;
## Prints "March, May, and July";
$List::ToHumanString::Separator = '*SEP*';
$List::ToHumanString::Extra_Comma = 0;
print to_human_string "I have {one item*SEP*many items}: *SEP*list*SEP*", qw/Foo Bar Baz/;
## Prints "I have many items: Foo, Bar and Baz" (note the missing comma before "and")
Exported by default. Takes a string to "humanize" as the first argument
and a list of items to use. Removes all undefs and empty and blank
strings before counting the number of items in the list. If the list
contains one item, chooses the "singular" variation in the first
argument's format (see below). If the list contains any other number of
items, chooses "plural" variation in the format. Once all the
substitutions have been done, returns the resultant string.
first argument format
"I have {one item|many items}"
"I have {one item that is|many items that are} |list|"
"I have item{|s}: |list|"
"I have {a|} thing{|s}"
$List::ToHumanString::Separator = '::SEP::';
"I have {one item::SEP::many items}: ::SEP::list::SEP::",
singular/plural
"to_human_string()" will replace any occurence of
"{singularSEPARATORplural}" with either the "singular" or "plural"
texts, depending on the number of items in the list given to it. The
"singular" and "plural" texts can be any text (even empty string) that
doesn't have a "SEPARATOR" in it. The "SEPARATOR" is the value of
$List::ToHumanString::Separator, which by default is a pipe character
("|"). Regex special characters in the "SEPARATOR" have no effect.
humanized list
"I have item{|s}: |list|"
"I have {one item::SEP::many items}: ::SEP::list::SEP::",
You can automatically insert a "humanized" list of items into your
string by using word "list" set off be "SEPARATOR" string on each side.
That string will be replaced by a "humanized" way to write the list of
items you provided, which is as follows:
empty list of items
to_human_string('|list|',);
# returns ''
Humanized string will be: empty string.
1-item list of items
to_human_string('|list|', 'foo');
# returns 'foo'
to_human_string('|list|', URI->new("http://example.com") );
# returns 'http://example.com'
Humanized string will be: the item itself (stringified).
2-item list of items
to_human_string('|list|', 'foo', 'bar');
# returns 'foo and bar'
Humanized string will be: the two items joined with ' and '
list with 3 or more items
to_human_string('|list|', 'foo', 'bar', 'ber', 'baz');
# returns 'foo, bar, ber, and baz'
$List::ToHumanString::Extra_Comma = 0;
to_human_string('|list|', 'foo', 'bar', 'ber', 'baz');
# returns 'foo, bar, ber and baz'
Humanized string will be: the list of items in the list you provided
joined with ', ' (comma and space). The last element is also preceded by
word 'and '. Note: depending on your stylistic preference, you might
wish not to have a comma before the last element. You can accomplish
that by setting $List::ToHumanString::Extra_Comma to zero.
VARIABLES
$List::ToHumanString::Separator
my @items = ( 1..10 );
$List::ToHumanString::Separator = '::SEP::';
print to_human_string "I have {one item::SEP::many items} {foo|bar}\n", @items;
## Prints "I have many items {foo|bar}"
Takes any non-empty string as a value. Specifies what separator to use
between the "singular" and "plural" texts in the string given to
"to_human_string()". Defaults to: "|" (a pipe character)
$List::ToHumanString::Extra_Comma
$List::ToHumanString::Extra_Comma = 0;
to_human_string('|list|', 'foo', 'bar', 'ber', 'baz');
# returns 'foo, bar, ber and baz'
Takes true or false values as a value. Specifies whether to use a comma
after the penultimate element in the list when using "to_human_string()"
to insert humanized list into the string. If set to a true value, the
comma will be used. Defaults to: 1 (true value).
AUTHOR
Zoffix Znet, "<zoffix at cpan.org>"
BUGS
Please report any bugs or feature requests to "bug-list-tohumanstring at
rt.cpan.org", or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=List-ToHumanString>. I
will be notified, and then you'll automatically be notified of progress
on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc List::ToHumanString
You can also look for information at:
* RT: CPAN's request tracker (report bugs here)
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=List-ToHumanString>
* AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/List-ToHumanString>
* CPAN Ratings
<http://cpanratings.perl.org/d/List-ToHumanString>
* Search CPAN
<http://search.cpan.org/dist/List-ToHumanString/>
LICENSE AND COPYRIGHT
Copyright 2013 Zoffix Znet.
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a copy
of the full license at:
<http://www.perlfoundation.org/artistic_license_2_0>
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.