i18n-tasks 0.3.6 → 0.3.7

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

@@ -5,14 +5,14 @@ module I18n::Tasks::Scanners
   #
   class PatternScanner < BaseScanner
     # Extract i18n keys from file based on the pattern which must capture the key literal.
-    # @return [String] keys found in file
+    # @return [Array<Key>] keys found in file
     def scan_file(path, text = read_file(path))
       keys = []
       text.scan(pattern) do |match|
         src_pos = Regexp.last_match.offset(0).first
         key     = match_to_key(match, path)
         next unless valid_key?(key)
-        keys << ::I18n::Tasks::Key.new(key, usage_context(text, src_pos))
+        keys << ::I18n::Tasks::Key.new(key, src_location(text, src_pos))
       end
       keys
     end

data/lib/i18n/tasks/unused_keys.rb

@@ -7,21 +7,24 @@ module I18n
       # @return [Array<[String, String]>] all the unused translations as an array of [key, value] pairs
       def unused_keys(locale = base_locale)
         @unused_keys         ||= {}
-        @unused_keys[locale] ||= ::I18n::Tasks::KeyGroup.new(
-            traverse_map_if(data[locale]) { |key, value|
-              next if used_in_expr?(key) || ignore_key?(key, :unused)
-              key = depluralize_key(locale, key)
-              [key, value] unless used_key?(key)
-            }.uniq, locale: locale, type: :unused)
+        @unused_keys[locale] ||= begin
+          keys = data[locale].traverse_map_if { |key, value|
+            next if used_in_expr?(key) || ignore_key?(key, :unused)
+            key = depluralize_key(locale, key)
+            [key, value] unless used_key?(key)
+          }.uniq
+          KeyGroup.new keys, locale: locale, type: :unused
+        end
       end
 
       def remove_unused!(locales = nil)
         locales ||= self.locales
-        unused = unused_keys
+        unused  = unused_keys
         locales.each do |locale|
-          data[locale] = list_to_tree traverse_map_if(data[locale]) { |key, value|
+          used_key_values = data[locale].traverse_map_if { |key, value|
             [key, value] unless unused.include?(depluralize_key(locale, key))
           }
+          data[locale] = used_key_values
         end
       end
     end

data/lib/i18n/tasks/used_keys.rb

@@ -2,18 +2,27 @@ require 'find'
 require 'i18n/tasks/scanners/pattern_with_scope_scanner'
 
 module I18n::Tasks::UsedKeys
+
   # find all keys in the source (relative keys are absolutized)
+  # @option opts [false|true] :src_locations
+  # @option opts [String] :key_filter
   # @return [Array<String>]
-  def used_keys(with_usages = false)
-    if with_usages
-      used_keys_group scanner.keys_with_usages
+  def used_keys(opts = {})
+    if opts[:key_filter]
+      scanner.with_key_filter(opts[:key_filter]) do
+        return used_keys(opts.except(:key_filter))
+      end
     else
-      @used_keys ||= used_keys_group scanner.keys
+      if opts[:src_locations]
+        used_keys_group scanner.keys_with_src_locations
+      else
+        @used_keys ||= used_keys_group scanner.keys
+      end
     end
   end
 
-  def used_keys_group(keys, opts = {})
-    ::I18n::Tasks::KeyGroup.new(keys, {type: :used, key_filter: scanner.key_filter}.merge(opts))
+  def used_keys_group(keys)
+    ::I18n::Tasks::KeyGroup.new keys, type: :used, key_filter: scanner.key_filter
   end
 
   def scanner

data/lib/i18n/tasks/version.rb

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

data/spec/file_system_data_spec.rb

@@ -45,7 +45,7 @@ describe 'File system i18n' do
           'c.yml' => {en: {c: 1}}.stringify_keys.to_yaml
       )
       TestCodebase.in_test_app_dir {
-        expect(data[:en].symbolize_keys).to eq(a: 1, b: 1, c: 1)
+        expect(data[:en].data.symbolize_keys).to eq(a: 1, b: 1, c: 1)
       }
     end
 
@@ -80,7 +80,7 @@ describe 'File system i18n' do
           'c.json' => {en: {c: 1}}.stringify_keys.to_json
       )
       TestCodebase.in_test_app_dir {
-        expect(data[:en].symbolize_keys).to eq(a: 1, b: 1, c: 1)
+        expect(data[:en].data.symbolize_keys).to eq(a: 1, b: 1, c: 1)
       }
     end
 

data/spec/google_translate_spec.rb

@@ -35,7 +35,7 @@ describe 'Google Translation' 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)
+            expect(task.data[:es].t('common.hello')).to eq(TEST_RESULT)
           end
         end
       end

data/spec/pattern_scanner_spec.rb

@@ -9,13 +9,13 @@ describe 'Pattern Scanner' do
      "t :a_b", "t :'a.b'", 't :"a.b"', "t(:ab)", "t(:'a.b')", 't(:"a.b")',
     'I18n.t("a.b")', 'I18n.translate("a.b")'].each do |s|
       it "matches #{s}" do
-        pattern.should match s
+        expect(pattern).to match s
       end
     end
 
     ["t \"a.b'", "t a.b"].each do |s|
       it "does not match #{s}" do
-        pattern.should_not match s
+        expect(pattern).to_not match s
       end
     end
   end

data/spec/relative_keys_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 describe 'Relative keys' do
-  let(:task) { I18n::Tasks::BaseTask.new }
+  let(:scanner) { I18n::Tasks::Scanners::BaseScanner.new }
 
   describe 'absolutize_key' do
 
     context 'default settings' do
       it 'works' do
-        task.absolutize_key('.title', 'app/views/movies/show.html.slim').should == 'movies.show.title'
+        scanner.absolutize_key('.title', 'app/views/movies/show.html.slim', %w(app/views)).should == 'movies.show.title'
       end
     end
 
     context 'custom roots' do
       it 'works' do
-        task.absolutize_key('.title', 'app/views-mobile/movies/show.html.slim', %w(app/views-mobile)).should == 'movies.show.title'
+        scanner.absolutize_key('.title', 'app/views-mobile/movies/show.html.slim', %w(app/views app/views-mobile)).should == 'movies.show.title'
       end
     end
 

data/spec/used_keys_spec.rb

@@ -14,8 +14,8 @@ h1 = t 'b'
     TestCodebase.teardown
   end
 
-  it '#used_keys(true) finds usages' do
-    used_keys = task.used_keys(true)
+  it '#used_keys(src_locations: true)' do
+    used_keys = task.used_keys(src_locations: true)
     expect(used_keys.size).to eq 2
     expect(used_keys[0].own_attr).to(
         eq(key:    'a',
@@ -28,10 +28,8 @@ h1 = t 'b'
     )
   end
 
-  it '#used_keys(true) finds usages with filter' do
-    used_keys = task.scanner.with_key_filter('b*') {
-      task.used_keys(true)
-    }
+  it '#used_keys(src_locations: true, key_filter: "b*")' do
+    used_keys = task.used_keys(key_filter: 'b*', src_locations: true)
     expect(used_keys.size).to eq 1
     expect(used_keys[0].own_attr).to(
         eq(key:    'b',

metadata

@@ -1,194 +1,189 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   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: activesupport
   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: easy_translate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   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: terminal-table
   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: highline
   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: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.7
 - !ruby/object:Gem::Dependency
   name: axlsx
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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'
 - !ruby/object:Gem::Dependency
   name: yard
   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: |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 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.
+  It scans calls such as `I18n.t('some.key')` and provides reports on key usage, missing, and unused keys.
+  It can also can pre-fill missing keys, including from Google Translate, and it can remove unused keys as well.
 email:
 - glex.spb@gmail.com
 executables:
@@ -196,9 +191,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -211,11 +206,14 @@ files:
 - lib/i18n/tasks/commands.rb
 - lib/i18n/tasks/commands_base.rb
 - lib/i18n/tasks/configuration.rb
+- lib/i18n/tasks/data.rb
 - lib/i18n/tasks/data/adapter/json_adapter.rb
 - lib/i18n/tasks/data/adapter/yaml_adapter.rb
+- lib/i18n/tasks/data/file_formats.rb
 - lib/i18n/tasks/data/file_system.rb
-- lib/i18n/tasks/data/storage/file_storage.rb
-- lib/i18n/tasks/data_traversal.rb
+- lib/i18n/tasks/data/file_system_base.rb
+- lib/i18n/tasks/data/locale_tree.rb
+- lib/i18n/tasks/data/router.rb
 - lib/i18n/tasks/fill_tasks.rb
 - lib/i18n/tasks/google_translation.rb
 - lib/i18n/tasks/ignore_keys.rb
@@ -235,7 +233,6 @@ files:
 - lib/i18n/tasks/scanners/base_scanner.rb
 - lib/i18n/tasks/scanners/pattern_scanner.rb
 - lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb
-- lib/i18n/tasks/translation_data.rb
 - lib/i18n/tasks/unused_keys.rb
 - lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb
@@ -272,17 +269,17 @@ require_paths:
 - lib
 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.0.14
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Manage translations in ruby applications with the awesome power of static