i18n-tasks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548b6c0914a87c8129d182758dfce8fd3e296f4c
-  data.tar.gz: afb9f738e869ca9250569559482b6abef7a729a7
+  metadata.gz: be5ef7d26c3df1ed7c2d3492c2ddbee544e561c0
+  data.tar.gz: c294aa392797e900e990defa0fbed3c5a7d7cafa
 SHA512:
-  metadata.gz: eacb09e1ed32e1e3023cc4484f3c907cfacb27e3ca58d938eb19411e3fdfdacdb7e4451bab2e4e677db577b64b0f6ec64751766cc520dd1b73e675a0ebe03aa4
-  data.tar.gz: 42867a547082972542fae5bfe92e6793a88c5b6bfb321485395d5e8b6ee010f015c66f0c3e4df81756554e0854ce3f1ac9a7488825a7a44096e08a89de9179f5
+  metadata.gz: 783c897ba722831c9893301270e3a8dee8c7dd0775a32bb293c137a3b643f4fd50c9d05628e794891c72bbcfadce25f844da3d3846b750c495ea94bf8ee15d00
+  data.tar.gz: df5d3744b47f1ed0366cb6305823d6f38737e4b583af2ac586808ada0a9a2a0c7a7470db592871962ad1ff3e82a5e4d76790d41207445ca3080054c666573e9a

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+  - 1.9.3

data/README.md

@@ -1,22 +1,29 @@
-i18n-tasks
+i18n-tasks  [![Build Status](https://travis-ci.org/glebm/i18n-tasks.png?branch=master)](https://travis-ci.org/glebm/i18n-tasks)
 ==========
 
-I18n tasks to find missing / unused translations and more
+Rails I18n tasks to find missing / unused translations and more. Works with slim / coffee / haml etc.
 
-There are 3 tasks available to manage translations.
+Use `rake -T i18n` to get the list of tasks with descriptions. There are 3 tasks available at the moment:
 
-    $ rake -T i18n
-    rake i18n:missing  # show keys with translation values identical to base
-    rake i18n:prefill  # add keys from base locale to others
-    rake i18n:unused   # find potentially unused translations
+* `i18n:missing` task shows all the keys that have not been translated yet *([source](https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/missing.rb))*
+* `i18n:prefill` task normalizes locale files, and adds missing keys from base locale to others *([source](https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/prefill.rb))*
+* `i18n:unused` task shows potentially unused translations *([source](https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/unused.rb))*
 
-* `i18n:missing` task shows all the keys that have not been translated yet
-* `i18n:prefill` task adds missing keys to locale files, prefilling with base locale (en) value by default
-* `i18n:unused` task shows potentially unused translations (it may give false positives)
+`i18n:unused` will detect pattern translations and not report them, e.g.:
+
+    t 'category.' + category.key # 'category.arts_and_crafts' considered used
+    t "category.#{category.key}" # also works
+
+For more examples see [the tests](https://github.com/glebm/i18n-tasks/blob/master/spec/i18n_tasks_spec.rb#L43-L59).
 
 Installation
-============
+------------
 
 Simply add to Gemfile:
 
     gem 'i18n-tasks', '~> 0.0.1'
+
+Configuration
+-------------
+
+Currently i18n-tasks only reports / writes to locale data in `config/locales/{locale_code}.yml`. *PRs making this configurable welcome!*

data/Rakefile

@@ -1 +1,5 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/i18n-tasks.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'rails'
+  spec.add_dependency 'rake'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
 end

data/lib/i18n/tasks/base_task.rb

@@ -0,0 +1,9 @@
+require 'i18n/tasks/task_helpers'
+
+module I18n
+  module Tasks
+    class BaseTask
+      include TaskHelpers
+    end
+  end
+end

data/lib/i18n/tasks/missing.rb

@@ -0,0 +1,19 @@
+require 'i18n/tasks/base_task'
+
+module I18n
+  module Tasks
+    class Missing < BaseTask
+      def perform
+        (I18n.available_locales.map(&:to_s) - [base_locale]).each do |locale|
+          trn = get_locale_data(locale)[locale]
+          traverse base[base_locale] do |key, base_value|
+            translated = t(trn, key)
+            if translated.blank? || translated == base_value
+              puts "#{locale}.#{key}: #{base_value}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/prefill.rb

@@ -0,0 +1,16 @@
+require 'i18n/tasks/base_task'
+
+module I18n
+  module Tasks
+    class Prefill < BaseTask
+      def perform
+        # Will also rewrite en, good for ordering
+        I18n.available_locales.map(&:to_s).each do |target_locale|
+          trn = get_locale_data(target_locale)
+          prefilled = { target_locale => base[base_locale] }.deep_merge(trn)
+          File.open(locale_file_path(target_locale), 'w'){ |f| f.write prefilled.to_yaml }
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/task_helpers.rb

@@ -0,0 +1,46 @@
+require 'open3'
+
+module I18n
+  module Tasks
+    module TaskHelpers
+      def run_command(*args)
+        _in, out, _err = Open3.popen3(*args)
+        out.gets nil
+      end
+
+      # locale data hash, with locale name as root
+      def get_locale_data(locale)
+        # todo multiple files, configuration option
+        YAML.load_file "config/locales/#{locale}.yml"
+      end
+
+      # main locale file path (for writing to)
+      def locale_file_path(locale)
+        "config/locales/#{locale}.yml"
+      end
+
+      # traverse hash, yielding with full key and value
+      def traverse(path = '', hash, &block)
+        hash.each do |k, v|
+          if v.is_a?(Hash)
+            traverse("#{path}.#{k}", v, &block)
+          else
+            block.call("#{path}.#{k}"[1..-1], v)
+          end
+        end
+      end
+
+      def t(hash, key)
+        key.split('.').inject(hash) { |r, seg| r.try(:[], seg) }
+      end
+
+      def base_locale
+        I18n.default_locale.to_s
+      end
+
+      def base
+        @base ||= get_locale_data(base_locale)
+      end
+    end
+  end
+end

data/lib/i18n/tasks/unused.rb

@@ -0,0 +1,18 @@
+require 'i18n/tasks/base_task'
+
+module I18n
+  module Tasks
+    class Unused < BaseTask
+      def perform
+        grep_out = run_command 'grep', '-horI', %q{\\bt(\\?\\s*['"]\\([^'"]*\\)['"]}, 'app/'
+        used_keys = grep_out.split("\n").map { |r| r.match(/['"](.*?)['"]/)[1] }.uniq.to_set
+        pattern_prefixes = used_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0] }
+        traverse base[base_locale] do |key, value|
+          if !used_keys.include?(key) && !pattern_prefixes.any? { |pp| key.start_with?(pp) }
+            puts "#{key}: #{value}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/tasks/i18n-tasks.rake

@@ -1,65 +1,23 @@
 require 'set'
-require 'open3'
+require 'active_support/core_ext'
+
+require 'i18n/tasks/missing'
+require 'i18n/tasks/prefill'
+require 'i18n/tasks/unused'
 
 namespace :i18n do
   desc 'add keys from base locale to others'
   task :prefill => :environment do
-    # Will also rewrite en, good for ordering
-    I18n.available_locales.map(&:to_s).each do |target_locale|
-      trn = YAML.load_file trn_path(target_locale)
-      prefilled = { target_locale => base[base_locale] }.deep_merge(trn)
-      File.open(trn_path(target_locale), 'w'){ |f| f.write prefilled.to_yaml }
-    end
+    I18n::Tasks::Prefill.new.perform
   end
 
   desc 'show keys with translation values identical to base'
   task :missing => :environment do
-    (I18n.available_locales.map(&:to_s) - [base_locale]).each do |locale|
-      trn = YAML.load_file(trn_path(locale))[locale]
-      traverse base[base_locale] do |key, base_value|
-        translated = t(trn, key)
-        if translated.blank? || translated == base_value
-          puts "#{locale}.#{key}: #{base_value}"
-        end
-      end
-    end
+    I18n::Tasks::Missing.new.perform
   end
 
   desc 'find potentially unused translations'
   task :unused => :environment do
-    _in, out, _err = Open3.popen3 'grep', '-horI', %q{\\bt(\\?\\s*['"]\\([^'"]*\\)['"]}, 'app/'
-    used_keys = out.gets(nil).split("\n").map { |r| r.match(/['"](.*?)['"]/)[1] }.uniq.to_set
-    pattern_prefixes = used_keys.select { |key| key =~ /\#{.*?}/ || key.ends_with?('.') }.map { |key| key.split(/\.?#/)[0] }
-    traverse base[base_locale] do |key, value|
-      if !used_keys.include?(key) && !pattern_prefixes.any? { |pp| key.start_with?(pp) }
-        puts "#{key}: #{value}"
-      end
-    end
-  end
-
-  define_method :trn_path do |locale|
-    "config/locales/#{locale}.yml"
-  end
-
-  define_method :traverse do |path = '', hash, &block|
-    hash.each do |k, v|
-      if v.is_a?(Hash)
-        traverse("#{path}.#{k}", v, &block)
-      else
-        block.call("#{path}.#{k}"[1..-1], v)
-      end
-    end
-  end
-
-  define_method :t do |hash, key|
-    key.split('.').inject(hash) { |r, seg| r.try(:[], seg) }
-  end
-
-  define_method :base_locale do
-    I18n.default_locale.to_s
-  end
-
-  define_method :base do
-    @base ||= YAML.load_file trn_path(base_locale)
+    I18n::Tasks::Unused.new.perform
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe 'rake i18n' do
+  describe 'missing' do
+    it 'detects missing or identical' do
+      TestCodebase.rake_result('i18n:missing').should be_i18n_keys %w(es.missing_in_es.a es.blank_in_es.a es.same_in_es.a)
+    end
+  end
+
+  describe 'unused' do
+    it 'detects unused' do
+      TestCodebase.rake_result('i18n:unused').should be_i18n_keys %w(unused.a)
+    end
+  end
+
+  describe 'prefill' do
+    it 'detects unused' do
+      TestCodebase.in_test_app_dir { YAML.load_file('config/locales/es.yml')['es']['missing_in_es'].should be_nil }
+      TestCodebase.rake_result('i18n:prefill')
+      TestCodebase.in_test_app_dir { YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a'].should == 'EN_TEXT' }
+    end
+  end
+
+  # --- setup ---
+  before do
+    gen_data = ->(v) {
+      {
+          'ca'            => {'a' => v, 'b' => v, 'c' => v, 'd' => v, 'e' => "#{v}%{i}", 'f' => "#{v}%{i}"},
+          'cb'            => {'a' => v, 'b' => "#{v}%{i}"},
+          'hash_pattern'  => {'a' => v},
+          'hash_pattern2' => {'a' => v},
+          'unused'        => {'a' => v},
+          'missing_in_es' => {'a' => v},
+          'same_in_es'    => {'a' => v},
+          'blank_in_es'   => {'a' => v}
+      }
+    }
+
+    en_data                          = gen_data.('EN_TEXT')
+    es_data                          = gen_data.('ES_TEXT').except('missing_in_es')
+    es_data['same_in_es']['a'] = 'EN_TEXT'
+    es_data['blank_in_es']['a']      = ''
+
+    fs = {
+        'config/locales/en.yml'     => {'en' => en_data}.to_yaml,
+        'config/locales/es.yml'     => {'es' => es_data}.to_yaml,
+        'app/views/index.html.slim' => <<-SLIM,
+        p \#{t('ca.a')} \#{t 'ca.b'} \#{t "ca.c"}
+        p \#{t 'ca.d'} \#{t 'ca.f', i: 'world'} \#{t 'ca.e', i: 'world'}
+        p \#{t 'missing_in_es.a'} \#{t 'same_in_es.a'} \#{t 'blank_in_es.a'}
+        SLIM
+        'app/controllers/events_controller.slim' => <<-RUBY,
+        class EventsController < ApplicationController
+           def show
+              redirect_to :edit, notice: I18n.t('cb.a')
+              I18n.t("cb.b", i: "Hello")
+              I18n.t("hash_pattern.\#{some_value}", i: "Hello")
+              I18n.t("hash_pattern2." + some_value, i: "Hello")
+           end
+        end
+        RUBY
+    }
+    TestCodebase.setup fs
+  end
+
+  after do
+    TestCodebase.teardown
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAKE_ENV'] ||= 'test'
+require 'rspec/autorun'
+$: << File.expand_path('../lib', __FILE__)
+require 'i18n/tasks'
+require 'rake'
+Rake.load_rakefile 'tasks/i18n-tasks.rake'
+Rake.load_rakefile 'support/test_codebase_env.rake'
+Dir['spec/support/**/*.rb'].each { |f| require "./#{f}" }
+
+RSpec.configure do |config|
+
+end
+

data/spec/support/i18n_tasks_output_matcher.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :be_i18n_keys do |expected|
+  match do |actual|
+    actual.split("\n").map { |x| x.split(':')[0] }.sort == expected.sort
+  end
+end

data/spec/support/test_codebase.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+module TestCodebase
+  extend self
+  AT = 'tmp/test_codebase'
+
+  DEFAULTS = {
+      'config/locales/en.yml' => {'en' => {}}.to_yaml,
+      'config/locales/es.yml' => {'es' => {}}.to_yaml
+  }
+
+  def setup(files)
+    FileUtils.mkdir_p AT
+    in_test_app_dir do
+      DEFAULTS.merge(files).each do |path, content|
+        FileUtils.mkdir_p File.dirname(path)
+        File.open(path, 'w') { |f| f.write(content) }
+      end
+    end
+  end
+
+  def teardown
+    FileUtils.rm_rf AT
+  end
+
+  def rake_result(task)
+    in_test_app_dir {
+      rake_task = Rake::Task[task]
+      rake_task.reenable
+      capture_stdout { rake_task.invoke }
+    }
+  end
+
+  def in_test_app_dir(&block)
+    pwd = Dir.pwd
+    Dir.chdir AT
+    block.call
+  ensure
+    Dir.chdir pwd
+  end
+
+  private
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    out.string
+  ensure
+    $stdout = STDOUT
+  end
+end

data/spec/support/test_codebase_env.rake

@@ -0,0 +1,4 @@
+task :environment do
+  I18n.default_locale = 'en'
+  I18n.available_locales = %w(en es)
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-23 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Rails I18n tasks to find missing / unused translations and more
 email:
 - glex.spb@gmail.com
@@ -48,15 +90,26 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
+- lib/i18n/tasks/base_task.rb
+- lib/i18n/tasks/missing.rb
+- lib/i18n/tasks/prefill.rb
 - lib/i18n/tasks/railtie.rb
+- lib/i18n/tasks/task_helpers.rb
+- lib/i18n/tasks/unused.rb
 - lib/i18n/tasks/version.rb
 - lib/tasks/i18n-tasks.rake
+- spec/i18n_tasks_spec.rb
+- spec/spec_helper.rb
+- spec/support/i18n_tasks_output_matcher.rb
+- spec/support/test_codebase.rb
+- spec/support/test_codebase_env.rake
 homepage: https://github.com/glebm/i18n-tasks
 licenses:
 - MIT
@@ -81,4 +134,9 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Rails I18n tasks to find missing / unused translations and more
-test_files: []
+test_files:
+- spec/i18n_tasks_spec.rb
+- spec/spec_helper.rb
+- spec/support/i18n_tasks_output_matcher.rb
+- spec/support/test_codebase.rb
+- spec/support/test_codebase_env.rake