i18n-tasks 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 188bad44ecd17931f47d9a52c8c757090f01b44c
-  data.tar.gz: b2be17a08191fed3f80262d829c0a2d6251d3318
+  metadata.gz: b81678a0e44f5c7593956fbe37f122aff4cdb7fc
+  data.tar.gz: e5bbc6aa629d379ab04551f00d706e714b2b845c
 SHA512:
-  metadata.gz: 2ceecebcd0b87015d6d5487f7a4e6e658f76a066d3960cf7b55e741ecbd7f99445c8110cb5b7a33f18f1319d27c6fbab014a7209e57033c071dc220fd815d419
-  data.tar.gz: 1de63c98ea3c1e7ad37cd00359e8e7e1cda7cdadfa454b44a7e7ae9a84a0b7789c96828d3093e3ac2bd45095f303fe21f9e4d65d7c37cbd356047505139cc077
+  metadata.gz: c5151ef672fedd86b317900c2621b03a09748e3275efd39221626f101dd895a53336c76ef73e2e973287c40af6d38130323cc89fa178fe0e2bce92fc3d705120
+  data.tar.gz: ec27bed50ae7691827b57619437ce3e3b943a0b01b658e7d350a12ef0af5fa20b921209534ec766e46a8e9864f90fbc67f909c3f15d097263bd0a35845378997

data/CHANGES.md

@@ -1,3 +1,7 @@
+## v0.3.6
+
+* fix issue with Google Translate
+
 ## v0.3.5
 
 * `config.locales` is now picked up by default from paths do data files. `base_locale` defaults to `en`.

data/README.md

@@ -1,11 +1,14 @@
 # i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Flattr this][badge-flattr]][flattr]
 
+i18n-tasks finds and manages missing and unused translations in your application.
+
 The basic approach to i18n key management in frameworks such as Rails is far from perfect.
 If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
 in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
-This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
+i18n-tasks improves this by using static analysis. It scans calls such as `I18n.t('some.key')` and uses this information to
+provide reports on key usage, missing and unused keys, and can prefill missing keys, including from Google Translate,
+and can also remove unused keys.
 
 <img width="534" height="288" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
 
@@ -14,7 +17,7 @@ This information is inferred based on the keys the gem detects used with calls s
 Add to Gemfile:
 
   ```ruby
-  gem 'i18n-tasks', '~> 0.3.2'
+  gem 'i18n-tasks', '~> 0.3.5'
   ```
 
 ## Usage

data/i18n-tasks.gemspec

@@ -10,12 +10,15 @@ Gem::Specification.new do |s|
   s.email         = ['glex.spb@gmail.com']
   s.summary       = %q{Manage translations in ruby applications with the awesome power of static analysis — Edit}
   s.description   = %q{
+i18n-tasks finds and manages missing and unused translations in your application.
+
 The basic approach to i18n key management in frameworks such as Rails is far from perfect.
 If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
 in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
-This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
+i18n-tasks improves this by using static analysis. It scans calls such as `I18n.t('some.key')` and uses this information to
+provide reports on key usage, missing and unused keys, and can prefill missing keys, including from Google Translate,
+and can also remove unused keys.
 }
   s.homepage      = 'https://github.com/glebm/i18n-tasks'
   if s.respond_to?(:metadata=)

data/lib/i18n/tasks.rb

@@ -19,11 +19,9 @@ module I18n
     )
     class << self
       def config
-        @config ||= begin
-          file = CONFIG_FILES.detect { |f| File.exists?(f) }
-          file = YAML.load(Erubis::Eruby.new(File.read(file)).result) if file
-          HashWithIndifferentAccess.new.merge(file.presence || {})
-        end
+        file = CONFIG_FILES.detect { |f| File.exists?(f) }
+        file = YAML.load(Erubis::Eruby.new(File.read(file)).result) if file
+        HashWithIndifferentAccess.new.merge(file.presence || {})
       end
       include ::I18n::Tasks::Logging
     end

data/lib/i18n/tasks/commands_base.rb

@@ -2,6 +2,11 @@ require 'ostruct'
 module I18n::Tasks
   class CommandsBase
     include ::I18n::Tasks::Logging
+
+    def initialize(i18n_task = nil)
+      @i18n_task = i18n_task
+    end
+
     def locales_opt(locales)
       return i18n_task.locales if locales == ['all'] || locales == 'all'
       if locales.present?

data/lib/i18n/tasks/fill_tasks.rb

@@ -13,9 +13,7 @@ module I18n::Tasks::FillTasks
         locales: non_base_locales(opts[:locales]),
         keys:    proc { |locale| keys_to_fill(locale).select(&t_proc(from)).select { |k| t(k).is_a?(String) } },
         values:  proc { |keys, locale|
-          google_translate keys.zip(keys.map(&t_proc(from))),
-                           to:   locale,
-                           from: from
+          google_translate(keys.zip(keys.map(&t_proc(from))), to: locale, from: from).map(&:last)
         }
     )
     update_data opts

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -28,20 +28,4 @@ module I18n::Tasks::KeyPatternMatching
         gsub(/:/, '(?<=^|\.)[^.]+?(?=\.|$)').
         gsub(/\{(.*?)}/) { "(#{$1.strip.gsub /\s*,\s*/, '|'})" }
   end
-
-  # @return [Array<String>] keys sans passed patterns
-  def exclude_patterns(keys, patterns)
-    pattern_re = compile_patterns_re patterns.select { |p| p.end_with?('.') }
-    (keys - patterns).reject { |k| k =~ pattern_re }
-  end
-
-  # compile prefix matching Regexp from the list of prefixes
-  # @return [Regexp] regexp matching any of the prefixes
-  def compile_start_with_re(prefixes)
-    if prefixes.blank?
-      MATCH_NOTHING # match nothing
-    else
-      /^(?:#{prefixes.map { |p| Regexp.escape(p) }.join('|')})/
-    end
-  end
 end

data/lib/i18n/tasks/missing_keys.rb

@@ -25,11 +25,6 @@ module I18n::Tasks
       @missing_keys_types ||= [:missing_from_base, :eq_base, :missing_from_locale]
     end
 
-    def untranslated_keys(locales = nil)
-      warn_deprecated '#untranslated_keys. Please use #missing_keys instead'
-      missing_keys(locales: locales)
-    end
-
     # @return [KeyGroup] missing keys, i.e. key that are in the code but are not in the base locale data
     def keys_missing_from_base
       @keys_missing_from_base ||= begin

data/lib/i18n/tasks/translation_data.rb

@@ -1,8 +1,5 @@
 require 'i18n/tasks/data/file_system'
 
-# older configs may use this
-require 'i18n/tasks/data/yaml'
-
 module I18n::Tasks::TranslationData
 
   # I18n data provider

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.3.5'
+    VERSION = '0.3.6'
   end
 end

data/spec/google_translate_spec.rb

@@ -1,14 +1,43 @@
 require 'spec_helper'
+require 'i18n/tasks/commands'
 
 describe 'Google Translation' do
   include I18n::Tasks::GoogleTranslation
 
+  TEST_STRING = 'Hello, %{user}!'
+  TEST_RESULT = 'Hola, %{user}!'
+
   if ENV['GOOGLE_TRANSLATE_API_KEY']
-    context 'real world test' do
-      it 'works' do
-        google_translate(
-            [['common.hello', "Hello, %{user}!"]], from: :en, to: :es, key: ENV['GOOGLE_TRANSLATE_API_KEY']
-        ).should == [['common.hello', 'Hola, %{user}!']]
+    describe 'real world test' do
+      delegate :i18n_cmd, :i18n_task, :in_test_app_dir, to: :TestCodebase
+
+      context 'API' do
+        it 'works' do
+          google_translate(
+              [['common.hello', TEST_STRING]], from: :en, to: :es, key: ENV['GOOGLE_TRANSLATE_API_KEY']
+          ).should == [['common.hello', TEST_RESULT]]
+        end
+      end
+
+      before do
+        TestCodebase.setup('config/locales/en.yml' => '', 'config/locales/es.yml' => '')
+      end
+
+      after do
+        TestCodebase.teardown
+      end
+
+      context 'command' do
+        let(:task) { i18n_task }
+        let(:cmd) { i18n_cmd(task) }
+
+        it 'works' do
+          in_test_app_dir do
+            task.data[:en] = {'common' => {'hello' => TEST_STRING}}
+            cmd.translate_missing
+            expect(task.data[:es]['common']['hello']).to eq(TEST_RESULT)
+          end
+        end
       end
     end
   end

data/spec/i18n_tasks_spec.rb

@@ -4,11 +4,7 @@ require 'i18n/tasks/commands'
 require 'fileutils'
 
 describe 'i18n-tasks' do
-  def run_cmd(name, *args, &block)
-    TestCodebase.in_test_app_dir do
-      capture_stdout { ::I18n::Tasks::Commands.new.send(name, *args, &block) }
-    end
-  end
+  delegate :run_cmd, :i18n_task, :in_test_app_dir, to: :TestCodebase
 
   describe 'missing' do
     let (:expected_missing_keys) {
@@ -39,8 +35,8 @@ describe 'i18n-tasks' do
 
   describe 'remove_unused' do
     it 'removes unused' do
-      TestCodebase.in_test_app_dir do
-        t = I18n::Tasks::BaseTask.new
+      in_test_app_dir do
+        t = i18n_task
         expected_unused_keys.each do |key|
           expect(t.key_value?(key, :en)).to be_true
           expect(t.key_value?(key, :es)).to be_true
@@ -60,7 +56,7 @@ describe 'i18n-tasks' do
 
   describe 'normalize' do
     it 'moves keys to the corresponding files as per data.write' do
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         expect(File).to_not exist 'config/locales/devise.en.yml'
         run_cmd :normalize
         expect(YAML.load_file('config/locales/devise.en.yml')['en']['devise']['a']).to eq 'EN_TEXT'
@@ -70,7 +66,7 @@ describe 'i18n-tasks' do
 
   describe 'xlsx_report' do
     it 'saves' do
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         capture_stderr { run_cmd :xlsx_report }
         expect(File).to exist 'tmp/i18n-report.xlsx'
         FileUtils.cp('tmp/i18n-report.xlsx', '..')
@@ -81,21 +77,21 @@ describe 'i18n-tasks' do
 
   describe 'add_missing' do
     it 'default placeholder' do
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']).to be_nil
       }
       run_cmd :add_missing, locales: 'base'
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['a']).to eq 'A'
       }
     end
 
     it 'placeholder: value' do
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
       }
       run_cmd :add_missing, locales: 'all', placeholder: 'TRME'
-      TestCodebase.in_test_app_dir {
+      in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME'
         # does not touch existing, but moves to the right file:
         expect(YAML.load_file('config/locales/devise.es.yml')['es']['devise']['a']).to eq 'ES_TEXT'
@@ -106,7 +102,7 @@ describe 'i18n-tasks' do
   describe 'config' do
     it 'prints config' do
       expect(YAML.load(run_cmd :config)).to(
-          eq TestCodebase.in_test_app_dir { I18n::Tasks::BaseTask.new.config_for_inspect }
+          eq(in_test_app_dir { i18n_task.config_for_inspect })
       )
     end
   end
@@ -126,7 +122,7 @@ TXT
 
   # --- setup ---
   BENCH_KEYS = 100
-  before do
+  before(:each) do
     gen_data = ->(v) {
       v_num = v.chars.map(&:ord).join('').to_i
       {

data/spec/support/test_codebase.rb

@@ -7,6 +7,24 @@ module TestCodebase
   extend self
   AT = 'tmp/test_codebase'
 
+  def i18n_task(*args)
+    TestCodebase.in_test_app_dir do
+      ::I18n::Tasks::BaseTask.new(*args)
+    end
+  end
+
+  def i18n_cmd(*args)
+    TestCodebase.in_test_app_dir do
+      ::I18n::Tasks::Commands.new(*args)
+    end
+  end
+
+  def run_cmd(name, *args, &block)
+    in_test_app_dir do
+      capture_stdout { i18n_cmd.send(name, *args, &block) }
+    end
+  end
+
   def setup(files = {})
     FileUtils.mkdir_p AT
     in_test_app_dir do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - glebm
@@ -180,12 +180,15 @@ dependencies:
         version: '0'
 description: |2
 
+  i18n-tasks finds and manages missing and unused translations in your application.
+
   The basic approach to i18n key management in frameworks such as Rails is far from perfect.
   If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
   in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-  i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
-  This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
+  i18n-tasks improves this by using static analysis. It scans calls such as `I18n.t('some.key')` and uses this information to
+  provide reports on key usage, missing and unused keys, and can prefill missing keys, including from Google Translate,
+  and can also remove unused keys.
 email:
 - glex.spb@gmail.com
 executables:
@@ -212,7 +215,6 @@ files:
 - lib/i18n/tasks/data/adapter/yaml_adapter.rb
 - lib/i18n/tasks/data/file_system.rb
 - lib/i18n/tasks/data/storage/file_storage.rb
-- lib/i18n/tasks/data/yaml.rb
 - lib/i18n/tasks/data_traversal.rb
 - lib/i18n/tasks/fill_tasks.rb
 - lib/i18n/tasks/google_translation.rb

data/lib/i18n/tasks/data/yaml.rb

@@ -1,13 +0,0 @@
-require 'i18n/tasks/data/file_system'
-
-module I18n::Tasks
-  module Data
-    class Yaml < FileSystem
-      def initialize(*args)
-        super
-        I18n::Tasks.warn_deprecated "data.adapter set to 'yaml'. please use 'file_system' instead"
-      end
-      register_adapter '*.yml', Adapter::YamlAdapter
-    end
-  end
-end