/usr/share/perl5/String/Formatter/Cookbook.pm is in libstring-formatter-perl 0.102084-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | use strict;
use warnings;
package String::Formatter::Cookbook;
{
$String::Formatter::Cookbook::VERSION = '0.102084';
}
# ABSTRACT: ways to put String::Formatter to use
1;
__END__
=pod
=head1 NAME
String::Formatter::Cookbook - ways to put String::Formatter to use
=head1 VERSION
version 0.102084
=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.
=encoding utf-8
=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<sprintf>, 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<Warning>: 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<strftime> or something
similar. The C<method_replace> 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<method_stringf>:
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 <rjbs@cpan.org>
=item *
Darren Chamberlain <darren@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by Ricardo Signes <rjbs@cpan.org>.
This is free software, licensed under:
The GNU General Public License, Version 2, June 1991
=cut
|