i18n-tasks 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ae19f0f97a5f8ae9221b45ef316b08a5efbe62
-  data.tar.gz: 2b957a1c692318da437ca4235aeb2a1b9e47f2b6
+  metadata.gz: f8f89d95e642baf84d0f2db83a184cdbfaca5fdb
+  data.tar.gz: a2051af98f8ea1c9eac7ee7b201ac1680e30b82c
 SHA512:
-  metadata.gz: d00e68fb5727c9d95df84b5de56bd57d53a6adc6e9e00e1ce05c16e6f99055b30b0bc9c478dfabba238962a5d75cc75dc75b97ae4724bde1b07e4f07150b396d
-  data.tar.gz: 5bc8932e731220f37abce28f4b637c60ab41ed02b8e3c8ab5f0c273385ae269fae4a996e408a006d9ba59bd95bab1e1599d2cc48670ff828421fe96d4d1380d4
+  metadata.gz: 6856046b53147ee028f7491f975694769ec069bd3740f288fd44b069764562ca818a253b333520f3bc670091d0fa4dfba4bed25b9e36c48bbbdfa726c10431a7
+  data.tar.gz: 258eae7c4f1909161f8fb494e3bc3d40afa7998058f4e0fbd836838340eec38680d0bc61b88a8234adc4166875a6f5003c864038db75204ca5f79f13b844c707

data/CHANGES.md

@@ -1,8 +1,14 @@
+## 0.5.1
+
+* Fix [conservative router](https://github.com/glebm/i18n-tasks#conservative-router).
+* Default router is now the default.
+
 ## 0.5.0
 
 * internals refactored to use trees everywhere
 * type `guide` in `i18n-tasks irb` to learn more about the commands
 * (remove-)unused tasks now work per locale
+* `ignore` settings are shown on `i18n-tasks config`
 * Rubinius 2.2.7 compatibility
 
 ## 0.4.5

data/README.md

@@ -18,7 +18,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.5.0'
+gem 'i18n-tasks', '~> 0.5.1'
 ```
 
 
@@ -173,6 +173,14 @@ data:
     - 'config/locales/%{locale}.yml'
 ```
 
+#### Key pattern syntax
+
+| syntax       | description                                               |
+|:------------:|:----------------------------------------------------------|
+|      `*`     | matches everything                                        |
+|      `:`     | matches a single key                                      |
+|   `{a, b.c}` | match any in set, can use `:` and `*`, match is captured  |
+
 For writing to locale files i18n-tasks provides 2 options.
 
 ##### Pattern router
@@ -181,7 +189,6 @@ Pattern router organizes keys based on a list of key patterns, as in the example
 
 ```
 data:
-  # pattern_router is default
   router: pattern_router
   # a list of {key pattern => file} routes, matched top to bottom
   write:
@@ -197,6 +204,7 @@ data:
 
 Conservative router keeps the keys where they are found, or infers the path from base locale.
 If the key is completely new, conservative router will fall back to the pattern router behaviour.
+Conservative router is the default router.
 
 ```
 data:
@@ -205,14 +213,6 @@ data:
     - 'config/locales/%{locale}.yml'
 ```
 
-#### Key pattern syntax
-
-| syntax       | description                                               |
-|:------------:|:----------------------------------------------------------|
-|      `*`     | matches everything                                        |
-|      `:`     | matches a single key                                      |
-|   `{a, b.c}` | match any in set, can use `:` and `*`, match is captured  |
-
 #### Custom adapters
 
 If you store data somewhere but in the filesystem, e.g. in the database or mongodb, you can implement a custom adapter.

data/lib/i18n/tasks/base_task.rb

@@ -9,6 +9,7 @@ require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
 require 'i18n/tasks/fill_tasks'
+require 'i18n/tasks/locale_pathname'
 require 'i18n/tasks/data'
 require 'i18n/tasks/configuration'
 

data/lib/i18n/tasks/commands.rb

@@ -74,10 +74,11 @@ module I18n::Tasks
     desc 'normalize translation data: sort and move to the right files'
     opts do
       on '-l', :locales=, 'Locales to normalize (default: all)', on_locale_opt
+      on '-p', :pattern_router, 'Use pattern router, regardless of config.', argument: false, optional: true
     end
     cmd :normalize do |opt = {}|
       parse_locales! opt
-      i18n_task.normalize_store! opt[:locales]
+      i18n_task.normalize_store! opt[:locales], opt[:pattern_router]
     end
 
     desc 'remove unused keys'

data/lib/i18n/tasks/console_context.rb

@@ -31,11 +31,11 @@ module I18n::Tasks
       def guide
         green(bold "i18n-tasks IRB Quick Start guide") + "\n" + <<-TEXT
 #{yellow 'Data as trees'}
-  data[base_locale]
+  tree(locale)
   missing_tree(locale, compared_to = base_locale)
   used_tree(source_locations: false, key_filter: nil)
   unused_tree(locale)
-  Tree::Siblings['es' => {'hello' => 'Hola'}]
+  build_tree('es' => {'hello' => 'Hola'})
 
 #{yellow 'Traversal'}
   tree = missing_tree(base_locale)
@@ -55,7 +55,7 @@ module I18n::Tasks
   # Pass {root: true} to include root node in full_key (usually locale)
 
 #{yellow 'Nodes'}
-  node = missing_tree(base_locale).leaves.first
+  node = node(key, locale)
   node.key      # only the part after the last dot
   node.full_key # full key. Includes root key, pass {root: false} to override.
   # also: value, value_or_children_hash, data, walk_to_root, walk_from_root

data/lib/i18n/tasks/data/file_system_base.rb

@@ -82,6 +82,25 @@ module I18n::Tasks
         reload
       end
 
+      def with_router(router)
+        router_was  = self.router
+        self.router = router
+        yield
+      ensure
+        self.router = router_was
+      end
+
+      def router
+        @router ||= begin
+          name = @config[:router].presence || 'conservative_router'
+          if name[0] != name[0].upcase
+            name = "I18n::Tasks::Data::Router::#{name.classify}"
+          end
+          name.constantize.new(self, @config)
+        end
+      end
+      attr_writer :router
+
       protected
 
       def read_locale(locale)
@@ -99,16 +118,6 @@ module I18n::Tasks
       def base_locale
         config[:base_locale]
       end
-
-      def router
-        @router ||= begin
-          name = @config[:router].presence || 'pattern_router'
-          if name[0] != name[0].upcase
-            name = "I18n::Tasks::Data::Router::#{name.classify}"
-          end
-          name.constantize.new(self, @config)
-        end
-      end
     end
   end
 end

data/lib/i18n/tasks/data/router/conservative_router.rb

@@ -13,30 +13,34 @@ module I18n::Tasks
 
       def route(locale, forest, &block)
         return to_enum(:route, locale, forest) unless block
-        out = {}
+        out = Hash.new { |hash, key| hash[key] = Set.new }
         not_found = Set.new
         forest.keys do |key, node|
           locale_key = "#{locale}.#{key}"
           path = adapter[locale][locale_key].try(:data).try(:[], :path)
-
           # infer from base
           unless path
             path = base_tree["#{base_locale}.#{key}"].try(:data).try(:[], :path)
-            path = path.try :sub, /(^|[\/.])#{base_locale}(?=\.)/, "\\1#{locale}"
+            path = LocalePathname.replace_locale(path, base_locale, locale)
           end
-
           if path
-            (out[path] ||= Set.new) << locale_key
+            out[path] << locale_key
           else
             not_found << locale_key
           end
         end
+
+        if not_found.present?
+          # fall back to pattern router
+          not_found_tree = forest.select_keys(root: true) { |key, _| not_found.include?(key) }
+          super(locale, not_found_tree) { |path, tree|
+            out[path] += tree.key_names(root: true)
+          }
+        end
+
         out.each do |dest, keys|
           block.yield dest, forest.select_keys(root: true) { |key, _| keys.include?(key) }
         end
-        if not_found.present?
-          super(locale, forest.select_keys(root: true) { |key, _| not_found.include?(key) }, &block)
-        end
       end
 
       protected

data/lib/i18n/tasks/data.rb

@@ -30,7 +30,7 @@ module I18n::Tasks
     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
 
     def t_proc(locale = base_locale)
@@ -44,11 +44,14 @@ module I18n::Tasks
     end
 
     # write to store, normalizing all data
-    def normalize_store!(from = nil)
+    def normalize_store!(from = nil, pattern_router = false)
       from = self.locales unless from
-      Array(from).each do |target_locale|
-        # the store itself handles normalization
-        data[target_locale] = data[target_locale]
+      router = pattern_router ? ::I18n::Tasks::Data::Router::PatternRouter.new(data, data.config) : data.router
+      data.with_router(router) do
+        Array(from).each do |target_locale|
+          # store handles normalization
+          data[target_locale] = data[target_locale]
+        end
       end
     end
   end

data/lib/i18n/tasks/fill_tasks.rb

@@ -3,10 +3,13 @@ module I18n::Tasks
   module FillTasks
     def fill_missing_value(opts = {})
       value = opts[:value] || ''
+      base  = opts[:base_locale] || base_locale
       locales_for_update(opts).each do |locale|
-        data[locale] = data[locale].merge! missing_tree(locale).keys { |key, node|
+        m = missing_tree(locale, base).keys { |key, node|
           node.value = value.respond_to?(:call) ? value.call(key, locale, node) : value
+          node.data[:path] = LocalePathname.replace_locale(node.data[:path], base, locale) if node.data.key?(:path)
         }
+        data[locale] = data[locale].merge! m
       end
     end
 

data/lib/i18n/tasks/locale_pathname.rb

@@ -0,0 +1,9 @@
+module I18n::Tasks
+  module LocalePathname
+    extend self
+
+    def replace_locale(path, from, to)
+      path.try :sub, /(^|[\/.])#{from}(?=\.)/, "\\1#{to}"
+    end
+  end
+end

data/lib/i18n/tasks/reports/terminal.rb

@@ -51,7 +51,7 @@ module I18n
                   line.strip!
                   line.sub!(/(.*?)(#{key})(.*)$/) { dark($1) + underline($2) + dark($3) }
                 }
-                puts "  #{green "#{u[:path]}:#{u[:line_num]}"} #{line}"
+                puts "  #{green "#{u[:src_path]}:#{u[:line_num]}"} #{line}"
               end
             end
           else

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

@@ -102,7 +102,7 @@ module I18n::Tasks::Scanners
     end
 
     def src_location(path, text, src_pos)
-      src = {path: path}
+      src = {src_path: path}
       if @record_src_loc
         src.merge!(src_text_location(text, src_pos))
       end

data/lib/i18n/tasks/version.rb

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

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

@@ -5,6 +5,7 @@ locales: [es]
 data:
   # The default file adapter supports YAML and JSON files. You can provide a class name here.
   adapter: file_system
+  #router: pattern_router
   # adapter options
   read:
     - 'config/locales/%{locale}.yml'

data/spec/i18n_tasks_spec.rb

@@ -62,7 +62,7 @@ describe 'i18n-tasks' do
     it 'moves keys to the corresponding files as per data.write' do
       in_test_app_dir {
         expect(File).to_not exist 'config/locales/devise.en.yml'
-        run_cmd :normalize
+        run_cmd :normalize, pattern_router: true
         expect(YAML.load_file('config/locales/devise.en.yml')['en']['devise']['a']).to eq 'EN_TEXT'
       }
     end
@@ -105,10 +105,10 @@ describe 'i18n-tasks' do
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
       }
+      run_cmd :normalize, pattern_router: true
       run_cmd :add_missing, locales: 'all', placeholder: 'TRME'
       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'
       }
     end

data/spec/used_keys_spec.rb

@@ -23,15 +23,15 @@ h1 = t 'b'
         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'}]
+            [{pos: 6, line_num: 1, line_pos: 7, line: "div = t 'a'", src_path: 'a.html.slim'},
+             {pos: 18, line_num: 2, line_pos: 7, line: "  p = t 'a'", src_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'}]
+            [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", src_path: 'a.html.slim'}]
     )
   end
 
@@ -42,7 +42,7 @@ h1 = t 'b'
         used_keys.leaves.first,
         'b',
         source_locations:
-            [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}]
+            [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", src_path: 'a.html.slim'}]
     )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - glebm
@@ -227,6 +227,7 @@ files:
 - lib/i18n/tasks/google_translation.rb
 - lib/i18n/tasks/ignore_keys.rb
 - lib/i18n/tasks/key_pattern_matching.rb
+- lib/i18n/tasks/locale_pathname.rb
 - lib/i18n/tasks/logging.rb
 - lib/i18n/tasks/missing_keys.rb
 - lib/i18n/tasks/plural_keys.rb