Commit | Line | Data |
a83ae797 |
1 | package Test::EOL; |
94bc2901 |
2 | # ABSTRACT: Check the correct line endings in your project |
a83ae797 |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
7 | use Test::Builder; |
8 | use File::Spec; |
9 | use FindBin qw($Bin); |
10 | use File::Find; |
11 | |
94bc2901 |
12 | use vars qw( $PERL $UNTAINT_PATTERN $PERL_PATTERN); |
a83ae797 |
13 | |
14 | $PERL = $^X || 'perl'; |
15 | $UNTAINT_PATTERN = qr|^([-+@\w./:\\]+)$|; |
16 | $PERL_PATTERN = qr/^#!.*perl/; |
17 | |
18 | my %file_find_arg = ($] <= 5.006) ? () : ( |
19 | untaint => 1, |
20 | untaint_pattern => $UNTAINT_PATTERN, |
21 | untaint_skip => 1, |
22 | ); |
23 | |
24 | my $Test = Test::Builder->new; |
25 | my $updir = File::Spec->updir(); |
26 | |
27 | sub import { |
28 | my $self = shift; |
29 | my $caller = caller; |
30 | { |
31 | no strict 'refs'; |
32 | *{$caller.'::eol_unix_ok'} = \&eol_unix_ok; |
33 | *{$caller.'::all_perl_files_ok'} = \&all_perl_files_ok; |
34 | } |
35 | $Test->exported_to($caller); |
36 | $Test->plan(@_); |
37 | } |
38 | |
39 | sub _all_perl_files { |
40 | my @all_files = _all_files(@_); |
41 | return grep { _is_perl_module($_) || _is_perl_script($_) } @all_files; |
42 | } |
43 | |
44 | sub _all_files { |
45 | my @base_dirs = @_ ? @_ : File::Spec->catdir($Bin, $updir); |
46 | my @found; |
47 | my $want_sub = sub { |
e52debaf |
48 | return if ($File::Find::dir =~ m![\\/]?CVS[\\/]|[\\/]?\.svn[\\/]!); # Filter out cvs or subversion dirs/ |
a83ae797 |
49 | return if ($File::Find::dir =~ m![\\/]?blib[\\/]libdoc$!); # Filter out pod doc in dist |
50 | return if ($File::Find::dir =~ m![\\/]?blib[\\/]man\d$!); # Filter out pod doc in dist |
27c70d46 |
51 | return if ($File::Find::dir =~ m![\\/]?inc!); # Filter out Module::Install stuff |
a83ae797 |
52 | return if ($File::Find::name =~ m!Build$!i); # Filter out autogenerated Build script |
53 | return unless (-f $File::Find::name && -r _); |
54 | push @found, File::Spec->no_upwards( $File::Find::name ); |
55 | }; |
56 | my $find_arg = { |
57 | %file_find_arg, |
58 | wanted => $want_sub, |
59 | no_chdir => 1, |
60 | }; |
61 | find( $find_arg, @base_dirs); |
62 | return @found; |
63 | } |
64 | |
f17f4176 |
65 | # Formats various human invisible symbols |
66 | # to similar visible ones. |
fe02d07d |
67 | # Perhaps ^M or something like that |
f17f4176 |
68 | # would be more appropriate? |
69 | |
fe02d07d |
70 | sub _show_whitespace { |
f17f4176 |
71 | my $string = shift; |
72 | $string =~ s/\r/[\\r]/g; |
73 | $string =~ s/\t/[\\t]/g; |
74 | $string =~ s/ /[\\s]/g; |
75 | return $string; |
76 | } |
77 | |
78 | # Format a line record for diagnostics. |
79 | |
fe02d07d |
80 | sub _debug_line { |
f17f4176 |
81 | my ( $options, $line ) = @_; |
82 | $line->[2] =~ s/\n\z//g; |
939ef613 |
83 | return "line $line->[1]: $line->[0] " . ( |
fe02d07d |
84 | $options->{show_lines} ? qq{: } . _show_whitespace( $line->[2] ) : q{} |
f17f4176 |
85 | ); |
86 | } |
87 | |
a83ae797 |
88 | sub eol_unix_ok { |
89 | my $file = shift; |
91613276 |
90 | my $test_txt; |
91 | $test_txt = shift if !ref $_[0]; |
939ef613 |
92 | $test_txt ||= "No incorrect line endings in '$file'"; |
91613276 |
93 | my $options = shift if ref $_[0] eq 'HASH'; |
94 | $options ||= { |
95 | trailing_whitespace => 0, |
f17f4176 |
96 | all_reasons => 0, |
91613276 |
97 | }; |
a83ae797 |
98 | $file = _module_to_path($file); |
fe02d07d |
99 | |
a83ae797 |
100 | open my $fh, $file or do { $Test->ok(0, $test_txt); $Test->diag("Could not open $file: $!"); return; }; |
f17f4176 |
101 | # Windows-- , default is :crlf, which hides \r\n -_- |
a2bfe7c3 |
102 | binmode( $fh, ':raw' ); |
a83ae797 |
103 | my $line = 0; |
f17f4176 |
104 | my @fails; |
a83ae797 |
105 | while (<$fh>) { |
106 | $line++; |
f17f4176 |
107 | if ( !$options->{trailing_whitespace} && /(\r+)$/ ) { |
108 | my $match = $1; |
109 | push @fails, [ _show_whitespace( $match ) , $line , $_ ]; |
a83ae797 |
110 | } |
f17f4176 |
111 | if ( $options->{trailing_whitespace} && /([ \t]*\r+|[ \t]+)$/ ) { |
112 | my $match = $1; |
113 | push @fails, [ _show_whitespace($match), $line , $_ ]; |
114 | } |
115 | # Minor short-circuit for people who don't need the whole file scanned |
116 | # once there's an err. |
117 | last if( @fails > 0 && !$options->{all_reasons} ); |
118 | } |
fe02d07d |
119 | if( @fails ){ |
f17f4176 |
120 | $Test->ok( 0, $test_txt . " on " . _debug_line({ show_lines => 0 } , $fails[0] ) ); |
121 | if ( $options->{all_reasons} || 1 ){ |
122 | $Test->diag( " Problem Lines: "); |
fe02d07d |
123 | for ( @fails ){ |
f17f4176 |
124 | $Test->diag(_debug_line({ show_lines => 1 } , $_ ) ); |
125 | } |
126 | } |
127 | return 0; |
a83ae797 |
128 | } |
129 | $Test->ok(1, $test_txt); |
130 | return 1; |
131 | } |
a83ae797 |
132 | sub all_perl_files_ok { |
91613276 |
133 | my $options = shift if ref $_[0] eq 'HASH'; |
a83ae797 |
134 | my @files = _all_perl_files( @_ ); |
135 | _make_plan(); |
136 | foreach my $file ( @files ) { |
91613276 |
137 | eol_unix_ok($file, $options); |
a83ae797 |
138 | } |
139 | } |
140 | |
141 | sub _is_perl_module { |
142 | $_[0] =~ /\.pm$/i || $_[0] =~ /::/; |
143 | } |
144 | |
145 | sub _is_perl_script { |
146 | my $file = shift; |
147 | return 1 if $file =~ /\.pl$/i; |
148 | return 1 if $file =~ /\.t$/; |
7ebe98c1 |
149 | open (my $fh, $file) or return; |
a83ae797 |
150 | my $first = <$fh>; |
151 | return 1 if defined $first && ($first =~ $PERL_PATTERN); |
152 | return; |
153 | } |
154 | |
155 | sub _module_to_path { |
156 | my $file = shift; |
157 | return $file unless ($file =~ /::/); |
158 | my @parts = split /::/, $file; |
159 | my $module = File::Spec->catfile(@parts) . '.pm'; |
160 | foreach my $dir (@INC) { |
161 | my $candidate = File::Spec->catfile($dir, $module); |
162 | next unless (-e $candidate && -f _ && -r _); |
163 | return $candidate; |
164 | } |
165 | return $file; |
166 | } |
167 | |
168 | sub _make_plan { |
169 | unless ($Test->has_plan) { |
170 | $Test->plan( 'no_plan' ); |
171 | } |
172 | $Test->expected_tests; |
173 | } |
174 | |
175 | sub _untaint { |
176 | my @untainted = map { ($_ =~ $UNTAINT_PATTERN) } @_; |
177 | return wantarray ? @untainted : $untainted[0]; |
178 | } |
179 | |
180 | 1; |
a83ae797 |
181 | |
182 | =head1 SYNOPSIS |
183 | |
936fb8fb |
184 | C<Test::EOL> lets you check for the presence of trailing whitespace and/or |
185 | windows line endings in your perl code. It reports its results in standard |
186 | C<Test::Simple> fashion: |
a83ae797 |
187 | |
188 | use Test::EOL tests => 1; |
29330dd1 |
189 | eol_unix_ok( 'lib/Module.pm', 'Module is ^M free'); |
a83ae797 |
190 | |
91613276 |
191 | and to add checks for trailing whitespace: |
192 | |
193 | use Test::EOL tests => 1; |
194 | eol_unix_ok( 'lib/Module.pm', 'Module is ^M and trailing whitespace free', { trailing_whitespace => 1 }); |
195 | |
a83ae797 |
196 | Module authors can include the following in a t/eol.t and have C<Test::EOL> |
197 | automatically find and check all perl files in a module distribution: |
198 | |
199 | use Test::EOL; |
200 | all_perl_files_ok(); |
201 | |
202 | or |
203 | |
204 | use Test::EOL; |
205 | all_perl_files_ok( @mydirs ); |
206 | |
91613276 |
207 | and if authors would like to check for trailing whitespace: |
208 | |
209 | use Test::EOL; |
210 | all_perl_files_ok({ trailing_whitespace => 1 }); |
211 | |
212 | or |
213 | |
214 | use Test::EOL; |
215 | all_perl_files_ok({ trailing_whitespace => 1 }, @mydirs ); |
216 | |
a83ae797 |
217 | =head1 DESCRIPTION |
218 | |
219 | This module scans your project/distribution for any perl files (scripts, |
29330dd1 |
220 | modules, etc) for the presence of windows line endings. |
a83ae797 |
221 | |
222 | =head1 EXPORT |
223 | |
224 | A list of functions that can be exported. You can delete this section |
225 | if you don't export anything, such as for a purely object-oriented module. |
226 | |
936fb8fb |
227 | =func all_perl_files_ok |
228 | |
229 | all_perl_files_ok( [ \%options ], [ @directories ] ) |
a83ae797 |
230 | |
231 | Applies C<eol_unix_ok()> to all perl files found in C<@directories> (and sub |
232 | directories). If no <@directories> is given, the starting point is one level |
233 | above the current running script, that should cover all the files of a typical |
234 | CPAN distribution. A perl file is *.pl or *.pm or *.t or a file starting |
235 | with C<#!...perl> |
236 | |
936fb8fb |
237 | Valid C<\%options> currently are: |
238 | |
239 | =over |
240 | |
241 | =item * trailing_whitespace |
242 | |
243 | By default Test::EOL only looks for Windows (CR/LF) line-endings. Set this |
244 | to true to raise errors if any kind of trailing whitespace is present in |
245 | the file. |
246 | |
247 | =item * all_reasons |
248 | |
249 | Normally Test::EOL reports only the first error in every file (given that |
250 | a text file originated on Windows will fail every single line). Set this |
251 | a true value to register a test failure for every line with an error. |
252 | |
253 | =back |
254 | |
a83ae797 |
255 | If the test plan is defined: |
256 | |
257 | use Test::EOL tests => 3; |
258 | all_perl_files_ok(); |
259 | |
260 | the total number of files tested must be specified. |
261 | |
936fb8fb |
262 | =func eol_unix_ok |
263 | |
264 | eol_unix_ok ( $file [, $text] [, \%options ] ) |
a83ae797 |
265 | |
266 | Run a unix EOL check on C<$file>. For a module, the path (lib/My/Module.pm) or the |
936fb8fb |
267 | name (My::Module) can be both used. C<$text> is the diagnostic label emited after |
268 | the C<ok>/C<not ok> TAP output. C<\%options> takes the same values as described in |
269 | L</all_perl_files_ok>. |
a83ae797 |
270 | |
a83ae797 |
271 | =head1 ACKNOWLEDGEMENTS |
272 | |
273 | Shamelessly ripped off from L<Test::NoTabs>. |
274 | |
275 | =head1 SEE ALSO |
276 | |
277 | L<Test::More>, L<Test::Pod>. L<Test::Distribution>, L<Test:NoWarnings>, |
278 | L<Test::NoTabs>, L<Module::Install::AuthorTests>. |
279 | |
a83ae797 |
280 | =cut |