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
|
package String::Trim::More;
our $DATE = '2017-01-27'; # DATE
our $VERSION = '0.03'; # VERSION
use 5.010001;
use strict;
use warnings;
use Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(
ltrim
rtrim
trim
ltrim_lines
rtrim_lines
trim_lines
trim_blank_lines
ellipsis
);
sub ltrim {
my $str = shift;
$str =~ s/\A\s+//s;
$str;
}
sub rtrim {
my $str = shift;
$str =~ s/\s+\z//s;
$str;
}
sub trim {
my $str = shift;
$str =~ s/\A\s+//s;
$str =~ s/\s+\z//s;
$str;
}
sub ltrim_lines {
my $str = shift;
$str =~ s/^[ \t]+//mg; # XXX other unicode non-newline spaces
$str;
}
sub rtrim_lines {
my $str = shift;
$str =~ s/[ \t]+$//mg;
$str;
}
sub trim_lines {
my $str = shift;
$str =~ s/^[ \t]+//mg;
$str =~ s/[ \t]+$//mg;
$str;
}
sub trim_blank_lines {
local $_ = shift;
return $_ unless defined;
s/\A(?:\n\s*)+//;
s/(?:\n\s*){2,}\z/\n/;
$_;
}
sub ellipsis {
my ($str, $maxlen, $ellipsis) = @_;
$maxlen //= 80;
$ellipsis //= "...";
if (length($str) <= $maxlen) {
return $str;
} else {
return substr($str, 0, $maxlen-length($ellipsis)) . $ellipsis;
}
}
1;
# ABSTRACT: Various string trimming utilities
__END__
=pod
=encoding UTF-8
=head1 NAME
String::Trim::More - Various string trimming utilities
=head1 VERSION
This document describes version 0.03 of String::Trim::More (from Perl distribution String-Trim-More), released on 2017-01-27.
=head1 DESCRIPTION
This is an alternative to L<String::Trim> (and similar modules, see L</"SEE
ALSO">). Instead of a single C<trim> function, this module provides several from
which you can choose on, depending on your needs.
=head1 FUNCTIONS
=head2 ltrim($str) => STR
Trim whitespaces (including newlines) at the beginning of string. Equivalent to:
$str =~ s/\A\s+//s;
=head2 ltrim_lines($str) => STR
Trim whitespaces (not including newlines) at the beginning of each line of
string. Equivalent to:
$str =~ s/^\s+//mg;
=head2 rtrim($str) => STR
Trim whitespaces (including newlines) at the end of string. Equivalent to:
$str =~ s/[ \t]+\z//s;
=head2 rtrim_lines($str) => STR
Trim whitespaces (not including newlines) at the end of each line of
string. Equivalent to:
$str =~ s/[ \t]+$//mg;
=head2 trim($str) => STR
ltrim + rtrim.
=head2 trim_lines($str) => STR
ltrim_lines + rtrim_lines.
=head2 trim_blank_lines($str) => STR
Trim blank lines at the beginning and the end. Won't trim blank lines in the
middle. Blank lines include lines with only whitespaces in them.
=head2 ellipsis($str[, $maxlen, $ellipsis]) => STR
Return $str unmodified if $str's length is less than $maxlen (default 80).
Otherwise cut $str to ($maxlen - length($ellipsis)) and append $ellipsis
(default '...') at the end.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/String-Trim-More>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-String-Trim-More>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=String-Trim-More>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 SEE ALSO
For trim functions: L<String::Trim>, L<Text::Trim>, L<String::Strip>,
L<String::Util>.
For ellipsis/eliding: L<Text::Elide> (elide at word boundaries),
L<String::Elide::Parts> (elide with more options).
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by perlancar@cpan.org.
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
|
