i18n-tasks 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 053f1f934ed84abbf4f86a11762c37c78cc286f8f809d3c8c5ca2918af57cb2a
-  data.tar.gz: 0f70179fa394de1faafc750185774d9a47f359de6b41c8542e038e8189933186
+  metadata.gz: 5006a01bb4cc0233b564962b0260a626c0985b9e787e234d95a8176c93716d94
+  data.tar.gz: a996c445790d6f679e17d77b241769d62fb6ee334af7bfa65f622b0c4b6b4864
 SHA512:
-  metadata.gz: 45934bf36576b5dfdf8e88f019779603ddcfe989c4d6ce5c3da75d07571b5097b1f06a7147663fadaef4995532d3d2661fc1733e2bf49396820202c14d33c005
-  data.tar.gz: 4853657f6fb46102d63d4a6f44ca0b07e3915ab7029369c815ec7530654973af30aee1184d826cc2df1a4a8c393525a3afa05005ef30aaabcf14435a66f693e6
+  metadata.gz: 26c74331f3f32be4c8fbb49c16b308d6549f75eada577c2a589b0897591607d29a92d535a3a680d93957ada6a402ecafe87b923c54ef5563bdad7ec09f3949ac
+  data.tar.gz: 792b07d6e3e8b90d15a2582c509b817189051846f9a1c520b0fb78a44aaa5c166def08c7819f204b3685d6d86a27f858e6c4a8ae0516c6305177a7c53217490b

data/README.md

@@ -24,7 +24,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', '~> 1.0.1'
+gem 'i18n-tasks', '~> 1.0.4'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -223,7 +223,7 @@ See the full list of tasks with `i18n-tasks --help`.
 
 ### Features and limitations
 
-`i18n-tasks` uses an AST scanner for `.rb` files, and a regexp-based scanner for other files, such as `.haml`.
+`i18n-tasks` uses an AST scanner for `.rb` and `.html.erb` files, and a regexp-based scanner for other files, such as `.haml`.
 
 #### Relative keys
 

data/lib/i18n/tasks/interpolations.rb

@@ -2,22 +2,26 @@
 
 module I18n::Tasks
   module Interpolations
-    VARIABLE_REGEX = /%{[^}]+}/.freeze
+    class << self
+      attr_accessor :variable_regex
+    end
+    @variable_regex = /%{[^}]+}/.freeze
 
     def inconsistent_interpolations(locales: nil, base_locale: nil) # rubocop:disable Metrics/AbcSize
       locales ||= self.locales
       base_locale ||= self.base_locale
       result = empty_forest
+      variable_regex = I18n::Tasks::Interpolations.variable_regex
 
       data[base_locale].key_values.each do |key, value|
         next if !value.is_a?(String) || ignore_key?(key, :inconsistent_interpolations)
 
-        base_vars = Set.new(value.scan(VARIABLE_REGEX))
+        base_vars = Set.new(value.scan(variable_regex))
         (locales - [base_locale]).each do |current_locale|
           node = data[current_locale].first.children[key]
           next unless node&.value.is_a?(String)
 
-          if base_vars != Set.new(node.value.scan(VARIABLE_REGEX))
+          if base_vars != Set.new(node.value.scan(variable_regex))
             result.merge!(node.walk_to_root.reduce(nil) { |c, p| [p.derive(children: c)] })
           end
         end

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

@@ -9,7 +9,7 @@ module I18n::Tasks::Scanners
     include AST::Processor::Mixin
     def initialize
       super()
-      @ruby_parser = LocalRubyParser.new
+      @ruby_parser = LocalRubyParser.new(ignore_blocks: true)
       @comments = []
     end
 
@@ -35,7 +35,10 @@ module I18n::Tasks::Scanners
       node
     end
 
+    # @param node [::Parser::AST::Node]
+    # @return [::Parser::AST::Node]
     def handler_missing(node)
+      node = transform_misparsed_comment(node)
       node.updated(
         nil,
         node.children.map { |child| node?(child) ? process(child) : child }
@@ -44,6 +47,35 @@ module I18n::Tasks::Scanners
 
     private
 
+    # Works around incorrect handling of comments of the form:
+    # <%# ... #>
+    # (no space between % and #)
+    #
+    # With a space the AST is:
+    #
+    #     s(:erb, nil, nil,
+    #       s(:code, " # this should not fail: ' "), nil)
+    #
+    # Without a space the AST is:
+    #
+    #     s(:erb,
+    #       s(:indicator, "#"), nil,
+    #       s(:code, " this should not fail: ' "), nil)
+    # @param node [::Parser::AST::Node]
+    # @return [::Parser::AST::Node]
+    def transform_misparsed_comment(node)
+      return node unless node.type == :erb && node.children.size == 4 &&
+        node.children[0]&.type == :indicator && node.children[0].children[0] == "#" &&
+        node.children[1].nil? &&
+        node.children[2]&.type == :code &&
+        node.children[3].nil?
+      code_node = node.children[2]
+      node.updated(
+        nil,
+        [nil, nil, code_node.updated(nil, ["##{code_node.children[0]}"]), nil]
+      )
+    end
+
     def node?(node)
       node.is_a?(::Parser::AST::Node)
     end

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

@@ -4,14 +4,23 @@ require 'parser/current'
 
 module I18n::Tasks::Scanners
   class LocalRubyParser
-    def initialize
+    # 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
+
+    def initialize(ignore_blocks: false)
       @parser = ::Parser::CurrentRuby.new
+      @ignore_blocks = ignore_blocks
     end
 
     # Parse string and normalize location
     def parse(source, location: nil)
       buffer = ::Parser::Source::Buffer.new('(string)')
-      buffer.source = source
+      buffer.source = if @ignore_blocks
+                        source.sub(BLOCK_EXPR, '')
+                      else
+                        source
+                      end
 
       @parser.reset
       ast, comments = @parser.parse_with_comments(buffer)
@@ -43,6 +52,8 @@ module I18n::Tasks::Scanners
     # @param local_location {Parser::Source::Map} Local location in the parsed string
     # @return {Parser::Source::Map}
     def updated_location(global_location, local_location)
+      return global_location if local_location.expression.nil?
+
       range = ::Parser::Source::Range.new(
         global_location.expression.source_buffer,
         global_location.expression.to_range.begin + local_location.expression.to_range.begin,

data/lib/i18n/tasks/scanners/results/occurrence.rb

@@ -48,7 +48,7 @@ module I18n::Tasks
         # rubocop:enable Metrics/ParameterLists
 
         def inspect
-          "Occurrence(#{@path}:#{@line_num}:#{@line_pos}:#{@pos}:#{@raw_key}:#{@default_arg}:#{@line})"
+          "Occurrence(#{@path}:#{@line_num}, line_pos: #{@line_pos}, pos: #{@pos}, raw_key: #{@raw_key}, default_arg: #{@default_arg}, line: #{@line})"
         end
 
         def ==(other)

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '1.0.1'
+    VERSION = '1.0.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - glebm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport