theme-check 1.2.0 → 1.3.0

data/lib/theme_check/checks/img_width_and_height.rb

@@ -9,8 +9,8 @@ module ThemeCheck
     ENDS_IN_CSS_UNIT = /(cm|mm|in|px|pt|pc|em|ex|ch|rem|vw|vh|vmin|vmax|%)$/i
 
     def on_img(node)
-      width = node.attributes["width"]&.value
-      height = node.attributes["height"]&.value
+      width = node.attributes["width"]
+      height = node.attributes["height"]
 
       record_units_in_field_offenses("width", width, node: node)
       record_units_in_field_offenses("height", height, node: node)
@@ -35,7 +35,7 @@ module ThemeCheck
       return unless value =~ ENDS_IN_CSS_UNIT
       value_without_units = value.gsub(ENDS_IN_CSS_UNIT, '')
       add_offense(
-        "The #{attribute} attribute does not take units. Replace with \"#{value_without_units}\".",
+        "The #{attribute} attribute does not take units. Replace with \"#{value_without_units}\"",
         node: node,
       )
     end

data/lib/theme_check/checks/missing_template.rb

@@ -7,20 +7,36 @@ module ThemeCheck
     doc docs_url(__FILE__)
     single_file false
 
+    def initialize(ignore_missing: [])
+      @ignore_missing = ignore_missing
+    end
+
     def on_include(node)
       template = node.value.template_name_expr
       if template.is_a?(String)
-        unless theme["snippets/#{template}"]
-          add_offense("'snippets/#{template}.liquid' is not found", node: node)
-        end
+        add_missing_offense("snippets/#{template}", node: node)
       end
     end
+
     alias_method :on_render, :on_include
 
     def on_section(node)
       template = node.value.section_name
-      unless theme["sections/#{template}"]
-        add_offense("'sections/#{template}.liquid' is not found", node: node)
+      add_missing_offense("sections/#{template}", node: node)
+    end
+
+    private
+
+    def ignore?(path)
+      @ignore_missing.any? { |pattern| File.fnmatch?(pattern, path) }
+    end
+
+    def add_missing_offense(name, node:)
+      path = "#{name}.liquid"
+      unless ignore?(path) || theme[name]
+        add_offense("'#{path}' is not found", node: node) do |corrector|
+          corrector.create(@theme, "#{name}.liquid", "")
+        end
       end
     end
   end

data/lib/theme_check/checks/pagination_size.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class PaginationSize < LiquidCheck
+    severity :suggestion
+    categories :performance
+    doc docs_url(__FILE__)
+
+    attr_reader :min_size
+    attr_reader :max_size
+
+    def initialize(min_size: 1, max_size: 50)
+      @min_size = min_size
+      @max_size = max_size
+    end
+
+    def on_document(_node)
+      @paginations = {}
+      @schema_settings = {}
+    end
+
+    def on_paginate(node)
+      size = node.value.page_size
+      unless @paginations.key?(size)
+        @paginations[size] = []
+      end
+      @paginations[size].push(node)
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (settings = schema["settings"])
+        @schema_settings = settings
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    def after_document(_node)
+      @paginations.each_pair do |size, nodes|
+        numerical_size = if size.is_a?(Numeric)
+          size
+        else
+          get_setting_default_value(size.lookups.last)
+        end
+        if numerical_size.nil?
+          nodes.each { |node| add_offense("Default pagination size should be defined in the section settings", node: node) }
+        elsif numerical_size > @max_size || numerical_size < @min_size || !numerical_size.is_a?(Integer)
+          nodes.each { |node| add_offense("Pagination size must be a positive integer between #{@min_size} and #{@max_size}", node: node) }
+        end
+      end
+    end
+
+    private
+
+    def get_setting_default_value(setting_id)
+      setting = @schema_settings.select { |s| s['id'] == setting_id }
+      unless setting.empty?
+        return setting.last['default']
+      end
+      # Setting does not exist
+      nil
+    end
+  end
+end

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -8,7 +8,7 @@ module ThemeCheck
 
     def on_script(node)
       return unless node.attributes["src"]
-      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"]&.value == "module"
+      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"] == "module"
 
       add_offense("Missing async or defer attribute on script tag", node: node)
     end

data/lib/theme_check/checks/remote_asset.rb

@@ -14,7 +14,7 @@ module ThemeCheck
     def on_element(node)
       return unless TAGS.include?(node.name)
 
-      resource_url = node.attributes["src"]&.value || node.attributes["href"]&.value
+      resource_url = node.attributes["src"] || node.attributes["href"]
       return if resource_url.nil? || resource_url.empty?
 
       # Ignore if URL is Liquid, taken care of by AssetUrlFilters check
@@ -25,7 +25,7 @@ module ThemeCheck
 
       # Ignore non-stylesheet rel tags
       rel = node.attributes["rel"]
-      return if rel && rel.value != "stylesheet"
+      return if rel && rel != "stylesheet"
 
       add_offense(
         "Asset should be served by the Shopify CDN for better performance.",

data/lib/theme_check/checks/space_inside_braces.rb

@@ -14,18 +14,38 @@ module ThemeCheck
       return unless node.markup
       return if :assign == node.type_name
 
-      outside_of_strings(node.markup) do |chunk|
+      outside_of_strings(node.markup) do |chunk, chunk_start|
         chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
-          add_offense("Too many spaces after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Too many spaces after '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+          )
         end
         chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
-          add_offense("Space missing after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Space missing after '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0),
+          )
         end
         chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
-          add_offense("Too many spaces before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Too many spaces before '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(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))
+          add_offense(
+            "Space missing before '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+          )
         end
       end
     end
@@ -57,7 +77,7 @@ module ThemeCheck
           corrector.insert_before(node, " ")
         end
       end
-      if node.markup[-1] != " "
+      if node.markup[-1] != " " && node.markup[-1] != "\n"
         add_offense("Space missing before '}}'", node: node) do |corrector|
           corrector.insert_after(node, " ")
         end

data/lib/theme_check/checks/undefined_object.rb

@@ -55,7 +55,7 @@ module ThemeCheck
       end
     end
 
-    def initialize(exclude_snippets: false)
+    def initialize(exclude_snippets: true)
       @exclude_snippets = exclude_snippets
       @files = {}
     end

data/lib/theme_check/checks/valid_html_translation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'nokogumbo'
+require 'nokogiri'
 
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck

data/lib/theme_check/checks.rb

@@ -29,8 +29,18 @@ module ThemeCheck
     def call_check_method(check, method, *args)
       return unless check.respond_to?(method) && !check.ignored?
 
-      Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+      # If you want to use binding.pry in unit tests, define the
+      # THEME_CHECK_DEBUG environment variable. e.g.
+      #
+      #   $ export THEME_CHECK_DEBUG=true
+      #   $ bundle exec rake tests:in_memory
+      #
+      if ENV['THEME_CHECK_DEBUG']
         check.send(method, *args)
+      else
+        Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+          check.send(method, *args)
+        end
       end
     rescue Liquid::Error
       # Pass-through Liquid errors

data/lib/theme_check/cli.rb

@@ -5,6 +5,8 @@ module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
+    FORMATS = [:text, :json]
+
     attr_accessor :path
 
     def initialize
@@ -15,6 +17,7 @@ module ThemeCheck
       @auto_correct = false
       @config_path = nil
       @fail_level = :error
+      @format = :text
     end
 
     def option_parser(parser = OptionParser.new, help: true)
@@ -29,6 +32,10 @@ module ThemeCheck
         "Use the config provided, overriding .theme-check.yml if present",
         "Use :theme_app_extension to use default checks for theme app extensions"
       ) { |path| @config_path = path }
+      @option_parser.on(
+        "-o", "--output FORMAT", FORMATS,
+        "The output format to use. (text|json, default: text)"
+      ) { |format| @format = format.to_sym }
       @option_parser.on(
         "-c", "--category CATEGORY", Check::CATEGORIES, "Only run this category of checks",
         "Runs checks matching all categories when specified more than once"
@@ -166,7 +173,7 @@ module ThemeCheck
     end
 
     def check
-      puts "Checking #{@config.root} ..."
+      STDERR.puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
@@ -175,10 +182,19 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
+      output_with_format(theme, analyzer)
       raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
         offense.check.severity_value <= Check.severity_value(@fail_level)
       end
     end
+
+    def output_with_format(theme, analyzer)
+      case @format
+      when :text
+        ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
+      when :json
+        ThemeCheck::JsonPrinter.new.print(analyzer.offenses)
+      end
+    end
   end
 end

data/lib/theme_check/corrector.rb

@@ -27,5 +27,9 @@ module ThemeCheck
       line.insert(node.range[0], insert_before)
       line.insert(node.range[1] + 1 + insert_before.length, insert_after)
     end
+
+    def create(theme, relative_path, content)
+      theme.storage.write(relative_path, content)
+    end
   end
 end

data/lib/theme_check/file_system_storage.rb

@@ -20,6 +20,9 @@ module ThemeCheck
     end
 
     def write(relative_path, content)
+      reset_memoizers unless file_exists?(relative_path)
+
+      file(relative_path).dirname.mkpath unless file(relative_path).dirname.directory?
       file(relative_path).write(content)
     end
 
@@ -36,6 +39,15 @@ module ThemeCheck
 
     private
 
+    def file_exists?(relative_path)
+      !!@files[relative_path]
+    end
+
+    def reset_memoizers
+      @file_array = nil
+      @directories = nil
+    end
+
     def glob(pattern)
       @root.glob(pattern).reject do |path|
         relative_path = path.relative_path_from(@root)

data/lib/theme_check/html_check.rb

@@ -3,7 +3,6 @@
 module ThemeCheck
   class HtmlCheck < Check
     extend ChecksTracking
-    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
   end
 end

data/lib/theme_check/html_node.rb

@@ -4,13 +4,14 @@ require "forwardable"
 module ThemeCheck
   class HtmlNode
     extend Forwardable
-    attr_reader :template
+    include RegexHelpers
+    attr_reader :template, :parent
 
-    def_delegators :@value, :content, :attributes
-
-    def initialize(value, template)
+    def initialize(value, template, placeholder_values = [], parent = nil)
       @value = value
       @template = template
+      @placeholder_values = placeholder_values
+      @parent = parent
     end
 
     def literal?
@@ -22,35 +23,55 @@ module ThemeCheck
     end
 
     def children
-      @value.children.map { |child| HtmlNode.new(child, template) }
+      @children ||= @value
+        .children
+        .map { |child| HtmlNode.new(child, template, @placeholder_values, self) }
     end
 
-    def parent
-      HtmlNode.new(@value.parent, template)
+    def attributes
+      @attributes ||= @value.attributes
+        .map { |k, v| [replace_placeholders(k), replace_placeholders(v.value)] }
+        .to_h
     end
 
-    def name
-      if @value.name == "#document-fragment"
-        "document"
-      else
-        @value.name
-      end
+    def content
+      @content ||= replace_placeholders(@value.content)
     end
 
+    # @value is not forwarded because we _need_ to replace the
+    # placeholders for the HtmlNode to make sense.
     def value
       if literal?
-        @value.content
+        content
       else
-        @value
+        markup
+      end
+    end
+
+    def name
+      if @value.name == "#document-fragment"
+        "document"
+      else
+        @value.name
       end
     end
 
     def markup
-      @value.to_html
+      @markup ||= replace_placeholders(@value.to_html)
     end
 
     def line_number
       @value.line
     end
+
+    private
+
+    def replace_placeholders(string)
+      # Replace all {%#{i}####%} with the actual content.
+      string.gsub(LIQUID_TAG) do |match|
+        key = /\d+/.match(match)[0]
+        @placeholder_values[key.to_i]
+      end
+    end
   end
 end

data/lib/theme_check/html_visitor.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
-require "nokogumbo"
+require "nokogiri"
 require "forwardable"
 
 module ThemeCheck
   class HtmlVisitor
+    include RegexHelpers
     attr_reader :checks
 
     def initialize(checks)
       @checks = checks
+      @placeholder_values = []
     end
 
     def visit_template(template)
       doc = parse(template)
-      visit(HtmlNode.new(doc, template))
+      visit(HtmlNode.new(doc, template, @placeholder_values))
     rescue ArgumentError => e
       call_checks(:on_parse_error, e, template)
     end
@@ -20,7 +22,19 @@ module ThemeCheck
     private
 
     def parse(template)
-      Nokogiri::HTML5.fragment(template.source, max_tree_depth: 400, max_attributes: 400)
+      parseable_source = +template.source.clone
+
+      # Replace all liquid tags with {%#{i}######%} to prevent the HTML
+      # parser from freaking out. We transparently replace those placeholders in
+      # HtmlNode.
+      matches(parseable_source, LIQUID_TAG_OR_VARIABLE).each do |m|
+        value = m[0]
+        @placeholder_values.push(value)
+        key = (@placeholder_values.size - 1).to_s
+        parseable_source[m.begin(0)...m.end(0)] = "{%#{key.ljust(m.end(0) - m.begin(0) - 4, '#')}%}"
+      end
+
+      Nokogiri::HTML5.fragment(parseable_source, max_tree_depth: 400, max_attributes: 400)
     end
 
     def visit(node)