i18n_check_translations 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzdiMDZmMzVhMThhZmRiMzkwYjdiNzRlMWFlMmMyMDM1NDc2YzIyYQ==
+  data.tar.gz: !binary |-
+    NmJmOGIwNTBkM2MzYjEwYjI4M2ZkOGY4YmU3ODQzM2UwMmYzNzhlOQ==
+SHA512:
+  metadata.gz: !binary |-
+    NThmNjcwNjZmOTI0ZjcxMjNjNDM1NGNhNjkwZGNjYjE5YTQzZmY5NWM5OTU4
+    NzFhMTk0YjUyZWQ1N2Y4MzkwNWIwNDU3OGEyMjJlOGNiNGFhMmE0YmQwZGI4
+    NjFhZThlYzc3ODA1MThiMThiM2Y0OWRhODhkODQxZWJjYWM0YmQ=
+  data.tar.gz: !binary |-
+    NTI2MjM0NDkzODdjZGRmNWI2YjdmMTg3ZmNiZGMxYmNhYTM2MzdhM2VmZDNj
+    NTQ1MTM0ZmNkNGY2MDJkYmY1ZmFkM2I0NjlkMmNkNmU5OTQxNmM5MWVmY2U0
+    MTY4YWQzNzMxZDc0MWRhOTFmYjE2ZWZlMmRkMzMxMDVlNzllY2Q=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*

data/.rvmrc

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p327@i18n_check_translations"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.25.17 (stable)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \grep -vE '^Using|Your bundle is complete'
+# fi

data/CHANGELOG

@@ -0,0 +1 @@
+v1.0.0. First Release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n_check_translations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Panayotis Matsinopoulos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# I18nCheckTranslations
+
+It can help you find out which translations are missing from your Rails translations files.
+So, it is basically a development utility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'i18n_check_translations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_check_translations
+
+## Usage
+
+Try on the command line:
+
+    rake i18n:check[en,nl]
+
+It will generate the file `i18n_check_translations.csv` with all the `en` (English) keys found in your translation files
+that reside in the directory tree `config/locales`. For each key, will hold the translation in English, the translation in `nl`,
+or a string starting from `translation missing` if the translation is missing, and the file that the translation is/was supposed
+to be.
+
+If you try:
+
+    rake i18n:check[en,nl,true]
+
+it will raise a `StandardError` exception when it will find a case in which the translation is missing.
+
+If you try:
+
+    rake i18n:check[en,nl,false,filename]
+
+it will generate the file with name `filename` and save the results in it.
+
+If you try:
+
+    rake i18n::check[en]
+
+or, in order words, if you omit the destination translation, task will run once for every available locale and will generate
+a corresponding file. For example, if your available locales (excluding English in the example) were `:nl` and `:gr` you
+would get the output in `i18n_check_translations-nl.csv` and in `i18n_check_translations-gr.csv`.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/i18n_check_translations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/i18n_check_translations.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_check_translations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_check_translations"
+  spec.version       = I18nCheckTranslations::VERSION
+  spec.authors       = ["Panayotis Matsinopoulos"]
+  spec.email         = ["panayotis@matsinopoulos.gr"]
+  spec.summary       = %q{Checks your consistency of your translations and can be helpful to find missing ones.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", File.join("lib", "tasks")]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/i18n_check_translations.rb

@@ -0,0 +1,163 @@
+require "i18n_check_translations/version"
+load 'i18n_check_translations.rake'
+require 'csv'
+
+module I18nCheckTranslations
+  # @param basic_locale {Symbol} e.g.: :en, :nl, :gr
+  # @param check_on_locale {Symbol} e.g.: :en, :nl, :gr
+  # @param raise_error_if_missing {true|false with default nil}
+  #
+  # @return {Hash} The result of processing the locales files for +basic_locale+ and trying to translate
+  #                all the keys to the +check_on_locale+. See example below.
+  #
+  # It takes all the translation keys for the +basic_locale+ and tries to translate them
+  # to +check_on_locale+. For those that are missing translations, it either write the
+  # error or raises and Exception.
+  #
+  # Usage example:
+  #
+  #  1) result = I18nCheckTranslations.check :en, :nl
+  #      will take all the *.en.yml files from config/locales and will build a
+  #      a Hash with all the translation keys and their values on the :nl locale
+  #      For example:
+  #
+  #      {"en.customer.first_name" => {:translation => "Voornaam",
+  #                                    :basic_local_translation => "First Name",
+  #                                    :localization_file => "/config/locales/customers/nl.yml"}}
+  #     If the translation is missing for :nl, then you are going to see on :translation something that
+  #     starts with "translation missing"
+  #
+  #  2) result = I18nCheckTranslations.check :en, :nl, true
+  #
+  #     Same as (1), but it will raise an error if a translation is missing
+  #
+  def self.check(basic_locale, check_on_locale, raise_error_if_missing = false)
+    result = {}
+
+    disable_fallbacks # if fallbacks are enabled, then missing translations will not be missing.
+
+    previous_locale = I18n.locale # save the current locale in order to restore it at the end of the process
+    I18n.locale = check_on_locale
+
+    Dir.glob(File.join(Rails.root, 'config', 'locales', '**', "*#{basic_locale}.yml")).each do |localization_file|
+      hash_input = YAML.load_file localization_file
+
+      paths = hash_traverse hash_input # big stuff of the work is done here to build all the translation keys from a file.
+
+      paths.each do |key, translation|
+        key_to_translate = key.gsub /^#{basic_locale.to_s}\./, '' # - remove the "en." from "en.customer.first_name"
+        new_key = "#{check_on_locale}.#{key_to_translate}"        # - and make it "nl.customer.first_name" to index the Hash result
+        new_translation = I18n.translate key_to_translate         # - do the translation
+
+        result[new_key] = {:translation => new_translation,
+                           :basic_locale_translation => translation,
+                           :localization_file => dest_localization_file(localization_file, basic_locale, check_on_locale)}
+
+        raise StandardError.new("Missing translation! #{result[new_key].inspect}") if new_translation.start_with?('translation missing') && raise_error_if_missing
+      end
+    end
+
+    I18n.locale = previous_locale # restore locale
+
+    enable_fallbacks
+
+    result
+  end
+
+  # Same as +I18nCheckTranslations.check+ but takes as input the +filename+ that will be used
+  # to save the results into a csv file.
+  #
+  def self.check_and_dump(filename, basic_locale, check_on_locale, raise_error_if_missing = false)
+    result = check(basic_locale, check_on_locale, raise_error_if_missing)
+    CSV.open filename, 'wb', :force_quotes => true do |csv|
+      csv << ['KEY', 'BASIC TRANSLATION', 'TRANSLATION', 'LOCALIZATION FILE']
+      result.each do |k, v|
+        csv << [k, v[:basic_locale_translation], v[:translation], v[:localization_file]]
+      end
+    end
+  end
+
+  private
+
+  # We build the destination localization file from the source localication file.
+  #
+  # Hence, given a source file: 'config/locales/customers/en.yml'
+  #              a basic locale: :en
+  #              a check_on_locale: :nl
+  #
+  # becomes 'config/locales/customers/nl.yml'
+  #
+  # We also take care to remove any Rails root prefix. Makes the path to file
+  # easier to read.
+  #
+  def self.dest_localization_file(source_localization_file, basic_locale, check_on_locale)
+    source_localization_file.gsub(/#{Rails.root}/, '').gsub(/#{basic_locale}.yml$/, "#{check_on_locale}.yml")
+  end
+
+  def self.disable_fallbacks
+    I18n.available_locales.each do |al|
+      I18n.fallbacks.merge!({al => [al]})
+    end
+  end
+
+  def self.enable_fallbacks
+    I18n.available_locales.each do |al|
+      I18n.fallbacks.merge!({al => [al, I18n.default_locale]})
+    end
+  end
+
+  # Takes hashes like this:
+  #
+  # hash = {:en => {:hello => 'Hello',
+  #                 :world => 'World',
+  #                 :wonderful => {:another => "wonderful",
+  #                                :what => "world"},
+  #                 :what_to => {:do_it => {:i_will_not => 'what is that?',
+  #                                         :you_will   => 'another one'},
+  #                              :redo_it => 'hello redo it'}
+  #                },
+  #         :gr => {:there => 'hello 2',
+  #                 :again => {:what => 'again what on earth'}}
+  #       }
+  #
+  # and returns a Hash like:
+  #
+  # {
+  #  'en.hello'                    => 'Hello',
+  #  'en.world'                    => 'World',
+  #  'en.wonderful.another'        => 'wonderful',
+  #  'en.wonderful.what'           => 'world',
+  #  'en.what_to.do_it.i_will_not' => 'what is that?',
+  #  'en.what_to.do_it.you_will'   => 'another one',
+  #  'en.what_to.redo_it'          => 'hello redo it',
+  #
+  #  'gr.there'                    => 'hello 2',
+  #  'gr.again.what'               => 'again what on earth'
+  # }
+  #
+  def self.hash_traverse(hash)
+    parents = []
+    paths = {}
+    hash.keys.each do |k|
+      paths = hash_traverse_root(hash, k, parents, paths)
+    end
+    paths
+  end
+
+  def self.hash_traverse_root(hash, k, parents, paths)
+    if hash[k].is_a?(Hash)
+      parents.push(k)
+      hash = hash[k]
+      hash.each do |k, v|
+        hash_traverse_root(hash, k, parents, paths)
+      end
+      parents.pop
+    elsif hash[k].is_a?(String)
+      parents.push(k)
+      path = parents.join(".")
+      paths[path] = hash[k]
+      parents.pop
+    end
+    paths
+  end
+end

data/lib/i18n_check_translations/version.rb

@@ -0,0 +1,3 @@
+module I18nCheckTranslations
+  VERSION = "1.0.0"
+end

data/lib/tasks/i18n_check_translations.rake

@@ -0,0 +1,29 @@
+require 'i18n_check_translations'
+require 'rake'
+
+desc "Check your locales for consistency and missing translations"
+namespace :i18n do
+  task :check, [:basic_locale, :check_on_locale, :raise_error_if_missing, :filename] => :environment do |t, args|
+    basic_locale           = args[:basic_locale]
+    check_on_locale        = args[:check_on_locale]
+    raise_error_if_missing = args[:raise_error_if_missing].present? ? args[:raise_error_if_missing] == 'true' : false
+    filename               = args[:filename]
+
+    basic_locale = I18n.default_locale if basic_locale.nil?
+    basic_locale = basic_locale.to_sym
+
+    check_on_locale = :all if check_on_locale.blank?
+    check_on_locale = check_on_locale.to_sym
+
+    filename = File.join(Rails.root, 'i18n_check_translations.csv') if filename.nil?
+
+    if check_on_locale == :all
+      I18n.available_locales.select {|al| al != basic_locale}.each do |dest_locale|
+        new_filename = filename.gsub /\.csv$/, "-#{dest_locale}.csv"
+        I18nCheckTranslations.check_and_dump(new_filename, basic_locale, dest_locale, raise_error_if_missing)
+      end
+    else
+      I18nCheckTranslations.check_and_dump(filename, basic_locale, check_on_locale, raise_error_if_missing)
+    end
+  end
+end

data/spec/i18n_check_translations_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe I18nCheckTranslations do
+  describe '.hash_traverse' do
+    shared_examples 'successful traversal' do
+      it 'successfully traverses' do
+        result = I18nCheckTranslations.send :hash_traverse, hash
+
+        expect(result).to eq(expected_result)
+      end
+    end
+    context 'given hash case 1' do
+      let(:hash) do
+        {:en => {:hello => 'Hello',
+                 :world => 'World',
+                 :wonderful => {:another => "wonderful",
+                                :what => "world"},
+                 :what_to => {:do_it => {:i_will_not => 'what is that?',
+                                         :you_will   => 'another one'},
+                              :redo_it => 'hello redo it'}
+        },
+         :gr => {:there => 'hello 2',
+                 :again => {:what => 'again what on earth'}}
+        }
+      end
+      let(:expected_result) do
+        {
+            'en.hello'                    => 'Hello',
+            'en.world'                    => 'World',
+            'en.wonderful.another'        => 'wonderful',
+            'en.wonderful.what'           => 'world',
+            'en.what_to.do_it.i_will_not' => 'what is that?',
+            'en.what_to.do_it.you_will'   => 'another one',
+            'en.what_to.redo_it'          => 'hello redo it',
+
+            'gr.there'                    => 'hello 2',
+            'gr.again.what'               => 'again what on earth'
+        }
+      end
+      it_behaves_like 'successful traversal'
+    end
+
+    context 'given hash case 2' do
+      let(:hash) do
+        {:en => {:hello => 'Hello'}}
+      end
+      let(:expected_result) do
+        {
+            'en.hello'                    => 'Hello'
+        }
+      end
+      it_behaves_like 'successful traversal'
+    end
+
+    context 'given hash case 3' do
+      let(:hash) do
+        {:en => {:hello => {:hello2 => {:hello3 => {:hello4 => 'Hello 4'},
+                                        :hello31 => 'Hello 31'},
+                            :hello21 => 'Hello 21'},
+                 :hello1 => 'Hello 1'}}
+      end
+      let(:expected_result) do
+        {
+            'en.hello.hello2.hello3.hello4' => 'Hello 4',
+            'en.hello.hello2.hello31'       => 'Hello 31',
+            'en.hello.hello21'              => 'Hello 21',
+            'en.hello1'                     => 'Hello 1'
+        }
+      end
+      it_behaves_like 'successful traversal'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'i18n_check_translations'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: i18n_check_translations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Panayotis Matsinopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- panayotis@matsinopoulos.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_check_translations.gemspec
+- lib/i18n_check_translations.rb
+- lib/i18n_check_translations/version.rb
+- lib/tasks/i18n_check_translations.rake
+- spec/i18n_check_translations_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/tasks
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Checks your consistency of your translations and can be helpful to find missing
+  ones.
+test_files:
+- spec/i18n_check_translations_spec.rb
+- spec/spec_helper.rb