theme-check 0.7.3 → 0.9.0

data/lib/theme_check/liquid_check.rb

@@ -16,9 +16,5 @@ module ThemeCheck
     ATTR = /[a-z0-9-]+/i
     HTML_ATTRIBUTE = /#{ATTR}(?:=#{QUOTED_LIQUID_ATTRIBUTE})?/omix
     HTML_ATTRIBUTES = /(?:#{HTML_ATTRIBUTE}|\s)*/omix
-
-    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, &block)
-      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, correction: block)
-    end
   end
 end

data/lib/theme_check/node.rb

@@ -125,5 +125,17 @@ module ThemeCheck
       start = template.full_line(line_number).index(markup)
       [start, start + markup.length - 1]
     end
+
+    def position
+      @position ||= Position.new(markup, template&.source, line_number)
+    end
+
+    def start_index
+      position.start_index
+    end
+
+    def end_index
+      position.end_index
+    end
   end
 end

data/lib/theme_check/offense.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 module ThemeCheck
-  Position = Struct.new(:line, :column)
-
   class Offense
     MAX_SOURCE_EXCERPT_SIZE = 120
 
@@ -20,6 +18,7 @@ module ThemeCheck
       end
 
       @node = node
+      @template = nil
       if node
         @template = node.template
       elsif template
@@ -40,8 +39,7 @@ module ThemeCheck
         @node.line_number
       end
 
-      @start_position = nil
-      @end_position = nil
+      @position = Position.new(@markup, @template&.source, @line_number)
     end
 
     def source_excerpt
@@ -56,20 +54,28 @@ module ThemeCheck
       end
     end
 
+    def start_index
+      @position.start_index
+    end
+
     def start_line
-      start_position.line
+      @position.start_row
     end
 
     def start_column
-      start_position.column
+      @position.start_column
+    end
+
+    def end_index
+      @position.end_index
     end
 
     def end_line
-      end_position.line
+      @position.end_row
     end
 
     def end_column
-      end_position.column
+      @position.end_column
     end
 
     def code_name
@@ -108,52 +114,30 @@ module ThemeCheck
       end
     end
 
-    def to_s
-      if template
-        "#{message} at #{location}"
-      else
-        message
-      end
-    end
-
-    private
-
-    def full_line(line)
-      # Liquid::Template is 1-indexed.
-      template.full_line(line + 1)
+    def whole_theme?
+      check.whole_theme?
     end
 
-    def lines_of_content
-      @lines ||= markup.lines.map { |x| x.sub(/\n$/, '') }
+    def single_file?
+      check.single_file?
     end
 
-    # 0-indexed, inclusive
-    def start_position
-      return @start_position if @start_position
-      return @start_position = Position.new(0, 0) unless line_number && markup
-
-      position = Position.new
-      position.line = line_number - 1
-      position.column = full_line(position.line).index(lines_of_content.first) || 0
-
-      @start_position = position
+    def ==(other)
+      other.is_a?(Offense) &&
+        check == other.check &&
+        message == other.message &&
+        template == other.template &&
+        node == other.node &&
+        markup == other.markup &&
+        line_number == other.line_number
     end
 
-    # 0-indexed, exclusive. It's the line + col that are exclusive.
-    # This is why it doesn't make sense to calculate them separately.
-    def end_position
-      return @end_position if @end_position
-      return @end_position = Position.new(0, 0) unless line_number && markup
-
-      position = Position.new
-      position.line = start_line + lines_of_content.size - 1
-      position.column = if start_line == position.line
-        start_column + markup.size
+    def to_s
+      if template
+        "#{message} at #{location}"
       else
-        lines_of_content.last.size
+        message
       end
-
-      @end_position = position
     end
   end
 end

data/lib/theme_check/parsing_helpers.rb

@@ -6,7 +6,7 @@ module ThemeCheck
       scanner = StringScanner.new(markup)
 
       while scanner.scan(/.*?("|')/)
-        yield scanner.matched[..-2]
+        yield scanner.matched[0..-2]
         # Skip to the end of the string
         scanner.skip_until(scanner.matched[-1] == "'" ? /[^\\]'/ : /[^\\]"/)
       end

data/lib/theme_check/position.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class Position
+    include PositionHelper
+
+    def initialize(needle, contents, line_number_1_indexed)
+      @needle = needle
+      @contents = contents
+      @line_number_1_indexed = line_number_1_indexed
+      @start_row_column = nil
+      @end_row_column = nil
+    end
+
+    def start_line_index
+      from_row_column_to_index(contents, line_number, 0)
+    end
+
+    # 0-indexed, inclusive
+    def start_index
+      contents.index(needle, start_line_index) || start_line_index
+    end
+
+    # 0-indexed, exclusive
+    def end_index
+      start_index + needle.size
+    end
+
+    def start_row
+      start_row_column[0]
+    end
+
+    def start_column
+      start_row_column[1]
+    end
+
+    def end_row
+      end_row_column[0]
+    end
+
+    def end_column
+      end_row_column[1]
+    end
+
+    private
+
+    def contents
+      return '' unless @contents.is_a?(String) && !@contents.empty?
+      @contents
+    end
+
+    def line_number
+      return 0 if @line_number_1_indexed.nil?
+      bounded(0, @line_number_1_indexed - 1, contents.lines.size - 1)
+    end
+
+    def needle
+      if @needle.nil? && !contents.empty? && !@line_number_1_indexed.nil?
+        contents.lines(chomp: true)[line_number] || ''
+      elsif contents.empty? || @needle.nil?
+        ''
+      else
+        @needle
+      end
+    end
+
+    def start_row_column
+      return @start_row_column unless @start_row_column.nil?
+      @start_row_column = from_index_to_row_column(contents, start_index)
+    end
+
+    def end_row_column
+      return @end_row_column unless @end_row_column.nil?
+      @end_row_column = from_index_to_row_column(contents, end_index)
+    end
+  end
+end

data/lib/theme_check/position_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# Note: Everything is 0-indexed here.
+
+module ThemeCheck
+  module PositionHelper
+    def from_row_column_to_index(content, row, col)
+      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
+    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
+      [row, col]
+    end
+
+    def bounded(a, x, b)
+      [a, [x, b].min].max
+    end
+  end
+end

data/lib/theme_check/remote_asset_file.rb

@@ -35,6 +35,9 @@ module ThemeCheck
       end
 
       @content = res.body
+
+    rescue OpenSSL::SSL::SSLError, Zlib::StreamError, *NET_HTTP_EXCEPTIONS
+      @contents = ''
     end
 
     def gzipped_size

data/lib/theme_check/shopify_liquid/tag.rb

@@ -8,6 +8,19 @@ module ThemeCheck
 
       def labels
         @tags ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+          .to_set
+      end
+
+      def tag_regex(tag)
+        return unless labels.include?(tag)
+        @tag_regexes ||= {}
+        @tag_regexes[tag] ||= /\A#{Liquid::TagStart}-?\s*#{tag}/m
+      end
+
+      def liquid_tag_regex(tag)
+        return unless labels.include?(tag)
+        @tag_liquid_regexes ||= {}
+        @tag_liquid_regexes[tag] ||= /^\s*#{tag}/m
       end
     end
   end

data/lib/theme_check/template.rb

@@ -32,6 +32,14 @@ module ThemeCheck
       relative_path.sub_ext('').to_s
     end
 
+    def json?
+      false
+    end
+
+    def liquid?
+      true
+    end
+
     def template?
       name.start_with?('templates')
     end

data/lib/theme_check/theme.rb

@@ -52,8 +52,13 @@ module ThemeCheck
       @all ||= json + liquid + assets
     end
 
-    def [](name)
-      all.find { |t| t.name == name }
+    def [](name_or_relative_path)
+      case name_or_relative_path
+      when Pathname
+        all.find { |t| t.relative_path == name_or_relative_path }
+      else
+        all.find { |t| t.name == name_or_relative_path }
+      end
     end
 
     def templates

data/lib/theme_check/version.rb

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

data/lib/theme_check/visitor.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Visitor
-    def initialize(checks)
+    attr_reader :checks
+
+    def initialize(checks, disabled_checks)
       @checks = checks
+      @disabled_checks = disabled_checks
     end
 
     def visit_template(template)
-      @disabled_checks = DisabledChecks.new
       visit(Node.new(template.root, nil, template))
     rescue Liquid::Error => exception
       exception.template_name = template.name
@@ -29,20 +31,8 @@ module ThemeCheck
       @disabled_checks.update(node) if node.comment?
     end
 
-    def visit_children(node)
-      node.children.each { |child| visit(child) }
-    end
-
     def call_checks(method, *args)
       checks.call(method, *args)
     end
-
-    def checks
-      return @checks unless @disabled_checks.any?
-
-      return @checks.always_enabled if @disabled_checks.all_disabled?
-
-      @checks.except_for(@disabled_checks)
-    end
   end
 end

data/theme-check.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Shopify/theme-check"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -72,6 +72,7 @@ files:
 - docs/checks/CHECK_DOCS_TEMPLATE.md
 - docs/checks/asset_size_css.md
 - docs/checks/asset_size_javascript.md
+- docs/checks/content_for_header_modification.md
 - docs/checks/convert_include_to_render.md
 - docs/checks/default_locale.md
 - docs/checks/deprecated_filter.md
@@ -84,6 +85,7 @@ files:
 - docs/checks/missing_template.md
 - docs/checks/nested_snippet.md
 - docs/checks/parser_blocking_javascript.md
+- docs/checks/parser_blocking_script_tag.md
 - docs/checks/remote_asset.md
 - docs/checks/required_directories.md
 - docs/checks/required_layout_theme_object.md
@@ -104,10 +106,12 @@ files:
 - lib/theme_check.rb
 - lib/theme_check/analyzer.rb
 - lib/theme_check/asset_file.rb
+- lib/theme_check/bug.rb
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/asset_size_css.rb
 - lib/theme_check/checks/asset_size_javascript.rb
+- lib/theme_check/checks/content_for_header_modification.rb
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
 - lib/theme_check/checks/deprecated_filter.rb
@@ -120,6 +124,7 @@ files:
 - lib/theme_check/checks/missing_template.rb
 - lib/theme_check/checks/nested_snippet.rb
 - lib/theme_check/checks/parser_blocking_javascript.rb
+- lib/theme_check/checks/parser_blocking_script_tag.rb
 - lib/theme_check/checks/remote_asset.rb
 - lib/theme_check/checks/required_directories.rb
 - lib/theme_check/checks/required_layout_theme_object.rb
@@ -138,8 +143,13 @@ files:
 - lib/theme_check/cli.rb
 - lib/theme_check/config.rb
 - lib/theme_check/corrector.rb
+- lib/theme_check/disabled_check.rb
 - lib/theme_check/disabled_checks.rb
+- lib/theme_check/exceptions.rb
 - lib/theme_check/file_system_storage.rb
+- lib/theme_check/html_check.rb
+- lib/theme_check/html_node.rb
+- lib/theme_check/html_visitor.rb
 - lib/theme_check/in_memory_storage.rb
 - lib/theme_check/json_check.rb
 - lib/theme_check/json_file.rb
@@ -153,18 +163,21 @@ files:
 - lib/theme_check/language_server/completion_providers/render_snippet_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/tag_completion_provider.rb
 - 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/handler.rb
-- lib/theme_check/language_server/position_helper.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/variable_lookup_finder.rb
 - lib/theme_check/liquid_check.rb
 - lib/theme_check/locale_diff.rb
 - lib/theme_check/node.rb
 - lib/theme_check/offense.rb
 - lib/theme_check/packager.rb
 - lib/theme_check/parsing_helpers.rb
+- lib/theme_check/position.rb
+- lib/theme_check/position_helper.rb
 - lib/theme_check/printer.rb
 - lib/theme_check/regex_helpers.rb
 - lib/theme_check/releaser.rb
@@ -196,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A Shopify Theme Linter