File Coverage

blib/lib/Jenkins/i18n/ProcOpts.pm

Criterion	Covered	Total	%
statement	90	91	98.9
branch	21	28	75.0
condition	2	3	66.6
subroutine	16	16	100.0
pod	9	9	100.0
total	138	147	93.8

package Jenkins::i18n::ProcOpts;

use 5.014004;
use strict;
use warnings;
use base       qw(Class::Accessor);
use Hash::Util qw(lock_hash unlock_value lock_value);
use Carp       qw(confess);
use File::Spec;

__PACKAGE__->follow_best_practice;
__PACKAGE__->mk_ro_accessors(qw(language source_dir target_dir counter));

our $VERSION = '0.10';

=pod

=head1 NAME

Jenkins::i18n::ProcOpts - process files definitions based on CLI options

=head1 SYNOPSIS

    use Jenkins::i18n::ProcOpts;
    my $proc = Jenkins::i18n::ProcOpts->new({
        source_dir  => $source,
        target_dir  => $target,
        use_counter => 1,
        is_remove   => 1,
        is_add      => 1,
        is_debug    => 0,
        lang        => 'pt_BR',
        search      => 'foobar'
    });

=head1 DESCRIPTION

This module define how the translation files should be processed based on the
collected CLI options.

=head2 EXPORT

None by default.

=head1 METHODS

=head2 new

Creates a new instance.

Expects a hash reference as parameter, with the following keys:

=over

=item *

C: a string representing the path where the files should be
reviewed.

=item *

C: a string representing the path where the processed files should
be written to.

=item *

C: A boolean (in Perl terms) if a counter is to be used.

=item *

C: A boolean (in Perl terms) if deprecated files should be removed.

=item *

C: a boolean (in Perl terms) if new files should be added.

=item *

C: a boolean (in Perl terms) if CLI is running in debug mode.

=item *

C: a string identifying the chosen language for processing.

=item *

C: optional, an string of a regular expression to match the content of
the translated properties, with you want to use that. Otherwise, just provide
C as a value.

=back

=cut

sub new {
    my ( $class, $params_ref ) = @_;
    confess 'Must receive an hash reference as parameter'
        unless ( ref($params_ref) eq 'HASH' );
    my @expected_keys
        = qw(source_dir target_dir use_counter is_remove is_add is_debug lang search);
    my $self = {
        counter => 0,
        ext_sep => qr/\./
    };

    foreach my $attrib (@expected_keys) {
        confess "must receive $attrib as parameter"
            unless ( exists( $params_ref->{$attrib} ) );
    }

    my @to_copy
        = qw(source_dir target_dir use_counter is_remove is_add is_debug);
    foreach my $attrib (@to_copy) {
        $self->{$attrib} = $params_ref->{$attrib};
    }

    $self->{language} = $params_ref->{lang};

    confess
'Removing or adding translation files are excluding operations, they cannot be both true at the same time'
        if ( $params_ref->{is_remove} and $params_ref->{is_add} );

    if ( defined( $params_ref->{search} ) ) {
        $self->{search}     = qr/$params_ref->{search}/;
        $self->{has_search} = 1;
    }
    else {
        $self->{has_search} = 0;
    }

    bless $self, $class;
    lock_hash( %{$self} );
    return $self;
}

=head2 is_to_search

Returns true (1) or false (0) if there is a defined term to search on the
translated properties values.

=cut

sub is_to_search {
    my $self = shift;
    return $self->{has_search};
}

=head2 search_term

Returns the compiled regular expression that will be used to match terms in the
translated properties values.

=cut

sub search_term {
    my $self = shift;
    confess 'There is no defined search term' unless ( $self->{has_search} );
    return $self->{search};
}

=head2 get_language

Returns a string identifying the chosen language for processing.

=head2 get_source_dir

Returns string of the path where the translation files should be looked for.

=head2 get_target_dir

Returns a string of the path where the reviewed translation files should be
written to.

=head2 inc

Increments the processed files counter.

=cut

sub inc {
    my $self = shift;

    if ( $self->use_counter ) {
        my $attrib = 'counter';
        unlock_value( %{$self}, $attrib );
        $self->{$attrib}++;
        lock_value( %{$self}, $attrib );
        return 1;
    }

    warn "Useless invocation of inc with file counter disabled\n";
    return 0;
}

=head2 use_counter

Returns true (1) or false (0) if the processed counter is in use.

=cut

sub use_counter {
    my $self = shift;
    return $self->{use_counter};
}

=head2 get_counter

Returns an integer representing the number of translation files already
processed.

=head2 is_remove

Returns true (1) or false (0) if the outdated translation files should be
removed.

=cut

sub is_remove {
    my $self = shift;
    return $self->{is_remove};
}

=head2 is_add

Returns true (1) or false (0) if the translation files should be added.

=cut

sub is_add {
    my $self = shift;
    return $self->{is_add};
}

=head2 is_debug

Returns true (1) or false (0) if the CLI is running in debug mode.

=cut

sub is_debug {
    my $self = shift;
    return $self->{is_debug};
}

=head2 define_files

Based on complete path to a translation file as input, defines the resulting
expected translation files and their locations, even if they don't yet exist.

Expects as parameter the complete path to a translation file (Jelly or Java
Properties).

Returns an array with the following elements:

=over

=item 1

The path to the current language file location.

=item 2

The path to the English Properties file location.

=item 3

The path to the corresponding Jelly file.

=back

All three items are formed based on convention, that doesn't mean that any of
them actually exists in the file system.

=cut

sub define_files {
    my ( $self, $file_path ) = @_;
    confess 'Must receive a file path as parameter' unless ($file_path);
    my ( $volume, $dirs, $filename ) = File::Spec->splitpath($file_path);
    my @file_parts      = split( $self->{ext_sep}, $filename );
    my $filename_ext    = pop(@file_parts);
    my $filename_prefix = join( '.', @file_parts );
    my ( $curr_lang_file, $english_file, $jelly_file );

    if ( $filename_ext eq 'jelly' ) {
        $curr_lang_file
            = $filename_prefix . '_' . $self->{language} . '.properties';
        $english_file = "$filename_prefix.properties";
        $jelly_file   = $filename;
    }
    elsif ( $filename_ext eq 'properties' ) {
        $curr_lang_file
            = $filename_prefix . '_' . $self->{language} . '.properties';
        $english_file = $filename;
        $jelly_file   = "$filename_prefix.jelly";
    }
    else {
        confess "Unexpected file extension '$filename_ext' in $file_path";
    }

    my @dirs;
    push( @dirs, $volume ) unless ( $volume eq '' );
    push( @dirs, $dirs )   unless ( $dirs eq '' );

    my $english_file_path = File::Spec->catfile( @dirs, $english_file );
    my $jelly_file_path   = File::Spec->catfile( @dirs, $jelly_file );

    if ( $self->{source_dir} eq $self->{target_dir} ) {
        return ( File::Spec->catfile( @dirs, $curr_lang_file ),
            $english_file_path, $jelly_file_path );
    }

    if ( $dirs ne '' ) {
        $dirs =~ s/$self->{source_dir}/$self->{target_dir}/;
        @dirs = ();
        push( @dirs, $volume ) unless ( $volume eq '' );
        push( @dirs, $dirs );
    }

    return ( File::Spec->catfile( @dirs, $curr_lang_file ),
        $english_file_path, $jelly_file_path );

}

1;
__END__