Documentating + authorship

[catagits/Test-EOL.git] / lib / Test / EOL.pm

diff --git a/lib/Test/EOL.pm b/lib/Test/EOL.pm
index bd736ba..fbbaa2f 100644 (file)
--- a/lib/Test/EOL.pm
+++ b/lib/Test/EOL.pm
@@ -63,10 +63,10 @@ sub _all_files {
 
 # Formats various human invisible symbols
 # to similar visible ones.
-# Perhaps ^M or something like that 
+# Perhaps ^M or something like that
 # would be more appropriate?
 
-sub _show_whitespace { 
+sub _show_whitespace {
     my $string = shift;
     $string =~ s/\r/[\\r]/g;
     $string =~ s/\t/[\\t]/g;
@@ -76,11 +76,11 @@ sub _show_whitespace {
 
 # Format a line record for diagnostics.
 
-sub _debug_line { 
+sub _debug_line {
     my ( $options, $line ) = @_;
     $line->[2] =~ s/\n\z//g;
-    return "line $line->[1] : $line->[0] " . ( 
-      $options->{show_lines} ? qq{: } . _show_whitespace( $line->[2] )  : q{} 
+    return "line $line->[1]: $line->[0] " . (
+      $options->{show_lines} ? qq{: } . _show_whitespace( $line->[2] )  : q{}
     );
 }
 
@@ -88,17 +88,17 @@ sub eol_unix_ok {
     my $file = shift;
     my $test_txt;
     $test_txt   = shift if !ref $_[0];
-    $test_txt ||= "No windows line endings in '$file'";
+    $test_txt ||= "No incorrect line endings in '$file'";
     my $options = shift if ref $_[0] eq 'HASH';
     $options ||= {
         trailing_whitespace => 0,
         all_reasons => 0,
     };
     $file = _module_to_path($file);
-    
+
     open my $fh, $file or do { $Test->ok(0, $test_txt); $Test->diag("Could not open $file: $!"); return; };
     # Windows-- , default is :crlf, which hides \r\n  -_-
-    binmode( $fh, ':raw:utf8' );
+    binmode( $fh, ':raw' );
     my $line = 0;
     my @fails;
     while (<$fh>) {
@@ -115,11 +115,11 @@ sub eol_unix_ok {
         # once there's an err.
         last if( @fails > 0 && !$options->{all_reasons} );
     }
-    if( @fails ){ 
+    if( @fails ){
        $Test->ok( 0, $test_txt . " on "  . _debug_line({ show_lines => 0 } , $fails[0]  )  );
        if ( $options->{all_reasons} || 1 ){
           $Test->diag( "  Problem Lines: ");
-          for ( @fails ){ 
+          for ( @fails ){
             $Test->diag(_debug_line({ show_lines => 1 } , $_ ) );
           }
        }
@@ -145,7 +145,7 @@ sub _is_perl_script {
     my $file = shift;
     return 1 if $file =~ /\.pl$/i;
     return 1 if $file =~ /\.t$/;
-    open my $fh, $file or return;
+    open (my $fh, $file) or return;
     my $first = <$fh>;
     return 1 if defined $first && ($first =~ $PERL_PATTERN);
     return;
@@ -180,9 +180,9 @@ sub _untaint {
 
 =head1 SYNOPSIS
 
-C<Test::EOL> lets you check the presence of windows line endings in your
-perl code. It
-report its results in standard C<Test::Simple> fashion:
+C<Test::EOL> lets you check for the presence of trailing whitespace and/or
+windows line endings in your perl code. It reports its results in standard
+C<Test::Simple> fashion:
 
   use Test::EOL tests => 1;
   eol_unix_ok( 'lib/Module.pm', 'Module is ^M free');
@@ -223,7 +223,9 @@ modules, etc) for the presence of windows line endings.
 A list of functions that can be exported.  You can delete this section
 if you don't export anything, such as for a purely object-oriented module.
 
-=func all_perl_files_ok( [ \%options ], [ @directories ] )
+=func all_perl_files_ok
+
+  all_perl_files_ok( [ \%options ], [ @directories ] )
 
 Applies C<eol_unix_ok()> to all perl files found in C<@directories> (and sub
 directories). If no <@directories> is given, the starting point is one level
@@ -231,6 +233,24 @@ above the current running script, that should cover all the files of a typical
 CPAN distribution. A perl file is *.pl or *.pm or *.t or a file starting
 with C<#!...perl>
 
+Valid C<\%options> currently are:
+
+=over
+
+=item * trailing_whitespace
+
+By default Test::EOL only looks for Windows (CR/LF) line-endings. Set this
+to true to raise errors if any kind of trailing whitespace is present in
+the file.
+
+=item * all_reasons
+
+Normally Test::EOL reports only the first error in every file (given that
+a text file originated on Windows will fail every single line). Set this
+a true value to register a test failure for every line with an error.
+
+=back
+
 If the test plan is defined:
 
   use Test::EOL tests => 3;
@@ -238,10 +258,14 @@ If the test plan is defined:
 
 the total number of files tested must be specified.
 
-=func eol_unix_ok( $file [, $text] [, \%options ]  )
+=func eol_unix_ok
+
+  eol_unix_ok ( $file [, $text] [, \%options ] )
 
 Run a unix EOL check on C<$file>. For a module, the path (lib/My/Module.pm) or the
-name (My::Module) can be both used.
+name (My::Module) can be both used. C<$text> is the diagnostic label emited after
+the C<ok>/C<not ok> TAP output. C<\%options> takes the same values as described in
+L</all_perl_files_ok>.
 
 =head1 ACKNOWLEDGEMENTS