theme-check 1.5.1 → 1.6.2

data/lib/theme_check/{visitor.rb → liquid_visitor.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module ThemeCheck
-  class Visitor
+  class LiquidVisitor
     attr_reader :checks
 
     def initialize(checks, disabled_checks)
@@ -8,10 +8,10 @@ module ThemeCheck
       @disabled_checks = disabled_checks
     end
 
-    def visit_template(template)
-      visit(Node.new(template.root, nil, template))
+    def visit_liquid_file(liquid_file)
+      visit(LiquidNode.new(liquid_file.root, nil, liquid_file))
     rescue Liquid::Error => exception
-      exception.template_name = template.name
+      exception.template_name = liquid_file.name
       call_checks(:on_error, exception)
     end
 

data/lib/theme_check/locale_diff.rb

@@ -14,26 +14,26 @@ module ThemeCheck
       visit_object(@default, @other, [])
     end
 
-    def add_as_offenses(check, key_prefix: [], node: nil, template: nil)
+    def add_as_offenses(check, key_prefix: [], node: nil, theme_file: nil)
       if extra_keys.any?
         add_keys_offense(check, "Extra translation keys", extra_keys,
-          key_prefix: key_prefix, node: node, template: template)
+          key_prefix: key_prefix, node: node, theme_file: theme_file)
       end
 
       if missing_keys.any?
         add_keys_offense(check, "Missing translation keys", missing_keys,
-          key_prefix: key_prefix, node: node, template: template)
+          key_prefix: key_prefix, node: node, theme_file: theme_file)
       end
     end
 
     private
 
-    def add_keys_offense(check, cause, keys, key_prefix:, node: nil, template: nil)
+    def add_keys_offense(check, cause, keys, key_prefix:, node: nil, theme_file: nil)
       message = "#{cause}: #{format_keys(key_prefix, keys)}"
       if node
         check.add_offense(message, node: node)
       else
-        check.add_offense(message, template: template)
+        check.add_offense(message, theme_file: theme_file)
       end
     end
 

data/lib/theme_check/node.rb

@@ -1,143 +1,37 @@
 # frozen_string_literal: true
 
 module ThemeCheck
-  # A node from the Liquid AST, the result of parsing a template.
   class Node
-    attr_reader :value, :parent, :template
-
-    def initialize(value, parent, template)
-      raise ArgumentError, "Expected a Liquid AST Node" if value.is_a?(Node)
-      @value = value
-      @parent = parent
-      @template = template
+    def parent
+      raise NotImplementedError
     end
 
-    # The original source code of the node. Doesn't contain wrapping braces.
-    def markup
-      if tag?
-        @value.raw
-      elsif @value.instance_variable_defined?(:@markup)
-        @value.instance_variable_get(:@markup)
-      end
+    def theme_file
+      raise NotImplementedError
     end
 
-    def markup=(markup)
-      if @value.instance_variable_defined?(:@markup)
-        @value.instance_variable_set(:@markup, markup)
-      end
+    def value
+      raise NotImplementedError
     end
 
-    # Array of children nodes.
     def children
-      @children ||= begin
-        nodes =
-          if comment?
-            []
-          elsif defined?(@value.class::ParseTreeVisitor)
-            @value.class::ParseTreeVisitor.new(@value, {}).children
-          elsif @value.respond_to?(:nodelist)
-            Array(@value.nodelist)
-          else
-            []
-          end
-        # Work around a bug in Liquid::Variable::ParseTreeVisitor that doesn't return
-        # the args in a hash as children nodes.
-        nodes = nodes.flat_map do |node|
-          case node
-          when Hash
-            node.values
-          else
-            node
-          end
-        end
-        nodes.map { |node| Node.new(node, self, @template) }
-      end
-    end
-
-    # Literals are hard-coded values in the template.
-    def literal?
-      @value.is_a?(String) || @value.is_a?(Integer)
+      raise NotImplementedError
     end
 
-    # A {% tag %} node?
-    def tag?
-      @value.is_a?(Liquid::Tag)
-    end
-
-    # A {% comment %} block node?
-    def comment?
-      @value.is_a?(Liquid::Comment)
-    end
-
-    # Top level node of every template.
-    def document?
-      @value.is_a?(Liquid::Document)
-    end
-    alias_method :root?, :document?
-
-    # A {% tag %}...{% endtag %} node?
-    def block_tag?
-      @value.is_a?(Liquid::Block)
-    end
-
-    # The body of blocks
-    def block_body?
-      @value.is_a?(Liquid::BlockBody)
-    end
-
-    # A block of type of node?
-    def block?
-      block_tag? || block_body? || document?
+    def markup
+      raise NotImplementedError
     end
 
-    # Most nodes have a line number, but it's not guaranteed.
     def line_number
-      @value.line_number if @value.respond_to?(:line_number)
-    end
-
-    # The `:under_score_name` of this type of node. Used to dispatch to the `on_<type_name>`
-    # and `after_<type_name>` check methods.
-    def type_name
-      @type_name ||= StringHelpers.underscore(StringHelpers.demodulize(@value.class.name)).to_sym
-    end
-
-    # Is this node inside a `{% liquid ... %}` block?
-    def inside_liquid_tag?
-      if line_number
-        template.excerpt(line_number).start_with?("{%")
-      else
-        false
-      end
-    end
-
-    # Is this node inside a `{%- ... -%}`
-    def whitespace_trimmed?
-      if line_number
-        template.excerpt(line_number).start_with?("{%-")
-      else
-        false
-      end
-    end
-
-    def range
-      start = template.full_line(line_number).index(markup)
-      [start, start + markup.length - 1]
-    end
-
-    def position
-      @position ||= Position.new(
-        markup,
-        template&.source,
-        line_number_1_indexed: line_number
-      )
+      raise NotImplementedError
     end
 
     def start_index
-      position.start_index
+      raise NotImplementedError
     end
 
     def end_index
-      position.end_index
+      raise NotImplementedError
     end
   end
 end

data/lib/theme_check/offense.rb

@@ -5,13 +5,13 @@ module ThemeCheck
 
     MAX_SOURCE_EXCERPT_SIZE = 120
 
-    attr_reader :check, :message, :template, :node, :markup, :line_number, :correction
+    attr_reader :check, :message, :theme_file, :node, :markup, :line_number, :correction
 
     def initialize(
       check:, # instance of a ThemeCheck::Check
       message: nil, # error message for the offense
-      template: nil, # Template
-      node: nil, # Node or HtmlNode
+      theme_file: nil, # ThemeFile
+      node: nil, # Node
       markup: nil, # string
       line_number: nil, # line number of the error (1-indexed)
       # node_markup_offset is the index inside node.markup to start
@@ -39,11 +39,11 @@ module ThemeCheck
       end
 
       @node = node
-      @template = nil
+      @theme_file = nil
       if node
-        @template = node.template
-      elsif template
-        @template = template
+        @theme_file = node.theme_file
+      elsif theme_file
+        @theme_file = theme_file
       end
 
       @markup = if markup
@@ -62,7 +62,7 @@ module ThemeCheck
 
       @position = Position.new(
         @markup,
-        @template&.source,
+        @theme_file&.source,
         line_number_1_indexed: @line_number,
         node_markup_offset: node_markup_offset,
         node_markup: node&.markup
@@ -72,7 +72,7 @@ module ThemeCheck
     def source_excerpt
       return unless line_number
       @source_excerpt ||= begin
-        excerpt = template.source_excerpt(line_number)
+        excerpt = theme_file.source_excerpt(line_number)
         if excerpt.size > MAX_SOURCE_EXCERPT_SIZE
           excerpt[0, MAX_SOURCE_EXCERPT_SIZE - 3] + '...'
         else
@@ -126,12 +126,12 @@ module ThemeCheck
     end
 
     def location
-      tokens = [template&.relative_path, line_number].compact
+      tokens = [theme_file&.relative_path, line_number].compact
       tokens.join(":") if tokens.any?
     end
 
     def location_range
-      tokens = [template&.relative_path, start_index, end_index].compact
+      tokens = [theme_file&.relative_path, start_index, end_index].compact
       tokens.join(":") if tokens.any?
     end
 
@@ -141,9 +141,35 @@ module ThemeCheck
 
     def correct
       if correctable?
-        corrector = Corrector.new(template: template)
+        corrector = Corrector.new(theme_file: theme_file)
         correction.call(corrector)
       end
+    rescue => e
+      ThemeCheck.bug(<<~EOS)
+        Exception while running `Offense#correct`:
+        ```
+        #{e.class}: #{e.message}
+          #{e.backtrace.join("\n  ")}
+        ```
+
+        Offense:
+        ```
+        #{JSON.pretty_generate(to_h)}
+        ```
+        Check options:
+        ```
+        #{check.options.pretty_inspect}
+        ```
+        Markup:
+        ```
+        #{markup}
+        ```
+        Node.Markup:
+        ```
+        #{node&.markup}
+        ```
+      EOS
+      exit(2)
     end
 
     def whole_theme?
@@ -165,7 +191,7 @@ module ThemeCheck
     alias_method :eql?, :==
 
     def to_s
-      if template
+      if theme_file
         "#{message} at #{location}"
       else
         message
@@ -173,7 +199,7 @@ module ThemeCheck
     end
 
     def to_s_range
-      if template
+      if theme_file
         "#{message} at #{location_range}"
       else
         message
@@ -183,7 +209,7 @@ module ThemeCheck
     def to_h
       {
         check: check.code_name,
-        path: template&.relative_path,
+        path: theme_file&.relative_path,
         severity: check.severity_value,
         start_line: start_line,
         start_column: start_column,

data/lib/theme_check/position.rb

@@ -16,22 +16,22 @@ module ThemeCheck
       @line_number_1_indexed = line_number_1_indexed
       @node_markup_offset = node_markup_offset
       @node_markup = node_markup
-      @strict_position = StrictPosition.new(
-        needle,
-        contents,
-        start_index,
-      )
     end
 
     def start_line_offset
-      from_row_column_to_index(contents, line_number, 0)
+      @start_line_offset ||= from_row_column_to_index(contents, line_number, 0)
     end
 
     def start_offset
-      return start_line_offset if @node_markup.nil?
-      node_markup_start = contents.index(@node_markup, start_line_offset)
-      return start_line_offset if node_markup_start.nil?
-      node_markup_start + @node_markup_offset
+      @start_offset ||= compute_start_offset
+    end
+
+    def strict_position
+      @strict_position ||= StrictPosition.new(
+        needle,
+        contents,
+        start_index,
+      )
     end
 
     # 0-indexed, inclusive
@@ -41,39 +41,50 @@ module ThemeCheck
 
     # 0-indexed, exclusive
     def end_index
-      @strict_position.end_index
+      strict_position.end_index
     end
 
     # 0-indexed, inclusive
     def start_row
-      @strict_position.start_row
+      strict_position.start_row
     end
 
     # 0-indexed, inclusive
     def start_column
-      @strict_position.start_column
+      strict_position.start_column
     end
 
     # 0-indexed, exclusive (both taken together are) therefore you
     # might end up on a newline character or the next line
     def end_row
-      @strict_position.end_row
+      strict_position.end_row
     end
 
     def end_column
-      @strict_position.end_column
+      strict_position.end_column
     end
 
     private
 
+    def compute_start_offset
+      return start_line_offset if @node_markup.nil?
+      node_markup_start = contents.index(@node_markup, start_line_offset)
+      return start_line_offset if node_markup_start.nil?
+      node_markup_start + @node_markup_offset
+    end
+
     def contents
       return '' unless @contents.is_a?(String) && !@contents.empty?
       @contents
     end
 
+    def content_line_count
+      @content_line_count ||= contents.count("\n")
+    end
+
     def line_number
       return 0 if @line_number_1_indexed.nil?
-      bounded(0, @line_number_1_indexed - 1, contents.lines.size - 1)
+      bounded(0, @line_number_1_indexed - 1, content_line_count)
     end
 
     def needle
@@ -93,7 +104,7 @@ module ThemeCheck
     end
 
     def can_find_needle?
-      !!contents.index(@needle)
+      !!contents.index(@needle, start_offset)
     end
 
     def entire_line_needle

data/lib/theme_check/position_helper.rb

@@ -7,31 +7,29 @@ module ThemeCheck
       return 0 unless content.is_a?(String) && !content.empty?
       return 0 unless row.is_a?(Integer) && col.is_a?(Integer)
       i = 0
-      result = 0
-      safe_row = bounded(0, row, content.lines.size - 1)
-      lines = content.lines
-      line_size = lines[i].size
-      while i < safe_row
-        result += line_size
-        i += 1
-        line_size = lines[i].size
-      end
-      result += bounded(0, col, line_size - 1)
-      result
+      safe_row = bounded(0, row, content.count("\n"))
+      scanner = StringScanner.new(content)
+      scanner.scan_until(/\n/) while i < safe_row && (i += 1)
+      result = scanner.charpos || 0
+      scanner.scan_until(/\n|\z/)
+      bounded(result, result + col, scanner.pre_match.size)
     end
 
     def from_index_to_row_column(content, index)
       return [0, 0] unless content.is_a?(String) && !content.empty?
       return [0, 0] unless index.is_a?(Integer)
       safe_index = bounded(0, index, content.size - 1)
-      lines = content[0..safe_index].lines
-      row = lines.size - 1
-      col = lines.last.size - 1
+      content_up_to_index = content[0...safe_index]
+      row = content_up_to_index.count("\n")
+      col = 0
+      col += 1 while (safe_index -= 1) && safe_index >= 0 && content[safe_index] != "\n"
       [row, col]
     end
 
     def bounded(a, x, b)
-      [a, [x, b].min].max
+      return a if x < a
+      return b if x > b
+      x
     end
   end
 end