theme-check 1.5.2 → 1.7.0

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

@@ -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/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/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/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/theme_file_rewriter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'parser'
+
+module ThemeCheck
+  class ThemeFileRewriter
+    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/version.rb

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

data/lib/theme_check.rb

@@ -4,20 +4,23 @@ require "liquid"
 require_relative "theme_check/version"
 require_relative "theme_check/bug"
 require_relative "theme_check/exceptions"
+require_relative "theme_check/theme_file_rewriter"
 require_relative "theme_check/theme_file"
+require_relative "theme_check/liquid_file"
+require_relative "theme_check/asset_file"
+require_relative "theme_check/json_file"
 require_relative "theme_check/analyzer"
 require_relative "theme_check/check"
 require_relative "theme_check/checks_tracking"
+require_relative "theme_check/liquid_check"
+require_relative "theme_check/html_check"
+require_relative "theme_check/json_check"
 require_relative "theme_check/cli"
 require_relative "theme_check/disabled_check"
 require_relative "theme_check/disabled_checks"
-require_relative "theme_check/liquid_check"
 require_relative "theme_check/locale_diff"
-require_relative "theme_check/asset_file"
 require_relative "theme_check/remote_asset_file"
 require_relative "theme_check/regex_helpers"
-require_relative "theme_check/json_check"
-require_relative "theme_check/json_file"
 require_relative "theme_check/json_helpers"
 require_relative "theme_check/position_helper"
 require_relative "theme_check/position"
@@ -25,22 +28,21 @@ require_relative "theme_check/language_server"
 require_relative "theme_check/checks"
 require_relative "theme_check/config"
 require_relative "theme_check/node"
+require_relative "theme_check/liquid_node"
+require_relative "theme_check/html_node"
 require_relative "theme_check/offense"
 require_relative "theme_check/printer"
 require_relative "theme_check/json_printer"
 require_relative "theme_check/shopify_liquid"
-require_relative "theme_check/storage"
 require_relative "theme_check/string_helpers"
+require_relative "theme_check/storage"
 require_relative "theme_check/file_system_storage"
 require_relative "theme_check/in_memory_storage"
 require_relative "theme_check/tags"
-require_relative "theme_check/template"
 require_relative "theme_check/theme"
-require_relative "theme_check/visitor"
 require_relative "theme_check/corrector"
-require_relative "theme_check/html_node"
+require_relative "theme_check/liquid_visitor"
 require_relative "theme_check/html_visitor"
-require_relative "theme_check/html_check"
 
 Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }
 

data/theme-check.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('liquid', '>= 5.0.1')
+  spec.add_dependency('liquid', '>= 5.1.0')
   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.5.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -203,12 +217,16 @@ files:
 - 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/messenger.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/liquid_file.rb
+- lib/theme_check/liquid_node.rb
+- lib/theme_check/liquid_visitor.rb
 - lib/theme_check/locale_diff.rb
 - lib/theme_check/node.rb
 - lib/theme_check/offense.rb
@@ -228,11 +246,10 @@ files:
 - lib/theme_check/storage.rb
 - lib/theme_check/string_helpers.rb
 - lib/theme_check/tags.rb
-- lib/theme_check/template.rb
 - lib/theme_check/theme.rb
 - lib/theme_check/theme_file.rb
+- lib/theme_check/theme_file_rewriter.rb
 - lib/theme_check/version.rb
-- lib/theme_check/visitor.rb
 - packaging/homebrew/theme_check.base.rb
 - theme-check.gemspec
 homepage: https://github.com/Shopify/theme-check