i18n-tasks 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81678a0e44f5c7593956fbe37f122aff4cdb7fc
-  data.tar.gz: e5bbc6aa629d379ab04551f00d706e714b2b845c
+  metadata.gz: f92285f463714c33d1c83515dcd2aaf6767e4663
+  data.tar.gz: b82019313500a6dc1a2122b56d0bc118086071a3
 SHA512:
-  metadata.gz: c5151ef672fedd86b317900c2621b03a09748e3275efd39221626f101dd895a53336c76ef73e2e973287c40af6d38130323cc89fa178fe0e2bce92fc3d705120
-  data.tar.gz: ec27bed50ae7691827b57619437ce3e3b943a0b01b658e7d350a12ef0af5fa20b921209534ec766e46a8e9864f90fbc67f909c3f15d097263bd0a35845378997
+  metadata.gz: 1cd49cb9ec3101e8ef38c75f5cace26f4dcf2afc613a89b15ea9741ec0ab420203d04039aefe79a5996cdef5736f2eb74b2503e076e2fd29cd7e05c6fda5258a
+  data.tar.gz: 4fec3b2eb4ad06d80429b653ede00d06522f4710ebdcdb21341d5723d2b696812086caeab0415abc8965878fd0d1d058f3346da293725b535c2a7900da36d9ec

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.3.7
+
+* Catch Errno::EPIPE to allow `i18n-tasks <command> | head` for large reports
+* Improved i18n-tasks config output
+
 ## v0.3.6
 
 * fix issue with Google Translate

data/README.md

@@ -2,13 +2,14 @@
 
 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.
+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, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
+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 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.
+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.
+It can also can 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.
 
 <img width="534" height="288" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
 
@@ -16,9 +17,12 @@ and can also remove unused keys.
 
 Add to Gemfile:
 
-  ```ruby
-  gem 'i18n-tasks', '~> 0.3.5'
-  ```
+```ruby
+gem 'i18n-tasks', '~> 0.3.7'
+```
+
+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
 
@@ -295,4 +299,5 @@ This was originally developed for [Zuigo](http://zuigo.com/), a platform to orga
 [badge-code-climate]: https://codeclimate.com/github/glebm/i18n-tasks.png
 [badge-flattr]: https://api.flattr.com/button/flattr-badge-large.png
 [flattr]: https://flattr.com/submit/auto?user_id=glebm&url=https%3A%2F%2Fgithub.com%2Fglebm%2Fi18n-tasks
+[i18n-gem]: https://github.com/svenfuchs/i18n "svenfuchs/i18n on Github"
 [screenshot-find]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot"

data/bin/i18n-tasks

@@ -24,16 +24,20 @@ end
 if command
   cmd  = ::I18n::Tasks::Commands.new
   meth = command[0]
-  opts = command[1].to_hash.reject{ |k, v| v.nil? }
+  opts = command[1].to_hash.reject { |k, v| v.nil? }
   args = command[2]
-
-  if opts.empty? && args.empty?
-    ::I18n::Tasks.log_verbose "run #{meth.tr('_', '-')} without arguments"
-    cmd.send meth
-  else
-    opts = opts.merge(arguments: args) unless args.empty?
-    ::I18n::Tasks.log_verbose "run #{meth.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
-    cmd.send meth, opts
+  begin
+    if opts.empty? && args.empty?
+      cmd.log_verbose "run #{meth.tr('_', '-')} without arguments"
+      cmd.send meth
+    else
+      opts = opts.merge(arguments: args) unless args.empty?
+      cmd.log_verbose "run #{meth.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
+      cmd.send meth, opts
+    end
+  rescue Errno::EPIPE
+    # ignore Errno::EPIPE which is throw when pipe breaks, e.g.:
+    # i18n-tasks missing | head
   end
 else
   STDERR.puts Term::ANSIColor.red "Command unknown: #{ARGV[0]}" if ARGV[0]

data/i18n-tasks.gemspec

@@ -12,13 +12,8 @@ Gem::Specification.new do |s|
   s.description   = %q{
 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.
 }
   s.homepage      = 'https://github.com/glebm/i18n-tasks'
   if s.respond_to?(:metadata=)

data/lib/i18n/tasks.rb

@@ -13,17 +13,6 @@ require 'i18n/tasks/base_task'
 
 module I18n
   module Tasks
-    CONFIG_FILES = %w(
-      config/i18n-tasks.yml config/i18n-tasks.yml.erb
-      i18n-tasks.yml i18n-tasks.yml.erb
-    )
-    class << self
-      def config
-        file = CONFIG_FILES.detect { |f| File.exists?(f) }
-        file = YAML.load(Erubis::Eruby.new(File.read(file)).result) if file
-        HashWithIndifferentAccess.new.merge(file.presence || {})
-      end
-      include ::I18n::Tasks::Logging
-    end
+
   end
 end

data/lib/i18n/tasks/base_task.rb

@@ -1,33 +1,30 @@
 # coding: utf-8
-require 'i18n/tasks/configuration'
 require 'i18n/tasks/key_pattern_matching'
-require 'i18n/tasks/relative_keys'
+require 'i18n/tasks/logging'
 require 'i18n/tasks/plural_keys'
 require 'i18n/tasks/used_keys'
-require 'i18n/tasks/translation_data'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
 require 'i18n/tasks/fill_tasks'
-require 'i18n/tasks/logging'
+require 'i18n/tasks/data'
+require 'i18n/tasks/configuration'
 
 module I18n
   module Tasks
     class BaseTask
-      include Configuration
       include KeyPatternMatching
-      include IgnoreKeys
-      include DataTraversal
-      include RelativeKeys
       include PluralKeys
       include UsedKeys
+      include IgnoreKeys
       include MissingKeys
       include UnusedKeys
-      include TranslationData
       include FillTasks
       include GoogleTranslation
       include Logging
+      include Configuration
+      include Data
 
       def initialize(config = {})
         self.config = config || {}

data/lib/i18n/tasks/commands.rb

@@ -14,7 +14,7 @@ module I18n::Tasks
       on '-t', :types, 'Filter by type (types: missing_from_base, eq_base, missing_from_locale)', as: Array, delimiter: /[+:,]/, argument: true, optional: false
     end
     cmd :missing do |opt = {}|
-      opt[:locales] = locales_opt_or_args(opt)
+      parse_locales! opt
       terminal_report.missing_keys i18n_task.missing_keys(opt)
     end
 
@@ -30,7 +30,7 @@ module I18n::Tasks
     end
     cmd :translate_missing do |opt = {}|
       opt[:from] = base_locale if opt[:from].blank? || opt[:from] == 'base'
-      opt[:locales] = locales_opt_or_args(opt)
+      parse_locales! opt
       i18n_task.fill_missing_google_translate opt
     end
 
@@ -40,9 +40,8 @@ module I18n::Tasks
       on '-p', :placeholder, 'Value for empty keys (default: base value or key.humanize)', argument: true, optional: false
     end
     cmd :add_missing do |opt = {}|
-      opt[:locales] = locales_opt_or_args(opt)
-      opt[:value] ||= opt.delete(:placeholder)
-      opt[:value] ||= proc { |key, locale|
+      parse_locales! opt
+      opt[:value] ||= opt.delete(:placeholder) || proc { |key, locale|
         # default to base value or key.humanize
         locale == base_locale && t(locale, base_locale) || key.split('.').last.to_s.humanize
       }
@@ -55,11 +54,7 @@ module I18n::Tasks
     end
     cmd :find do |opt = {}|
       opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
-      filter = opt[:filter].is_a?(String) ? opt[:filter].tr('+', ',') : nil
-      used_keys = i18n_task.scanner.with_key_filter(filter) {
-        i18n_task.used_keys true
-      }
-      terminal_report.used_keys used_keys
+      terminal_report.used_keys i18n_task.used_keys(key_filter: opt[:filter].presence, src_locations: true)
     end
 
     desc 'normalize translation data: sort and move to the right files'
@@ -67,7 +62,8 @@ module I18n::Tasks
       on '-l', :locales=, 'Locales to normalize (default: all)', on_locale_opt
     end
     cmd :normalize do |opt = {}|
-      i18n_task.normalize_store! locales_opt_or_args(opt)
+      parse_locales! opt
+      i18n_task.normalize_store! opt[:locales]
     end
 
     desc 'remove unused keys'
@@ -75,14 +71,14 @@ module I18n::Tasks
       on '-l', :locales=, 'Locales to remove unused keys from (default: all)', on_locale_opt
     end
     cmd :remove_unused do |opt = {}|
-      locales = locales_opt_or_args(opt)
+      parse_locales!(opt)
       unused_keys = i18n_task.unused_keys
       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 locales * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
+          exit 1 unless agree(red "All these translations will be removed in #{bold opt[:locales] * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
         end
-        i18n_task.remove_unused!(locales)
+        i18n_task.remove_unused!(opt[:locales])
         $stderr.puts "Removed #{unused_keys.size} keys"
       else
         $stderr.puts bold green 'No unused keys to remove'
@@ -91,7 +87,10 @@ module I18n::Tasks
 
     desc 'display i18n-tasks configuration'
     cmd :config do
-      puts i18n_task.config_for_inspect.to_yaml.sub(/\A---\n/, '').gsub('!ruby/hash:ActiveSupport::HashWithIndifferentAccess', '')
+      cfg = i18n_task.config_for_inspect.to_yaml
+      cfg.sub! /\A---\n/, ''
+      cfg.gsub! /^([^\s-].+?)$/, Term::ANSIColor.cyan(Term::ANSIColor.bold('\1'))
+      puts cfg
     end
 
     desc 'save missing and unused translations to an Excel file'

data/lib/i18n/tasks/commands_base.rb

@@ -18,8 +18,8 @@ module I18n::Tasks
       end
     end
 
-    def locales_opt_or_args(opt)
-      locales_opt(opt[:arguments].presence || opt[:locales]).tap do |locales|
+    def parse_locales!(opt)
+      opt[:locales] = locales_opt(opt[:arguments].presence || opt[:locales]).tap do |locales|
         log_verbose "locales for the command are #{locales.inspect}"
       end
     end

data/lib/i18n/tasks/configuration.rb

@@ -5,8 +5,18 @@ module I18n::Tasks::Configuration
     @config || (self.config = {})
   end
 
+  CONFIG_FILES = %w(
+      config/i18n-tasks.yml config/i18n-tasks.yml.erb
+      i18n-tasks.yml i18n-tasks.yml.erb
+  )
+  def file_config
+    file = CONFIG_FILES.detect { |f| File.exists?(f) }
+    file = YAML.load(Erubis::Eruby.new(File.read(file)).result) if file
+    {}.with_indifferent_access.merge(file.presence || {})
+  end
+
   def config=(conf)
-    @config          = I18n::Tasks.config.deep_merge(conf)
+    @config          = file_config.deep_merge(conf)
     @config_sections = {}
     @config
   end
@@ -15,12 +25,10 @@ module I18n::Tasks::Configuration
   #  @return [{adapter: String, options: Hash}]
   def data_config
     @config_sections[: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: adapter, options: conf.except(:adapter, :class)}
+      {
+          adapter: data.class.name,
+          config: data.config
+      }
     end
   end
 
@@ -65,6 +73,11 @@ module I18n::Tasks::Configuration
     end
   end
 
+  def non_base_locales(from = nil)
+    from ||= self.locales
+    Array(from) - [base_locale]
+  end
+
   # @return [String] default i18n locale
   def base_locale
     @config_sections[:base_locale] ||= (config[:base_locale] || 'en').to_s

data/lib/i18n/tasks/data.rb

@@ -0,0 +1,78 @@
+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}"
+      end
+      adapter.constantize.new(conf.except(:adapter, :class))
+    end
+  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
+
+  # whether the value for key exists in locale (defaults: base_locale)
+  def key_value?(key, locale = base_locale)
+    t(key, locale).present?
+  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]
+    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 = {})
+    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] += keys.map(&:to_s).zip(values)
+  end
+
+end

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

@@ -0,0 +1,41 @@
+module I18n
+  module Tasks
+    module Data
+      module FileFormats
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        delegate :adapter_for, to: :class
+
+        protected
+
+        def load_file(file)
+          adapter_for(file).parse(
+              ::File.read(file)
+          )
+        end
+
+        def write_tree(path, tree)
+          ::File.open(path, 'w') { |f|
+            f.write(adapter_for(path).dump(tree.to_hash))
+          }
+        end
+
+        module ClassMethods
+          # @param pattern [String] File.fnmatch pattern
+          # @param adapter [responds to parse(string)->hash and dump(hash)->string]
+          def register_adapter(pattern, adapter)
+            (@fn_patterns ||= {})[pattern] = adapter
+          end
+
+          def adapter_for(path)
+            @fn_patterns.detect { |pattern, adapter|
+              ::File.fnmatch(pattern, path)
+            }[1] or raise "Adapter not found for #{path}. Registered adapters: #{@fn_patterns.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/data/file_system.rb

@@ -1,11 +1,10 @@
-require 'i18n/tasks/data/storage/file_storage'
+require 'i18n/tasks/data/file_system_base'
 require 'i18n/tasks/data/adapter/json_adapter'
 require 'i18n/tasks/data/adapter/yaml_adapter'
 
 module I18n::Tasks
   module Data
-    class FileSystem
-      include Storage::FileStorage
+    class FileSystem < FileSystemBase
       register_adapter '*.yml', Adapter::YamlAdapter
       register_adapter '*.json', Adapter::JsonAdapter
     end