i18n-tasks 0.9.33 → 1.0.12

data/lib/i18n/tasks/locale_pathname.rb

@@ -10,7 +10,7 @@ module I18n::Tasks
       private
 
       def path_locale_re(locale)
-        (@path_locale_res ||= {})[locale] ||= %r{(?<=^|[/.])#{locale}(?=[/.])}
+        (@path_locale_res ||= {})[locale] ||= %r{(?<=^|[/.-])#{locale}(?=[/.])}
       end
     end
   end

data/lib/i18n/tasks/missing_keys.rb

@@ -60,11 +60,14 @@ module I18n::Tasks
       locales.each_with_object(empty_forest) do |locale, forest|
         required_keys = required_plural_keys_for_locale(locale)
         next if required_keys.empty?
+
         tree = empty_forest
         plural_nodes data[locale] do |node|
           children = node.children
           present_keys = Set.new(children.map { |c| c.key.to_sym })
+          next if ignore_key?(node.full_key(root: false), :missing)
           next if present_keys.superset?(required_keys)
+
           tree[node.full_key] = node.derive(
             value: children.to_hash,
             children: nil,
@@ -132,6 +135,7 @@ module I18n::Tasks
         locale = root.key
         root.keys do |key, node|
           next unless yield node
+
           if locales_and_node_by_key.key?(key)
             locales_and_node_by_key[key][0] << locale
           else

data/lib/i18n/tasks/plural_keys.rb

@@ -5,12 +5,13 @@ module I18n::Tasks::PluralKeys
   # Ref: http://cldr.unicode.org/index/cldr-spec/plural-rules
   CLDR_CATEGORY_KEYS = %w[zero one two few many other].freeze
   PLURAL_KEY_SUFFIXES = Set.new CLDR_CATEGORY_KEYS
-  PLURAL_KEY_RE = /\.(?:#{CLDR_CATEGORY_KEYS * '|'})$/
+  PLURAL_KEY_RE = /\.(?:#{CLDR_CATEGORY_KEYS * '|'})$/.freeze
 
   def collapse_plural_nodes!(tree)
     tree.leaves.map(&:parent).compact.uniq.each do |node|
       children = node.children
       next unless plural_forms?(children)
+
       node.value    = children.to_hash
       node.children = nil
       node.data.merge! children.first.data
@@ -23,6 +24,7 @@ module I18n::Tasks::PluralKeys
   # @return [String] the base form if the key is a specific plural form (e.g. apple for apple.many), the key otherwise.
   def depluralize_key(key, locale = base_locale)
     return key if key !~ PLURAL_KEY_RE
+
     key_name = last_key_part(key)
     parent_key = key[0..- (key_name.length + 2)]
     nodes = tree("#{locale}.#{parent_key}").presence || (locale != base_locale && tree("#{base_locale}.#{parent_key}"))
@@ -37,10 +39,12 @@ module I18n::Tasks::PluralKeys
   # @yieldparam node [::I18n::Tasks::Data::Tree::Node] plural node
   def plural_nodes(tree)
     return to_enum(:plural_nodes, tree) unless block_given?
+
     visited = Set.new
     tree.leaves do |node|
       parent = node.parent
       next if !parent || visited.include?(parent)
+
       yield parent if plural_forms?(parent.children)
       visited.add(parent)
     end
@@ -48,14 +52,9 @@ module I18n::Tasks::PluralKeys
   end
 
   def plural_forms?(s)
-    return false if non_plural_other?(s)
     s.present? && s.all? { |node| node.leaf? && plural_suffix?(node.key) }
   end
 
-  def non_plural_other?(s)
-    s.size == 1 && s.first.leaf? && (!s.first.value.is_a?(String) || !s.first.value.include?('%{count}'))
-  end
-
   def plural_suffix?(key)
     PLURAL_KEY_SUFFIXES.include?(key)
   end

data/lib/i18n/tasks/references.rb

@@ -10,12 +10,14 @@ module I18n::Tasks
                            data_refs = merge_reference_trees(data_forest.select_keys { |_, node| node.reference? }))
       fail ArgumentError, 'usages must be a Data::Tree::Instance' unless usages.is_a?(Data::Tree::Siblings)
       fail ArgumentError, 'all_references must be a Data::Tree::Instance' unless data_refs.is_a?(Data::Tree::Siblings)
+
       raw_refs = empty_forest
       resolved_refs = empty_forest
       refs = empty_forest
       data_refs.key_to_node.each do |ref_key_part, ref_node|
         usages.each do |usage_node|
           next unless usage_node.key == ref_key_part
+
           if ref_node.leaf?
             process_leaf!(ref_node, usage_node, raw_refs, resolved_refs, refs)
           else
@@ -89,8 +91,8 @@ module I18n::Tasks
             if node.value != other.value
               log_warn(
                 'Conflicting references: '\
-            "#{node.full_key(root: false)} ⮕ #{node.value} in #{node.data[:locale]},"\
-            " but ⮕ #{other.value} in #{other.data[:locale]}"
+                "#{node.full_key(root: false)} ⮕ #{node.value} in #{node.data[:locale]},"\
+                " but ⮕ #{other.value} in #{other.data[:locale]}"
               )
             end
           end

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

@@ -9,6 +9,7 @@ module I18n::Tasks::Reports
     end
 
     attr_reader :task
+
     delegate :base_locale, :locales, to: :task
 
     protected
@@ -36,7 +37,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.positive?}"
+        "#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n.positive?}"
     end
 
     # Sort keys by their attributes in order
@@ -58,6 +59,7 @@ module I18n::Tasks::Reports
 
     def format_locale(locale)
       return '' unless locale
+
       if locale.split('+') == task.locales.sort
         'all'
       else
@@ -67,8 +69,7 @@ module I18n::Tasks::Reports
 
     def collapse_missing_tree!(forest)
       forest = task.collapse_plural_nodes!(forest)
-      forest = task.collapse_same_key_in_locales!(forest) { |node| node.data[:type] == :missing_used }
-      forest
+      task.collapse_same_key_in_locales!(forest) { |node| node.data[:type] == :missing_used }
     end
   end
 end

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

@@ -106,9 +106,10 @@ module I18n
         private
 
         def missing_key_info(leaf)
-          if leaf[:type] == :missing_used
+          case leaf[:type]
+          when :missing_used
             first_occurrence leaf
-          elsif leaf[:type] == :missing_plural
+          when :missing_plural
             leaf[:data][:missing_keys].join(', ')
           else
             "#{Rainbow(leaf[:data][:missing_diff_locale]).cyan} "\
@@ -120,9 +121,9 @@ module I18n
           if data[:ref_info]
             from, to = data[:ref_info]
             resolved = key[0...to.length]
-            after    = key[to.length..-1]
+            after    = key[to.length..]
             "  #{Rainbow(from).yellow}#{Rainbow(after).cyan}\n" \
-            "#{Rainbow('⮕').yellow.bright} #{Rainbow(resolved).yellow.bright}"
+              "#{Rainbow('⮕').yellow.bright} #{Rainbow(resolved).yellow.bright}"
           else
             Rainbow(key).cyan
           end
@@ -134,6 +135,7 @@ module I18n
 
         def format_reference_desc(node_data)
           return nil unless node_data
+
           case node_data[:ref_type]
           when :reference_usage
             Rainbow('(ref)').yellow.bright
@@ -159,9 +161,9 @@ module I18n
             print_table headings: [Rainbow(I18n.t('i18n_tasks.common.locale')).cyan.bright,
                                    Rainbow(I18n.t('i18n_tasks.common.key')).cyan.bright,
                                    I18n.t('i18n_tasks.common.value')] do |t|
-              t.rows = locale_key_value_datas.map { |(locale, k, v, data)|
+              t.rows = locale_key_value_datas.map do |(locale, k, v, data)|
                 [{ value: Rainbow(locale).cyan, alignment: :center }, format_key(k, data), format_value(v)]
-              }
+              end
             end
           else
             puts 'ø'

data/lib/i18n/tasks/scanners/ast_matchers/base_matcher.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module I18n::Tasks::Scanners::AstMatchers
+  class BaseMatcher
+    def initialize(scanner:)
+      @scanner = scanner
+    end
+
+    def convert_to_key_occurrences(send_node, _method_name, location: send_node.loc)
+      fail('Not implemented')
+    end
+
+    protected
+
+    # If the node type is of `%i(sym str int false true)`, return the value as a string.
+    # Otherwise, if `config[:strict]` is `false` and the type is of `%i(dstr dsym)`,
+    # return the source as if it were a string.
+    #
+    # @param node [Parser::AST::Node]
+    # @param array_join_with [String, nil] if set to a string, arrays will be processed and their elements joined.
+    # @param array_flatten [Boolean] if true, nested arrays are flattened,
+    #     otherwise their source is copied and surrounded by #{}. No effect unless `array_join_with` is set.
+    # @param array_reject_blank [Boolean] if true, empty strings and `nil`s are skipped.
+    #      No effect unless `array_join_with` is set.
+    # @return [String, nil] `nil` is returned only when a dynamic value is encountered in strict mode
+    #     or the node type is not supported.
+    def extract_string(node, array_join_with: nil, array_flatten: false, array_reject_blank: false) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+      return if node.nil?
+
+      if %i[sym str int].include?(node.type)
+        node.children[0].to_s
+      elsif %i[true false].include?(node.type)
+        node.type.to_s
+      elsif node.type == :nil
+        ''
+      elsif node.type == :array && array_join_with
+        extract_array_as_string(
+          node,
+          array_join_with: array_join_with,
+          array_flatten: array_flatten,
+          array_reject_blank: array_reject_blank
+        ).tap do |str|
+          # `nil` is returned when a dynamic value is encountered in strict mode. Propagate:
+          return nil if str.nil?
+        end
+      elsif !@scanner.config[:strict] && %i[dsym dstr].include?(node.type)
+        node.children.map do |child|
+          if %i[sym str].include?(child.type)
+            child.children[0].to_s
+          else
+            child.loc.expression.source
+          end
+        end.join
+      end
+    end
+
+    # Extract the whole hash from a node of type `:hash`
+    #
+    # @param node [AST::Node] a node of type `:hash`.
+    # @return [Hash] the whole hash from the node
+    def extract_hash(node)
+      return {} if node.nil?
+
+      if node.type == :hash
+        node.children.each_with_object({}) do |pair, h|
+          key = pair.children[0].children[0].to_s
+          value = pair.children[1].children[0]
+          h[key] = value
+        end
+      end
+    end
+
+    # Extract a hash pair with a given literal key.
+    #
+    # @param node [AST::Node] a node of type `:hash`.
+    # @param key [String] node key as a string (indifferent symbol-string matching).
+    # @return [AST::Node, nil] a node of type `:pair` or nil.
+    def extract_hash_pair(node, key)
+      node.children.detect do |child|
+        next unless child.type == :pair
+
+        key_node = child.children[0]
+        %i[sym str].include?(key_node.type) && key_node.children[0].to_s == key
+      end
+    end
+
+    # Extract an array as a single string.
+    #
+    # @param array_join_with [String] joiner of the array elements.
+    # @param array_flatten [Boolean] if true, nested arrays are flattened,
+    #     otherwise their source is copied and surrounded by #{}.
+    # @param array_reject_blank [Boolean] if true, empty strings and `nil`s are skipped.
+    # @return [String, nil] `nil` is returned only when a dynamic value is encountered in strict mode.
+    def extract_array_as_string(node, array_join_with:, array_flatten: false, array_reject_blank: false)
+      children_strings = node.children.map do |child|
+        if %i[sym str int true false].include?(child.type)
+          extract_string child
+        else
+          # ignore dynamic argument in strict mode
+          return nil if @scanner.config[:strict]
+
+          if %i[dsym dstr].include?(child.type) || (child.type == :array && array_flatten)
+            extract_string(child, array_join_with: array_join_with)
+          else
+            "\#{#{child.loc.expression.source}}"
+          end
+        end
+      end
+      if array_reject_blank
+        children_strings.reject! do |x|
+          # empty strings and nils in the scope argument are ignored by i18n
+          x == ''
+        end
+      end
+      children_strings.join(array_join_with)
+    end
+  end
+end

data/lib/i18n/tasks/scanners/ast_matchers/message_receivers_matcher.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/scanners/ast_matchers/base_matcher'
+require 'i18n/tasks/scanners/results/occurrence'
+
+module I18n::Tasks::Scanners::AstMatchers
+  class MessageReceiversMatcher < BaseMatcher
+    def initialize(scanner:, receivers:, message:)
+      super(scanner: scanner)
+      @receivers = Array(receivers)
+      @message = message
+    end
+
+    # @param send_node [Parser::AST::Node]
+    # @param method_name [Symbol, nil]
+    # @param location [Parser::Source::Map]
+    # @return [nil, [key, Occurrence]] full absolute key name and the occurrence.
+    def convert_to_key_occurrences(send_node, method_name, location: send_node.loc)
+      return unless node_match?(send_node)
+
+      receiver = send_node.children[0]
+      first_arg_node = send_node.children[2]
+      second_arg_node = send_node.children[3]
+
+      key = extract_string(first_arg_node)
+      return if key.nil?
+
+      key, default_arg = process_options(node: second_arg_node, key: key)
+
+      return if key.nil?
+
+      [
+        full_key(receiver: receiver, key: key, location: location, calling_method: method_name),
+        I18n::Tasks::Scanners::Results::Occurrence.from_range(
+          raw_key: key,
+          range: location.expression,
+          default_arg: default_arg
+        )
+      ]
+    end
+
+    private
+
+    def node_match?(node)
+      receiver = node.children[0]
+      message = node.children[1]
+
+      @message == message && @receivers.any? { |r| r == receiver }
+    end
+
+    def full_key(receiver:, key:, location:, calling_method:)
+      if receiver.nil?
+        # Relative keys only work if called via `t()` but not `I18n.t()`:
+        @scanner.absolute_key(
+          key,
+          location.expression.source_buffer.name,
+          calling_method: calling_method
+        )
+      else
+        key
+      end
+    end
+
+    def process_options(node:, key:)
+      return [key, nil] if node&.type != :hash
+
+      scope_node = extract_hash_pair(node, 'scope')
+
+      if scope_node
+        scope = extract_string(
+          scope_node.children[1],
+          array_join_with: '.',
+          array_flatten: true,
+          array_reject_blank: true
+        )
+        return nil if scope.nil? && scope_node.type != :nil
+
+        key = [scope, key].join('.') unless scope == ''
+      end
+      if default_arg_node = extract_hash_pair(node, 'default')
+        default_arg = if default_arg_node.children[1]&.type == :hash
+          extract_hash(default_arg_node.children[1])
+        else
+          extract_string(default_arg_node.children[1])
+        end
+      end
+
+      [key, default_arg]
+    end
+  end
+end

data/lib/i18n/tasks/scanners/ast_matchers/rails_model_matcher.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/scanners/results/occurrence'
+
+module I18n::Tasks::Scanners::AstMatchers
+  class RailsModelMatcher < BaseMatcher
+    def convert_to_key_occurrences(send_node, _method_name, location: send_node.loc)
+      human_attribute_name_to_key_occurences(send_node: send_node, location: location) ||
+        model_name_human_to_key_occurences(send_node: send_node, location: location)
+    end
+
+    private
+
+    def human_attribute_name_to_key_occurences(send_node:, location:)
+      children = Array(send_node&.children)
+      receiver = children[0]
+      method_name = children[1]
+
+      return unless method_name == :human_attribute_name && receiver.type == :const
+
+      value = children[2]
+
+      model_name = underscore(receiver.to_a.last)
+      attribute = extract_string(value)
+      key = "activerecord.attributes.#{model_name}.#{attribute}"
+      [
+        key,
+        I18n::Tasks::Scanners::Results::Occurrence.from_range(
+          raw_key: key,
+          range: location.expression
+        )
+      ]
+    end
+
+    # User.model_name.human(count: 2)
+    # s(:send,
+    #   s(:send,
+    #     s(:const, nil, :User), :model_name), :human,
+    #   s(:hash,
+    #     s(:pair,
+    #       s(:sym, :count),
+    #       s(:int, 2))))
+    def model_name_human_to_key_occurences(send_node:, location:)
+      children = Array(send_node&.children)
+      return unless children[1] == :human
+
+      base_children = Array(children[0]&.children)
+      class_node = base_children[0]
+
+      return unless class_node&.type == :const && base_children[1] == :model_name
+
+      model_name = underscore(class_node.to_a.last)
+      key = "activerecord.models.#{model_name}"
+      [
+        key,
+        I18n::Tasks::Scanners::Results::Occurrence.from_range(
+          raw_key: key,
+          range: location.expression
+        )
+      ]
+    end
+
+    def underscore(value)
+      value = value.dup.to_s
+      value.gsub!(/(.)([A-Z])/, '\1_\2')
+      value.downcase!
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'ast'
+require 'set'
+require 'i18n/tasks/scanners/local_ruby_parser'
+
+module I18n::Tasks::Scanners
+  class ErbAstProcessor
+    include AST::Processor::Mixin
+    def initialize
+      super()
+      @ruby_parser = LocalRubyParser.new(ignore_blocks: true)
+      @comments = []
+    end
+
+    def process_and_extract_comments(ast)
+      result = process(ast)
+      [result, @comments]
+    end
+
+    def on_code(node)
+      parsed, comments = @ruby_parser.parse(
+        node.children[0],
+        location: node.location
+      )
+      @comments.concat(comments)
+
+      unless parsed.nil?
+        parsed = parsed.updated(
+          nil,
+          parsed.children.map { |child| node?(child) ? process(child) : child }
+        )
+        node = node.updated(:send, parsed)
+      end
+      node
+    end
+
+    # @param node [::Parser::AST::Node]
+    # @return [::Parser::AST::Node]
+    def handler_missing(node)
+      node = handle_comment(node)
+      return if node.nil?
+
+      node.updated(
+        nil,
+        node.children.map { |child| node?(child) ? process(child) : child }
+      )
+    end
+
+    private
+
+    # Convert ERB-comments to ::Parser::Source::Comment and skip processing node
+    #
+    # @param node Parser::AST::Node Potential comment node
+    # @return Parser::AST::Node or nil
+    def handle_comment(node)
+      if node.type == :erb && node.children.size == 4 &&
+         node.children[0]&.type == :indicator && node.children[0].children[0] == '#' &&
+         node.children[2]&.type == :code
+
+        # Do not continue parsing this node
+        comment = node.children[2]
+        @comments << ::Parser::Source::Comment.new(comment.location.expression)
+        return
+      end
+
+      node
+    end
+
+    def node?(node)
+      node.is_a?(::Parser::AST::Node)
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/scanners/ruby_ast_scanner'
+require 'i18n/tasks/scanners/erb_ast_processor'
+require 'better_html/errors'
+require 'better_html/parser'
+
+module I18n::Tasks::Scanners
+  # Scan for I18n.translate calls in ERB-file better-html and ASTs
+  class ErbAstScanner < RubyAstScanner
+    def initialize(**args)
+      super(**args)
+      @erb_ast_processor = ErbAstProcessor.new
+    end
+
+    private
+
+    # Parse file on path and returns AST and comments.
+    #
+    # @param path Path to file to parse
+    # @return [{Parser::AST::Node}, [Parser::Source::Comment]]
+    def path_to_ast_and_comments(path)
+      parser = BetterHtml::Parser.new(make_buffer(path))
+      ast = convert_better_html(parser.ast)
+      @erb_ast_processor.process_and_extract_comments(ast)
+    end
+
+    # Convert BetterHtml nodes to Parser::AST::Node
+    #
+    # @param node BetterHtml::Parser::AST::Node
+    # @return Parser::AST::Node
+    def convert_better_html(node)
+      definition = Parser::Source::Map::Definition.new(
+        node.location.begin,
+        node.location.begin,
+        node.location.begin,
+        node.location.end
+      )
+      Parser::AST::Node.new(
+        node.type,
+        node.children.map { |child| child.is_a?(BetterHtml::AST::Node) ? convert_better_html(child) : child },
+        {
+          location: definition
+        }
+      )
+    end
+  end
+end

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

@@ -11,10 +11,11 @@ module I18n::Tasks::Scanners
     attr_reader :config
 
     def initialize(
-        config: {},
-        file_finder_provider: Files::CachingFileFinderProvider.new,
-        file_reader: Files::CachingFileReader.new
+      config: {},
+      file_finder_provider: Files::CachingFileFinderProvider.new,
+      file_reader: Files::CachingFileReader.new
     )
+      super()
       @config      = config
       @file_reader = file_reader
       @file_finder = file_finder_provider.get(**config.slice(:paths, :only, :exclude))

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

@@ -22,9 +22,6 @@ module I18n::Tasks::Scanners::Files
     # @param (see FileFinder#traverse_files)
     # @yieldparam (see FileFinder#traverse_files)
     # @return (see FileFinder#traverse_files)
-    def traverse_files
-      super
-    end
 
     alias uncached_find_files find_files
     private :uncached_find_files

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

@@ -15,6 +15,7 @@ module I18n::Tasks::Scanners::Files
     #     Files matching any of the exclusion patterns will be excluded even if they match an inclusion pattern.
     def initialize(paths: ['.'], only: nil, exclude: [])
       fail 'paths argument is required' if paths.nil?
+
       @paths   = paths
       @include = only
       @exclude = exclude || []
@@ -25,8 +26,8 @@ module I18n::Tasks::Scanners::Files
     # @yield [path]
     # @yieldparam path [String] the path of the found file.
     # @return [Array<of block results>]
-    def traverse_files
-      find_files.map { |path| yield path }
+    def traverse_files(&block)
+      find_files.map(&block)
     end
 
     # @return [Array<String>] found files