File Coverage

lib/File/ByLine.pm

Criterion	Covered	Total	%
statement	81	87	93.1
branch	16	24	66.6
condition			n/a
subroutine	20	20	100.0
pod	12	12	100.0
total	129	143	90.2

#!/usr/bin/perl

#
# Copyright (C) 2018 Joelle Maslak
# All Rights Reserved - See License
#

package File::ByLine;
$File::ByLine::VERSION = '1.192590';
use v5.10;

# ABSTRACT: Line-by-line file access loops

use strict;
use warnings;
use autodie;

use Carp;
use Fcntl;
use File::ByLine::Object;
use Scalar::Util qw(reftype);

# Object with default options
our $OBJ = File::ByLine::Object->new();


#
# Exports
#
require Exporter;
our @ISA = qw(Exporter);

## no critic (Modules::ProhibitAutomaticExportation)
our @EXPORT =
  qw(dolines forlines greplines maplines parallel_dolines parallel_forlines parallel_greplines parallel_maplines readlines writefile appendfile);
## use critic

our @EXPORT_OK =
  qw(dolines forlines greplines maplines parallel_dolines parallel_forlines parallel_greplines parallel_maplines readlines writefile appendfile);


sub dolines (&$) {
    my ( $code, $file ) = @_;

    return $OBJ->do( $code, $file );
}


sub forlines ($&) {
    my ( $file, $code ) = @_;

    return $OBJ->do( $code, $file );
}


sub parallel_dolines (&$$) {
    my ( $code, $file, $procs ) = @_;

    if ( !defined($procs) ) {
        croak("Must include number of child processes");
    }

    if ( $procs <= 0 ) { croak("Number of processes must be >= 1"); }

    my $byline = File::ByLine::Object->new();
    $byline->processes($procs);

    return $byline->do( $code, $file );
}


sub parallel_forlines ($$&) {
    my ( $file, $procs, $code ) = @_;

    if ( !defined($procs) ) {
        croak("Must include number of child processes");
    }

    if ( $procs <= 0 ) { croak("Number of processes must be >= 1"); }

    my $byline = File::ByLine::Object->new();
    $byline->processes($procs);

    return $byline->do( $code, $file );
}


sub greplines (&$) {
    my ( $code, $file ) = @_;

    return $OBJ->grep( $code, $file );
}


sub parallel_greplines (&$$) {
    my ( $code, $file, $procs ) = @_;

    if ( !defined($procs) ) {
        croak("Must include number of child processes");
    }

    if ( $procs <= 0 ) { croak("Number of processes must be >= 1"); }

    my $byline = File::ByLine::Object->new();
    $byline->processes($procs);

    return $byline->grep( $code, $file );
}


sub maplines (&$) {
    my ( $code, $file ) = @_;

    return $OBJ->map( $code, $file );
}


sub parallel_maplines (&$$) {
    my ( $code, $file, $procs ) = @_;

    if ( !defined($procs) ) {
        croak("Must include number of child processes");
    }

    if ( $procs <= 0 ) { croak("Number of processes must be >= 1"); }

    my $byline = File::ByLine::Object->new();
    $byline->processes($procs);

    return $byline->map( $code, $file );
}


sub readlines ($) {
    my ($file) = @_;

    return $OBJ->lines($file);
}


sub writefile ($@) {
    my ( $file, @lines ) = @_;
    if ( !defined($file) ) { die("Must define the filename"); }

    # Last line should have it's newline removed, if applicable
    if (@lines) { $lines[-1] =~ s/\n$//s; }

    open my $fh, '>', $file;
    foreach my $line (@lines) {
        say $fh $line;
    }
    close $fh;

    return;
}


sub appendfile ($@) {
    my ( $file, @lines ) = @_;
    if ( !defined($file) ) { die("Must define the filename"); }

    # Last line should have it's newline removed, if applicable
    if (@lines) { $lines[-1] =~ s/\n$//s; }

    open my $fh, '>>', $file;
    foreach my $line (@lines) {
        say $fh $line;
    }
    close $fh;

    return;
}

#
# Object Oriented Interface
#

sub new {
    shift;    # Remove the first parameter because we want to specify the class.

    return File::ByLine::Object->new(@_);
}


1;

__END__