i18n-tasks 0.2.19 → 0.2.20

data/lib/i18n/tasks/scanners/pattern_scanner.rb

@@ -2,23 +2,25 @@
 require 'i18n/tasks/scanners/base_scanner'
 module I18n::Tasks::Scanners
   class PatternScanner < BaseScanner
-    LITERAL_RE = /:?".+?"|:?'.+?'|:\w+/
+    LITERAL_RE      = /:?".+?"|:?'.+?'|:\w+/
     DEFAULT_PATTERN = /\bt(?:ranslate)?[( ]\s*(#{LITERAL_RE})/
 
     # Extract i18n keys from file based on the pattern. The pattern must capture key literal.
     # @return [String] keys found in file
-    def scan_file(path)
+    def scan_file(path, text = read_file(path))
       keys = []
-      File.open(path, 'rb') do |f|
-        f.read.scan(pattern) do |match|
-          key = extract_key_from_match(match, path)
-          keys << key if valid_key?(key)
-        end
+      text.scan(pattern) do |match|
+        src_pos = Regexp.last_match.offset(0).first
+        key     = extract_key_from_match(match, path)
+        next unless valid_key?(key)
+        keys << ::I18n::Tasks::Key.new(key, src: usage_context(text, src_pos))
       end
       keys
     end
 
     protected
+
+
     def pattern
       @pattern ||= config[:pattern].present? ? Regexp.new(config[:pattern]) : DEFAULT_PATTERN
     end

data/lib/i18n/tasks/translation_data.rb

@@ -1,3 +1,6 @@
+require 'i18n/tasks/data/file_system'
+
+# older configs may use this
 require 'i18n/tasks/data/yaml'
 
 module I18n::Tasks::TranslationData
@@ -36,4 +39,4 @@ module I18n::Tasks::TranslationData
       data[target_locale] = data[target_locale]
     end
   end
-end
+end

data/lib/i18n/tasks/unused_keys.rb

@@ -6,18 +6,20 @@ module I18n
     module UnusedKeys
       # @return [Array<[String, String]>] all the unused translations as an array of [key, value] pairs
       def unused_keys(locale = base_locale)
-        traverse_map_if data[locale] do |key, value|
-          next if pattern_key?(key) || ignore_key?(key, :unused)
-          key = depluralize_key(locale, key)
-          [key, value] unless used_key?(key)
-        end.uniq
+        @unused_keys         ||= {}
+        @unused_keys[locale] ||= ::I18n::Tasks::KeyGroup.new(
+            traverse_map_if(data[locale]) { |key, value|
+              next if pattern_key?(key) || ignore_key?(key, :unused)
+              key = depluralize_key(locale, key)
+              [key, value] unless used_key?(key)
+            }.uniq, locale: locale, type: :unused)
       end
 
       def remove_unused!(locales = self.locales)
-        exclude = unused_keys.map(&:first).to_set
+        unused = unused_keys
         locales.each do |locale|
           data[locale] = list_to_tree traverse_map_if(data[locale]) { |key, value|
-            [key, value] unless exclude.include?(depluralize_key(locale, key))
+            [key, value] unless unused.include?(depluralize_key(locale, key))
           }
         end
       end

data/lib/i18n/tasks/{source_keys.rb → used_keys.rb}

@@ -1,11 +1,11 @@
 require 'find'
 require 'i18n/tasks/scanners/pattern_scanner'
 
-module I18n::Tasks::SourceKeys
+module I18n::Tasks::UsedKeys
   # find all keys in the source (relative keys are absolutized)
   # @return [Array<String>]
-  def find_source_keys
-    @source_keys ||= scanner.keys
+  def used_keys
+    @used_keys ||= I18n::Tasks::KeyGroup.new(scanner.keys, type: :used)
   end
 
   def scanner
@@ -18,8 +18,7 @@ module I18n::Tasks::SourceKeys
 
   # whether the key is used in the source
   def used_key?(key)
-    @used_keys ||= find_source_keys.to_set
-    @used_keys.include?(key)
+    used_keys.include?(key)
   end
 
   # dynamically generated keys in the source, e.g t("category.#{category_key}")
@@ -31,6 +30,6 @@ module I18n::Tasks::SourceKeys
   # keys in the source that end with a ., e.g. t("category.#{cat.i18n_key}") or t("category." + category.key)
   def pattern_key_prefixes
     @pattern_keys_prefixes ||=
-        find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0].presence }.compact
+        used_keys.key_names.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0].presence }.compact
   end
 end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.2.19'
+    VERSION = '0.2.20'
   end
 end

data/lib/tasks/i18n-tasks.rake

@@ -1,6 +1,5 @@
 require 'set'
 require 'i18n/tasks'
-require 'i18n/tasks/base_task'
 require 'i18n/tasks/reports/terminal'
 require 'active_support/core_ext/module/delegation'
 require 'i18n/tasks/reports/spreadsheet'
@@ -13,54 +12,59 @@ namespace :i18n do
 
   desc 'show missing translations'
   task :missing, [:locales] => 'i18n:setup' do |t, args|
-    i18n_report.missing_translations i18n_tasks.untranslated_keys(i18n_parse_locales args[:locales])
+    i18n_report.missing_keys i18n_task.missing_keys(locales: i18n_parse_locales(args[:locales]))
   end
 
   namespace :missing do
     desc 'keys present in code but not existing in base locale data'
-    task :not_in_base => 'i18n:setup' do |t, args|
-      i18n_report.missing_translations i18n_tasks.keys_not_in_base_info
+    task :missing_from_base => 'i18n:setup' do |t, args|
+      i18n_report.missing_keys i18n_task.keys_missing_from_base
     end
 
     desc 'keys present but with value same as in base locale'
     task :eq_base, [:locales] => 'i18n:setup' do |t, args|
-      i18n_report.missing_translations i18n_tasks.keys_eq_base_info(i18n_parse_locales args[:locales])
+      i18n_report.missing_keys i18n_task.missing_keys(type: :eq_base, locales: i18n_parse_locales(args[:locales]))
     end
 
     desc 'keys that exist in base locale but are blank in passed locales'
-    task :blank, [:locales] => 'i18n:setup' do |t, args|
-      i18n_report.missing_translations i18n_tasks.keys_eq_base_info(i18n_parse_locales args[:locales])
+    task :missing_from_locale, [:locales] => 'i18n:setup' do |t, args|
+      i18n_report.missing_keys i18n_task.missing_keys(type: :missing_from_locale, locales: i18n_parse_locales(args[:locales]))
     end
   end
 
   desc 'show unused translations'
   task :unused => 'i18n:setup' do
-    i18n_report.unused_translations
+    i18n_report.unused_keys
   end
 
   desc 'add placeholder for missing values to the base locale (default: key.humanize)'
   task :add_missing, [:placeholder] => 'i18n:setup' do |t, args|
-    i18n_tasks.add_missing! base_locale, args[:placeholder]
+    i18n_task.add_missing! base_locale, args[:placeholder]
   end
 
   desc 'remove unused keys'
   task :remove_unused, [:locales] => 'i18n:setup' do |t, args|
-    locales     = i18n_parse_locales(args[:locales]) || i18n_tasks.locales
-    unused_keys = i18n_tasks.unused_keys
+    locales     = i18n_parse_locales(args[:locales]) || i18n_task.locales
+    unused_keys = i18n_task.unused_keys
     if unused_keys.present?
-      i18n_report.unused_translations(unused_keys)
+      i18n_report.unused_keys(unused_keys)
       unless ENV['CONFIRM']
         exit 1 unless agree(red "All these translations will be removed in #{bold locales * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
       end
-      i18n_tasks.remove_unused!(locales)
+      i18n_task.remove_unused!(locales)
     else
       STDERR.puts bold green 'No unused keys to remove'
     end
   end
+  
+  desc 'show usages'
+  task :usages => 'i18n:setup' do
+    i18n_report.used_keys
+  end
 
   desc 'normalize translation data: sort and move to the right files'
   task :normalize, [:locales] => 'i18n:setup' do |t, args|
-    i18n_tasks.normalize_store! args[:locales]
+    i18n_task.normalize_store! args[:locales]
   end
 
   desc 'save missing and unused translations to an Excel file'
@@ -81,27 +85,27 @@ namespace :i18n do
 
     desc 'add "" values for missing and untranslated keys to locales (default: all)'
     task :blanks, [:locales] => 'i18n:setup' do |t, args|
-      i18n_tasks.fill_with_blanks! i18n_parse_locales args[:locales]
+      i18n_task.fill_with_blanks! i18n_parse_locales args[:locales]
     end
 
     desc 'add Google Translated values for untranslated keys to locales (default: all non-base)'
     task :google_translate, [:locales] => 'i18n:setup' do |t, args|
-      i18n_tasks.fill_with_google_translate! i18n_parse_locales args[:locales]
+      i18n_task.fill_with_google_translate! i18n_parse_locales args[:locales]
     end
 
     desc 'copy base locale values for all untranslated keys to locales (default: all non-base)'
     task :base_value, [:locales] => 'i18n:setup' do |t, args|
-      i18n_tasks.fill_with_base_values! i18n_parse_locales args[:locales]
+      i18n_task.fill_with_base_values! i18n_parse_locales args[:locales]
     end
   end
 
   module ::I18n::Tasks::RakeHelpers
     include Term::ANSIColor
 
-    delegate :base_locale, to: :i18n_tasks
+    delegate :base_locale, to: :i18n_task
 
-    def i18n_tasks
-      @i18n_tasks ||= I18n::Tasks::BaseTask.new
+    def i18n_task
+      @i18n_task ||= I18n::Tasks::BaseTask.new
     end
 
     def i18n_report

data/spec/file_system_data_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe 'File system i18n' do
+  describe 'yml' do
+      let!(:data) { I18n::Tasks::Data::FileSystem.new }
+      after { TestCodebase.teardown }
+
+      it 'reads' do
+        data.config = {read: ['a.yml', '{b,c}.yml']}
+        TestCodebase.setup(
+            'a.yml' => {en: {a: 1}}.stringify_keys.to_yaml,
+            'b.yml' => {en: {b: 1}}.stringify_keys.to_yaml,
+            'c.yml' => {en: {c: 1}}.stringify_keys.to_yaml
+        )
+        TestCodebase.in_test_app_dir {
+          data[:en].symbolize_keys.should == {a: 1, b: 1, c: 1}
+        }
+      end
+
+      it 'writes' do
+        data.config = {read: 'a.yml', write: [['{:}.*', '\1.%{locale}.yml']]}
+        keys        = {'a' => {'b' => 'c'}, 'x' => 'y'}
+        locale_data = {'pizza' => keys, 'sushi' => keys}
+        TestCodebase.setup
+        TestCodebase.in_test_app_dir {
+          data[:en] = locale_data
+          files     = %w(pizza.en.yml sushi.en.yml)
+          Dir['*.yml'].sort.should == files.sort
+          files.each { |f| YAML.load_file(f)['en'].should == {File.basename(f, '.en.yml') => keys} }
+        }
+      end
+  end
+
+  describe 'json' do
+    let!(:data) {
+      I18n::Tasks::Data::FileSystem.new(
+        read:  ['config/locales/%{locale}.json'],
+        write: ['config/locales/%{locale}.json']
+      )
+    }
+    after { TestCodebase.teardown }
+
+    it 'reads' do
+      data.config = {read: ['a.json', '{b,c}.json']}
+      TestCodebase.setup(
+          'a.json' => {en: {a: 1}}.stringify_keys.to_json,
+          'b.json' => {en: {b: 1}}.stringify_keys.to_json,
+          'c.json' => {en: {c: 1}}.stringify_keys.to_json
+      )
+      TestCodebase.in_test_app_dir {
+        data[:en].symbolize_keys.should == {a: 1, b: 1, c: 1}
+      }
+    end
+
+    it 'writes' do
+      data.config = {read: 'a.json', write: [['{:}.*', '\1.%{locale}.json']]}
+      keys        = {'a' => {'b' => 'c'}, 'x' => 'y'}
+      locale_data = {'pizza' => keys, 'sushi' => keys}
+      TestCodebase.setup
+      TestCodebase.in_test_app_dir {
+        data[:en] = locale_data
+        files     = %w(pizza.en.json sushi.en.json)
+        Dir['*.json'].sort.should == files.sort
+        files.each { |f| JSON.parse(File.read f)['en'].should == {File.basename(f, '.en.json') => keys} }
+      }
+    end
+  end
+end

data/spec/fixtures/config/i18n-tasks.yml

@@ -1,7 +1,7 @@
 # i18n data storage
 data:
-  # The default YAML adapter supports reading from and writing to YAML files
-  adapter: yaml
+  # The default file adapter supports YAML and JSON files. You can provide a class name here.
+  adapter: file_system
   # adapter options
   read:
     - 'config/locales/%{locale}.yml'

data/spec/i18n_tasks_spec.rb

@@ -20,7 +20,7 @@ describe 'rake i18n' do
     it 'detects unused' do
       TestCodebase.capture_stderr do
         out = TestCodebase.rake_result('i18n:unused')
-        out.should be_i18n_keys expected_unused_keys
+        expect(out).to be_i18n_keys expected_unused_keys
       end
     end
 
@@ -29,8 +29,8 @@ describe 'rake i18n' do
         t = I18n::Tasks::BaseTask.new
 
         expected_unused_keys.each do |key|
-          t.t(t.data[:en], key).should be_present
-          t.t(t.data[:es], key).should be_present
+          expect(t.t(t.data[:en], key)).to be_present
+          expect(t.t(t.data[:es], key)).to be_present
         end
 
         ENV['CONFIRM'] = '1'
@@ -39,8 +39,8 @@ describe 'rake i18n' do
         t.data.reload
         # or save both to an xlsx file:
         expected_unused_keys.each do |key|
-          t.t(t.data[:en], key).should be_nil
-          t.t(t.data[:es], key).should be_nil
+          expect(t.t(t.data[:en], key)).to be_nil
+          expect(t.t(t.data[:es], key)).to be_nil
         end
       end
     end

data/spec/key_group_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'KeyGroup' do
+  def key_group(group, attr = {})
+    ::I18n::Tasks::KeyGroup.new(group, attr)
+  end
+
+  let!(:kg_attr) { { a: :b, x: '0' } }
+  let!(:kg) { key_group %w(a b), kg_attr }
+
+  it('#attr') { expect(kg.attr).to eq kg_attr }
+
+  it '#to_a' do
+    expect(kg.to_a).to eq [
+        {key: 'a'}.merge(kg_attr),
+        {key: 'b'}.merge(kg_attr)
+    ]
+  end
+
+  it '#merge' do
+    kg2_attr = {a: :b, x: '1', c: :d}
+    kg2 = key_group %w(c), kg2_attr
+    kg3 = key_group [{key: 'd', prop: true}]
+    expect([kg, kg2, kg3].reduce(:+).to_a).to eq [
+        {key: 'a'}.merge(kg_attr),
+        {key: 'b'}.merge(kg_attr),
+        {key: 'c'}.merge(kg2_attr),
+        {key: 'd', prop: true}
+    ]
+  end
+
+  it '#merge shared attr' do
+    kg2 = key_group %w(c d), kg_attr
+    expect((kg + kg2).keys[0].own_attr).to eq kg.keys[0].own_attr
+  end
+
+  it '#sort!' do
+    kg = key_group [{key: 'a', prop: '0'}, {key: 'b', prop: '1'}]
+    kg.sort! { |a, b| b[:prop] <=> a[:prop] }
+    expect(kg.keys[0][:prop]).to eq '1'
+  end
+
+  it '#sort_by_attr!' do
+    expect(key_group(%w(a b c)).tap { |kg|
+      kg.sort_by_attr!(key: :desc)
+    }.keys.map(&:key)).to eq %w(c b a)
+  end
+end

data/spec/used_keys_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'UsedKeys' do
+  let(:task) { I18n::Tasks::BaseTask.new }
+
+  it 'shows usages' do
+    task.config[:search] = {paths: ['a.html.slim']}
+    TestCodebase.setup('a.html.slim' => <<-SLIM)
+div = t 'a'
+  p = t 'a'
+    SLIM
+    TestCodebase.in_test_app_dir {
+      used_keys = task.used_keys
+      expect(used_keys.size).to eq 1
+      usages_expected = [
+          {pos: 6, line_num: 1, line_pos: 7, line: "div = t 'a'", path: 'a.html.slim'},
+          {pos: 18, line_num: 2, line_pos: 7, line: "  p = t 'a'", path: 'a.html.slim'}
+      ]
+      expect(used_keys[0].attr).to eq(type: :used, key: 'a', usages: usages_expected)
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.19
+  version: 0.2.20
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -196,15 +196,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/img/i18n-usages.png
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb
 - lib/i18n/tasks/configuration.rb
+- lib/i18n/tasks/data/adapter/json_adapter.rb
+- 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
 - lib/i18n/tasks/ignore_keys.rb
+- lib/i18n/tasks/key.rb
+- lib/i18n/tasks/key_group.rb
 - lib/i18n/tasks/key_pattern_matching.rb
 - lib/i18n/tasks/missing_keys.rb
 - lib/i18n/tasks/plural_keys.rb
@@ -215,12 +222,12 @@ files:
 - lib/i18n/tasks/reports/terminal.rb
 - lib/i18n/tasks/scanners/base_scanner.rb
 - lib/i18n/tasks/scanners/pattern_scanner.rb
-- lib/i18n/tasks/source_keys.rb
 - lib/i18n/tasks/translation_data.rb
-- lib/i18n/tasks/untranslated_keys.rb
 - lib/i18n/tasks/unused_keys.rb
+- lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb
 - lib/tasks/i18n-tasks.rake
+- spec/file_system_data_spec.rb
 - spec/fixtures/app/assets/javascripts/application.js
 - spec/fixtures/app/controllers/events_controller.rb
 - spec/fixtures/app/views/index.html.slim
@@ -228,6 +235,7 @@ files:
 - spec/fixtures/config/i18n-tasks.yml
 - spec/google_translate_spec.rb
 - spec/i18n_tasks_spec.rb
+- spec/key_group_spec.rb
 - spec/key_pattern_matching_spec.rb
 - spec/pattern_scanner_spec.rb
 - spec/readme_spec.rb
@@ -238,7 +246,7 @@ files:
 - spec/support/key_pattern_matcher.rb
 - spec/support/test_codebase.rb
 - spec/support/test_codebase_env.rake
-- spec/yaml_adapter_spec.rb
+- spec/used_keys_spec.rb
 homepage: https://github.com/glebm/i18n-tasks
 licenses:
 - MIT
@@ -266,6 +274,7 @@ specification_version: 4
 summary: Tasks to manage missing and unused translations in ruby applications using
   I18n.
 test_files:
+- spec/file_system_data_spec.rb
 - spec/fixtures/app/assets/javascripts/application.js
 - spec/fixtures/app/controllers/events_controller.rb
 - spec/fixtures/app/views/index.html.slim
@@ -273,6 +282,7 @@ test_files:
 - spec/fixtures/config/i18n-tasks.yml
 - spec/google_translate_spec.rb
 - spec/i18n_tasks_spec.rb
+- spec/key_group_spec.rb
 - spec/key_pattern_matching_spec.rb
 - spec/pattern_scanner_spec.rb
 - spec/readme_spec.rb
@@ -283,5 +293,5 @@ test_files:
 - spec/support/key_pattern_matcher.rb
 - spec/support/test_codebase.rb
 - spec/support/test_codebase_env.rake
-- spec/yaml_adapter_spec.rb
+- spec/used_keys_spec.rb
 has_rdoc: