i18n-tasks 1.0.14 → 1.1.0

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

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/scanners/ruby_ast_scanner'
-require 'i18n/tasks/scanners/local_ruby_parser'
+require "i18n/tasks/scanners/ruby_scanner"
+require "i18n/tasks/scanners/local_ruby_parser"
+require "i18n/tasks/scanners/occurrence_from_position"
+require "prism"
 
 module I18n::Tasks::Scanners
-  # Scan for I18n.translate calls in ERB-file better-html and ASTs
-  class ErbAstScanner < RubyAstScanner
-    DEFAULT_REGEXP = /<%(={1,2}|-|\#|%)?(.*?)([-=])?%>/m.freeze
+  # Scan for I18n.translate calls in ERB-file using regexp and Parser/Prism
+  class ErbAstScanner < RubyScanner
+    include OccurrenceFromPosition
 
-    def initialize(**args)
-      super(**args)
-      @ruby_parser = LocalRubyParser.new(ignore_blocks: true)
+    DEFAULT_REGEXP = /<%(={1,2}|-|\#-?|%)?(.*?)([-=])?%>/m
+
+    # Parser scanner, method called in RubyScanner
+    def ast_parser_parse_file(path)
+      @ruby_parser ||= LocalRubyParser.new(ignore_blocks: true)
+      super
     end
 
     private
@@ -34,11 +39,11 @@ module I18n::Tasks::Scanners
           stop = match.end(0) - 2 - (tailch&.size || 0)
 
           case character
-          when '=', nil, '-'
+          when "=", nil, "-"
             parsed, parsed_comments = handle_code(buffer, code, start, stop)
             comments.concat(parsed_comments)
             children << parsed unless parsed.nil?
-          when '#', '#-'
+          when "#", "#-"
             comments << handle_comment(buffer, start, stop)
           end
         end
@@ -74,5 +79,59 @@ module I18n::Tasks::Scanners
         )
       ::Parser::AST::Node.new(:erb, children, location: location)
     end
+
+    # Prism scanner, method called in RubyScanner
+    def prism_parse_file(path)
+      occurrences = []
+      content = File.read(path)
+
+      content.scan(DEFAULT_REGEXP) do |indicator, code, _tailch, _rspace|
+        match = Regexp.last_match
+        character = indicator ? indicator[0] : nil
+        start = match.begin(0) + 2 + (character&.size || 0)
+
+        case character
+        when "=", nil, "-"
+          occurrences += process_code(path, code, content, start)
+        when "#", "#-"
+          occurrences += process_comments(path, code, content, start)
+        end
+      end
+
+      occurrences
+    end
+
+    def process_code(path, code, content, start)
+      return [] if code.strip.empty? # skip empty ERB tags
+
+      process_prism_results(path, Prism.parse(code)).map do |key, occurrence|
+        [
+          key,
+          occurrence_from_position(
+            path,
+            content,
+            start + occurrence.pos,
+            raw_key: occurrence.raw_key
+          )
+        ]
+      end
+    end
+
+    def process_comments(path, code, content, start)
+      return [] if code.strip.empty?
+
+      parsed = Prism.parse(code.gsub("i18n-tasks-use ", "#i18n-tasks-use "))
+      process_prism_results(path, parsed).map do |key, occurrence|
+        [
+          key,
+          occurrence_from_position(
+            path,
+            content,
+            start + (code.index(key) || occurrence.pos),
+            raw_key: occurrence.raw_key
+          )
+        ]
+      end
+    end
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/scanners/scanner'
+require "i18n/tasks/scanners/scanner"
 
 module I18n::Tasks::Scanners
   # A base class for a scanner that analyses files.
@@ -16,7 +16,7 @@ module I18n::Tasks::Scanners
       file_reader: Files::CachingFileReader.new
     )
       super()
-      @config      = config
+      @config = config
       @file_reader = file_reader
       @file_finder = file_finder_provider.get(**config.slice(:paths, :only, :exclude))
     end
@@ -36,7 +36,7 @@ module I18n::Tasks::Scanners
     #
     # @return [Array<[key, Results::KeyOccurrence]>] each occurrence found in the file
     def scan_file(_path)
-      fail 'Unimplemented'
+      fail "Unimplemented"
     end
 
     # Read a file. Reads of the same path are cached.
@@ -53,8 +53,8 @@ module I18n::Tasks::Scanners
     # @param (see FileFinder#traverse_files)
     # @yieldparam (see FileFinder#traverse_files)
     # @return (see FileFinder#traverse_files)
-    def traverse_files(&block)
-      @file_finder.traverse_files(&block)
+    def traverse_files(&)
+      @file_finder.traverse_files(&)
     end
 
     # @note This method is cached, it will only access the filesystem on the first invocation.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/concurrent/cached_value'
-require 'i18n/tasks/scanners/files/file_finder'
+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.
@@ -23,7 +23,7 @@ module I18n::Tasks::Scanners::Files
     # @yieldparam (see FileFinder#traverse_files)
     # @return (see FileFinder#traverse_files)
 
-    alias uncached_find_files find_files
+    alias_method :uncached_find_files, :find_files
     private :uncached_find_files
 
     # @note This method is cached, it will only access the filesystem on the first invocation.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/concurrent/cache'
-require 'i18n/tasks/scanners/files/caching_file_finder'
+require "i18n/tasks/concurrent/cache"
+require "i18n/tasks/scanners/files/caching_file_finder"
 
 module I18n::Tasks::Scanners::Files
   # Finds the files and provides their contents.
@@ -12,7 +12,7 @@ module I18n::Tasks::Scanners::Files
     # @param exclude [Array<String>]
     def initialize(exclude: [])
       @cache = ::I18n::Tasks::Concurrent::Cache.new
-      @defaults = { exclude: exclude }
+      @defaults = {exclude: exclude}
     end
 
     # Initialize a {CachingFileFinder} or get one from cache based on the constructor arguments.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/concurrent/cache'
-require 'i18n/tasks/scanners/files/file_reader'
+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.

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

@@ -13,10 +13,10 @@ module I18n::Tasks::Scanners::Files
     #     Files not matching any of the inclusion patterns will be excluded.
     # @param exclude [Arry<String>] {File.fnmatch}-compatible patterns of files to exclude.
     #     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?
+    def initialize(paths: ["."], only: nil, exclude: [])
+      fail "paths argument is required" if paths.nil?
 
-      @paths   = paths
+      @paths = paths
       @include = only
       @exclude = exclude || []
     end
@@ -26,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(&block)
-      find_files.map(&block)
+    def traverse_files(&)
+      find_files.map(&)
     end
 
     # @return [Array<String>] found files
@@ -36,10 +36,10 @@ module I18n::Tasks::Scanners::Files
       paths = @paths.select { |p| File.exist?(p) }
       log_warn "None of the search.paths exist #{@paths.inspect}" if paths.empty?
       Find.find(*paths) do |path|
-        is_dir   = File.directory?(path)
-        hidden   = File.basename(path).start_with?('.') && !%w[. ./].include?(path)
+        is_dir = File.directory?(path)
+        hidden = File.basename(path).start_with?(".") && !%w[. ./].include?(path)
         not_incl = @include && !path_fnmatch_any?(path, @include)
-        excl     = path_fnmatch_any?(path, @exclude)
+        excl = path_fnmatch_any?(path, @exclude)
         if is_dir || hidden || not_incl || excl
           Find.prune if is_dir && (hidden || excl)
         else

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

@@ -12,7 +12,7 @@ module I18n::Tasks::Scanners::Files
     # @return [String] file contents
     def read_file(path)
       result = nil
-      File.open(path, 'rb', encoding: 'UTF-8') { |f| result = f.read }
+      File.open(path, "rb", encoding: "UTF-8") { |f| result = f.read }
       result
     end
   end

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

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'parser/current'
+require "i18n/tasks/scanners/ruby_parser_factory"
 
 module I18n::Tasks::Scanners
   class LocalRubyParser
     # ignore_blocks feature inspired by shopify/better-html
     # https://github.com/Shopify/better-html/blob/087943ffd2a5877fa977d71532010b0c91239519/lib/better_html/test_helper/ruby_node.rb#L24
-    BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/.freeze
+    BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
 
     def initialize(ignore_blocks: false)
-      @parser = ::Parser::CurrentRuby.new
+      @parser = RubyParserFactory.create_parser
       @ignore_blocks = ignore_blocks
     end
 
     # Parse string and normalize location
     def parse(source, location: nil)
-      buffer = ::Parser::Source::Buffer.new('(string)')
+      buffer = ::Parser::Source::Buffer.new("(string)")
       buffer.source = if @ignore_blocks
-                        source.sub(BLOCK_EXPR, '')
-                      else
-                        source
-                      end
+        source.sub(BLOCK_EXPR, "")
+      else
+        source
+      end
 
       @parser.reset
       ast, comments = @parser.parse_with_comments(buffer)
@@ -42,7 +42,7 @@ module I18n::Tasks::Scanners
       node.updated(
         nil,
         node.children.map { |child| normalize_location(child, location) },
-        { location: updated_location(location, node.location) }
+        {location: updated_location(location, node.location)}
       )
     end
 

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

@@ -13,7 +13,7 @@ module I18n
         # @return [Results::Occurrence]
         def occurrence_from_position(path, contents, position, raw_key: nil)
           line_begin = contents.rindex(/^/, position - 1)
-          line_end   = contents.index(/.(?=\r?\n|$)/, position)
+          line_end = contents.index(/.(?=\r?\n|$)/, position)
           Results::Occurrence.new(
             path: path,
             pos: position,

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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.
+# Used in the PrismScanners::Visitor class.
+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
+
+    def visit_string_node(node)
+      node.content
+    end
+
+    def visit_array_node(node)
+      node.child_nodes.map { |child| visit(child) }
+    end
+
+    def visit_arguments_node(node)
+      node.child_nodes.map { |child| visit(child) }
+    end
+
+    def visit_integer_node(node)
+      node.value
+    end
+
+    def visit_lambda_node(node)
+      node
+    end
+  end
+end