theme-check 0.7.3 → 0.9.0

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -17,13 +17,13 @@ module ThemeCheck
     end
 
     def after_document(node)
-      return if @disabled_checks.full_document_disabled?
-      return unless @disabled_checks.any?
+      checks_missing_end_index = @disabled_checks.checks_missing_end_index
+      return if checks_missing_end_index.empty?
 
-      message = if @disabled_checks.all_disabled?
+      message = if checks_missing_end_index.any? { |name| name == :all }
         "All checks were"
       else
-        @disabled_checks.all.join(', ') + " " + (@disabled_checks.all.size == 1 ? "was" : "were")
+        checks_missing_end_index.join(', ') + " " + (checks_missing_end_index.size == 1 ? "was" : "were")
       end
 
       add_offense("#{message} disabled but not re-enabled with theme-check-enable", node: node)

data/lib/theme_check/checks/missing_template.rb

@@ -5,6 +5,7 @@ module ThemeCheck
     severity :suggestion
     category :liquid
     doc docs_url(__FILE__)
+    single_file false
 
     def on_include(node)
       template = node.value.template_name_expr

data/lib/theme_check/checks/nested_snippet.rb

@@ -20,7 +20,7 @@ module ThemeCheck
       end
     end
 
-    def initialize(max_nesting_level: 2)
+    def initialize(max_nesting_level: 3)
       @max_nesting_level = max_nesting_level
       @templates = {}
     end

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -1,48 +1,16 @@
 # frozen_string_literal: true
 module ThemeCheck
   # Reports errors when trying to use parser-blocking script tags
-  class ParserBlockingJavaScript < LiquidCheck
-    include RegexHelpers
+  class ParserBlockingJavaScript < HtmlCheck
     severity :error
-    categories :liquid, :performance
+    categories :html, :performance
     doc docs_url(__FILE__)
 
-    PARSER_BLOCKING_SCRIPT_TAG = %r{
-      <script                                    # Find the start of a script tag
-      (?=[^>]+?src=)                             # Make sure src= is in the script with a lookahead
-      (?:(?!defer|async|type=["']module['"]).)*? # Find tags that don't have defer|async|type="module"
-      /?>
-    }xim
-    SCRIPT_TAG_FILTER = /\{\{[^}]+script_tag\s+\}\}/
+    def on_script(node)
+      return unless node.attributes["src"]
+      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"]&.value == "module"
 
-    def on_document(node)
-      @source = node.template.source
-      @node = node
-      record_offenses
-    end
-
-    private
-
-    def record_offenses
-      record_offenses_from_regex(
-        message: "Missing async or defer attribute on script tag",
-        regex: PARSER_BLOCKING_SCRIPT_TAG,
-      )
-      record_offenses_from_regex(
-        message: "The script_tag filter is parser-blocking. Use a script tag with the async or defer attribute for better performance",
-        regex: SCRIPT_TAG_FILTER,
-      )
-    end
-
-    def record_offenses_from_regex(regex: nil, message: nil)
-      matches(@source, regex).each do |match|
-        add_offense(
-          message,
-          node: @node,
-          markup: match[0],
-          line_number: @source[0...match.begin(0)].count("\n") + 1
-        )
-      end
+      add_offense("Missing async or defer attribute on script tag", node: node)
     end
   end
 end

data/lib/theme_check/checks/parser_blocking_script_tag.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when trying to use parser-blocking script tags
+  class ParserBlockingScriptTag < LiquidCheck
+    severity :error
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
+
+    def on_variable(node)
+      used_filters = node.value.filters.map { |name, *_rest| name }
+      if used_filters.include?("script_tag")
+        add_offense(
+          "The script_tag filter is parser-blocking. Use a script tag with the async or defer " \
+          "attribute for better performance",
+          node: node
+        )
+      end
+    end
+  end
+end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -15,12 +15,18 @@ module ThemeCheck
       return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk|
-        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))
         end
-        chunk.scan(/([,:])\S/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
           add_offense("Space missing after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
         end
+        chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+          add_offense("Too many spaces before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+        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))
+        end
       end
     end
 

data/lib/theme_check/checks/template_length.rb

@@ -8,6 +8,9 @@ module ThemeCheck
     def initialize(max_length: 200, exclude_schema: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
+    end
+
+    def on_document(_node)
       @excluded_lines = 0
     end
 

data/lib/theme_check/checks/valid_html_translation.rb

@@ -5,6 +5,7 @@ require 'nokogumbo'
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck
     severity :suggestion
+    category :translation
     doc docs_url(__FILE__)
 
     def on_file(file)

data/lib/theme_check/cli.rb

@@ -17,7 +17,7 @@ module ThemeCheck
     end
 
     def option_parser(parser = OptionParser.new, help: true)
-      return @option_parser if @option_parser
+      return @option_parser if defined?(@option_parser)
       @option_parser = parser
       @option_parser.banner = "Usage: theme-check [options] [/path/to/your/theme]"
 

data/lib/theme_check/config.rb

@@ -91,7 +91,13 @@ module ThemeCheck
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
-        check = check_class.new(**options_for_check)
+        ignored_patterns = options_for_check.delete(:ignore) || []
+        check = if options_for_check.empty?
+          check_class.new
+        else
+          check_class.new(**options_for_check)
+        end
+        check.ignored_patterns = ignored_patterns
         check.options = options_for_check
         check
       end.compact
@@ -104,7 +110,7 @@ module ThemeCheck
     private
 
     def check_name?(name)
-      name.start_with?(/[A-Z]/)
+      name.to_s.start_with?(/[A-Z]/)
     end
 
     def validate_configuration(configuration, default_configuration = self.class.default, parent_keys = [])

data/lib/theme_check/disabled_check.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This class keeps track of checks being turned on and off in ranges.
+# We'll use the node position to figure out if the test is disabled or not.
+module ThemeCheck
+  class DisabledCheck
+    attr_reader :name, :template, :ranges
+    attr_accessor :first_line
+
+    def initialize(template, name)
+      @template = template
+      @name = name
+      @ranges = []
+      @first_line = false
+    end
+
+    def start_index=(index)
+      return unless ranges.empty? || !last.end.nil?
+      @ranges << (index..)
+    end
+
+    def end_index=(index)
+      return if ranges.empty? || !last.end.nil?
+      @ranges << (@ranges.pop.begin..index)
+    end
+
+    def disabled?(index)
+      index == 0 && first_line ||
+        ranges.any? { |range| range.cover?(index) }
+    end
+
+    def last
+      ranges.last
+    end
+
+    def missing_end_index?
+      return false if first_line && ranges.size == 1
+      last&.end.nil?
+    end
+  end
+end

data/lib/theme_check/disabled_checks.rb

@@ -8,50 +8,52 @@ module ThemeCheck
 
     ACTION_DISABLE_CHECKS = :disable
     ACTION_ENABLE_CHECKS = :enable
-    ACTION_UNRELATED_COMMENT = :unrelated
 
     def initialize
-      @disabled = []
-      @all_disabled = false
-      @full_document_disabled = false
+      @disabled_checks = Hash.new do |hash, key|
+        template, check_name = key
+        hash[key] = DisabledCheck.new(template, check_name)
+      end
     end
 
     def update(node)
       text = comment_text(node)
-
       if start_disabling?(text)
-        @disabled = checks_from_text(text)
-        @all_disabled = @disabled.empty?
-
-        if node&.line_number == 1
-          @full_document_disabled = true
+        checks_from_text(text).each do |check_name|
+          disabled = @disabled_checks[[node.template, check_name]]
+          disabled.start_index = node.start_index
+          disabled.first_line = true if node.line_number == 1
         end
       elsif stop_disabling?(text)
-        checks = checks_from_text(text)
-        @disabled = checks.empty? ? [] : @disabled - checks
-
-        @all_disabled = false
+        checks_from_text(text).each do |check_name|
+          disabled = @disabled_checks[[node.template, check_name]]
+          next unless disabled
+          disabled.end_index = node.end_index
+        end
       end
     end
 
-    # Whether any checks are currently disabled
-    def any?
-      !@disabled.empty? || @all_disabled
-    end
+    def disabled?(check, template, check_name, index)
+      return true if check.ignored_patterns&.any? do |pattern|
+        template.relative_path.fnmatch?(pattern)
+      end
 
-    # Whether all checks should be disabled
-    def all_disabled?
-      @all_disabled
+      @disabled_checks[[template, :all]]&.disabled?(index) ||
+        @disabled_checks[[template, check_name]]&.disabled?(index)
     end
 
-    # Get a list of all the individual disabled checks
-    def all
-      @disabled
+    def checks_missing_end_index
+      @disabled_checks.values
+        .select(&:missing_end_index?)
+        .map(&:name)
     end
 
-    # If the first line of the document is a theme-check-disable comment
-    def full_document_disabled?
-      @full_document_disabled
+    def remove_disabled_offenses(checks)
+      checks.disableable.each do |check|
+        check.offenses.reject! do |offense|
+          disabled?(check, offense.template, offense.code_name, offense.start_index)
+        end
+      end
     end
 
     private
@@ -69,9 +71,11 @@ module ThemeCheck
     end
 
     # Return a list of checks from a theme-check-disable comment
-    # Returns [] if all checks are meant to be disabled
+    # Returns [:all] if all checks are meant to be disabled
     def checks_from_text(text)
-      text.gsub(DISABLE_PREFIX_PATTERN, '').strip.split(',').map(&:strip)
+      checks = text.gsub(DISABLE_PREFIX_PATTERN, '').strip.split(',').map(&:strip)
+      return [:all] if checks.empty?
+      checks
     end
   end
 end

data/lib/theme_check/exceptions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "net/http"
+
+TIMEOUT_EXCEPTIONS = [
+  Net::ReadTimeout,
+  Net::OpenTimeout,
+  Net::WriteTimeout,
+  Errno::ETIMEDOUT,
+  Timeout::Error,
+]
+
+CONNECTION_EXCEPTIONS = [
+  IOError,
+  EOFError,
+  SocketError,
+  Errno::EINVAL,
+  Errno::ECONNRESET,
+  Errno::ECONNABORTED,
+  Errno::EPIPE,
+  Errno::ECONNREFUSED,
+  Errno::EAGAIN,
+  Errno::EHOSTUNREACH,
+  Errno::ENETUNREACH,
+]
+
+NET_HTTP_EXCEPTIONS = [
+  Net::HTTPBadResponse,
+  Net::HTTPHeaderSyntaxError,
+  Net::ProtocolError,
+  *TIMEOUT_EXCEPTIONS,
+  *CONNECTION_EXCEPTIONS,
+]

data/lib/theme_check/html_check.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class HtmlCheck < Check
+    extend ChecksTracking
+  end
+end

data/lib/theme_check/html_node.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "forwardable"
+
+module ThemeCheck
+  class HtmlNode
+    extend Forwardable
+    attr_reader :template
+
+    def_delegators :@value, :content, :attributes
+
+    def initialize(value, template)
+      @value = value
+      @template = template
+    end
+
+    def literal?
+      @value.name == "text"
+    end
+
+    def children
+      @value.children.map { |child| HtmlNode.new(child, template) }
+    end
+
+    def parent
+      HtmlNode.new(@value.parent, template)
+    end
+
+    def name
+      if @value.name == "#document-fragment"
+        "document"
+      else
+        @value.name
+      end
+    end
+
+    def value
+      if literal?
+        @value.content
+      else
+        @value
+      end
+    end
+
+    def markup
+      @value.to_html
+    end
+
+    def line_number
+      @value.line
+    end
+  end
+end

data/lib/theme_check/html_visitor.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "nokogumbo"
+require "forwardable"
+
+module ThemeCheck
+  class HtmlVisitor
+    attr_reader :checks
+
+    def initialize(checks)
+      @checks = checks
+    end
+
+    def visit_template(template)
+      doc = parse(template)
+      visit(HtmlNode.new(doc, template))
+    end
+
+    private
+
+    def parse(template)
+      Nokogiri::HTML5.fragment(template.source)
+    end
+
+    def visit(node)
+      call_checks(:"on_#{node.name}", node)
+      node.children.each { |child| visit(child) }
+      unless node.literal?
+        call_checks(:"after_#{node.name}", node)
+      end
+    end
+
+    def call_checks(method, *args)
+      checks.call(method, *args)
+    end
+  end
+end