File Coverage

blib/lib/File/Canonicalizer.pm

Criterion	Covered	Total	%
statement	15	59	25.4
branch	0	32	0.0
condition	0	6	0.0
subroutine	5	6	83.3
pod	1	1	100.0
total	21	104	20.1

package File::Canonicalizer;

use 5.006;
use strict;
use warnings FATAL => 'all';
use English;

require Exporter;
our @ISA = qw(Exporter);
our @EXPORT = qw(file_canonicalizer);

use Carp;
our $VERSION = '0.11';

sub file_canonicalizer {
   my ( $inp_file                                       # 1
      , $out_file                                       # 2
      , $remove_comments_started_with_RE                # 3
      , $replace_adjacent_tabs_and_spaces_with_1_space  # 4
      , $replace_adjacent_slashes_with_single_slash     # 5
      , $remove_white_char_from_line_edges              # 6
      , $remove_empty_lines                             # 7
      , $convert_to_lowercased                          # 8
      , $remove_leading_zeroes                          # 9
      , $sort_lines                                     #10
      , $aref_replacements                              #11
      ) = @_ ;

   my %lines ;
   my $INP;
   my $OUT;
   my $i ;
   my $replaced_pattern;
   my $replacement;

   unless ($inp_file) { $inp_file = '&STDIN'; }
   open ($INP, "<$inp_file") || croak "Error: Can't open file \"$inp_file\" for read: $!";
   unless ($out_file) { $out_file = '&STDOUT'; }
   open ($OUT, ">$out_file") || croak "Error: Can't open file \"$out_file\" for write: $!" ;

   while (<$INP>)
   {
     chomp;
     if ($remove_comments_started_with_RE) { s/$remove_comments_started_with_RE.+$//; }
     if ($replace_adjacent_tabs_and_spaces_with_1_space) { s/[ \t]+/ /g; }
     if ($replace_adjacent_slashes_with_single_slash) { s#/+#/#g; }
     if ($remove_empty_lines) { (/^\s*$/) && next; }
     if ($remove_white_char_from_line_edges) { s/(^[ \t]*|[ \t]*$)//g; }
     if ($convert_to_lowercased) { $_ = lc; }
     if ($remove_leading_zeroes) { s/(\W)0+(\d)/$1$2/g; }

     if (defined $aref_replacements)
     {
        $i = 0;
        REPLACEMENTS: while (1)
        {
           ($replaced_pattern, $replacement) = (@{$aref_replacements})[$i++,$i++];
           (defined $replacement) || last REPLACEMENTS;
           s/$replaced_pattern/$replacement/g;
        }
     }

     if ($sort_lines) { $lines{$_} = undef; next; }
     print $OUT "$_\n" || croak "Error: Can't write to $out_file: $!";
   }

   if ($sort_lines)
   {
      for (sort keys %lines)
      {  print $OUT "$_\n" || croak "Error: Can't write to $out_file: $!"; }
   }

   close $OUT;
   close $INP;
}  #  end of 'sub file_canonicalizer'

1;

__END__