2 # ABSTRACT: Check the correct line endings in your project
12 use vars qw( $PERL $UNTAINT_PATTERN $PERL_PATTERN);
14 $PERL = $^X || 'perl';
15 $UNTAINT_PATTERN = qr|^([-+@\w./:\\]+)$|;
16 $PERL_PATTERN = qr/^#!.*perl/;
18 my %file_find_arg = ($] <= 5.006) ? () : (
20 untaint_pattern => $UNTAINT_PATTERN,
24 my $Test = Test::Builder->new;
33 *{$caller.'::eol_unix_ok'} = \&eol_unix_ok;
34 *{$caller.'::all_perl_files_ok'} = \&all_perl_files_ok;
36 $Test->exported_to($caller);
38 if ($_[0] && $_[0] eq 'no_plan') {
46 my @all_files = _all_files(@_);
47 return grep { _is_perl_module($_) || _is_perl_script($_) || _is_pod_file($_) } @all_files;
51 my @base_dirs = @_ ? @_ : cwd();
52 my $options = pop(@base_dirs) if ref $base_dirs[-1] eq 'HASH';
55 return if ($File::Find::dir =~ m![\\/]?CVS[\\/]|[\\/]?\.svn[\\/]!); # Filter out cvs or subversion dirs/
56 return if ($File::Find::dir =~ m![\\/]?blib[\\/]libdoc$!); # Filter out pod doc in dist
57 return if ($File::Find::dir =~ m![\\/]?blib[\\/]man\d$!); # Filter out pod doc in dist
58 return if ($File::Find::dir =~ m![\\/]?inc!); # Filter out Module::Install stuff
59 return if ($File::Find::name =~ m!Build$!i); # Filter out autogenerated Build script
60 return unless (-f $File::Find::name && -r _);
61 push @found, File::Spec->no_upwards( $File::Find::name );
68 find( $find_arg, @base_dirs);
72 # Formats various human invisible symbols
73 # to similar visible ones.
74 # Perhaps ^M or something like that
75 # would be more appropriate?
77 sub _show_whitespace {
79 $string =~ s/\r/[\\r]/g;
80 $string =~ s/\t/[\\t]/g;
81 $string =~ s/ /[\\s]/g;
85 # Format a line record for diagnostics.
88 my ( $options, $line ) = @_;
89 $line->[2] =~ s/\n\z//g if defined $line->[2];
90 return "line $line->[1]: $line->[0]" . (
91 $options->{show_lines} && defined $line->[2]
92 ? qq{: } . _show_whitespace( $line->[2] )
100 $test_txt = shift if !ref $_[0];
101 $test_txt ||= "No incorrect line endings in '$file'";
102 my $options = shift if ref $_[0] eq 'HASH';
104 trailing_whitespace => 0,
105 trailing_newline => 0,
108 $file = _module_to_path($file);
110 open my $fh, $file or do { $Test->ok(0, $test_txt); $Test->diag("Could not open $file: $!"); return; };
111 # Windows-- , default is :crlf, which hides \r\n -_-
112 binmode( $fh, ':raw' );
120 push @fails, [ _show_whitespace($match) , $line , $_ ]
121 if !$fails{eol}++ or $options->{all_reasons};
123 if ( $options->{trailing_whitespace} && /([ \t]+)\r*$/ ) {
125 push @fails, [ _show_whitespace($match), $line , $_ ]
126 if !$fails{tws}++ or $options->{all_reasons};
134 if ( $options->{trailing_newline} && eof ) {
135 push @fails, [ sprintf('%d blank line%s at end of file',
136 $blank_lines, $blank_lines > 1 ? 's' : ''),
139 push @fails, [ 'Missing "\n" at end of file', $line, undef ]
142 # Minor short-circuit for people who don't need the whole file scanned
143 # once there's an err.
144 last if( @fails > 0 && !$options->{all_reasons} );
147 $Test->ok( 0, $test_txt . " on " . _debug_line({ show_lines => 0 } , $fails[0] ) );
148 if ( $options->{all_reasons} || 1 ){
149 $Test->diag( " Problem Lines: ");
151 $Test->diag(_debug_line({ show_lines => 1 } , $_ ) );
156 $Test->ok(1, $test_txt);
159 sub all_perl_files_ok {
160 my $options = shift if ref $_[0] eq 'HASH';
161 my @files = _all_perl_files( @_ );
163 foreach my $file ( @files ) {
164 eol_unix_ok($file, $options);
168 sub _is_perl_module {
169 $_[0] =~ /\.pm$/i || $_[0] =~ /::/;
176 sub _is_perl_script {
178 return 1 if $file =~ /\.pl$/i;
179 return 1 if $file =~ /\.t$/;
180 open (my $fh, $file) or return;
182 return 1 if defined $first && ($first =~ $PERL_PATTERN);
186 sub _module_to_path {
188 return $file unless ($file =~ /::/);
189 my @parts = split /::/, $file;
190 my $module = File::Spec->catfile(@parts) . '.pm';
191 foreach my $dir (@INC) {
192 my $candidate = File::Spec->catfile($dir, $module);
193 next unless (-e $candidate && -f _ && -r _);
201 unless ($Test->has_plan) {
202 $Test->plan( 'no_plan' );
204 $Test->expected_tests;
208 my @untainted = map { ($_ =~ $UNTAINT_PATTERN) } @_;
209 return wantarray ? @untainted : $untainted[0];
216 C<Test::EOL> lets you check for the presence of trailing whitespace and/or
217 windows line endings in your perl code. It reports its results in standard
218 C<Test::Simple> fashion:
220 use Test::EOL tests => 1;
221 eol_unix_ok( 'lib/Module.pm', 'Module is ^M free');
223 and to add checks for trailing whitespace:
225 use Test::EOL tests => 1;
226 eol_unix_ok( 'lib/Module.pm', 'Module is ^M and trailing whitespace free', { trailing_whitespace => 1 });
228 Module authors can include the following in a t/eol.t and have C<Test::EOL>
229 automatically find and check all perl files in a module distribution:
237 all_perl_files_ok( @mydirs );
239 and if authors would like to check for trailing whitespace:
242 all_perl_files_ok({ trailing_whitespace => 1 });
247 all_perl_files_ok({ trailing_whitespace => 1 }, @mydirs );
252 use Test::EOL 'no_test';
256 and if authors would like to check that there's a single newline and no
257 blank lines at the end of each file:
260 all_perl_files_ok({ trailing_newline => 1 });
265 all_perl_files_ok({ trailing_newline => 1 }, @mydirs );
269 This module scans your project/distribution for any perl files (scripts,
270 modules, etc) for the presence of windows line endings.
274 A list of functions that can be exported. You can delete this section
275 if you don't export anything, such as for a purely object-oriented module.
277 =func all_perl_files_ok
279 all_perl_files_ok( [ \%options ], [ @directories ] )
281 Applies C<eol_unix_ok()> to all perl files found in C<@directories> (and sub
282 directories). If no <@directories> is given, the starting point is the current
283 working directory, as tests are usually run from the top directory in a typical
284 CPAN distribution. A perl file is *.pl or *.pm or *.pod or *.t or a file starting
287 Valid C<\%options> currently are:
291 =item * trailing_whitespace
293 By default Test::EOL only looks for Windows (CR/LF) line-endings. Set this
294 to true to raise errors if any kind of trailing whitespace is present in
297 =item * trailing_newline
299 Set this to true to raise an error if the file doesn't end with exactly
300 one newline and no blank lines.
304 Normally Test::EOL reports only the first error in every file (given that
305 a text file originated on Windows will fail every single line). Set this
306 a true value to register a test failure for every line with an error.
310 If the test plan is defined:
312 use Test::EOL tests => 3;
315 the total number of files tested must be specified.
319 eol_unix_ok ( $file [, $text] [, \%options ] )
321 Run a unix EOL check on C<$file>. For a module, the path (lib/My/Module.pm) or the
322 name (My::Module) can be both used. C<$text> is the diagnostic label emited after
323 the C<ok>/C<not ok> TAP output. C<\%options> takes the same values as described in
324 L</all_perl_files_ok>.
326 =head1 ACKNOWLEDGEMENTS
328 Shamelessly ripped off from L<Test::NoTabs>.
332 L<Test::More>, L<Test::Pod>. L<Test::Distribution>, L<Test:NoWarnings>,
333 L<Test::NoTabs>, L<Module::Install::AuthorTests>.