File Coverage

blib/lib/Mixin/Linewise/Readers.pm

Criterion	Covered	Total	%
statement	53	53	100.0
branch	22	28	78.5
condition	4	6	66.6
subroutine	13	13	100.0
pod			n/a
total	92	100	92.0

use strict;
use warnings;
package Mixin::Linewise::Readers 0.109;
# ABSTRACT: get linewise readers for strings and filenames

use 5.008001; # PerlIO
use Carp ();
use IO::File;
use PerlIO::utf8_strict;

use Sub::Exporter -setup => {
  exports => { map {; "read_$_" => \"_mk_read_$_" } qw(file string) },
  groups  => {
    default => [ qw(read_file read_string) ],
    readers => [ qw(read_file read_string) ],
  },
};

#pod =head1 SYNOPSIS
#pod
#pod   package Your::Pkg;
#pod   use Mixin::Linewise::Readers -readers;
#pod
#pod   sub read_handle {
#pod     my ($self, $handle) = @_;
#pod
#pod     LINE: while (my $line = $handle->getline) {
#pod       next LINE if $line =~ /^#/;
#pod
#pod       print "non-comment: $line";
#pod     }
#pod   }
#pod
#pod Then:
#pod
#pod   use Your::Pkg;
#pod
#pod   Your::Pkg->read_file($filename);
#pod
#pod   Your::Pkg->read_string($string);
#pod
#pod   Your::Pkg->read_handle($fh);
#pod
#pod =head1 EXPORTS
#pod
#pod C and C are exported by default.  Either can be
#pod requested individually, or renamed.  They are generated by
#pod L, so consult its documentation for more
#pod information.
#pod
#pod Both can be generated with the option "method" which requests that a method
#pod other than "read_handle" is called with the created IO::Handle.
#pod
#pod If given a "binmode" option, any C type functions will use
#pod that as an IO layer, otherwise, the default is C.
#pod
#pod   use Mixin::Linewise::Readers -readers => { binmode => "raw" };
#pod   use Mixin::Linewise::Readers -readers => { binmode => "encoding(iso-8859-1)" };
#pod
#pod =head2 read_file
#pod
#pod   Your::Pkg->read_file($filename);
#pod   Your::Pkg->read_file(\%options, $filename);
#pod
#pod If generated, the C export attempts to open the named file for
#pod reading, and then calls C on the opened handle.
#pod
#pod An optional hash reference may be passed before C<$filename> with options.
#pod The only valid option currently is C, which overrides any
#pod default set from C or the built-in C.
#pod
#pod Any arguments after C<$filename> are passed along after to C.
#pod
#pod =cut

sub _mk_read_file {
  my ($self, $name, $arg) = @_;

  my $method = defined $arg->{method} ? $arg->{method} : 'read_handle';
  my $dflt_enc = defined $arg->{binmode} ? $arg->{binmode} : 'utf8_strict';

  sub {
    my ($invocant, $options, $filename);
    if ( ref $_[1] eq 'HASH' ) {
      # got options before filename
      ($invocant, $options, $filename) = splice @_, 0, 3;
    }
    else {
      ($invocant, $filename) = splice @_, 0, 2;
    }

    my $binmode = defined $options->{binmode} ? $options->{binmode} : $dflt_enc;
    $binmode =~ s/^://; # we add it later

    # Check the file
    Carp::croak "no filename specified"           unless $filename;
    Carp::croak "file '$filename' does not exist" unless -e $filename;
    Carp::croak "'$filename' is not readable"     unless -r _;

    my $handle = IO::File->new($filename, "<:$binmode")
      or Carp::croak "couldn't read file '$filename': $!";

    $invocant->$method($handle, @_);
  }
}

#pod =head2 read_string
#pod
#pod   Your::Pkg->read_string($string);
#pod   Your::Pkg->read_string(\%option, $string);
#pod
#pod If generated, the C creates a handle on the given string, and
#pod then calls C on the opened handle.  Because handles on strings
#pod must be octet-oriented, the string B.  It will be opened
#pod in the default binmode established by importing.  (See L, above.)
#pod
#pod Any arguments after C<$string> are passed along after to C.
#pod
#pod Like C, this method can take a leading hashref with one valid
#pod argument: C.
#pod
#pod =cut

sub _mk_read_string {
  my ($self, $name, $arg) = @_;

  my $method = defined $arg->{method} ? $arg->{method} : 'read_handle';
  my $dflt_enc = defined $arg->{binmode} ? $arg->{binmode} : 'utf8_strict';

  sub {
    my ($opt) = @_ > 2 && ref $_[1] ? splice(@_, 1, 1) : undef;
    my ($invocant, $string) = splice @_, 0, 2;

    my $binmode = ($opt && $opt->{binmode}) ? $opt->{binmode} : $dflt_enc;
    $binmode =~ s/^://; # we add it later

    Carp::croak "no string provided" unless defined $string;

    open my $handle, "<:$binmode", \$string
      or die "error opening string for reading: $!";

    $invocant->$method($handle, @_);
  }
}

1;

__END__