theme-check 1.4.0 → 1.6.0

data/lib/theme_check/offense.rb

@@ -144,6 +144,32 @@ module ThemeCheck
         corrector = Corrector.new(template: template)
         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?

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

@@ -5,6 +5,7 @@ module ThemeCheck
     LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
     LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
     LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
+    HTML_LIQUID_PLACEHOLDER = /≬[0-9a-z]+#*≬/m
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
 
     def matches(s, re)
@@ -16,20 +17,5 @@ module ThemeCheck
       end
       matches
     end
-
-    def href_to_file_size(href)
-      # asset_url (+ optional stylesheet_tag) variables
-      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
-        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
-        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
-        return if asset.nil?
-        asset.gzipped_size
-
-      # remote URLs
-      elsif href =~ %r{^(https?:)?//}
-        asset = RemoteAssetFile.from_src(href)
-        asset.gzipped_size
-      end
-    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/template.rb

@@ -3,10 +3,11 @@
 module ThemeCheck
   class Template < ThemeFile
     def write
-      content = updated_content
+      content = rewriter.to_s
       if source != content
-        @storage.write(@relative_path, content)
+        @storage.write(@relative_path, content.gsub("\n", @eol))
         @source = content
+        @rewriter = nil
       end
     end
 
@@ -26,19 +27,8 @@ module ThemeCheck
       name.start_with?('snippets')
     end
 
-    def lines
-      # Retain trailing newline character
-      @lines ||= source.split("\n", -1)
-    end
-
-    # Not entirely obvious but lines is mutable, corrections are to be
-    # applied on @lines.
-    def updated_content
-      lines.join("\n")
-    end
-
-    def excerpt(line)
-      lines[line - 1].strip
+    def rewriter
+      @rewriter ||= TemplateRewriter.new(@relative_path, source)
     end
 
     def source_excerpt(line)
@@ -46,10 +36,6 @@ module ThemeCheck
       original_lines[line - 1].strip
     end
 
-    def full_line(line)
-      lines[line - 1]
-    end
-
     def parse
       @ast ||= self.class.parse(source)
     end

data/lib/theme_check/template_rewriter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'parser'
+
+module ThemeCheck
+  class TemplateRewriter
+    def initialize(name, source)
+      @buffer = Parser::Source::Buffer.new(name, source: source)
+      @rewriter = Parser::Source::TreeRewriter.new(
+        @buffer
+      )
+    end
+
+    def insert_before(node, content)
+      @rewriter.insert_before(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def insert_after(node, content)
+      @rewriter.insert_after(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def replace(node, content)
+      @rewriter.replace(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def wrap(node, insert_before, insert_after)
+      @rewriter.wrap(
+        range(node.start_index, node.end_index),
+        insert_before,
+        insert_after,
+      )
+    end
+
+    def to_s
+      @rewriter.process
+    end
+
+    private
+
+    def range(start_index, end_index)
+      Parser::Source::Range.new(
+        @buffer,
+        start_index,
+        end_index,
+      )
+    end
+  end
+end

data/lib/theme_check/theme_file.rb

@@ -6,6 +6,8 @@ module ThemeCheck
     def initialize(relative_path, storage)
       @relative_path = relative_path
       @storage = storage
+      @source = nil
+      @eol = "\n"
     end
 
     def path
@@ -20,8 +22,23 @@ module ThemeCheck
       relative_path.sub_ext('').to_s
     end
 
+    # For the corrector to work properly, we should have a
+    # simple mental model of the internal representation of eol
+    # characters (Windows uses \r\n, Linux uses \n).
+    #
+    # Parser::Source::Buffer strips the \r from the source file, so if
+    # you are autocorrecting the file you might lose that info and
+    # cause a git diff. It also makes the node.start_index/end_index
+    # calculation break. That's not cool.
+    #
+    # So in here we track whether the source file has \r\n in it and
+    # we'll make sure that the file we write has the same eol as the
+    # source file.
     def source
-      @source ||= @storage.read(@relative_path)
+      return @source if @source
+      @source = @storage.read(@relative_path)
+      @eol = @source.include?("\r\n") ? "\r\n" : "\n"
+      @source = @source.gsub("\r\n", "\n")
     end
 
     def json?

data/lib/theme_check/version.rb

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

data/lib/theme_check.rb

@@ -34,6 +34,7 @@ require_relative "theme_check/string_helpers"
 require_relative "theme_check/file_system_storage"
 require_relative "theme_check/in_memory_storage"
 require_relative "theme_check/tags"
+require_relative "theme_check/template_rewriter"
 require_relative "theme_check/template"
 require_relative "theme_check/theme"
 require_relative "theme_check/visitor"

data/theme-check.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('liquid', '>= 5.0.1')
   spec.add_dependency('nokogiri', '>= 1.12')
+  spec.add_dependency('parser', '~> 3')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: 
 email:
 - marcandre.cournoyer@shopify.com
@@ -90,6 +104,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 +132,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 +156,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
@@ -203,6 +220,7 @@ files:
 - 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
@@ -225,6 +243,7 @@ files:
 - lib/theme_check/string_helpers.rb
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb
+- lib/theme_check/template_rewriter.rb
 - lib/theme_check/theme.rb
 - lib/theme_check/theme_file.rb
 - lib/theme_check/version.rb