theme-check 1.3.0 → 1.5.2

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/printer.rb

@@ -2,14 +2,18 @@
 
 module ThemeCheck
   class Printer
+    def initialize(out_stream = STDOUT)
+      @out = out_stream
+    end
+
     def print(theme, offenses, auto_correct)
       offenses.each do |offense|
         print_offense(offense, auto_correct)
-        puts
+        @out.puts
       end
 
       correctable = offenses.select(&:correctable?)
-      puts "#{theme.all.size} files inspected, #{red(offenses.size.to_s + ' offenses')} detected, \
+      @out.puts "#{theme.all.size} files inspected, #{red(offenses.size.to_s + ' offenses')} detected, \
 #{yellow(correctable.size.to_s + ' offenses')} #{auto_correct ? 'corrected' : 'auto-correctable'}"
     end
 
@@ -26,15 +30,15 @@ module ThemeCheck
         ""
       end
 
-      puts location +
+      @out.puts location +
         colorized_severity(offense.severity) + ": " +
         yellow(offense.check_name) + ": " +
         corrected +
         offense.message + "."
       if offense.source_excerpt
-        puts "\t#{offense.source_excerpt}"
+        @out.puts "\t#{offense.source_excerpt}"
         if offense.markup_start_in_excerpt
-          puts "\t" + (" " * offense.markup_start_in_excerpt) + ("^" * offense.markup.size)
+          @out.puts "\t" + (" " * offense.markup_start_in_excerpt) + ("^" * offense.markup.size)
         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/theme.rb

@@ -7,7 +7,8 @@ module ThemeCheck
     LIQUID_REGEX = /\.liquid$/i
     JSON_REGEX = /\.json$/i
 
-    attr_accessor :storage
+    attr_reader :storage
+    attr_writer :default_locale_json
 
     def initialize(storage)
       @storage = storage

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -90,6 +90,7 @@ files:
 - docs/checks/deprecate_bgsizes.md
 - docs/checks/deprecate_lazysizes.md
 - docs/checks/deprecated_filter.md
+- docs/checks/deprecated_global_app_block_type.md
 - docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
@@ -117,6 +118,7 @@ files:
 - docs/checks/valid_html_translation.md
 - docs/checks/valid_json.md
 - docs/checks/valid_schema.md
+- docs/flamegraph.svg
 - docs/preview.png
 - exe/theme-check
 - exe/theme-check-language-server
@@ -140,6 +142,7 @@ files:
 - lib/theme_check/checks/deprecate_bgsizes.rb
 - lib/theme_check/checks/deprecate_lazysizes.rb
 - lib/theme_check/checks/deprecated_filter.rb
+- lib/theme_check/checks/deprecated_global_app_block_type.rb
 - lib/theme_check/checks/html_parsing_error.rb
 - lib/theme_check/checks/img_lazy_loading.rb
 - lib/theme_check/checks/img_width_and_height.rb
@@ -194,10 +197,16 @@ files:
 - lib/theme_check/language_server/constants.rb
 - lib/theme_check/language_server/diagnostics_tracker.rb
 - lib/theme_check/language_server/document_link_engine.rb
+- lib/theme_check/language_server/document_link_provider.rb
+- lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb
+- lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb
+- lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb
+- lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb
 - lib/theme_check/language_server/handler.rb
 - lib/theme_check/language_server/protocol.rb
 - lib/theme_check/language_server/server.rb
 - lib/theme_check/language_server/tokens.rb
+- lib/theme_check/language_server/uri_helper.rb
 - lib/theme_check/language_server/variable_lookup_finder.rb
 - lib/theme_check/liquid_check.rb
 - lib/theme_check/locale_diff.rb