theme-check 0.9.0 → 1.0.0

data/lib/theme_check/checks/template_length.rb

@@ -5,9 +5,11 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(max_length: 200, exclude_schema: true)
+    def initialize(max_length: 500, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
+      @exclude_stylesheet = exclude_stylesheet
+      @exclude_javascript = exclude_javascript
     end
 
     def on_document(_node)
@@ -15,9 +17,15 @@ module ThemeCheck
     end
 
     def on_schema(node)
-      if @exclude_schema
-        @excluded_lines += node.value.nodelist.join.count("\n")
-      end
+      exclude_node_lines(node) if @exclude_schema
+    end
+
+    def on_stylesheet(node)
+      exclude_node_lines(node) if @exclude_stylesheet
+    end
+
+    def on_javascript(node)
+      exclude_node_lines(node) if @exclude_javascript
     end
 
     def after_document(node)
@@ -26,5 +34,11 @@ module ThemeCheck
         add_offense("Template has too many lines [#{lines}/#{@max_length}]", template: node.template)
       end
     end
+
+    private
+
+    def exclude_node_lines(node)
+      @excluded_lines += node.value.nodelist.join.count("\n")
+    end
   end
 end

data/lib/theme_check/html_check.rb

@@ -3,5 +3,7 @@
 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

@@ -17,6 +17,10 @@ module ThemeCheck
       @value.name == "text"
     end
 
+    def element?
+      @value.element?
+    end
+
     def children
       @value.children.map { |child| HtmlNode.new(child, template) }
     end

data/lib/theme_check/html_visitor.rb

@@ -13,19 +13,23 @@ module ThemeCheck
     def visit_template(template)
       doc = parse(template)
       visit(HtmlNode.new(doc, template))
+    rescue ArgumentError => e
+      call_checks(:on_parse_error, e, template)
     end
 
     private
 
     def parse(template)
-      Nokogiri::HTML5.fragment(template.source)
+      Nokogiri::HTML5.fragment(template.source, max_tree_depth: 400, max_attributes: 400)
     end
 
     def visit(node)
+      call_checks(:on_element, node) if node.element?
       call_checks(:"on_#{node.name}", node)
       node.children.each { |child| visit(child) }
       unless node.literal?
         call_checks(:"after_#{node.name}", node)
+        call_checks(:after_element, node) if node.element?
       end
     end
 

data/lib/theme_check/json_file.rb

@@ -46,6 +46,11 @@ module ThemeCheck
       false
     end
 
+    def ==(other)
+      other.is_a?(JsonFile) && relative_path == other.relative_path
+    end
+    alias_method :eql?, :==
+
     private
 
     def load!

data/lib/theme_check/language_server/diagnostics_tracker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "logger"
 
 module ThemeCheck
   module LanguageServer
@@ -16,6 +17,7 @@ module ThemeCheck
       def build_diagnostics(offenses, analyzed_files: nil)
         reported_files = Set.new
         new_single_file_offenses = {}
+        analyzed_files = analyzed_files.map { |path| Pathname.new(path) } if analyzed_files
 
         offenses.group_by(&:template).each do |template, template_offenses|
           next unless template

data/lib/theme_check/liquid_check.rb

@@ -5,16 +5,5 @@ module ThemeCheck
   class LiquidCheck < Check
     extend ChecksTracking
     include ParsingHelpers
-
-    TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
-    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
-    START_OR_END_QUOTE = /(^['"])|(['"]$)/
-    QUOTED_LIQUID_ATTRIBUTE = %r{
-      '(?:#{TAG}|#{VARIABLE}|[^'])*'| # any combination of tag/variable or non straight quote inside straight quotes
-      "(?:#{TAG}|#{VARIABLE}|[^"])*"  # any combination of tag/variable or non double quotes inside double quotes
-    }omix
-    ATTR = /[a-z0-9-]+/i
-    HTML_ATTRIBUTE = /#{ATTR}(?:=#{QUOTED_LIQUID_ATTRIBUTE})?/omix
-    HTML_ATTRIBUTES = /(?:#{HTML_ATTRIBUTE}|\s)*/omix
   end
 end

data/lib/theme_check/offense.rb

@@ -124,13 +124,13 @@ module ThemeCheck
 
     def ==(other)
       other.is_a?(Offense) &&
-        check == other.check &&
+        code_name == other.code_name &&
         message == other.message &&
-        template == other.template &&
-        node == other.node &&
-        markup == other.markup &&
-        line_number == other.line_number
+        location == other.location &&
+        start_index == other.start_index &&
+        end_index == other.end_index
     end
+    alias_method :eql?, :==
 
     def to_s
       if template

data/lib/theme_check/parsing_helpers.rb

@@ -7,8 +7,10 @@ module ThemeCheck
 
       while scanner.scan(/.*?("|')/)
         yield scanner.matched[0..-2]
+        quote = scanner.matched[-1] == "'" ? "'" : "\""
         # Skip to the end of the string
-        scanner.skip_until(scanner.matched[-1] == "'" ? /[^\\]'/ : /[^\\]"/)
+        # Check for empty string first, since follow regexp uses lookahead
+        scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
       end
 
       yield scanner.rest if scanner.rest?

data/lib/theme_check/regex_helpers.rb

@@ -2,6 +2,8 @@
 
 module ThemeCheck
   module RegexHelpers
+    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    START_OR_END_QUOTE = /(^['"])|(['"]$)/
     def matches(s, re)
       start_at = 0
       matches = []
@@ -11,5 +13,20 @@ module ThemeCheck
       end
       matches
     end
+
+    def href_to_file_size(href)
+      # asset_url (+ optional stylesheet_tag) variables
+      if href =~ /^#{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/tags.rb

@@ -125,6 +125,42 @@ module ThemeCheck
       end
     end
 
+    class Render < Liquid::Tag
+      SYNTAX = /((?:#{Liquid::QuotedString}|#{Liquid::VariableSegment})+)(\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?(\s+(?:as)\s+(#{Liquid::VariableSegment}+))?/o
+
+      disable_tags "include"
+
+      attr_reader :template_name_expr, :attributes
+
+      def initialize(tag_name, markup, options)
+        super
+
+        raise SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
+
+        template_name = Regexp.last_match(1)
+        with_or_for = Regexp.last_match(3)
+        variable_name = Regexp.last_match(4)
+
+        @alias_name = Regexp.last_match(6)
+        @variable_name_expr = variable_name ? parse_expression(variable_name) : nil
+        @template_name_expr = parse_expression(template_name)
+        @for = (with_or_for == Liquid::Render::FOR)
+
+        @attributes = {}
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @attributes[key] = parse_expression(value)
+        end
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.template_name_expr,
+          ] + @node.attributes.values
+        end
+      end
+    end
+
     class Style < Liquid::Block; end
 
     class Schema < Liquid::Raw; end
@@ -135,6 +171,7 @@ module ThemeCheck
 
     Liquid::Template.register_tag('form', Form)
     Liquid::Template.register_tag('layout', Layout)
+    Liquid::Template.register_tag('render', Render)
     Liquid::Template.register_tag('paginate', Paginate)
     Liquid::Template.register_tag('section', Section)
     Liquid::Template.register_tag('style', Style)

data/lib/theme_check/template.rb

@@ -91,6 +91,7 @@ module ThemeCheck
     def ==(other)
       other.is_a?(Template) && relative_path == other.relative_path
     end
+    alias_method :eql?, :==
 
     def self.parse(source)
       Liquid::Template.parse(

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -69,13 +69,23 @@ files:
 - data/shopify_liquid/tags.yml
 - data/shopify_translation_keys.yml
 - dev.yml
-- docs/checks/CHECK_DOCS_TEMPLATE.md
+- docs/api/check.md
+- docs/api/html_check.md
+- docs/api/json_check.md
+- docs/api/liquid_check.md
+- docs/checks/TEMPLATE.md.erb
 - docs/checks/asset_size_css.md
+- docs/checks/asset_size_css_stylesheet_tag.md
 - docs/checks/asset_size_javascript.md
+- docs/checks/asset_url_filters.md
 - docs/checks/content_for_header_modification.md
 - docs/checks/convert_include_to_render.md
 - docs/checks/default_locale.md
+- docs/checks/deprecate_bgsizes.md
+- docs/checks/deprecate_lazysizes.md
 - docs/checks/deprecated_filter.md
+- docs/checks/html_parsing_error.md
+- docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
 - docs/checks/liquid_tag.md
 - docs/checks/matching_schema_translations.md
@@ -109,12 +119,19 @@ files:
 - lib/theme_check/bug.rb
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
+- lib/theme_check/checks/TEMPLATE.rb.erb
 - lib/theme_check/checks/asset_size_css.rb
+- lib/theme_check/checks/asset_size_css_stylesheet_tag.rb
 - lib/theme_check/checks/asset_size_javascript.rb
+- lib/theme_check/checks/asset_url_filters.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/deprecate_bgsizes.rb
+- lib/theme_check/checks/deprecate_lazysizes.rb
 - lib/theme_check/checks/deprecated_filter.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
 - lib/theme_check/checks/liquid_tag.rb
 - lib/theme_check/checks/matching_schema_translations.rb
@@ -216,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: A Shopify Theme Linter