i18n-tasks 0.9.24 → 0.9.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43145655fa3f1bfe8346745641fbab0cbcdc6d4fce7644360f47dc22c2d1c57
-  data.tar.gz: 3ec016b5aca6502d4a8cc73e9f1850e6d87a6469e631d27a2b9710538b696e34
+  metadata.gz: c701c96d03c3226bb8c9a6e2bed8477c7846645ee384a93c569c090cfe9b76ae
+  data.tar.gz: 5209c23392064c0d0a15cc61f2a82d0a08294e58afd7b1466b433295ae861e98
 SHA512:
-  metadata.gz: dc3f0df2e53aef54e7fa0d1953c3d448a4ccc57c8a04f60b1494ea3500b8b98d7473548683c62f5c36795a3bd20eab16ee4d2a898f2de6ca21b6cfd64d7dd67f
-  data.tar.gz: d744f48d0b9572e93906cddce55004eadd8a8aa867f6ca436540bedb989274077a641d83c28b5a034adb1a7106d70a2cbac069301d2febcd32eb25e44c674ab8
+  metadata.gz: 4a573608dff03c12f15920a84ed5c01d2377c593e43ed1cf27c0f9a1951b75fa4211be678b1ad150df7a129365f09a77e398c45d6260c87213f62985dbad58d9
+  data.tar.gz: 9bf7f845ef28e04b87bbbdc9b0e293ef7187b808ce7a7b690434441a725d6b61ef74759f77e26d5df756d49220f04ff6d0a716581cda040979c41d2d1d374b4c

data/README.md

@@ -22,7 +22,7 @@ i18n-tasks can be used with any project using the ruby [i18n gem][i18n-gem] (def
 Add i18n-tasks to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.9.24'
+gem 'i18n-tasks', '~> 0.9.25'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -125,6 +125,9 @@ $ i18n-tasks remove-unused
 These tasks can infer [dynamic keys](#dynamic-keys) such as `t("category.\#{category.name}")` if you set
 `search.strict` to false, or pass `--no-strict` on the command line.
 
+If you want to keep the ordering from the original language file when using remove-unused, pass
+`-k` or `--keep-order`.
+
 ### Normalize data
 
 Sort the keys:

data/config/locales/en.yml

@@ -13,6 +13,7 @@ en:
             locales implicitly.
           confirm: Confirm automatically
           data_format: 'Data format: %{valid_text}.'
+          keep_order: Keep the order of the keys
           key_pattern: Filter by key pattern (e.g. 'common.*')
           key_pattern_to_rename: Full key (pattern) to rename. Required
           locale: :i18n_tasks.common.locale

data/config/locales/ru.yml

@@ -10,6 +10,7 @@ ru:
           all_locales: Не ожидать, что маски ключа начинаются с локали. Применять маски ко всем локалям.
           confirm: Подтвердить автоматом
           data_format: 'Формат данных: %{valid_text}. %{default_text}.'
+          keep_order: Keep the order of the keys
           key_pattern: Маска ключа (например, common.*)
           key_pattern_to_rename: Полный ключ (шаблон) для переименования. Необходимый параметр.
           locale: 'Язык. По умолчанию: base'

data/i18n-tasks.gemspec

@@ -11,23 +11,21 @@ Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
   s.email         = ['glex.spb@gmail.com']
   s.license       = 'MIT'
   s.summary       = 'Manage localization and translation with the awesome power of static analysis'
-  s.description   = <<-TEXT
-i18n-tasks helps you find and manage missing and unused translations.
+  s.description   = <<~TEXT
+    i18n-tasks helps you find and manage missing and unused translations.
 
-It analyses code statically for key usages, such as `I18n.t('some.key')`, in order to report keys that are missing or unused,
-pre-fill missing keys (optionally from Google Translate), and remove unused keys.
+    It analyses code statically for key usages, such as `I18n.t('some.key')`, in order to report keys that are missing or unused,
+    pre-fill missing keys (optionally from Google Translate), and remove unused keys.
 TEXT
-  s.post_install_message = <<-TEXT
-# Install default configuration:
-cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
-# Add an RSpec for missing and unused keys:
-cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
+  s.post_install_message = <<~TEXT
+    # Install default configuration:
+    cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
+    # Add an RSpec for missing and unused keys:
+    cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
 TEXT
   s.homepage = 'https://github.com/glebm/i18n-tasks'
   s.metadata = { 'issue_tracker' => 'https://github.com/glebm/i18n-tasks' } if s.respond_to?(:metadata=)
-  # rubocop:disable Gemspec/RequiredRubyVersion
-  s.required_ruby_version = '~> 2.1' if s.respond_to?(:required_ruby_version=)
-  # rubocop:enable Gemspec/RequiredRubyVersion
+  s.required_ruby_version = '~> 2.3' if s.respond_to?(:required_ruby_version=)
 
   s.files = `git ls-files`.split($/)
   s.files -= s.files.grep(%r{^(doc/|\.|spec/)}) + %w[CHANGES.md config/i18n-tasks.yml Gemfile]

data/lib/i18n/tasks/command/commands/usages.rb

@@ -10,6 +10,11 @@ module I18n::Tasks
             '--[no-]strict',
             t('i18n_tasks.cmd.args.desc.strict')
 
+        arg :keep_order,
+            '-k',
+            '--keep-order',
+            t('i18n_tasks.cmd.args.desc.keep_order')
+
         cmd :find,
             pos:  '[pattern]',
             desc: t('i18n_tasks.cmd.desc.find'),
@@ -35,13 +40,14 @@ module I18n::Tasks
         cmd :remove_unused,
             pos:  '[locale ...]',
             desc: t('i18n_tasks.cmd.desc.remove_unused'),
-            args: %i[locales out_format strict confirm]
+            args: %i[locales out_format strict keep_order confirm]
 
         def remove_unused(opt = {})
           unused_keys = i18n.unused_keys(opt.slice(:locales, :strict))
           if unused_keys.present?
             terminal_report.unused_keys(unused_keys)
             confirm_remove_unused!(unused_keys, opt)
+            i18n.data.config = i18n.data.config.merge(sort: false) if opt[:'keep-order']
             removed = i18n.data.remove_by_key!(unused_keys)
             log_stderr t('i18n_tasks.remove_unused.removed', count: unused_keys.leaves.count)
             print_forest removed, opt

data/lib/i18n/tasks/command/option_parsers/locale.rb

@@ -47,7 +47,7 @@ module I18n::Tasks
           end
 
           def move_base_locale_to_front!(locales, base_locale)
-            if (pos = locales.index(base_locale)) && pos > 0
+            if (pos = locales.index(base_locale)) && pos.positive?
               locales[pos], locales[0] = locales[0], locales[pos]
             end
             locales

data/lib/i18n/tasks/concurrent/cache.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/concurrent/cached_value'
+
+module I18n::Tasks::Concurrent
+  # A thread-safe cache.
+  # @since 0.9.25
+  class Cache
+    def initialize
+      @mutex = Mutex.new
+      @map = {}
+    end
+
+    # @param [Object] key
+    # @return [Object] Cached or computed value.
+    def fetch(key, &block)
+      @mutex.synchronize do
+        @map[key] ||= CachedValue.new(&block)
+      end.get
+    end
+  end
+end

data/lib/i18n/tasks/concurrent/cached_value.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/concurrent/cached_value'
+
+module I18n::Tasks::Concurrent
+  # A thread-safe memoized value.
+  # The given computation is guaranteed to be invoked at most once.
+  # @since 0.9.25
+  class CachedValue
+    NULL = Object.new
+
+    # @param [Proc] computation The computation that returns the value to cache.
+    def initialize(&computation)
+      @computation = computation
+      @mutex = Mutex.new
+      @result = NULL
+    end
+
+    # @return [Object] Result of the computation.
+    def get
+      return @result unless @result == NULL
+      @mutex.synchronize do
+        @result = @computation.call
+      end
+    end
+  end
+end

data/lib/i18n/tasks/console_context.rb

@@ -34,41 +34,41 @@ module I18n::Tasks
       end
 
       def guide
-        Rainbow('i18n-tasks IRB Quick Start guide').green.bright + "\n" + <<-TEXT
-#{Rainbow('Data as trees').yellow}
-  tree(locale)
-  used_tree(key_filter: nil, strict: nil)
-  unused_tree(locale: base_locale, strict: nil)
-  build_tree('es' => {'hello' => 'Hola'})
+        Rainbow('i18n-tasks IRB Quick Start guide').green.bright + "\n" + <<~TEXT
+          #{Rainbow('Data as trees').yellow}
+            tree(locale)
+            used_tree(key_filter: nil, strict: nil)
+            unused_tree(locale: base_locale, strict: nil)
+            build_tree('es' => {'hello' => 'Hola'})
 
-#{Rainbow('Traversal').yellow}
-  tree = missing_diff_tree('es')
-  tree.nodes { |node| }
-  tree.nodes.to_a
-  tree.leaves { |node| }
-  tree.each { |root_node| }
-  # also levels, depth_first, and breadth_first
+          #{Rainbow('Traversal').yellow}
+            tree = missing_diff_tree('es')
+            tree.nodes { |node| }
+            tree.nodes.to_a
+            tree.leaves { |node| }
+            tree.each { |root_node| }
+            # also levels, depth_first, and breadth_first
 
-#{Rainbow('Select nodes').yellow}
-  tree.select_nodes { |node| } # new tree with only selected nodes
+          #{Rainbow('Select nodes').yellow}
+            tree.select_nodes { |node| } # new tree with only selected nodes
 
-#{Rainbow('Match by full key').yellow}
-  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)
+          #{Rainbow('Match by full key').yellow}
+            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)
 
-#{Rainbow('Nodes').yellow}
-  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
-  Tree::Node.new(key: 'en')
+          #{Rainbow('Nodes').yellow}
+            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
+            Tree::Node.new(key: 'en')
 
-#{Rainbow('Keys').yellow}
-  t(key, locale)
-  key_value?(key, locale)
-  depluralize_key(key, locale) # convert 'hat.one' to 'hat'
+          #{Rainbow('Keys').yellow}
+            t(key, locale)
+            key_value?(key, locale)
+            depluralize_key(key, locale) # convert 'hat.one' to 'hat'
         TEXT
       end
     end

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

@@ -45,8 +45,8 @@ module I18n
           ::File.read(path, encoding: 'UTF-8')
         end
 
-        def write_tree(path, tree)
-          hash = tree.to_hash(true)
+        def write_tree(path, tree, sort = true)
+          hash = tree.to_hash(sort)
           adapter = self.class.adapter_name_for_path(path)
           content = adapter_dump(hash, adapter)
           # Ignore unchanged data

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

@@ -21,7 +21,8 @@ module I18n::Tasks
       }.freeze
 
       def initialize(config = {})
-        self.config  = config.except(:base_locale, :locales)
+        self.config = config.except(:base_locale, :locales)
+        self.config[:sort] = !config[:keep_order]
         @base_locale = config[:base_locale]
         locales = config[:locales].presence
         @locales = LocaleList.normalize_locale_list(locales || available_locales, base_locale, true)
@@ -55,17 +56,17 @@ module I18n::Tasks
       # @param [::I18n::Tasks::Data::Siblings] tree
       def set(locale, tree)
         locale = locale.to_s
-        @trees.delete(locale) if @trees
+        @trees&.delete(locale)
         paths_before = Set.new(get(locale)[locale].leaves.map { |node| node.data[:path] })
         paths_after = Set.new([])
         router.route locale, tree do |path, tree_slice|
           paths_after << path
-          write_tree path, tree_slice
+          write_tree path, tree_slice, config[:sort]
         end
         (paths_before - paths_after).each do |path|
           FileUtils.remove_file(path) if File.exist?(path)
         end
-        @trees.delete(locale) if @trees
+        @trees&.delete(locale)
         @available_locales = nil
       end
 
@@ -179,14 +180,14 @@ module I18n::Tasks
         data.each do |key, value|
           if key.nil?
             data.delete(key)
-            log_warn <<-TEXT
-Skipping a nil key found in #{path.inspect}:
-  key: #{suffix.join('.')}.`nil`
-  value: #{value.inspect}
-Nil keys are not supported by i18n.
-The following unquoted YAML keys result in a nil key:
-  #{%w[null Null NULL ~].join(', ')}
-See http://yaml.org/type/null.html
+            log_warn <<~TEXT
+              Skipping a nil key found in #{path.inspect}:
+                key: #{suffix.join('.')}.`nil`
+                value: #{value.inspect}
+              Nil keys are not supported by i18n.
+              The following unquoted YAML keys result in a nil key:
+                #{%w[null Null NULL ~].join(', ')}
+              See http://yaml.org/type/null.html
 TEXT
           elsif value.is_a?(Hash)
             filter_nil_keys! path, value, suffix + [key]

data/lib/i18n/tasks/data/tree/node.rb

@@ -143,7 +143,7 @@ module I18n::Tasks::Data::Tree
     end
 
     def to_siblings
-      parent && parent.children || Siblings.new(nodes: [self])
+      parent&.children || Siblings.new(nodes: [self])
     end
 
     def to_hash(sort = false)

data/lib/i18n/tasks/data/tree/traversal.rb

@@ -104,7 +104,7 @@ module I18n::Tasks
         to_remove = []
         each do |node|
           if block.yield(node)
-            node.children.select_nodes!(&block) if node.children
+            node.children&.select_nodes!(&block)
           else
             # removing during each is unsafe
             to_remove << node

data/lib/i18n/tasks/locale_pathname.rb

@@ -4,7 +4,7 @@ module I18n::Tasks
   module LocalePathname
     class << self
       def replace_locale(path, from, to)
-        path && path.gsub(path_locale_re(from), to)
+        path&.gsub(path_locale_re(from), to)
       end
 
       private

data/lib/i18n/tasks/logging.rb

@@ -23,10 +23,8 @@ module I18n::Tasks::Logging
   end
 
   def log_stderr(*args)
+    # We don't want output from different threads to get intermixed.
     MUTEX.synchronize do
-      # 1. We don't want output from different threads to get intermixed.
-      # 2. StringIO is currently not thread-safe (blows up) on JRuby:
-      # https://github.com/jruby/jruby/issues/4417
       $stderr.puts(*args)
     end
   end

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

@@ -32,7 +32,7 @@ module I18n::Tasks::Reports
     def used_title(keys_nodes, filter)
       used_n = keys_nodes.map { |_k, node| node.data[:occurrences].size }.reduce(:+).to_i
       "#{keys_nodes.size} key#{'s' if keys_nodes.size != 1}#{" matching '#{filter}'" if filter}"\
-      "#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n > 0}"
+      "#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n.positive?}"
     end
 
     # Sort keys by their attributes in order

data/lib/i18n/tasks/scanners/files/caching_file_finder.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'i18n/tasks/concurrent/cached_value'
 require 'i18n/tasks/scanners/files/file_finder'
+
 module I18n::Tasks::Scanners::Files
   # Finds the files in the specified search paths with support for exclusion / inclusion patterns.
   # Wraps a {FileFinder} and caches the results.
@@ -11,8 +13,7 @@ module I18n::Tasks::Scanners::Files
     # @param (see FileFinder#initialize)
     def initialize(**args)
       super
-      @mutex = Mutex.new
-      @cached_paths = nil
+      @cached_value = ::I18n::Tasks::Concurrent::CachedValue.new { uncached_find_files }
     end
 
     # Traverse the paths and yield the matching ones.
@@ -25,10 +26,13 @@ module I18n::Tasks::Scanners::Files
       super
     end
 
+    alias uncached_find_files find_files
+    private :uncached_find_files
+
     # @note This method is cached, it will only access the filesystem on the first invocation.
     # @return (see FileFinder#find_files)
     def find_files
-      @cached_paths || @mutex.synchronize { @cached_paths ||= super }
+      @cached_value.get
     end
   end
 end

data/lib/i18n/tasks/scanners/files/caching_file_finder_provider.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'i18n/tasks/concurrent/cache'
 require 'i18n/tasks/scanners/files/caching_file_finder'
 
 module I18n::Tasks::Scanners::Files
@@ -10,8 +11,7 @@ module I18n::Tasks::Scanners::Files
   class CachingFileFinderProvider
     # @param exclude [Array<String>]
     def initialize(exclude: [])
-      @cache = {}
-      @mutex = Mutex.new
+      @cache = ::I18n::Tasks::Concurrent::Cache.new
       @defaults = { exclude: exclude }
     end
 
@@ -20,13 +20,11 @@ module I18n::Tasks::Scanners::Files
     # @param (see FileFinder#initialize)
     # @return [CachingFileFinder]
     def get(**file_finder_args)
-      @cache[file_finder_args] || @mutex.synchronize do
-        @cache[file_finder_args] ||= begin
-          args = file_finder_args.dup
-          args[:exclude] = @defaults[:exclude] + (args[:exclude] || [])
-          args[:exclude].uniq!
-          CachingFileFinder.new(**args)
-        end
+      @cache.fetch(file_finder_args) do
+        args = file_finder_args.dup
+        args[:exclude] = @defaults[:exclude] + (args[:exclude] || [])
+        args[:exclude].uniq!
+        CachingFileFinder.new(**args)
       end
     end
   end

data/lib/i18n/tasks/scanners/files/caching_file_reader.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'i18n/tasks/concurrent/cache'
 require 'i18n/tasks/scanners/files/file_reader'
+
 module I18n::Tasks::Scanners::Files
   # Reads the files in 'rb' mode and UTF-8 encoding.
   # Wraps a {FileReader} and caches the results.
@@ -10,8 +12,7 @@ module I18n::Tasks::Scanners::Files
   class CachingFileReader < FileReader
     def initialize
       super
-      @mutex = Mutex.new
-      @cache = {}
+      @cache = ::I18n::Tasks::Concurrent::Cache.new
     end
 
     # Return the contents of the file at the given path.
@@ -21,8 +22,7 @@ module I18n::Tasks::Scanners::Files
     # @return (see FileReader#read_file)
     # @note This method is cached, it will only access the filesystem on the first invocation.
     def read_file(path)
-      absolute_path = File.expand_path(path)
-      @cache[absolute_path] || @mutex.synchronize { @cache[absolute_path] ||= super }
+      @cache.fetch(File.expand_path(path)) { super }
     end
   end
 end

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

@@ -41,7 +41,7 @@ module I18n
         def prefix(normalized_path, calling_method: nil)
           file_key       = normalized_path.gsub(%r{(\.[^/]+)*$}, '').tr(File::SEPARATOR, DOT)
           calling_method = calling_method.call if calling_method.respond_to?(:call)
-          if calling_method && calling_method.present?
+          if calling_method&.present?
             # Relative keys in mailers have a `_mailer` infix, but relative keys in controllers do not have one:
             "#{file_key.sub(/_controller$/, '')}.#{calling_method}"
           else

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

@@ -48,7 +48,7 @@ module I18n::Tasks::Scanners
       message  = send_node.children[1]
       valid_receivers = @message_receivers[message]
       # use `any?` because `include?` checks type equality, but the receiver is a Parser::AST::Node != AST::Node.
-      @callback.call(send_node, @method_name) if valid_receivers && valid_receivers.any? { |r| r == receiver }
+      @callback.call(send_node, @method_name) if valid_receivers&.any? { |r| r == receiver }
       # always invoke handler_missing to get nested translations in children
       handler_missing send_node
       nil

data/lib/i18n/tasks/translators/base_translator.rb

@@ -68,7 +68,7 @@ module I18n::Tasks
           # dump recursively
           value.map { |v| dump_value v }
         when String
-          replace_interpolations value
+          replace_interpolations value unless value.empty?
         end
       end
 
@@ -82,7 +82,11 @@ module I18n::Tasks
           # implode array
           untranslated.map { |from| parse_value(from, each_translated) }
         when String
-          restore_interpolations untranslated, each_translated.next
+          if untranslated.empty?
+            untranslated
+          else
+            restore_interpolations untranslated, each_translated.next
+          end
         else
           untranslated
         end
@@ -115,11 +119,11 @@ module I18n::Tasks
       end
 
       def raise_interpolation_error(untranslated, translated, e)
-        fail CommandError.new(e, <<-TEXT.strip)
-Error when restoring interpolations:
-  original: "#{untranslated}"
-  response: "#{translated}"
-  error: #{e.message} (#{e.class.name})
+        fail CommandError.new(e, <<~TEXT.strip)
+          Error when restoring interpolations:
+            original: "#{untranslated}"
+            response: "#{translated}"
+            error: #{e.message} (#{e.class.name})
         TEXT
       end
 

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.24'
+    VERSION = '0.9.25'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.24
+  version: 0.9.25
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -294,6 +294,8 @@ files:
 - lib/i18n/tasks/command/options/locales.rb
 - lib/i18n/tasks/command_error.rb
 - lib/i18n/tasks/commands.rb
+- lib/i18n/tasks/concurrent/cache.rb
+- lib/i18n/tasks/concurrent/cached_value.rb
 - lib/i18n/tasks/configuration.rb
 - lib/i18n/tasks/console_context.rb
 - lib/i18n/tasks/data.rb
@@ -368,7 +370,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="