i18n-tasks 0.3.11 → 0.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84ba1f92ba2da94773501e168515c76c3c6c21ab
-  data.tar.gz: 5d72ea2de6df682ab6f57b8f76d051f6d8b0f3e8
+  metadata.gz: 328ef834a8ef2756aa154f9e4eb5207df02486d4
+  data.tar.gz: d3d0d63e4fb566037f64606cdfd2a140928492c1
 SHA512:
-  metadata.gz: 46efbb3c38b02738ee34069bc4d9384603485f5f0aeba4227139596ce7bd383cb5c9b9b2f98ddadacd9c1c28bec47170e137f02856d2b4de56a7d724ab853a76
-  data.tar.gz: a8b7a4968b32960205152674040c913e4032d999ee90f2b48e789593c1f81cfef3264c5f747d34608246548dd9fbbaafb94e7b01f8b825849515f7cf802956b7
+  metadata.gz: 0ea465b2b3799df29d77c5db1c7fdbb5deb824b838399f663ef82411f62dee84f14fef9e34498b958e06e53deacd91bbf53252933f9792ef4ad2f0cd3b2c0a5f
+  data.tar.gz: f0e8d5a760021dd976741f28f06bc5aa2e4fcdc2158573b2eeb9795f8984f6c15c39a46a717f7de44a4bcd8757e858541b74a08230c9433534eb148922d831b2

data/.jrubyrc

@@ -0,0 +1,2 @@
+compat.version=2.0
+

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
 rvm:
-- 2.1.0
+- 2.1.1
 - 2.0.0
-- 1.9.3
 - jruby
 - rbx
+matrix:
+  allow_failures:
+  # no keyword argument support in rbx
+  - rbx
 env:
   global:
   - TRAVIS=1

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 0.4.0 (not yet released)
+
+* In addition to pattern router, a new conservative router that keeps the keys in place. (See [#57](https://github.com/glebm/i18n-tasks/issues/57))
+* `i18n-tasks irb` for debugging
+* This release is a major refactoring to use real trees internally (as opposed to nested hashes).
+Real trees allow for much easier [traversal](/lib/i18n/tasks/data/tree/traversal.rb).
+With these trees, information can be associated with each node, which allows for things like the conservative router.
+
 ## 0.3.11
 
 * Improve plural key handling

data/Gemfile

@@ -3,15 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in i18n-tasks.gemspec
 gemspec
 
-platform :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubysl-mutex_m', '~> 2.0'
-  gem 'psych'
-  group :development do
-    gem 'racc'
-  end
-end
-
 group :development do
   gem 'coveralls', require: false
+  gem 'byebug', platform: :mri, require: false
 end

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.3.10'
+gem 'i18n-tasks', '~> 0.3.11'
 ```
 
 i18n-tasks does not load or execute any of the application's code but performs static-only analysic.
@@ -45,6 +45,7 @@ Available commands:
   remove-unused       remove unused keys
   config              display i18n-tasks configuration
   xlsx-report         save missing and unused translations to an Excel file
+  irb                 irb session within i18n-tasks context
 
 See `<command> --help` for more information on a specific command.
 ```
@@ -90,6 +91,13 @@ i18n-tasks find '{number,currency}.format.*'
 
 ![i18n-screenshot][screenshot-find]
 
+### Find / remove unused keys
+
+```bash
+i18n-tasks unused
+i18n-tasks remove-unused
+```
+
 #### Features
 
 Relative keys (`t '.title'`) and plural keys (`key.{one,many,other,...}`) are fully supported.
@@ -144,12 +152,13 @@ data:
 
 #### Multiple locale files
 
-Use `data.read` and `data.write` options to work with locale data spread over multiple files.
+Use `data` options to work with locale data spread over multiple files.
+
+`data.read` accepts a list of file globs to read from per-locale:
 
 ```
 # config/i18n-tasks.yml
 data:
-  # a list of file globs to read from per-locale
   read:
     # read from namespaced files, e.g. simple_form.en.yml
     - 'config/locales/*.%{locale}.yml'
@@ -157,6 +166,18 @@ data:
     - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
     # default
     - 'config/locales/%{locale}.yml'
+```
+
+For writing to locale files i18n-tasks provides 2 options.
+
+##### Pattern router
+
+Pattern router organizes keys based on a list of key patterns, as in the example below:
+
+```
+data:
+  # pattern_router is default
+  router: pattern_router
   # a list of {key pattern => file} routes, matched top to bottom
   write:
     # write models.* and views.* keys to the respective files
@@ -167,6 +188,18 @@ data:
     - 'config/locales/%{locale}.yml'
 ```
 
+##### Conservative router (v0.4.0+)
+
+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.
+
+```
+data:
+  router: conservative_router
+  write:
+    - 'config/locales/%{locale}.yml'
+```
+
 #### Key pattern syntax
 
 | syntax       | description                                               |

data/Rakefile

@@ -3,3 +3,9 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
+task :irb do
+  # $: << File.expand_path('lib', __FILE__)
+  require 'i18n/tasks'
+  require 'i18n/tasks/commands'
+  ::I18n::Tasks::Commands.new.irb
+end

data/bin/i18n-tasks

@@ -11,7 +11,9 @@ err = proc { |message, exit_code|
 
 command = nil
 begin
-  slop = Slop.parse(help: true) do
+  args = ARGV.dup
+  args = ['--help'] if args.empty?
+  slop = Slop.parse(args, help: true) do
     on('-v', '--version', 'Print the version') {
       puts I18n::Tasks::VERSION
       exit

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+---
+en:
+  y: 3
+  z: 4

data/config/locales/es.yml

@@ -0,0 +1 @@
+--- {}

data/i18n-tasks.gemspec

@@ -29,11 +29,11 @@ It can also can pre-fill missing keys, including from Google Translate, and it c
 
   s.add_dependency 'erubis'
   s.add_dependency 'activesupport'
-  s.add_dependency 'easy_translate', '>= 0.4.0'
+  s.add_dependency 'easy_translate', '>= 0.5.0'
   s.add_dependency 'term-ansicolor'
   s.add_dependency 'terminal-table'
   s.add_dependency 'highline'
-  s.add_dependency 'slop', '>= 3.4.7'
+  s.add_dependency 'slop', '>= 3.5.0'
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'

data/lib/i18n/tasks.rb

@@ -1,3 +1,12 @@
+# define all the modules to be able to use ::
+module I18n
+  module Tasks
+    module Data
+    end
+  end
+end
+
+
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/delegation'
@@ -11,8 +20,3 @@ require 'i18n/tasks/key'
 require 'i18n/tasks/key_group'
 require 'i18n/tasks/base_task'
 
-module I18n
-  module Tasks
-
-  end
-end

data/lib/i18n/tasks/base_task.rb

@@ -8,6 +8,7 @@ require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
 require 'i18n/tasks/fill_tasks'
+require 'i18n/tasks/file_structure'
 require 'i18n/tasks/data'
 require 'i18n/tasks/configuration'
 
@@ -24,15 +25,12 @@ module I18n
       include GoogleTranslation
       include Logging
       include Configuration
+      include FileStructure
       include Data
 
       def initialize(config = {})
         self.config = config || {}
       end
-
-      def in_task(&block)
-        instance_exec(&block)
-      end
     end
   end
 end

data/lib/i18n/tasks/commands.rb

@@ -117,6 +117,15 @@ module I18n::Tasks
       spreadsheet_report.save_report opt[:path]
     end
 
+    desc 'irb session within i18n-tasks context'
+    cmd :irb do
+      require 'irb'
+      IRB.setup nil
+      IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+      require 'irb/ext/multi-irb'
+      IRB.irb nil, i18n_task
+    end
+
     protected
 
     def terminal_report

data/lib/i18n/tasks/data.rb

@@ -1,78 +1,95 @@
 require 'i18n/tasks/data/file_system'
 
-module I18n::Tasks::Data
-  # I18n data provider
-  # @see I18n::Tasks::Data::FileSystem
-  def data
-    @data ||= begin
-      conf    = (config[:data] || {}).with_indifferent_access
-      adapter = (conf[:adapter].presence || conf[:class].presence || :file_system).to_s
-      if adapter !~ /[A-Z]/
-        adapter = "I18n::Tasks::Data::#{adapter.camelize}"
+module I18n::Tasks
+  module Data
+
+    # I18n data provider
+    # @see I18n::Tasks::Data::FileSystem
+    def data
+      @data ||= begin
+        conf    = (config[:data] || {}).with_indifferent_access
+        adapter = (conf[:adapter].presence || conf[:class].presence || :file_system).to_s
+        if adapter !~ /[A-Z]/
+          adapter = "I18n::Tasks::Data::#{adapter.camelize}"
+        end
+        adapter.constantize.new(conf.except(:adapter, :class).merge(base_locale: base_locale))
       end
-      adapter.constantize.new(conf.except(:adapter, :class))
     end
-  end
 
-  def t(key, locale = base_locale)
-    data.t(key, locale)
-  end
+    def t(key, locale = base_locale)
+      data.t(key, locale)
+    end
 
-  def t_proc(locale = base_locale)
-    @t_proc         ||= {}
-    @t_proc[locale] ||= proc { |key| t(key, locale) }
-  end
+    def tree(locale)
+      data[locale][locale].children
+    end
 
-  # whether the value for key exists in locale (defaults: base_locale)
-  def key_value?(key, locale = base_locale)
-    t(key, locale).present?
-  end
+    def node(key, locale = base_locale)
+      data[locale]["#{locale}.#{key}"]
+    end
 
-  # write to store, normalizing all data
-  def normalize_store!(from = nil)
-    from = self.locales unless from
-    Array(from).each do |target_locale|
-      # the store itself handles normalization
-      data[target_locale] = data[target_locale]
+    def build_tree(hash)
+      I18n::Tasks::Data::Tree::Siblings.from_nested_hash(hash)
     end
-  end
 
-  # if :locales option present, call update_locale_data for each locale
-  # otherwise, call update_locale_data for :locale option or base locale
-  # @option opts [Array] :locales
-  # @option opts [String] :locale
-  def update_data(opts = {})
-    if opts.key?(:locales)
-      locales = (Array(opts[:locales]).presence || self.locales).map(&:to_s)
-      # make sure base_locale always comes first if present
-      locales = [base_locale] + (locales - [base_locale]) if locales.include?(base_locale)
-      opts    = opts.except(:locales)
-      locales.each { |locale| update_locale_data(locale, opts.merge(locale: locale)) }
-    else
-      update_locale_data(opts[:locale] || base_locale, opts)
+    def t_proc(locale = base_locale)
+      @t_proc         ||= {}
+      @t_proc[locale] ||= proc { |key| t(key, locale) }
     end
-  end
 
-  # @param locale
-  # @option opts [Array|Proc] :keys keys to update, if proc call with locale
-  # @option opts [String|Proc] value, if proc call with each key
-  # @option opts [String|Proc] values, if proc call with all the keys
-  def update_locale_data(locale, opts = {})
-    keys = opts[:keys]
-    keys = keys.call(locale) if keys.respond_to?(:call)
-    return if keys.empty?
+    # whether the value for key exists in locale (defaults: base_locale)
+    def key_value?(key, locale = base_locale)
+      !t(key, locale).nil?
+    end
 
-    values = opts[:values]
-    values = values.call(keys, locale) if values.respond_to?(:call)
-    values ||= begin
-      value = opts[:value] or raise 'pass value or values'
-      if value.respond_to?(:call)
-        keys.map { |key| value.call(key, locale) }
+    # write to store, normalizing all data
+    def normalize_store!(from = nil)
+      from = self.locales unless from
+      Array(from).each do |target_locale|
+        # the store itself handles normalization
+        data[target_locale] = data[target_locale]
+      end
+    end
+
+    # if :locales option present, call update_locale_data for each locale
+    # otherwise, call update_locale_data for :locale option or base locale
+    # @option opts [Array] :locales
+    # @option opts [String] :locale
+    def update_data(opts = {})
+      if opts.key?(:locales)
+        locales = (Array(opts[:locales]).presence || self.locales).map(&:to_s)
+        # make sure base_locale always comes first if present
+        locales = [base_locale] + (locales - [base_locale]) if locales.include?(base_locale)
+        opts    = opts.except(:locales)
+        locales.each { |locale| update_locale_data(locale, opts.merge(locale: locale)) }
       else
-        [value] * keys.size
+        update_locale_data(opts[:locale] || base_locale, opts)
       end
     end
-    data[locale] += keys.map(&:to_s).zip(values)
-  end
 
+    # @param locale
+    # @option opts [Array|Proc] :keys keys to update, if proc call with locale
+    # @option opts [String|Proc] value, if proc call with each key
+    # @option opts [String|Proc] values, if proc call with all the keys
+    def update_locale_data(locale, opts = {})
+      locale = locale.to_s
+      keys   = opts[:keys]
+      keys   = keys.call(locale) if keys.respond_to?(:call)
+      return if keys.empty?
+
+      values       = opts[:values]
+      values       = values.call(keys, locale) if values.respond_to?(:call)
+      values       ||= begin
+        value = opts[:value] or raise 'pass value or values'
+        if value.respond_to?(:call)
+          keys.map { |key| value.call(key, locale) }
+        else
+          [value] * keys.size
+        end
+      end
+      data[locale] = tree(locale).merge!(
+          Tree::Siblings.from_flat_pairs keys.map(&:to_s).zip(values)
+      ).parent
+    end
+  end
 end

data/lib/i18n/tasks/data/file_formats.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module I18n
   module Tasks
     module Data
@@ -19,6 +21,7 @@ module I18n
         end
 
         def write_tree(path, tree)
+          ::FileUtils.mkpath(File.dirname path)
           ::File.open(path, 'w') { |f|
             adapter_name, adapter_pattern, adapter = adapter_for(path)
             adapter_options = (config[adapter_name] || {})[:write]

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

@@ -1,12 +1,12 @@
-require 'i18n/tasks/data/locale_tree'
-require 'i18n/tasks/data/router'
+require 'i18n/tasks/data/tree/node'
+require 'i18n/tasks/data/router/pattern_router'
+require 'i18n/tasks/data/router/conservative_router'
 require 'i18n/tasks/data/file_formats'
 require 'i18n/tasks/key_pattern_matching'
 
 module I18n::Tasks
   module Data
     class FileSystemBase
-      include ::I18n::Tasks::Data::Router
       include ::I18n::Tasks::Data::FileFormats
 
       attr_reader :config
@@ -20,48 +20,32 @@ module I18n::Tasks
         self.config = config
       end
 
-      def t(key, locale)
-        get(locale).t(key)
-      end
-
-      def config=(config)
-        @config = DEFAULTS.deep_merge((config || {}).with_indifferent_access)
-        @config[:write] = compile_routes @config[:write]
-        reload
-      end
-
       # get locale tree
       def get(locale)
-        locale               = locale.to_s
-        @locale_data[locale] ||= begin
-          hash = config[:read].map do |path|
-            Dir.glob path % {locale: locale}
-          end.reduce(:+).map do |locale_file|
-            load_file locale_file
-          end.inject({}) do |hash, locale_data|
-            hash.deep_merge! locale_data || {}
-            hash
-          end[locale.to_s] || {}
-          LocaleTree.new locale, hash.to_hash
-        end
+        locale         = locale.to_s
+        @trees         ||= {}
+        @trees[locale] ||= Tree::Siblings[locale => {}].merge!(
+            read_locale locale
+        )
       end
 
       alias [] get
 
       # set locale tree
-      def set(locale, values)
+      def set(locale, tree)
         locale = locale.to_s
-        route_values config[:write], values, locale do |path, tree|
-          write_tree path, tree
+        router.route locale, tree do |path, tree_slice|
+          write_tree path, tree_slice
         end
-        @locale_data[locale] = nil
+        @trees.delete(locale) if @trees
+        @available_locales = nil
       end
 
       alias []= set
 
       # @return self
       def reload
-        @locale_data       = {}
+        @trees             = nil
         @available_locales = nil
         self
       end
@@ -85,6 +69,45 @@ module I18n::Tasks
           locales
         end
       end
+
+      def t(key, locale)
+        tree = self[locale.to_s]
+        return unless tree
+        tree[locale][key].try(:hash_or_value)
+      end
+
+      def config=(config)
+        @config = DEFAULTS.deep_merge((config || {}).with_indifferent_access)
+        reload
+      end
+
+      protected
+
+      def read_locale(locale)
+        Array(config[:read]).map do |path|
+          Dir.glob path % {locale: locale}
+        end.reduce(:+).map do |path|
+          [path.freeze, load_file(path) || {}]
+        end.map do |path, data|
+          Data::Tree::Siblings.from_nested_hash(data).tap do |s|
+            s.leaves { |x| x.data[:path] = path }
+          end
+        end.reduce(:merge!) || Tree::Siblings.null
+      end
+
+      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