theme-check 1.6.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,250 +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
-      @tag_markup = nil
-      @line_number_offset = 0
+    def parent
+      raise NotImplementedError
     end
 
-    # The original source code of the node. Doesn't contain wrapping braces.
-    def markup
-      if tag?
-        tag_markup
-      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)
-    end
-
-    # A {% tag %} node?
-    def tag?
-      @value.is_a?(Liquid::Tag)
-    end
-
-    def variable?
-      @value.is_a?(Liquid::Variable)
-    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)
+      raise NotImplementedError
     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
-      if tag? && @value.respond_to?(:line_number)
-        markup # initialize the line_number_offset
-        @value.line_number - @line_number_offset
-      elsif @value.respond_to?(:line_number)
-        @value.line_number
-      end
-    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
-
-    def source
-      template&.source
-    end
-
-    WHITESPACE = /\s/
-
-    # Is this node inside a `{% liquid ... %}` block?
-    def inside_liquid_tag?
-      # What we're doing here is starting at the start of the tag and
-      # backtrack on all the whitespace until we land on something. If
-      # that something is {% or %-, then we can safely assume that
-      # we're inside a full tag and not a liquid tag.
-      @inside_liquid_tag ||= if tag? && line_number && source
-        i = 1
-        i += 1 while source[start_index - i] =~ WHITESPACE && i < start_index
-        first_two_backtracked_characters = source[(start_index - i - 1)..(start_index - i)]
-        first_two_backtracked_characters != "{%" && first_two_backtracked_characters != "%-"
-      else
-        false
-      end
-    end
-
-    # Is this node inside a tag or variable that starts by removing whitespace. i.e. {%- or {{-
-    def whitespace_trimmed_start?
-      @whitespace_trimmed_start ||= if line_number && source && !inside_liquid_tag?
-        i = 1
-        i += 1 while source[start_index - i] =~ WHITESPACE && i < start_index
-        source[start_index - i] == "-"
-      else
-        false
-      end
-    end
-
-    # Is this node inside a tag or variable ends starts by removing whitespace. i.e. -%} or -}}
-    def whitespace_trimmed_end?
-      @whitespace_trimmed_end ||= if line_number && source && !inside_liquid_tag?
-        i = 0
-        i += 1 while source[end_index + i] =~ WHITESPACE && i < source.size
-        source[end_index + i] == "-"
-      else
-        false
-      end
-    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
-    end
-
-    def start_token
-      return "" if inside_liquid_tag?
-      output = ""
-      output += "{{" if variable?
-      output += "{%" if tag?
-      output += "-" if whitespace_trimmed_start?
-      output
-    end
-
-    def end_token
-      return "" if inside_liquid_tag?
-      output = ""
-      output += "-" if whitespace_trimmed_end?
-      output += "}}" if variable?
-      output += "%}" if tag?
-      output
-    end
-
-    private
-
-    # Here we're hacking around a glorious bug in Liquid that makes it so the
-    # line_number and markup of a tag is wrong if there's whitespace
-    # between the tag_name and the markup of the tag.
-    #
-    # {%
-    #   render
-    #   'foo'
-    # %}
-    #
-    # Returns a raw value of "render 'foo'\n".
-    # The "\n  " between render and 'foo' got replaced by a single space.
-    #
-    # And the line number is the one of 'foo'\n%}. Yay!
-    #
-    # This breaks any kind of position logic we have since that string
-    # does not exist in the template.
-    def tag_markup
-      return @value.tag_name if @value.instance_variable_get('@markup').empty?
-      return @tag_markup if @tag_markup
-
-      l = 1
-      scanner = StringScanner.new(source)
-      scanner.scan_until(/\n/) while l < @value.line_number && (l += 1)
-      start = scanner.charpos
-
-      tag_markup = @value.instance_variable_get('@markup')
-
-      # See https://github.com/Shopify/theme-check/pull/423/files#r701936559 for a detailed explanation
-      # of why we're doing the check below.
-      #
-      # TL;DR it's because line_numbers are not enough to accurately
-      # determine the position of the raw markup and because that
-      # markup could be present on the same line outside of a Tag. e.g.
-      #
-      # uhoh {% if uhoh %}
-      if (match = /#{@value.tag_name} +#{Regexp.escape(tag_markup)}/.match(source, start))
-        return @tag_markup = match[0]
-      end
-
-      # find the markup
-      markup_start = source.index(tag_markup, start)
-      markup_end = markup_start + tag_markup.size
-
-      # go back until you find the tag_name
-      tag_start = markup_start
-      tag_start -= 1 while source[tag_start - 1] =~ WHITESPACE
-      tag_start -= @value.tag_name.size
-
-      # keep track of the error in line_number
-      @line_number_offset = source[tag_start...markup_start].count("\n")
-
-      # return the real raw content
-      @tag_markup = source[tag_start...markup_end]
+      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,7 +141,7 @@ module ThemeCheck
 
     def correct
       if correctable?
-        corrector = Corrector.new(template: template)
+        corrector = Corrector.new(theme_file: theme_file)
         correction.call(corrector)
       end
     rescue => e
@@ -191,7 +191,7 @@ module ThemeCheck
     alias_method :eql?, :==
 
     def to_s
-      if template
+      if theme_file
         "#{message} at #{location}"
       else
         message
@@ -199,7 +199,7 @@ module ThemeCheck
     end
 
     def to_s_range
-      if template
+      if theme_file
         "#{message} at #{location_range}"
       else
         message
@@ -209,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

@@ -104,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/theme.rb

@@ -23,7 +23,7 @@ module ThemeCheck
     def liquid
       @liquid ||= @storage.files
         .select { |path| LIQUID_REGEX.match?(path) }
-        .map { |path| Template.new(path, @storage) }
+        .map { |path| LiquidFile.new(path, @storage) }
     end
 
     def json

data/lib/theme_check/{template_rewriter.rb → theme_file_rewriter.rb}

@@ -3,7 +3,7 @@
 require 'parser'
 
 module ThemeCheck
-  class TemplateRewriter
+  class ThemeFileRewriter
     def initialize(name, source)
       @buffer = Parser::Source::Buffer.new(name, source: source)
       @rewriter = Parser::Source::TreeRewriter.new(

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "1.6.1"
+  VERSION = "1.6.2"
 end