theme-check 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f0635001a9f808d12b55e0328536911bde9ea36160bcf34a63f10114401d18
-  data.tar.gz: 78365fe98014904e058191934663b75d24701db8a2a2585edac2557192cec5d5
+  metadata.gz: 960f944628496ea317205e34678a78ec1e560dbfb48f40cfa33be2d82ebe4770
+  data.tar.gz: 66e2abe15609c6e5a40d13d05aa0daedf9fbd783e31226bbfb0c6961c1d89ad6
 SHA512:
-  metadata.gz: 0520e083dac843ed6273ba17e0cb44ee0e9e2c412f85a81b176da8b0912a583ab262c0c25b0b580df9c53cabefca305dce468559efa6df786ff37b7583e7ecc4
-  data.tar.gz: 58b7483ad5935de781eddf850a73c88f04aadbae394416f901fa38e173b44b4af3717947fc72cc009c899866ce1d27cc3f6597d5de7dd7ea1ef6984393d71ff4
+  metadata.gz: d920362e7729fc739c0a0202e00a605025db3d80c2fdfac5be9d6d9ea6c74bc4922baa82e093851432417863106c14964f6fdc76f66e55fd7947f33887b989c1
+  data.tar.gz: 26eb4ba427e8380ece15160c2c27cd052802ec233bb61a4a17e36dcf7f008cc7bc569b71649c525c6d57a7d79654469af65ec664726665584806928cf7258483

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+v1.5.2 / 2021-09-09
+===================
+
+  * Handle invalid URIs in RemoteAssetFile ([#418](https://github.com/shopify/theme-check/issues/418), [#438](https://github.com/shopify/theme-check/issues/438))
+  * Fix `Bad start_index` error in SpaceInsideBraces ([#423](https://github.com/shopify/theme-check/issues/423))
+  * Autocorrect missing directories ([#389](https://github.com/shopify/theme-check/issues/389))
+
 v1.5.1 / 2021-09-08
 ===================
 

data/lib/theme_check/checks/liquid_tag.rb

@@ -13,7 +13,7 @@ module ThemeCheck
     end
 
     def on_tag(node)
-      if !node.inside_liquid_tag?
+      if node.inside_liquid_tag?
         reset_consecutive_statements
       # Ignore comments
       elsif !node.comment?

data/lib/theme_check/checks/required_directories.rb

@@ -18,7 +18,9 @@ module ThemeCheck
     private
 
     def add_missing_directories_offense(directory)
-      add_offense("Theme is missing '#{directory}' directory")
+      add_offense("Theme is missing '#{directory}' directory") do |corrector|
+        corrector.mkdir(@theme, directory)
+      end
     end
   end
 end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -15,52 +15,57 @@ module ThemeCheck
       return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk, chunk_start|
-        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)(  +)/) do |_match|
           add_offense(
             "Too many spaces after '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(2),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(2)
           )
         end
         chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
           add_offense(
             "Space missing after '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
+            markup: Regexp.last_match(1),
             node_markup_offset: chunk_start + Regexp.last_match.begin(0),
           )
         end
-        chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+        chunk.scan(/(  +)(\||==|<>|<=|>=|<|>|!=)+/) do |_match|
           add_offense(
-            "Too many spaces before '#{Regexp.last_match(1)}'",
+            "Too many spaces before '#{Regexp.last_match(2)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(1),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(1)
           )
         end
         chunk.scan(/(\A|\S)(?<match>\||==|<>|<=|>=|<|\b>|!=)/) do |_match|
           add_offense(
             "Space missing before '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(:match),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(:match)
           )
         end
       end
     end
 
     def on_tag(node)
-      if node.inside_liquid_tag?
-        markup = if node.whitespace_trimmed?
-          "-%}"
-        else
-          "%}"
-        end
+      unless node.inside_liquid_tag?
         if node.markup[-1] != " " && node.markup[-1] != "\n"
-          add_offense("Space missing before '#{markup}'", node: node, markup: node.markup[-1] + markup)
+          add_offense(
+            "Space missing before '#{node.end_token}'",
+            node: node,
+            markup: node.markup[-1],
+            node_markup_offset: node.markup.size - 1,
+          )
         elsif node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
-          add_offense("Too many spaces before '#{markup}'", node: node, markup: Regexp.last_match(2) + markup)
+          add_offense(
+            "Too many spaces before '#{node.end_token}'",
+            node: node,
+            markup: Regexp.last_match(2),
+            node_markup_offset: node.markup.size - Regexp.last_match(2).size
+          )
         end
       end
       @ignore = true
@@ -73,22 +78,40 @@ module ThemeCheck
     def on_variable(node)
       return if @ignore || node.markup.empty?
       if node.markup[0] != " "
-        add_offense("Space missing after '{{'", node: node) do |corrector|
+        add_offense(
+          "Space missing after '#{node.start_token}'",
+          node: node,
+          markup: node.markup[0]
+        ) do |corrector|
           corrector.insert_before(node, " ")
         end
       end
       if node.markup[-1] != " " && node.markup[-1] != "\n"
-        add_offense("Space missing before '}}'", node: node) do |corrector|
+        add_offense(
+          "Space missing before '#{node.end_token}'",
+          node: node,
+          markup: node.markup[-1],
+          node_markup_offset: node.markup.size - 1,
+        ) do |corrector|
           corrector.insert_after(node, " ")
         end
       end
-      if node.markup[0] == " " && node.markup[1] == " "
-        add_offense("Too many spaces after '{{'", node: node) do |corrector|
+      if node.markup =~ /\A(  +)/m
+        add_offense(
+          "Too many spaces after '#{node.start_token}'",
+          node: node,
+          markup: Regexp.last_match(1),
+        ) do |corrector|
           corrector.replace(node, " #{node.markup.lstrip}")
         end
       end
-      if node.markup[-1] == " " && node.markup[-2] == " "
-        add_offense("Too many spaces before '}}'", node: node) do |corrector|
+      if node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
+        add_offense(
+          "Too many spaces before '#{node.end_token}'",
+          node: node,
+          markup: Regexp.last_match(2),
+          node_markup_offset: node.markup.size - Regexp.last_match(2).size
+        ) do |corrector|
           corrector.replace(node, "#{node.markup.rstrip} ")
         end
       end

data/lib/theme_check/corrector.rb

@@ -36,5 +36,9 @@ module ThemeCheck
       theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
       theme.default_locale_json.update_contents('{}')
     end
+
+    def mkdir(theme, relative_path)
+      theme.storage.mkdir(relative_path)
+    end
   end
 end

data/lib/theme_check/file_system_storage.rb

@@ -26,6 +26,12 @@ module ThemeCheck
       file(relative_path).write(content)
     end
 
+    def mkdir(relative_path)
+      reset_memoizers unless file_exists?(relative_path)
+
+      file(relative_path).mkpath unless file(relative_path).directory?
+    end
+
     def files
       @file_array ||= glob("**/*")
         .map { |path| path.relative_path_from(@root).to_s }

data/lib/theme_check/in_memory_storage.rb

@@ -23,6 +23,10 @@ module ThemeCheck
       @files[relative_path] = content
     end
 
+    def mkdir(relative_path)
+      @files[relative_path] = nil
+    end
+
     def files
       @files.keys
     end

data/lib/theme_check/node.rb

@@ -10,12 +10,14 @@ module ThemeCheck
       @value = value
       @parent = parent
       @template = template
+      @tag_markup = nil
+      @line_number_offset = 0
     end
 
     # The original source code of the node. Doesn't contain wrapping braces.
     def markup
       if tag?
-        @value.raw
+        tag_markup
       elsif @value.instance_variable_defined?(:@markup)
         @value.instance_variable_get(:@markup)
       end
@@ -64,6 +66,10 @@ module ThemeCheck
       @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)
@@ -92,7 +98,12 @@ module ThemeCheck
 
     # Most nodes have a line number, but it's not guaranteed.
     def line_number
-      @value.line_number if @value.respond_to?(: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>`
@@ -101,19 +112,45 @@ module ThemeCheck
       @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?
-      if line_number
-        template.excerpt(line_number).start_with?("{%")
+      # 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 `{%- ... -%}`
-    def whitespace_trimmed?
-      if line_number
-        template.excerpt(line_number).start_with?("{%-")
+    # 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
@@ -132,6 +169,24 @@ module ThemeCheck
       )
     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
+
     def start_index
       position.start_index
     end
@@ -139,5 +194,62 @@ module ThemeCheck
     def end_index
       position.end_index
     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.raw 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]
+    end
   end
 end

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

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

data/lib/theme_check/remote_asset_file.rb

@@ -17,6 +17,8 @@ module ThemeCheck
 
       def uri(src)
         URI.parse(src.sub(%r{^//}, "https://"))
+      rescue URI::InvalidURIError
+        nil
       end
     end
 
@@ -26,6 +28,7 @@ module ThemeCheck
     end
 
     def content
+      return if @uri.nil?
       return @content unless @content.nil?
 
       res = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: @uri.scheme == 'https') do |http|
@@ -41,6 +44,7 @@ module ThemeCheck
     end
 
     def gzipped_size
+      return if @uri.nil?
       @gzipped_size ||= content.bytesize
     end
   end

data/lib/theme_check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Marc-André Cournoyer