i18n-tasks 0.4.5 → 0.5.0

data/lib/i18n/tasks/used_keys.rb

@@ -2,51 +2,52 @@
 require 'find'
 require 'i18n/tasks/scanners/pattern_with_scope_scanner'
 
-module I18n::Tasks::UsedKeys
+module I18n::Tasks
+  module 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(opts = {})
-    if opts[:key_filter]
-      scanner.with_key_filter(opts[:key_filter]) do
-        return used_keys(opts.except(:key_filter))
-      end
-    else
-      if opts[:src_locations]
-        used_keys_group scanner.keys_with_src_locations
-      else
-        @used_keys ||= used_keys_group scanner.keys
-      end
+    # find all keys in the source (relative keys are absolutized)
+    # @option opts [false|true] :source_locations
+    # @option opts [String] :key_filter
+    # @return [Array<String>]
+    def used_tree(opts = {})
+      return scanner.with_key_filter(opts[:key_filter]) { used_tree(opts.except(:key_filter)) } if opts[:key_filter]
+      key_attrs = opts[:source_locations] ? scanner.keys_with_source_locations : scanner.keys
+      Data::Tree::Node.new(
+          key: 'used',
+          data: {key_filter: scanner.key_filter},
+          children: Data::Tree::Siblings.from_key_attr(key_attrs)
+      ).to_siblings
     end
-  end
 
-  def used_keys_group(keys)
-    ::I18n::Tasks::KeyGroup.new keys, type: :used, key_filter: scanner.key_filter
-  end
+    def scanner
+      @scanner ||= begin
+        search_config = (config[:search] || {}).with_indifferent_access
+        class_name    = search_config[:scanner] || '::I18n::Tasks::Scanners::PatternWithScopeScanner'
+        class_name.constantize.new search_config.merge(relative_roots: relative_roots)
+      end
+    end
 
-  def scanner
-    @scanner ||= begin
-      search_config = (config[:search] || {}).with_indifferent_access
-      class_name    = search_config[:scanner] || '::I18n::Tasks::Scanners::PatternWithScopeScanner'
-      class_name.constantize.new search_config.merge(relative_roots: relative_roots)
+    def used_key_names
+      @used_key_names ||= used_tree.key_names
     end
-  end
 
-  # whether the key is used in the source
-  def used_key?(key)
-    used_keys.include?(key)
-  end
+    # whether the key is used in the source
+    def used_key?(key)
+      used_key_names.include?(key)
+    end
 
-  # @return whether the key is potentially used in a code expression such as:
-  #   t("category.#{category_key}")
-  def used_in_expr?(key)
-    !!(key =~ expr_key_re)
-  end
+    # @return whether the key is potentially used in a code expression such as:
+    #   t("category.#{category_key}")
+    def used_in_expr?(key)
+      !!(key =~ expr_key_re)
+    end
 
-  # keys in the source that end with a ., e.g. t("category.#{cat.i18n_key}") or t("category." + category.key)
-  def expr_key_re
-    @expr_key_re ||= compile_key_pattern "{#{used_keys.keys.select(&:expr?).map(&:key_match_pattern) * ','}}"
+    # keys in the source that end with a ., e.g. t("category.#{cat.i18n_key}") or t("category." + category.key)
+    def expr_key_re
+      @expr_key_re ||= begin
+        patterns = used_key_names.select { |k| key_expression?(k) }.map { |k| key_match_pattern(k) }
+        compile_key_pattern "{#{patterns * ','}}"
+      end
+    end
   end
 end

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 module I18n
   module Tasks
-    VERSION = '0.4.5'
+    VERSION = '0.5.0'
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -27,7 +27,7 @@ describe 'i18n-tasks' do
     end
   end
 
-  let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural) }
+  let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural).map { |k| %w(en es).map { |l| "#{l}.#{k}" } }.reduce(:+) }
   describe 'unused' do
     it 'detects unused' do
       capture_stderr do
@@ -40,7 +40,8 @@ describe 'i18n-tasks' do
     it 'removes unused' do
       in_test_app_dir do
         t = i18n_task
-        expected_unused_keys.each do |key|
+        unused = expected_unused_keys.map { |k| k.split('.', 2)[1] }
+        unused.each do |key|
           expect(t.key_value?(key, :en)).to be true
           expect(t.key_value?(key, :es)).to be true
         end
@@ -49,7 +50,7 @@ describe 'i18n-tasks' do
           run_cmd :remove_unused
         }
         t.data.reload
-        expected_unused_keys.each do |key|
+        unused.each do |key|
           expect(t.key_value?(key, :en)).to be false
           expect(t.key_value?(key, :es)).to be false
         end
@@ -139,7 +140,7 @@ describe 'i18n-tasks' do
 used.a 2
   app/views/usages.html.slim:1 p = t 'used.a'
   app/views/usages.html.slim:2 b = t 'used.a'
-TXT
+        TXT
       end
     end
   end
@@ -151,53 +152,53 @@ TXT
     gen_data = ->(v) {
       v_num = v.chars.map(&:ord).join('').to_i
       {
-        '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},
-            'pattern2' => {'a' => v},
-        },
-        'unused'              => {'a' => v, 'numeric' => v_num, 'plural' => {'one' => v, 'other' => v}},
-        'ignore_unused'       => {'a' => v},
-        'missing_in_es'       => {'a' => v},
-        'missing_in_es_plural_1' => { 'a' => {'one' => v, 'other' => v}},
-        'missing_in_es_plural_2' => { 'a' => {'one' => v, 'other' => v}},
-        'same_in_es'          => {'a' => v},
-        'ignore_eq_base_all'  => {'a' => v},
-        'ignore_eq_base_es'   => {'a' => v},
-        'blank_in_es'         => {'a' => v},
-        'relative'            => {
-            'index' => {
-                'title' => v,
-                'description' => v,
-                'summary' => v,
-            }
-        },
-        'numeric'             => {'a' => v_num},
-        'plural'              => {'a' => {'one' => v, 'other' => "%{count} #{v}s"}},
-        'devise'              => {'a' => v},
-        'scoped' => {'x' => v},
-        'very'   => {'scoped' => {'x' => v}},
-        'used'   => {'a' => 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},
+              'pattern2' => {'a' => v},
+          },
+          'unused'                 => {'a' => v, 'numeric' => v_num, 'plural' => {'one' => v, 'other' => v}},
+          'ignore_unused'          => {'a' => v},
+          'missing_in_es'          => {'a' => v},
+          'missing_in_es_plural_1' => {'a' => {'one' => v, 'other' => v}},
+          'missing_in_es_plural_2' => {'a' => {'one' => v, 'other' => v}},
+          'same_in_es'             => {'a' => v},
+          'ignore_eq_base_all'     => {'a' => v},
+          'ignore_eq_base_es'      => {'a' => v},
+          'blank_in_es'            => {'a' => v},
+          'relative'               => {
+              'index' => {
+                  'title'       => v,
+                  'description' => v,
+                  'summary'     => v,
+              }
+          },
+          'numeric'                => {'a' => v_num},
+          'plural'                 => {'a' => {'one' => v, 'other' => "%{count} #{v}s"}},
+          'devise'                 => {'a' => v},
+          'scoped'                 => {'x' => v},
+          'very'                   => {'scoped' => {'x' => v}},
+          'used'                   => {'a' => v}
       }.tap { |r|
         gen = r["bench"] = {}
         BENCH_KEYS.times { |i| gen["key#{i}"] = v }
       }
     }
 
-    en_data = gen_data.('EN_TEXT')
-    es_data = gen_data.('ES_TEXT').except(
+    en_data                            = gen_data.('EN_TEXT')
+    es_data                            = gen_data.('ES_TEXT').except(
         'missing_in_es', 'missing_in_es_plural_1', 'missing_in_es_plural_2')
-    es_data['same_in_es']['a']  = 'EN_TEXT'
-    es_data['blank_in_es']['a'] = ''
+    es_data['same_in_es']['a']         = 'EN_TEXT'
+    es_data['blank_in_es']['a']        = ''
     es_data['ignore_eq_base_all']['a'] = 'EN_TEXT'
     es_data['ignore_eq_base_es']['a']  = 'EN_TEXT'
 
     fs = fixtures_contents.merge(
-      'config/locales/en.yml'                 => {'en' => en_data}.to_yaml,
-      'config/locales/es.yml'                 => {'es' => es_data}.to_yaml,
-      # test that our algorithms can scale to the order of {BENCH_KEYS} keys.
-      'vendor/heavy.file' => BENCH_KEYS.times.map { |i| "t('bench.key#{i}') " }.join
+        'config/locales/en.yml' => {'en' => en_data}.to_yaml,
+        'config/locales/es.yml' => {'es' => es_data}.to_yaml,
+        # test that our algorithms can scale to the order of {BENCH_KEYS} keys.
+        'vendor/heavy.file'     => BENCH_KEYS.times.map { |i| "t('bench.key#{i}') " }.join
     )
 
     TestCodebase.setup fs

data/spec/locale_tree/siblings_spec.rb

@@ -3,6 +3,18 @@ require 'spec_helper'
 
 describe 'Tree siblings / forest' do
 
+  context 'Node' do
+    it '::new with children' do
+      children = I18n::Tasks::Data::Tree::Siblings.from_key_attr([['a', value: 1]])
+      #require 'byebug'; byebug
+      node = I18n::Tasks::Data::Tree::Node.new(
+          key: 'fr',
+          children: children
+      )
+      expect(node.to_siblings.first.children.first.parent.key).to eq 'fr'
+    end
+  end
+
   context 'a tree' do
     let(:a_hash) { {a: 1, b: {ba: 1, bb: 2}}.deep_stringify_keys }
 
@@ -22,9 +34,22 @@ describe 'Tree siblings / forest' do
     end
 
     it '#merge' do
-      a = build_tree(a_hash)
+      a      = build_tree(a_hash)
       b_hash = {b: {bc: 1}, c: 1}.deep_stringify_keys
       expect(a.merge(build_tree(b_hash)).to_hash).to eq(a_hash.deep_merge(b_hash))
     end
+
+    it '#intersect' do
+      x = {a: 1, b: {ba: 1, bb: 2}}
+      y = {b: {ba: 1, bc: 3}, c: 1}
+      intersection = {b: {ba: 1}}.deep_stringify_keys
+      a = build_tree(x)
+      b = build_tree(y)
+      expect(a.intersect_keys(b, root: true).to_hash).to eq(intersection)
+    end
+
+    it '#select_keys' do
+      expect(build_tree(a: 1, b: 1).select_keys {|k, node| k == 'b'}.to_hash).to eq({'b' => 1})
+    end
   end
 end

data/spec/support/i18n_tasks_output_matcher.rb

@@ -11,9 +11,12 @@ RSpec::Matchers.define :be_i18n_keys do |expected|
       row.gsub(/(?:\s|^)\|(?:\s|$)/, ' ').gsub(/\s+/, ' ').strip.split(' ').map(&:presence).compact
     }
     return [] if actual.empty?
-    if actual[0][1] =~ /[✗∅=]/
+    if actual[0][1] =~ /([✗∅=])/
       locale_col = 0
       key_col    = 2
+    elsif actual[0].length == 3
+      locale_col = 0
+      key_col = 1
     else
       key_col = 0
     end

data/spec/support/trees.rb

@@ -1,6 +1,11 @@
 # coding: utf-8
 module Trees
+  def expect_node_key_data(node, key, data)
+    expect(node.full_key(root: false)).to eq key
+    expect(node.data).to eq data
+  end
+
   def build_tree(hash)
-    I18n::Tasks::Data::Tree::Siblings.from_nested_hash(hash)
+    I18n::Tasks::Data::Tree::Siblings.from_nested_hash(hash.deep_stringify_keys)
   end
 end

data/spec/used_keys_spec.rb

@@ -15,26 +15,34 @@ h1 = t 'b'
     TestCodebase.teardown
   end
 
-  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',
-           usages: [{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'}])
+  it '#used_keys(source_locations: true)' do
+    used   = task.used_tree(source_locations: true)
+    leaves = used.leaves.to_a
+    expect(leaves.size).to eq 2
+    expect_node_key_data(
+        leaves[0],
+        'a',
+        source_locations:
+            [{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[1].own_attr).to(
-        eq(key:    'b',
-           usages: [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}])
+
+    expect_node_key_data(
+        leaves[1],
+        'b',
+        source_locations:
+            [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}]
     )
   end
 
-  it '#used_keys(src_locations: true, key_filter: "b*")' do
-    used_keys = task.used_keys(key_filter: 'b*', src_locations: true)
+  it '#used_keys(source_locations: true, key_filter: "b*")' do
+    used_keys = task.used_tree(key_filter: 'b*', source_locations: true)
     expect(used_keys.size).to eq 1
-    expect(used_keys[0].own_attr).to(
-        eq(key:    'b',
-           usages: [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}])
+    expect_node_key_data(
+        used_keys.leaves.first,
+        'b',
+        source_locations:
+            [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}]
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -180,7 +180,7 @@ dependencies:
         version: '0'
 description: |2
 
-  i18n-tasks finds and manages missing and unused translations in your application.
+  i18n-tasks helps you find and manage missing and unused translations.
 
   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.
@@ -210,6 +210,7 @@ files:
 - lib/i18n/tasks/commands.rb
 - lib/i18n/tasks/commands_base.rb
 - lib/i18n/tasks/configuration.rb
+- lib/i18n/tasks/console_context.rb
 - lib/i18n/tasks/data.rb
 - lib/i18n/tasks/data/adapter/json_adapter.rb
 - lib/i18n/tasks/data/adapter/yaml_adapter.rb
@@ -222,15 +223,9 @@ files:
 - lib/i18n/tasks/data/tree/nodes.rb
 - lib/i18n/tasks/data/tree/siblings.rb
 - lib/i18n/tasks/data/tree/traversal.rb
-- lib/i18n/tasks/file_structure.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/key_group.rb
-- lib/i18n/tasks/key/match_pattern.rb
-- lib/i18n/tasks/key/usages.rb
-- lib/i18n/tasks/key_group.rb
 - lib/i18n/tasks/key_pattern_matching.rb
 - lib/i18n/tasks/logging.rb
 - lib/i18n/tasks/missing_keys.rb
@@ -255,7 +250,6 @@ 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/locale_tree/siblings_spec.rb
 - spec/pattern_scanner_spec.rb
@@ -307,7 +301,6 @@ 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/locale_tree/siblings_spec.rb
 - spec/pattern_scanner_spec.rb

data/lib/i18n/tasks/file_structure.rb

@@ -1,19 +0,0 @@
-# coding: utf-8
-module I18n::Tasks::FileStructure
-  def identify(routes = data.config.read)
-
-  end
-
-
-  class NonLeafVisitor
-    def visit(node)
-      puts "non-leaf: #{node}"
-    end
-  end
-
-  class LeafVisitor
-    def visit(node)
-      puts "leaf: #{node}"
-    end
-  end
-end

data/lib/i18n/tasks/key.rb

@@ -1,48 +0,0 @@
-# coding: utf-8
-require 'i18n/tasks/key/key_group'
-require 'i18n/tasks/key/match_pattern'
-require 'i18n/tasks/key/usages'
-
-module I18n
-  module Tasks
-    # Container for i18n key and its attributes
-    class Key
-      include ::I18n::Tasks::Key::KeyGroup
-      include ::I18n::Tasks::Key::MatchPattern
-      include ::I18n::Tasks::Key::Usages
-
-      attr_accessor :own_attr
-
-      # @param [Array<Key, Value>|Hash|String] key_or_attr
-      # @param [Hash] attr optional
-      def initialize(key_or_attr, own_attr = {})
-        @own_attr = if key_or_attr.is_a?(Array)
-                      {key: key_or_attr[0], value: key_or_attr[1]}.merge(own_attr)
-                    elsif key_or_attr.is_a?(Hash)
-                      key_or_attr.merge(own_attr)
-                    else
-                      (own_attr || {}).merge(key: key_or_attr)
-                    end
-        @own_attr[:key] = @own_attr[:key].to_s
-      end
-
-      def ==(other)
-        self.attr == other.attr
-      end
-
-      def inspect
-        "#<#{self.class.name}#{attr.inspect}>"
-      end
-
-      def key
-        @own_attr[:key]
-      end
-
-      alias to_s key
-
-      def value
-        @own_attr[:value]
-      end
-    end
-  end
-end