theme-check 1.0.0 → 1.4.0

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)

data/lib/theme_check/json_check.rb

@@ -4,8 +4,8 @@ module ThemeCheck
   class JsonCheck < Check
     extend ChecksTracking
 
-    def add_offense(message, markup: nil, line_number: nil, template: nil)
-      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template)
+    def add_offense(message, markup: nil, line_number: nil, template: nil, &block)
+      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template, correction: block)
     end
   end
 end

data/lib/theme_check/json_file.rb

@@ -1,29 +1,15 @@
 # frozen_string_literal: true
 require "json"
-require "pathname"
 
 module ThemeCheck
-  class JsonFile
+  class JsonFile < ThemeFile
     def initialize(relative_path, storage)
-      @relative_path = relative_path
-      @storage = storage
+      super
       @loaded = false
       @content = nil
       @parser_error = nil
     end
 
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def source
-      @source ||= @storage.read(@relative_path)
-    end
-
     def content
       load!
       @content
@@ -34,22 +20,20 @@ module ThemeCheck
       @parser_error
     end
 
-    def name
-      relative_path.sub_ext('').to_s
+    def update_contents(new_content = '{}')
+      @content = new_content
     end
 
-    def json?
-      true
-    end
-
-    def liquid?
-      false
+    def write
+      if source != @content
+        @storage.write(@relative_path, content)
+        @source = content
+      end
     end
 
-    def ==(other)
-      other.is_a?(JsonFile) && relative_path == other.relative_path
+    def json?
+      true
     end
-    alias_method :eql?, :==
 
     private
 

data/lib/theme_check/json_printer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'json'
+
+module ThemeCheck
+  class JsonPrinter
+    def print(offenses)
+      json = offenses_by_path(offenses)
+      puts JSON.dump(json)
+    end
+
+    def offenses_by_path(offenses)
+      offenses
+        .map(&:to_h)
+        .group_by { |offense| offense[:path] }
+        .map do |(path, path_offenses)|
+          {
+            path: path,
+            offenses: path_offenses.map { |offense| offense.filter { |k, _v| k != :path } },
+            errorCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:error] },
+            suggestionCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:suggestion] },
+            styleCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:style] },
+          }
+        end
+    end
+  end
+end

data/lib/theme_check/language_server/constants.rb

@@ -2,13 +2,28 @@
 
 module ThemeCheck
   module LanguageServer
-    PARTIAL_RENDER = %r{
-      \{\%-?\s*render\s+'(?<partial>[^']*)'|
-      \{\%-?\s*render\s+"(?<partial>[^"]*)"|
+    def self.partial_tag(tag)
+      %r{
+        \{\%-?\s*#{tag}\s+'(?<partial>[^']*)'|
+        \{\%-?\s*#{tag}\s+"(?<partial>[^"]*)"|
 
-      # in liquid tags the whole line is white space until render
-      ^\s*render\s+'(?<partial>[^']*)'|
-      ^\s*render\s+"(?<partial>[^"]*)"
+        # in liquid tags the whole line is white space until the tag
+        ^\s*#{tag}\s+'(?<partial>[^']*)'|
+        ^\s*#{tag}\s+"(?<partial>[^"]*)"
+      }mix
+    end
+
+    PARTIAL_RENDER = partial_tag('render')
+    PARTIAL_INCLUDE = partial_tag('include')
+    PARTIAL_SECTION = partial_tag('section')
+
+    ASSET_INCLUDE = %r{
+      \{\{-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      \{\{-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
+
+      # in liquid tags the whole line is white space until the asset partial
+      ^\s*(?:echo|assign[^=]*\=)\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      ^\s*(?:echo|assign[^=]*\=)\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
     }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -3,46 +3,18 @@
 module ThemeCheck
   module LanguageServer
     class DocumentLinkEngine
-      include PositionHelper
-      include RegexHelpers
-
       def initialize(storage)
         @storage = storage
+        @providers = DocumentLinkProvider.all.map { |x| x.new(storage) }
       end
 
       def document_links(relative_path)
         buffer = @storage.read(relative_path)
         return [] unless buffer
-        matches(buffer, PARTIAL_RENDER).map do |match|
-          start_line, start_character = from_index_to_row_column(
-            buffer,
-            match.begin(:partial),
-          )
-
-          end_line, end_character = from_index_to_row_column(
-            buffer,
-            match.end(:partial)
-          )
-
-          {
-            target: link(match[:partial]),
-            range: {
-              start: {
-                line: start_line,
-                character: start_character,
-              },
-              end: {
-                line: end_line,
-                character: end_character,
-              },
-            },
-          }
+        @providers.flat_map do |p|
+          p.document_links(buffer)
         end
       end
-
-      def link(partial)
-        "file://#{@storage.path('snippets/' + partial + '.liquid')}"
-      end
     end
   end
 end

data/lib/theme_check/language_server/document_link_provider.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class DocumentLinkProvider
+      include RegexHelpers
+      include PositionHelper
+
+      class << self
+        attr_accessor :partial_regexp, :destination_directory, :destination_postfix
+
+        def all
+          @all ||= []
+        end
+
+        def inherited(subclass)
+          all << subclass
+        end
+      end
+
+      def initialize(storage = InMemoryStorage.new)
+        @storage = storage
+      end
+
+      def partial_regexp
+        self.class.partial_regexp
+      end
+
+      def destination_directory
+        self.class.destination_directory
+      end
+
+      def destination_postfix
+        self.class.destination_postfix
+      end
+
+      def document_links(buffer)
+        matches(buffer, partial_regexp).map do |match|
+          start_line, start_character = from_index_to_row_column(
+            buffer,
+            match.begin(:partial),
+          )
+
+          end_line, end_character = from_index_to_row_column(
+            buffer,
+            match.end(:partial)
+          )
+
+          {
+            target: file_link(match[:partial]),
+            range: {
+              start: {
+                line: start_line,
+                character: start_character,
+              },
+              end: {
+                line: end_line,
+                character: end_character,
+              },
+            },
+          }
+        end
+      end
+
+      def file_link(partial)
+        "file://#{@storage.path(destination_directory + '/' + partial + destination_postfix)}"
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class AssetDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = ASSET_INCLUDE
+      @destination_directory = "assets"
+      @destination_postfix = ""
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class IncludeDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_INCLUDE
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class RenderDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_RENDER
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class SectionDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_SECTION
+      @destination_directory = "sections"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 require "benchmark"
+require "uri"
+require "cgi"
 
 module ThemeCheck
   module LanguageServer
@@ -53,10 +55,9 @@ module ThemeCheck
       end
 
       def on_text_document_did_open(_id, params)
-        return unless @diagnostics_tracker.first_run?
         relative_path = relative_path_from_text_document_uri(params)
         @storage.write(relative_path, text_document_text(params))
-        analyze_and_send_offenses(text_document_uri(params))
+        analyze_and_send_offenses(text_document_uri(params)) if @diagnostics_tracker.first_run?
       end
 
       def on_text_document_did_save(_id, params)
@@ -98,8 +99,10 @@ module ThemeCheck
         path_from_uri(params.dig('textDocument', 'uri'))
       end
 
-      def path_from_uri(uri)
-        uri&.sub('file://', '')
+      def path_from_uri(uri_string)
+        return if uri_string.nil?
+        uri = URI(uri_string)
+        CGI.unescape(uri.path)
       end
 
       def relative_path_from_text_document_uri(params)