i18n-tasks 1.0.15 → 1.1.0

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/scanners/file_scanner'
-require 'i18n/tasks/scanners/relative_keys'
-require 'i18n/tasks/scanners/occurrence_from_position'
-require 'i18n/tasks/scanners/ruby_key_literals'
+require "i18n/tasks/scanners/file_scanner"
+require "i18n/tasks/scanners/relative_keys"
+require "i18n/tasks/scanners/occurrence_from_position"
+require "i18n/tasks/scanners/ruby_key_literals"
 
 module I18n::Tasks::Scanners
   # Maps the provided patterns to keys.
@@ -34,14 +34,14 @@ module I18n::Tasks::Scanners
       @patterns.flat_map do |pattern, key|
         result = []
         text.scan(pattern) do |_|
-          match    = Regexp.last_match
-          matches  = match.names.map(&:to_sym).zip(match.captures).to_h
+          match = Regexp.last_match
+          matches = match.names.map(&:to_sym).zip(match.captures).to_h
           if matches.key?(:key)
             matches[:key] = strip_literal(matches[:key])
             next unless valid_key?(matches[:key])
           end
           result << [absolute_key(format(key, matches), path),
-                     occurrence_from_position(path, text, match.offset(0).first)]
+            occurrence_from_position(path, text, match.offset(0).first)]
         end
         result
       end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/scanners/file_scanner'
-require 'i18n/tasks/scanners/relative_keys'
-require 'i18n/tasks/scanners/occurrence_from_position'
-require 'i18n/tasks/scanners/ruby_key_literals'
+require "i18n/tasks/scanners/file_scanner"
+require "i18n/tasks/scanners/relative_keys"
+require "i18n/tasks/scanners/occurrence_from_position"
+require "i18n/tasks/scanners/ruby_key_literals"
 
 module I18n::Tasks::Scanners
   # Scan for I18n.t usages using a simple regular expression.
@@ -12,15 +12,15 @@ module I18n::Tasks::Scanners
     include OccurrenceFromPosition
     include RubyKeyLiterals
 
-    TRANSLATE_CALL_RE = /(?<=^|[^\p{L}_'\-.]|[^\p{L}'-]I18n\.|I18n\.)t(?:!|ranslate!?)?/.freeze
+    TRANSLATE_CALL_RE = /(?<=^|[^\p{L}_'\-.]|[^\p{L}'-]I18n\.|I18n\.)t(?:!|ranslate!?)?/
     IGNORE_LINES = {
-      'coffee' => /^\s*#(?!\si18n-tasks-use)/,
-      'erb' => /^\s*<%\s*#(?!\si18n-tasks-use)/,
-      'es6' => %r{^\s*//(?!\si18n-tasks-use)},
-      'haml' => /^\s*-\s*#(?!\si18n-tasks-use)/,
-      'js' => %r{^\s*//(?!\si18n-tasks-use)},
-      'opal' => /^\s*#(?!\si18n-tasks-use)/,
-      'slim' => %r{^\s*(?:-#|/)(?!\si18n-tasks-use)}
+      "coffee" => /^\s*#(?!\si18n-tasks-use)/,
+      "erb" => /^\s*<%\s*#(?!\si18n-tasks-use)/,
+      "es6" => %r{^\s*//(?!\si18n-tasks-use)},
+      "haml" => /^\s*-\s*#(?!\si18n-tasks-use)/,
+      "js" => %r{^\s*//(?!\si18n-tasks-use)},
+      "opal" => /^\s*#(?!\si18n-tasks-use)/,
+      "slim" => %r{^\s*(?:-#|/)(?!\si18n-tasks-use)}
     }.freeze
 
     def initialize(**args)
@@ -47,13 +47,13 @@ module I18n::Tasks::Scanners
         key = match_to_key(match, path, location)
         next unless key
 
-        key += ':' if key.end_with?('.')
+        key += ":" if key.end_with?(".")
         next unless valid_key?(key)
 
         keys << [key, location]
       end
       keys
-    rescue Exception => e # rubocop:disable Lint/RescueException
+    rescue => e
       raise ::I18n::Tasks::CommandError.new(e, "Error scanning #{path}: #{e.message}")
     end
 
@@ -62,7 +62,7 @@ module I18n::Tasks::Scanners
     # @return [String] full absolute key name
     def match_to_key(match, path, location)
       absolute_key(strip_literal(match[0]), path,
-                   calling_method: -> { closest_method(location) if key_relative_to_method?(path) })
+        calling_method: -> { closest_method(location) if key_relative_to_method?(path) })
     end
 
     def exclude_line?(line, path)
@@ -70,11 +70,11 @@ module I18n::Tasks::Scanners
       re && re =~ line
     end
 
-    VALID_KEY_RE_DYNAMIC = /^(#{VALID_KEY_CHARS}|[:\#{@}\[\]])+$/.freeze
+    VALID_KEY_RE_DYNAMIC = /^(#{VALID_KEY_CHARS}|[:\#{@}\[\]])+$/
 
     def valid_key?(key)
       if @config[:strict]
-        super(key)
+        super
       else
         key =~ VALID_KEY_RE_DYNAMIC
       end
@@ -85,9 +85,9 @@ module I18n::Tasks::Scanners
     end
 
     def closest_method(occurrence)
-      method = File.readlines(occurrence.path, encoding: 'UTF-8')
-                   .first(occurrence.line_num - 1).reverse_each.find { |x| x =~ /\bdef\b/ }
-      method && method.strip.sub(/^def\s*/, '').sub(/[(\s;].*$/, '')
+      method = File.readlines(occurrence.path, encoding: "UTF-8")
+        .first(occurrence.line_num - 1).reverse_each.find { |x| x =~ /\bdef\b/ }
+      method && method.strip.sub(/^def\s*/, "").sub(/[(\s;].*$/, "")
     end
 
     # This method only exists for backwards compatibility with monkey-patches and plugins

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/scanners/pattern_scanner'
+require "i18n/tasks/scanners/pattern_scanner"
 
 module I18n::Tasks::Scanners
   # Scans for I18n.t(key, scope: ...) usages
@@ -21,13 +21,13 @@ module I18n::Tasks::Scanners
     # @param [String] path
     # @return [String] full absolute key name with scope resolved if any
     def match_to_key(match, path, location)
-      key   = super
+      key = super
       scope = match[1]
       if scope
         scope_parts = extract_literal_or_array_of_literals(scope)
         return nil if scope_parts.nil? || scope_parts.empty?
 
-        "#{scope_parts.join('.')}.#{key}"
+        "#{scope_parts.join(".")}.#{key}"
       else
         key unless match[0] =~ /\A\w/
       end
@@ -43,7 +43,7 @@ module I18n::Tasks::Scanners
       if val =~ /\A[\w@]/
         "\#{#{val}}"
       else
-        super(val)
+        super
       end
     end
 
@@ -77,18 +77,18 @@ module I18n::Tasks::Scanners
         end
       end
       s.each_char.with_index do |c, i|
-        if c == '['
+        if c == "["
           return nil unless braces_stack.empty?
 
           braces_stack.push(i)
-        elsif c == ']'
+        elsif c == "]"
           break
-        elsif c == ','
+        elsif c == ","
           consume_literal.call
           break if braces_stack.empty?
         elsif c =~ VALID_KEY_CHARS || /['":]/ =~ c
           acc << c
-        elsif c != ' '
+        elsif c != " "
           return nil
         end
       end

data/lib/i18n/tasks/scanners/prism_scanners/arguments_visitor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'prism/visitor'
+require "prism/visitor"
 
 # This class is used to parse the arguments to e.g. a Prism::CallNode and return the values we need
 # for turning them into translations and occurrences.
@@ -9,11 +9,18 @@ module I18n::Tasks::Scanners::PrismScanners
   class ArgumentsVisitor < Prism::Visitor
     def visit_keyword_hash_node(node)
       node.child_nodes.each_with_object({}) do |child, hash|
+        next if child.type == :assoc_splat_node
+
         hash[visit(child.key)] = visit(child.value)
         hash
       end
     end
 
+    # Cannot handle arguments that are calls
+    def visit_call_node(_node)
+      nil
+    end
+
     def visit_symbol_node(node)
       node.value
     end

data/lib/i18n/tasks/scanners/prism_scanners/nodes.rb

@@ -4,14 +4,16 @@
 # Used in the PrismScanners::Visitor class.
 module I18n::Tasks::Scanners::PrismScanners
   class Root
-    attr_reader(:calls, :translation_calls, :children, :node, :parent)
+    attr_reader(:calls, :translation_calls, :children, :node, :parent, :rails, :file_path)
 
-    def initialize(node: nil, parent: nil)
+    def initialize(node: nil, parent: nil, file_path: nil, rails: false)
       @calls = []
       @translation_calls = []
       @children = []
       @node = node
       @parent = parent
+      @rails = rails
+      @file_path = file_path
     end
 
     def add_child(node)
@@ -24,27 +26,44 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def add_translation_call(translation_call)
-      @translation_calls << translation_call
+      @translation_calls += Array(translation_call)
     end
 
-    def support_relative_keys?
-      false
+    def rails_view?
+      rails && file_path.present? && file_path.include?("app/views/")
     end
 
-    def private_method
-      false
+    def partial_view?
+      file_path.present? && File.basename(file_path).start_with?("_")
+    end
+
+    def support_relative_keys?
+      rails_view? && !partial_view?
     end
 
     def path
-      []
+      if rails_view?
+        folder_path = file_path.sub(%r{app/views/}, "").split("/")
+        name = folder_path.pop.split(".").first
+
+        [*folder_path, name]
+      else
+        []
+      end
     end
 
     def process
       (@translation_calls + @children.flat_map(&:process)).flatten
     end
+
+    # Only supported for Rails controllers currently
+    def private_method
+      false
+    end
   end
 
   class TranslationCall
+    class ScopeError < StandardError; end
     attr_reader(:node, :key, :receiver, :options, :parent)
 
     def initialize(node:, key:, receiver:, options:, parent:)
@@ -56,7 +75,7 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def relative_key?
-      @key&.start_with?('.') && @receiver.nil?
+      @key&.start_with?(".") && @receiver.nil?
     end
 
     def with_parent(parent)
@@ -83,34 +102,47 @@ module I18n::Tasks::Scanners::PrismScanners
       occurrence(file_path)
     end
 
+    # Returns either a single key string or an array of candidate key strings for this call.
     def full_key
       return nil if key.nil?
       return nil unless key.is_a?(String)
       return nil if relative_key? && !support_relative_keys?
 
-      parts = [scope]
+      base_parts = [scope].compact
 
       if relative_key?
-        parts.concat(parent&.path || [])
-        parts << key
+        # For relative keys in controllers/methods, generate candidate keys by
+        # progressively stripping trailing path segments from the parent path.
+        # Example: parent.path = ["events", "create"], key = ".success"
+        # yields: ["events.create.success", "events.success"]
+        parent_path = parent&.path || []
+        rel_key = key[1..] # strip leading dot # rubocop:disable Performance/ArraySemiInfiniteRangeSlice
+
+        candidates = []
+        parent_path_length = parent_path.length
+        # Do not generate an unscoped bare key (keep_count = 0). Start from full parent path
+        parent_path_length.downto(1) do |keep_count|
+          parts = base_parts + parent_path.first(keep_count) + [rel_key]
+          candidates << parts.compact.join(".")
+        end
 
-        # TODO: Fallback to controller without action name
-      elsif key.start_with?('.')
-        parts << key[1..]
+        candidates.map { |c| c.gsub("..", ".") }
+      elsif key.start_with?(".")
+        [base_parts + [key[1..]]].flatten.compact.join(".").gsub("..", ".") # rubocop:disable Performance/ArraySemiInfiniteRangeSlice,Performance/ChainArrayAllocation
       else
-        parts << key
+        [base_parts + [key]].flatten.compact.join(".").gsub("..", ".") # rubocop:disable Performance/ChainArrayAllocation
       end
-
-      parts.compact.join('.').gsub('..', '.')
     end
 
     private
 
     def scope
       return nil if @options.nil?
-      return nil unless @options['scope']
+      return nil unless @options["scope"]
 
-      Array(@options['scope']).compact.map(&:to_s).join('.')
+      fail(ScopeError, "Could not process scope") if @options.key?("scope") && (Array(@options["scope"]).empty? || !Array(@options["scope"]).all? { |s| s.is_a?(String) || s.is_a?(Symbol) })
+
+      Array(@options["scope"]).join(".")
     end
 
     def occurrence(file_path)
@@ -118,38 +150,35 @@ module I18n::Tasks::Scanners::PrismScanners
 
       location = local_node.location
 
-      final_key = full_key
-      return nil if final_key.nil?
-
-      [
-        final_key,
-        ::I18n::Tasks::Scanners::Results::Occurrence.new(
-          path: file_path,
-          line: local_node.respond_to?(:slice) ? local_node.slice : local_node.location.slice,
-          pos: location.start_offset,
-          line_pos: location.start_column,
-          line_num: location.start_line,
-          raw_key: key
-        )
-      ]
-    end
-
-    def occurrences_from_comments(file_path)
-      Array(@comment_translations).flat_map do |child_node|
-        child_node.with_context(
-          path: @path,
-          options: {
-            **@context_options,
-            comment_for_node: @node
-          }
-        ).occurrences(file_path)
+      final = full_key
+      return nil if final.nil?
+
+      occurrence = ::I18n::Tasks::Scanners::Results::Occurrence.new(
+        path: file_path,
+        line: local_node.respond_to?(:slice) ? local_node.slice : local_node.location.slice,
+        pos: location.start_offset,
+        line_pos: location.start_column,
+        line_num: location.start_line,
+        raw_key: key
+      )
+
+      # full_key may be a single String or an Array of candidate strings
+      if final.is_a?(Array)
+        # record candidate keys on the occurrence (first candidate is the primary)
+        occurrence.instance_variable_set(:@candidate_keys, final)
+        [final.first, occurrence]
+      else
+        occurrence.instance_variable_set(:@candidate_keys, [final])
+        [final, occurrence]
       end
+    rescue ScopeError
+      nil
     end
 
     # Only public methods are added to the context path
     # Only some classes supports relative keys
     def support_relative_keys?
-      parent.is_a?(ParsedMethod) && parent.support_relative_keys?
+      (parent.is_a?(ParsedMethod) || parent.is_a?(Root)) && parent.support_relative_keys?
     end
   end
 
@@ -158,10 +187,6 @@ module I18n::Tasks::Scanners::PrismScanners
       false
     end
 
-    def private_method
-      false
-    end
-
     def path
       (@parent&.path || []) + [path_name]
     end
@@ -179,9 +204,8 @@ module I18n::Tasks::Scanners::PrismScanners
       @methods = []
       @private_methods = []
       @before_actions = []
-      @rails = rails
 
-      super(node: node, parent: parent)
+      super
     end
 
     def add_child(node)
@@ -200,8 +224,14 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def process # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-      return @children.flat_map(&:process) unless controller?
+      if controller?
+        process_controller
+      else
+        super
+      end
+    end
 
+    def process_controller
       methods_by_name = @methods.group_by(&:name)
       private_methods_by_name = @private_methods.group_by(&:name)
 
@@ -221,7 +251,9 @@ module I18n::Tasks::Scanners::PrismScanners
           next unless before_action.applies_to?(method.name)
 
           method.add_translation_call(
-            translation_calls.map { |call| call.with_parent(method) }
+            translation_calls.map do |call|
+              call.with_parent(method)
+            end
           )
         end
       end
@@ -240,7 +272,7 @@ module I18n::Tasks::Scanners::PrismScanners
           nested_calls[method.name] << other_method.name
 
           if nested_calls[call.name]&.include?(method.name)
-            fail(ArgumentError, "Cyclic call detected: #{call.name} -> #{method.name}")
+            next
           end
 
           other_method.translation_calls.each do |translation_call|
@@ -249,7 +281,7 @@ module I18n::Tasks::Scanners::PrismScanners
         end
       end
 
-      @children.flat_map(&:process) + new_translation_calls
+      @translation_calls + @children.flat_map(&:process) + new_translation_calls
     end
 
     def private_methods!
@@ -257,7 +289,7 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def support_relative_keys?
-      @rails && controller?
+      controller? || mailer?
     end
 
     def path
@@ -265,12 +297,16 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def controller?
-      @node.name.to_s.end_with?('Controller')
+      @rails && @node.name.to_s.end_with?("Controller")
+    end
+
+    def mailer?
+      @rails && @node.name.to_s.end_with?("Mailer")
     end
 
     def path_name
       path = @node.constant_path.full_name_parts.map { |s| s.to_s.underscore }
-      path.last.gsub!(/_controller\z/, '') if controller?
+      path.last.delete_suffix!("_controller") if controller?
 
       path
     end
@@ -301,7 +337,7 @@ module I18n::Tasks::Scanners::PrismScanners
   end
 
   class ParsedBeforeAction < Root
-    attr_reader(:name)
+    attr_accessor(:name, :only, :except)
 
     def initialize(node:, parent:, name: nil, only: nil, except: nil)
       @name = name
@@ -312,7 +348,7 @@ module I18n::Tasks::Scanners::PrismScanners
     end
 
     def support_relative_keys?
-      true
+      false
     end
 
     def applies_to?(method_name)
@@ -330,5 +366,9 @@ module I18n::Tasks::Scanners::PrismScanners
     def path
       @parent&.path || []
     end
+
+    def process
+      @translation_calls.filter { |call| !call.relative_key? }
+    end
   end
 end