The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Jenkins-i18n-0.10
River stage zero No dependents
++
/ Jenkins::i18n::Stats

NAME

Jenkins::i18n::Stats - class to provide translations processing statistics

SYNOPSIS

  use Jenkins::i18n::Stats;

DESCRIPTION

Jenkins::i18n::Stats

EXPORT

None by default.

METHODS

new

Creates a new instance.

get_keys

Return the number of all keys retrieve from all files processed, ignoring if they are repeated several times.

get_files

Returns the number of found translation files.

get_missing

Returns the number of keys that are missing after comparing a language to the original in English.

get_unused

Returns the number of keys that are available in the a language but not in the original English.

get_empty

Returns the number of keys in the language that are available but doesn't actually have a translated value.

get_same

Returns the number of keys that have the same values as the original in English. Not necessarilly an error.

get_no_jenkins

Returns the number of keys that are not related to Jenkins, but coming from Hudson.

inc_files

Increments the files counter.

inc_missing

Increments the missing counter.

inc_unused

Increments the unused counter.

inc_empty

Increments the empty counter.

inc_same

Increments the same counter.

inc_no_jenkins

Increments the no_jenkins counter.

add_key

Increments the keys counters.

This is required in order to allow the counting of unique keys processed, as well all the keys processed.

get_unique_keys

Returns the number of unique keys processed.

perc_done

Calculates how much of the translation is completed.

Requires no parameters.

Returns a float as the percentage of the translation that is completed.

summary

Returns a summary of all statistics in text format.

The summary is returned as a hash reference.

files

Getter for the files attribute.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

This file is part of Jenkins Translation Tool project.

Jenkins Translation Tool is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Jenkins Translation Tool is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Jenkins Translation Tool. If not, see (http://www.gnu.org/licenses/).

The original translation-tool.pl script was licensed through the MIT License, copyright (c) 2004-, Kohsuke Kawaguchi, Sun Microsystems, Inc., and a number of other of contributors. Translations files generated by the Jenkins Translation Tool CLI are distributed with the same MIT License.