i18n-tasks 0.8.7 → 0.9.0.rc1

data/lib/i18n/tasks/commands.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/command/dsl'
 require 'i18n/tasks/command/collection'
 require 'i18n/tasks/command/commands/health'

data/lib/i18n/tasks/configuration.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks::Configuration
   # i18n-tasks config (defaults + config/i18n-tasks.yml)
   # @return [Hash{String => String,Hash,Array}]
@@ -53,13 +52,6 @@ module I18n::Tasks::Configuration
     end
   end
 
-  def search_config
-    @config_sections[:search] ||= {
-        scanner: scanner.class.name,
-        config:  scanner.config
-    }
-  end
-
   # @return [Array<String>] all available locales, base_locale is always first
   def locales
     @config_sections[:locales] ||= data.locales
@@ -87,7 +79,7 @@ module I18n::Tasks::Configuration
     internal_locale
     locales
     data_config
-    search_config
+    @config_sections[:search] ||= search_config
     translation_config
     IGNORE_TYPES.each do |ignore_type|
       ignore_config ignore_type

data/lib/i18n/tasks/console_context.rb

@@ -36,8 +36,8 @@ module I18n::Tasks
         green(bold "i18n-tasks IRB Quick Start guide") + "\n" + <<-TEXT
 #{yellow 'Data as trees'}
   tree(locale)
-  used_tree(source_occurrences: false, key_filter: nil)
-  unused_tree(locale)
+  used_tree(key_filter: nil, strict: nil)
+  unused_tree(locale: base_locale, strict: nil)
   build_tree('es' => {'hello' => 'Hola'})
 
 #{yellow 'Traversal'}

data/lib/i18n/tasks/data.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/data/file_system'
 
 module I18n::Tasks

data/lib/i18n/tasks/data/adapter/json_adapter.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'json'
 
 module I18n::Tasks

data/lib/i18n/tasks/data/adapter/yaml_adapter.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'yaml'
 module I18n::Tasks
   module Data

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'fileutils'
 
 module I18n

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/data/file_system_base'
 require 'i18n/tasks/data/adapter/json_adapter'
 require 'i18n/tasks/data/adapter/yaml_adapter'

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/data/tree/node'
 require 'i18n/tasks/data/router/pattern_router'
 require 'i18n/tasks/data/router/conservative_router'

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/data/router/pattern_router'
 
 module I18n::Tasks

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/data/tree/node'
 

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 
 require 'i18n/tasks/data/tree/traversal'
 require 'i18n/tasks/data/tree/siblings'
@@ -10,13 +9,13 @@ module I18n::Tasks::Data::Tree
     attr_accessor :value
     attr_reader :key, :children, :parent
 
-    def initialize(opts = {})
-      @key          = opts[:key]
+    def initialize(key:, value: nil, data: nil, parent: nil, children: nil)
+      @key          = key
       @key = @key.to_s.freeze if @key
-      @value        = opts[:value]
-      @data         = opts[:data]
-      @parent       = opts[:parent]
-      self.children = (opts[:children] if opts[:children])
+      @value        = value
+      @data         = data
+      @parent       = parent
+      self.children = (children if children)
     end
 
     def attributes

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 
 require 'i18n/tasks/data/tree/traversal'
 module I18n::Tasks::Data::Tree

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

@@ -1,8 +1,8 @@
-# coding: utf-8
-
 require 'set'
 require 'i18n/tasks/split_key'
 require 'i18n/tasks/data/tree/nodes'
+require 'i18n/tasks/data/tree/node'
+
 module I18n::Tasks::Data::Tree
   # Siblings represents a subtree sharing a common parent
   # in case of an empty parent (nil) it represents a forest
@@ -44,7 +44,7 @@ module I18n::Tasks::Data::Tree
     end
 
     def replace_node!(node, new_node)
-      @list[@list.index(node)] = new_node
+      @list[@list.index(node)]  = new_node
       key_to_node[new_node.key] = new_node
     end
 
@@ -64,7 +64,7 @@ module I18n::Tasks::Data::Tree
     def set(full_key, node)
       raise 'value should be a I18n::Tasks::Data::Tree::Node' unless node.is_a?(Node)
       key_part, rest = split_key(full_key, 2)
-      child = key_to_node[key_part]
+      child          = key_to_node[key_part]
 
       if rest
         unless child
@@ -202,11 +202,23 @@ module I18n::Tasks::Data::Tree
         forest
       end
 
+      # @param key_occurrences [I18n::Tasks::Scanners::KeyOccurrences]
+      # @return [Siblings]
+      def from_key_occurrences(key_occurrences)
+        build_forest do |forest|
+          key_occurrences.each do |key_occurrence|
+            forest[key_occurrence.key] = ::I18n::Tasks::Data::Tree::Node.new(
+                key:  split_key(key_occurrence.key).last,
+                data: {occurrences: key_occurrence.occurrences})
+          end
+        end
+      end
+
       def from_key_attr(key_attrs, opts = {}, &block)
         build_forest(opts) { |forest|
           key_attrs.each { |(full_key, attr)|
             raise "Invalid key #{full_key.inspect}" if full_key.end_with?('.')
-            node = Node.new(attr.merge(key: split_key(full_key).last))
+            node = ::I18n::Tasks::Data::Tree::Node.new(attr.merge(key: split_key(full_key).last))
             block.call(full_key, node) if block
             forest[full_key] = node
           }
@@ -216,7 +228,7 @@ module I18n::Tasks::Data::Tree
       def from_key_names(keys, opts = {}, &block)
         build_forest(opts) { |forest|
           keys.each { |full_key|
-            node = Node.new(key: split_key(full_key).last)
+            node = ::I18n::Tasks::Data::Tree::Node.new(key: split_key(full_key).last)
             block.call(full_key, node) if block
             forest[full_key] = node
           }
@@ -238,16 +250,23 @@ module I18n::Tasks::Data::Tree
       def from_flat_pairs(pairs)
         Siblings.new.tap do |siblings|
           pairs.each { |full_key, value|
-            siblings[full_key] = Node.new(key: split_key(full_key).last, value: value)
+            siblings[full_key] = ::I18n::Tasks::Data::Tree::Node.new(key: split_key(full_key).last, value: value)
           }
         end
       end
 
       private
       def parse_parent_opt!(opts)
-        opts[:parent] = Node.new(key: opts[:parent_key]) if opts[:parent_key]
-        opts[:parent] = Node.new(opts[:parent_attr]) if opts[:parent_attr]
-        opts[:parent] = Node.new(key: opts[:parent_locale], data: {locale: opts[:parent_locale]}) if opts[:parent_locale]
+        if opts[:parent_key]
+          opts[:parent] = ::I18n::Tasks::Data::Tree::Node.new(key: opts[:parent_key])
+        end
+        if opts[:parent_attr]
+          opts[:parent] = ::I18n::Tasks::Data::Tree::Node.new(opts[:parent_attr])
+        end
+        if opts[:parent_locale]
+          opts[:parent] = ::I18n::Tasks::Data::Tree::Node.new(
+              key: opts[:parent_locale], data: {locale: opts[:parent_locale]})
+        end
       end
     end
   end

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks
   module Data::Tree
     # Any Enumerable that yields nodes can mix in this module
@@ -147,12 +146,10 @@ module I18n::Tasks
         value_proc ||= proc { |node|
           node_value = node.value
           human_key  = ActiveSupport::Inflector.humanize(node.key.to_s)
-          full_key = node.full_key
           StringInterpolation.interpolate_soft(
               val_pattern,
               value: node_value,
               human_key: human_key,
-              key: full_key,
               value_or_human_key: node_value.presence || human_key
           )
         }

data/lib/i18n/tasks/google_translation.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'easy_translate'
 require 'i18n/tasks/html_keys'
 

data/lib/i18n/tasks/ignore_keys.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks::IgnoreKeys
   # whether to ignore the key
   # will also apply global ignore rules

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks::KeyPatternMatching
   extend self
   MATCH_NOTHING = /\z\A/

data/lib/i18n/tasks/logging.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks::Logging
   extend self
 

data/lib/i18n/tasks/missing_keys.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'set'
 module I18n::Tasks
   module MissingKeys

data/lib/i18n/tasks/plural_keys.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'set'
 module I18n::Tasks::PluralKeys
   PLURAL_KEY_SUFFIXES = Set.new %w(zero one two few many other)

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 module I18n::Tasks::Reports
   class Base
     include I18n::Tasks::Logging
@@ -31,7 +30,7 @@ module I18n::Tasks::Reports
     def used_title(used_tree)
       leaves = used_tree.leaves.to_a
       filter = used_tree.first.root.data[:key_filter]
-      used_n = leaves.map { |node| node.data[:source_occurrences].size }.reduce(:+).to_i
+      used_n = leaves.map { |node| node.data[:occurrences].size }.reduce(:+).to_i
       "#{leaves.length} key#{'s' if leaves.size != 1}#{" matching '#{filter}'" if filter}#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n > 0}"
     end
 

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/reports/base'
 require 'fileutils'
 

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

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'i18n/tasks/reports/base'
 require 'terminal-table'
 module I18n
@@ -29,7 +28,7 @@ module I18n
           {missing_used: red(glyph), missing_diff: yellow(glyph)}[type]
         end
 
-        def used_keys(used_tree = task.used_tree(source_occurrences: true))
+        def used_keys(used_tree = task.used_tree)
           print_title used_title(used_tree)
           keys_nodes = used_tree.keys.to_a
           if keys_nodes.present?
@@ -66,11 +65,11 @@ module I18n
         end
 
         def forest_stats(forest, stats = task.forest_stats(forest))
-          text = if stats[:locale_count] == 1
-                   I18n.t('i18n_tasks.data_stats.text_single_locale', stats)
-                 else
-                   I18n.t('i18n_tasks.data_stats.text', stats)
-                 end
+          text  = if stats[:locale_count] == 1
+                    I18n.t('i18n_tasks.data_stats.text_single_locale', stats)
+                  else
+                    I18n.t('i18n_tasks.data_stats.text', stats)
+                  end
           title = bold(I18n.t('i18n_tasks.data_stats.title', stats.slice(:locales)))
           print_info "#{cyan title} #{cyan text}"
         end
@@ -86,7 +85,7 @@ module I18n
         end
 
         def print_occurrences(node, full_key = node.full_key)
-          occurrences = node.data[:source_occurrences]
+          occurrences = node.data[:occurrences]
           puts "#{bold "#{full_key}"} #{green(occurrences.size.to_s) if occurrences.size > 1}"
           occurrences.each do |occurrence|
             puts "  #{key_occurrence full_key, occurrence}"
@@ -132,21 +131,46 @@ module I18n
           puts ::Terminal::Table.new(opts, &block)
         end
 
-        def key_occurrence(full_key, info)
-          location = green "#{info[:src_path]}:#{info[:line_num]}"
-          source   = highlight_key(full_key, info[:line], info[:line_pos]..-1).strip
+        def key_occurrence(full_key, occurrence)
+          location = green "#{occurrence.path}:#{occurrence.line_num}"
+          source   = highlight_key(full_key, occurrence.line, occurrence.line_pos..-1).strip
           "#{location} #{source}"
         end
 
+        def first_occurrence(leaf)
+          # @type [I18n::Tasks::Scanners::KeyOccurrences]
+          occurrences = leaf[:data][:occurrences]
+          # @type [I18n::Tasks::Scanners::Occurrence]
+          first       = occurrences.first
+          [green("#{first.path}:#{first.line_num}"),
+           ("(#{I18n.t 'i18n_tasks.common.n_more', count: occurrences.length - 1})" if occurrences.length > 1)
+          ].compact.join(' ')
+        end
+
         def highlight_key(full_key, line, range = (0..-1))
-          line.dup.tap { |s| s[range] = s[range].sub(full_key) { |m| underline m } }
+          line.dup.tap { |s|
+            s[range] = s[range].sub(full_key) { |m|
+              highlight_string m
+            }
+          }
         end
 
-        def first_occurrence(leaf)
-          usages = leaf[:data][:source_occurrences]
-          first  = usages.first
-          [green("#{first[:src_path]}:#{first[:line_num]}"),
-           ("(#{I18n.t 'i18n_tasks.common.n_more', count: usages.length - 1})" if usages.length > 1)].compact.join(' ')
+        module HighlightUnderline
+          def highlight_string(s)
+            underline s
+          end
+        end
+
+        module HighlightOther
+          def highlight_string(s)
+            yellow s
+          end
+        end
+
+        if Gem.win_platform?
+          include HighlightOther
+        else
+          include HighlightUnderline
         end
       end
     end

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

@@ -0,0 +1,32 @@
+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.
+  #
+  # @note This class is thread-safe. All methods are cached.
+  # @since 0.9.0
+  class CachingFileFinder < FileFinder
+    # @param (see FileFinder#initialize)
+    def initialize(**args)
+      super
+      @mutex = Mutex.new
+      @cached_paths = nil
+    end
+
+    # Traverse the paths and yield the matching ones.
+    #
+    # @note This method is cached, it will only access the filesystem on the first invocation.
+    # @param (see FileFinder#traverse_files)
+    # @yieldparam (see FileFinder#traverse_files)
+    # @return (see FileFinder#traverse_files)
+    def traverse_files
+      super
+    end
+
+    # @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 }
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'i18n/tasks/scanners/files/caching_file_finder'
+
+module I18n::Tasks::Scanners::Files
+  # Finds the files and provides their contents.
+  #
+  # @note This class is thread-safe. All methods are cached.
+  # @since 0.9.0
+  class CachingFileFinderProvider
+    def initialize
+      @cache = {}
+      @mutex = Mutex.new
+    end
+
+    # Initialize a {CachingFileFinder} or get one from cache based on the constructor arguments.
+    #
+    # @param (see FileFinder#initialize)
+    # @return [CachingFileFinder]
+    def get(**file_finder_args)
+      @cache[file_finder_args] || @mutex.synchronize do
+        @cache[file_finder_args] ||= CachingFileFinder.new(**file_finder_args)
+      end
+    end
+  end
+end