i18n-tasks 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b205200e5f46e458947cd7efa0a3f4781555bed
-  data.tar.gz: 3c233c02ca02b64ce1e5b02d2e068bbee0b1db2a
+  metadata.gz: f4ae19f0f97a5f8ae9221b45ef316b08a5efbe62
+  data.tar.gz: 2b957a1c692318da437ca4235aeb2a1b9e47f2b6
 SHA512:
-  metadata.gz: 774d211a16131bcfbf7df07fdb9a0fd7d4926d227df2bb499772af12e12b77f1911dc0b9cf6e39d4f232ed41feb3bbf86781e9ca6d364b7b4d70894690f0b864
-  data.tar.gz: bc56dfc3f345175e329904430678ddbafefcb85a73c068055cd31062dec2b8bd7ab0d6ddb924af410222bdb17b709dd6821ecbadff7b0a9668c9f20a9da9b497
+  metadata.gz: d00e68fb5727c9d95df84b5de56bd57d53a6adc6e9e00e1ce05c16e6f99055b30b0bc9c478dfabba238962a5d75cc75dc75b97ae4724bde1b07e4f07150b396d
+  data.tar.gz: 5bc8932e731220f37abce28f4b637c60ab41ed02b8e3c8ab5f0c273385ae269fae4a996e408a006d9ba59bd95bab1e1599d2cc48670ff828421fe96d4d1380d4

data/.travis.yml

@@ -5,10 +5,6 @@ rvm:
 - 1.9.3
 - jruby-head
 - rbx-2
-matrix:
-  allow_failures:
-  # no keyword argument support in rbx
-  - rvm: rbx-2
 env:
   global:
   - TRAVIS=1

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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
+* Rubinius 2.2.7 compatibility
+
 ## 0.4.5
 
 * Respect tty color setting

data/README.md

@@ -1,12 +1,12 @@
 # i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Gemnasium][badge-gemnasium]][gemnasium]
 
-i18n-tasks finds and manages missing and unused translations in your application.
+i18n-tasks helps you find and manage missing and unused translations.
 
 The default approach to locale data management with gems such as [i18n][i18n-gem] is flawed.
 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 and introduce 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 provides reports on key usage, missing, and unused keys.
+i18n-tasks improves this by i18n-tasks analysing code statically, without running it. It scans calls such as `I18n.t('some.key')` and provides reports on key usage, missing, and unused keys.
 It can also pre-fill missing keys, including from Google Translate, and it can remove unused keys as well.
 
 i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails), or similar, even if it isn't ruby.
@@ -18,11 +18,9 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.4.5'
+gem 'i18n-tasks', '~> 0.5.0'
 ```
 
-i18n-tasks does not load or execute any of the application's code but performs static-only analysic.
-This means you can install the gem and run it on a project without adding it to Gemfile.
 
 ## Usage
 
@@ -311,6 +309,10 @@ translation:
   api_key: <Google Translate API key>
 ```
 
+## Interactive Console
+
+`i18n-tasks irb` starts an IRB session in i18n-tasks context. Type `guide` for more information.
+
 ## RSpec integration
 
 You might want to test for missing and unused translations as part of your test suite.
@@ -335,8 +337,7 @@ describe 'I18n' do
   end
 end
 ```
-
-## XLSX
+### XLSX
 
 Export missing and unused data to XLSX:
 
@@ -344,14 +345,9 @@ Export missing and unused data to XLSX:
 i18n-tasks xlsx-report
 ```
 
+### HTML
 
-## HTML
-
-While i18n-tasks does not provide an HTML version of the report, you can add [one like this](https://gist.github.com/glebm/6887030).
-
----
-
-This was originally developed for [Zuigo](http://zuigo.com/), a platform to organize and discover events.
+While i18n-tasks does not provide an HTML version of the report, you can add [one like this](https://gist.github.com/glebm/bdd3ab6d12d915f0c81b).
 
 [MIT license]: /LICENSE.txt
 [travis]: https://travis-ci.org/glebm/i18n-tasks

data/i18n-tasks.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email         = ['glex.spb@gmail.com']
   s.summary       = %q{Manage translations in ruby applications with the awesome power of static analysis — Edit}
   s.description   = %q{
-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.

data/lib/i18n/tasks.rb

@@ -17,7 +17,5 @@ require 'term/ansicolor'
 require 'erubis'
 
 require 'i18n/tasks/version'
-require 'i18n/tasks/key'
-require 'i18n/tasks/key_group'
 require 'i18n/tasks/base_task'
 

data/lib/i18n/tasks/base_task.rb

@@ -9,7 +9,6 @@ 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'
 
@@ -26,12 +25,15 @@ module I18n
       include GoogleTranslation
       include Logging
       include Configuration
-      include FileStructure
       include Data
 
       def initialize(config = {})
         self.config = config || {}
       end
+
+      def inspect
+        "i18n-tasks BaseTask config: #{config_for_inspect}"
+      end
     end
   end
 end

data/lib/i18n/tasks/commands.rb

@@ -20,8 +20,12 @@ module I18n::Tasks
     end
 
     desc 'show unused translations'
-    cmd :unused do
-      terminal_report.unused_keys
+    opts do
+      on '-l', :locales=, 'Filter by locale (default: all)', on_locale_opt
+    end
+    cmd :unused do |opt = {}|
+      parse_locales! opt
+      terminal_report.unused_keys i18n_task.unused_keys(opt)
     end
 
     desc 'translate missing keys with Google Translate'
@@ -64,7 +68,7 @@ module I18n::Tasks
     end
     cmd :find do |opt = {}|
       opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
-      terminal_report.used_keys i18n_task.used_keys(key_filter: opt[:filter].presence, src_locations: true)
+      terminal_report.used_keys i18n_task.used_tree(key_filter: opt[:filter].presence, source_locations: true)
     end
 
     desc 'normalize translation data: sort and move to the right files'
@@ -81,15 +85,15 @@ module I18n::Tasks
       on '-l', :locales=, 'Locales to remove unused keys from (default: all)', on_locale_opt
     end
     cmd :remove_unused do |opt = {}|
-      parse_locales!(opt)
-      unused_keys = i18n_task.unused_keys
+      parse_locales! opt
+      unused_keys = i18n_task.unused_keys(opt)
       if unused_keys.present?
         terminal_report.unused_keys(unused_keys)
         unless ENV['CONFIRM']
-          exit 1 unless agree(red "All these translations will be removed in #{bold opt[:locales] * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
+          exit 1 unless agree(red "#{unused_keys.leaves.count} translations will be removed in #{bold opt[:locales] * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
         end
         i18n_task.remove_unused!(opt[:locales])
-        $stderr.puts "Removed #{unused_keys.size} keys"
+        $stderr.puts "Removed #{unused_keys.leaves.count} keys"
       else
         $stderr.puts bold green 'No unused keys to remove'
       end
@@ -100,7 +104,6 @@ module I18n::Tasks
       cfg = i18n_task.config_for_inspect.to_yaml
       cfg.sub! /\A---\n/, ''
       cfg.gsub! /^([^\s-].+?:)/, Term::ANSIColor.cyan(Term::ANSIColor.bold('\1'))
-      cfg.gsub! '!ruby/hash:ActiveSupport::HashWithIndifferentAccess', ''
       puts cfg
     end
 
@@ -119,13 +122,10 @@ module I18n::Tasks
       spreadsheet_report.save_report opt[:path]
     end
 
-    desc 'irb session within i18n-tasks context'
+    desc 'REPL 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
+      require 'i18n/tasks/console_context'
+      ::I18n::Tasks::ConsoleContext.start
     end
 
     protected

data/lib/i18n/tasks/configuration.rb

@@ -85,6 +85,11 @@ module I18n::Tasks::Configuration
     @config_sections[:base_locale] ||= (config[:base_locale] || 'en').to_s
   end
 
+  def ignore_config(type = nil)
+    key = type ? "ignore_#{type}" : 'ignore'
+    @config_sections[key] ||= config[key]
+  end
+
   # evaluated configuration (as the app sees it)
   def config_sections
     # init all sections
@@ -94,13 +99,16 @@ module I18n::Tasks::Configuration
     search_config
     relative_roots
     translation_config
+    [nil, :missing, :unused, :eq_base].each do |ignore_type|
+      ignore_config ignore_type
+    end
     @config_sections
   end
 
   def config_for_inspect
     # hide empty sections, stringify keys
-    Hash[config_sections.reject { |k, v| v.empty? }.map { |k, v|
-      [k.to_s, v.respond_to?(:stringify_keys) ? v.stringify_keys : v] }].tap do |h|
+    Hash[config_sections.reject { |k, v| v.nil? || v.empty? }.map { |k, v|
+      [k.to_s, v.respond_to?(:deep_stringify_keys) ? v.deep_stringify_keys : v] }].tap do |h|
       h.each do |_k, v|
         if v.is_a?(Hash) && v.key?('config')
           v.merge! v.delete('config')

data/lib/i18n/tasks/console_context.rb

@@ -0,0 +1,73 @@
+module I18n::Tasks
+  class ConsoleContext < BaseTask
+    def banner
+      puts Messages.banner
+    end
+
+    def guide
+      puts Messages.guide
+    end
+
+    class << self
+      def start
+        require 'irb'
+        IRB.setup nil
+        ctx = IRB::Irb.new.context
+        IRB.conf[:MAIN_CONTEXT] = ctx
+        STDERR.puts Messages.banner
+        require 'irb/ext/multi-irb'
+        IRB.irb nil, new
+      end
+    end
+
+    module Messages
+      include Term::ANSIColor
+      extend self
+
+      def banner
+        bold("i18n-tasks v#{I18n::Tasks::VERSION} IRB") + "\nType #{green 'guide'} to learn more"
+      end
+
+      def guide
+        green(bold "i18n-tasks IRB Quick Start guide") + "\n" + <<-TEXT
+#{yellow 'Data as trees'}
+  data[base_locale]
+  missing_tree(locale, compared_to = base_locale)
+  used_tree(source_locations: false, key_filter: nil)
+  unused_tree(locale)
+  Tree::Siblings['es' => {'hello' => 'Hola'}]
+
+#{yellow 'Traversal'}
+  tree = missing_tree(base_locale)
+  tree.nodes { |node| }
+  tree.nodes.to_a
+  tree.leaves { |node| }
+  tree.each { |root_node| }
+  # also levels, depth_first, and breadth_first
+
+#{yellow 'Select nodes'}
+  tree.select_nodes { |node| } # new tree with only selected nodes
+
+#{yellow 'Match by full key'}
+  tree.select_keys { |key, leaf| } # new tree with only selected keys
+  tree.grep_keys(/hello/)          # grep, using ===
+  tree.keys { |key, leaf| }        # enumerate over [full_key, leaf_node]
+  # Pass {root: true} to include root node in full_key (usually locale)
+
+#{yellow 'Nodes'}
+  node = missing_tree(base_locale).leaves.first
+  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
+  Tree::Node.new(key: 'en')
+
+#{yellow 'Keys'}
+  t(key, locale)
+  key_value?(key, locale)
+  depluralize_key(key, locale) # convert 'hat.one' to 'hat'
+  absolutize_key(key, path)    # '.title' to 'users.index.title'
+        TEXT
+      end
+    end
+  end
+end

data/lib/i18n/tasks/data.rb

@@ -21,12 +21,6 @@ module I18n::Tasks
       data.t(key, locale)
     end
 
-    def missing_tree(locale, compared_to = base_locale)
-      data[compared_to].select_keys(root: false) { |key, node|
-        !key_value?(key, locale) && !ignore_key?(key, :missing)
-      }
-    end
-
     def tree(locale)
       data[locale][locale].children
     end
@@ -57,46 +51,5 @@ module I18n::Tasks
         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
-        update_locale_data(opts[:locale] || base_locale, opts)
-      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 = {})
-      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/adapter/yaml_adapter.rb

@@ -8,7 +8,12 @@ module I18n::Tasks
 
         # @return [Hash] locale tree
         def parse(str, options)
-          YAML.load(str, options || {})
+          if YAML.method(:load).arity.abs == 2
+            YAML.load(str, options || {})
+          else
+            # older jruby and rbx 2.2.7 do not accept options
+            YAML.load(str)
+          end
         end
 
         # @return [String]

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

@@ -74,7 +74,7 @@ module I18n::Tasks
       def t(key, locale)
         tree = self[locale.to_s]
         return unless tree
-        tree[locale][key].try(:hash_or_value)
+        tree[locale][key].try(:value_or_children_hash)
       end
 
       def config=(config)

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

@@ -15,14 +15,14 @@ module I18n::Tasks
         return to_enum(:route, locale, forest) unless block
         out = {}
         not_found = Set.new
-        forest.keys(root: false) do |key, node|
+        forest.keys do |key, node|
           locale_key = "#{locale}.#{key}"
-          path = adapter[locale][locale_key].data[:path]
+          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}(?=\.)/, locale
+            path = path.try :sub, /(^|[\/.])#{base_locale}(?=\.)/, "\\1#{locale}"
           end
 
           if path
@@ -32,10 +32,10 @@ module I18n::Tasks
           end
         end
         out.each do |dest, keys|
-          block.yield dest, forest.select_keys { |key, _| keys.include?(key) }
+          block.yield dest, forest.select_keys(root: true) { |key, _| keys.include?(key) }
         end
         if not_found.present?
-          super(locale, forest.select_keys { |key, _| not_found.include?(key) }, &block)
+          super(locale, forest.select_keys(root: true) { |key, _| not_found.include?(key) }, &block)
         end
       end
 

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

@@ -28,7 +28,7 @@ module I18n::Tasks
         return to_enum(:route, locale, forest) unless block
         locale = locale.to_s
         out = {}
-        forest.keys(root: false) do |key, _node|
+        forest.keys do |key, _node|
           pattern, path = routes.detect { |route| route[0] =~ key }
           if pattern
             key_match = $~
@@ -41,7 +41,7 @@ module I18n::Tasks
         end
         out.each do |dest, keys|
           block.yield dest,
-                      forest.select_keys { |key, _| keys.include?(key) }
+                      forest.select_keys(root: true) { |key, _| keys.include?(key) }
         end
       end