theme-check 1.0.0 → 1.4.0

data/lib/theme_check/language_server/server.rb

@@ -52,8 +52,19 @@ module ThemeCheck
         response_body = JSON.dump(response)
         log(JSON.pretty_generate(response)) if $DEBUG
 
-        @out.write("Content-Length: #{response_body.bytesize}\r\n")
-        @out.write("\r\n")
+        # Because programming is fun,
+        #
+        # Ruby on Windows turns \n into \r\n. Which means that \r\n
+        # gets turned into \r\r\n. Which means that the protocol
+        # breaks on windows unless we turn STDOUT into binary mode and
+        # set the encoding manually (yuk!) or we do this little hack
+        # here and put \n which gets transformed into \r\n on windows
+        # only...
+        #
+        # Hours wasted: 8.
+        eol = Gem.win_platform? ? "\n" : "\r\n"
+        @out.write("Content-Length: #{response_body.bytesize}#{eol}")
+        @out.write(eol)
         @out.write(response_body)
         @out.flush
       end

data/lib/theme_check/language_server.rb

@@ -8,6 +8,7 @@ require_relative "language_server/variable_lookup_finder"
 require_relative "language_server/completion_helper"
 require_relative "language_server/completion_provider"
 require_relative "language_server/completion_engine"
+require_relative "language_server/document_link_provider"
 require_relative "language_server/document_link_engine"
 require_relative "language_server/diagnostics_tracker"
 
@@ -15,6 +16,10 @@ Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file
 end
 
+Dir[__dir__ + "/language_server/document_link_providers/*.rb"].each do |file|
+  require file
+end
+
 module ThemeCheck
   module LanguageServer
     def self.start

data/lib/theme_check/node.rb

@@ -22,9 +22,7 @@ module ThemeCheck
     end
 
     def markup=(markup)
-      if tag?
-        @value.raw = markup
-      elsif @value.instance_variable_defined?(:@markup)
+      if @value.instance_variable_defined?(:@markup)
         @value.instance_variable_set(:@markup, markup)
       end
     end
@@ -127,7 +125,11 @@ module ThemeCheck
     end
 
     def position
-      @position ||= Position.new(markup, template&.source, line_number)
+      @position ||= Position.new(
+        markup,
+        template&.source,
+        line_number_1_indexed: line_number
+      )
     end
 
     def start_index

data/lib/theme_check/offense.rb

@@ -1,11 +1,32 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Offense
+    include PositionHelper
+
     MAX_SOURCE_EXCERPT_SIZE = 120
 
     attr_reader :check, :message, :template, :node, :markup, :line_number, :correction
 
-    def initialize(check:, message: nil, template: nil, node: nil, markup: nil, line_number: nil, correction: nil)
+    def initialize(
+      check:, # instance of a ThemeCheck::Check
+      message: nil, # error message for the offense
+      template: nil, # Template
+      node: nil, # Node or HtmlNode
+      markup: nil, # string
+      line_number: nil, # line number of the error (1-indexed)
+      # node_markup_offset is the index inside node.markup to start
+      # looking for markup :mindblow:.
+      # This is so we can accurately highlight node substrings.
+      # e.g. if we have the following scenario in which we
+      # want to highlight the middle comma
+      #   * node.markup == "replace ',',', '"
+      #   * markup == ","
+      # Then we need some way of telling our Position class to start
+      # looking for the second comma. This is done with node_markup_offset.
+      # More context can be found in #376.
+      node_markup_offset: 0,
+      correction: nil # block
+    )
       @check = check
       @correction = correction
 
@@ -39,7 +60,13 @@ module ThemeCheck
         @node.line_number
       end
 
-      @position = Position.new(@markup, @template&.source, @line_number)
+      @position = Position.new(
+        @markup,
+        @template&.source,
+        line_number_1_indexed: @line_number,
+        node_markup_offset: node_markup_offset,
+        node_markup: node&.markup
+      )
     end
 
     def source_excerpt
@@ -103,8 +130,13 @@ module ThemeCheck
       tokens.join(":") if tokens.any?
     end
 
+    def location_range
+      tokens = [template&.relative_path, start_index, end_index].compact
+      tokens.join(":") if tokens.any?
+    end
+
     def correctable?
-      line_number && correction
+      !!correction
     end
 
     def correct
@@ -139,5 +171,26 @@ module ThemeCheck
         message
       end
     end
+
+    def to_s_range
+      if template
+        "#{message} at #{location_range}"
+      else
+        message
+      end
+    end
+
+    def to_h
+      {
+        check: check.code_name,
+        path: template&.relative_path,
+        severity: check.severity_value,
+        start_line: start_line,
+        start_column: start_column,
+        end_line: end_line,
+        end_column: end_column,
+        message: message,
+      }
+    end
   end
 end

data/lib/theme_check/parsing_helpers.rb

@@ -5,15 +5,16 @@ module ThemeCheck
     def outside_of_strings(markup)
       scanner = StringScanner.new(markup)
 
-      while scanner.scan(/.*?("|')/)
-        yield scanner.matched[0..-2]
+      while scanner.scan(/.*?("|')/m)
+        chunk_start = scanner.pre_match.size
+        yield scanner.matched[0..-2], chunk_start
         quote = scanner.matched[-1] == "'" ? "'" : "\""
         # Skip to the end of the string
         # Check for empty string first, since follow regexp uses lookahead
         scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
       end
 
-      yield scanner.rest if scanner.rest?
+      yield scanner.rest, scanner.charpos if scanner.rest?
     end
   end
 end

data/lib/theme_check/position.rb

@@ -4,42 +4,64 @@ module ThemeCheck
   class Position
     include PositionHelper
 
-    def initialize(needle, contents, line_number_1_indexed)
-      @needle = needle
-      @contents = contents
+    def initialize(
+      needle_arg,
+      contents_arg,
+      line_number_1_indexed: nil,
+      node_markup: nil,
+      node_markup_offset: 0 # the index of markup inside the node_markup
+    )
+      @needle = needle_arg
+      @contents = contents_arg
       @line_number_1_indexed = line_number_1_indexed
-      @start_row_column = nil
-      @end_row_column = nil
+      @node_markup_offset = node_markup_offset
+      @node_markup = node_markup
+      @strict_position = StrictPosition.new(
+        needle,
+        contents,
+        start_index,
+      )
     end
 
-    def start_line_index
+    def start_line_offset
       from_row_column_to_index(contents, line_number, 0)
     end
 
+    def start_offset
+      return start_line_offset if @node_markup.nil?
+      node_markup_start = contents.index(@node_markup, start_line_offset)
+      return start_line_offset if node_markup_start.nil?
+      node_markup_start + @node_markup_offset
+    end
+
     # 0-indexed, inclusive
     def start_index
-      contents.index(needle, start_line_index) || start_line_index
+      contents.index(needle, start_offset)
     end
 
     # 0-indexed, exclusive
     def end_index
-      start_index + needle.size
+      @strict_position.end_index
     end
 
+    # 0-indexed, inclusive
     def start_row
-      start_row_column[0]
+      @strict_position.start_row
     end
 
+    # 0-indexed, inclusive
     def start_column
-      start_row_column[1]
+      @strict_position.start_column
     end
 
+    # 0-indexed, exclusive (both taken together are) therefore you
+    # might end up on a newline character or the next line
     def end_row
-      end_row_column[0]
+      @strict_position.end_row
     end
 
     def end_column
-      end_row_column[1]
+      @strict_position.end_column
     end
 
     private
@@ -55,15 +77,77 @@ module ThemeCheck
     end
 
     def needle
-      if @needle.nil? && !contents.empty? && !@line_number_1_indexed.nil?
-        contents.lines(chomp: true)[line_number] || ''
+      if has_content_and_line_number_but_no_needle?
+        entire_line_needle
       elsif contents.empty? || @needle.nil?
         ''
+      elsif !can_find_needle?
+        entire_line_needle
       else
         @needle
       end
     end
 
+    def has_content_and_line_number_but_no_needle?
+      @needle.nil? && !contents.empty? && @line_number_1_indexed.is_a?(Integer)
+    end
+
+    def can_find_needle?
+      !!contents.index(@needle)
+    end
+
+    def entire_line_needle
+      contents.lines(chomp: true)[line_number] || ''
+    end
+  end
+
+  # This method is stricter than Position in the sense that it doesn't
+  # accept invalid inputs. Makes for code that is easier to understand.
+  class StrictPosition
+    include PositionHelper
+
+    attr_reader :needle, :contents
+
+    def initialize(needle, contents, start_index)
+      raise ArgumentError, 'Bad start_index' unless start_index.is_a?(Integer)
+      raise ArgumentError, 'Bad contents' unless contents.is_a?(String)
+      raise ArgumentError, 'Bad needle' unless needle.is_a?(String) || !contents.index(needle, start_index)
+
+      @needle = needle
+      @contents = contents
+      @start_index = start_index
+      @start_row_column = nil
+      @end_row_column = nil
+    end
+
+    # 0-indexed, inclusive
+    def start_index
+      @contents.index(needle, @start_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 start_row_column
       return @start_row_column unless @start_row_column.nil?
       @start_row_column = from_index_to_row_column(contents, start_index)

data/lib/theme_check/regex_helpers.rb

@@ -2,8 +2,11 @@
 
 module ThemeCheck
   module RegexHelpers
-    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
+    LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
+
     def matches(s, re)
       start_at = 0
       matches = []
@@ -16,7 +19,7 @@ module ThemeCheck
 
     def href_to_file_size(href)
       # asset_url (+ optional stylesheet_tag) variables
-      if href =~ /^#{VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
+      if href =~ /^#{LIQUID_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?

data/lib/theme_check/tags.rb

@@ -169,14 +169,31 @@ module ThemeCheck
 
     class Stylesheet < Liquid::Raw; end
 
-    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)
-    Liquid::Template.register_tag('schema', Schema)
-    Liquid::Template.register_tag('javascript', Javascript)
-    Liquid::Template.register_tag('stylesheet', Stylesheet)
+    class << self
+      attr_writer :register_tags
+
+      def register_tags?
+        @register_tags
+      end
+
+      def register_tag(name, klass)
+        Liquid::Template.register_tag(name, klass)
+      end
+
+      def register_tags!
+        return if !register_tags? || (defined?(@registered_tags) && @registered_tags)
+        @registered_tags = true
+        register_tag('form', Form)
+        register_tag('layout', Layout)
+        register_tag('render', Render)
+        register_tag('paginate', Paginate)
+        register_tag('section', Section)
+        register_tag('style', Style)
+        register_tag('schema', Schema)
+        register_tag('javascript', Javascript)
+        register_tag('stylesheet', Stylesheet)
+      end
+    end
+    self.register_tags = true
   end
 end

data/lib/theme_check/template.rb

@@ -1,25 +1,7 @@
 # frozen_string_literal: true
-require "pathname"
 
 module ThemeCheck
-  class Template
-    def initialize(relative_path, storage)
-      @storage = storage
-      @relative_path = relative_path
-    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
-
+  class Template < ThemeFile
     def write
       content = updated_content
       if source != content
@@ -28,14 +10,6 @@ module ThemeCheck
       end
     end
 
-    def name
-      relative_path.sub_ext('').to_s
-    end
-
-    def json?
-      false
-    end
-
     def liquid?
       true
     end
@@ -88,16 +62,13 @@ module ThemeCheck
       parse.root
     end
 
-    def ==(other)
-      other.is_a?(Template) && relative_path == other.relative_path
-    end
-    alias_method :eql?, :==
-
     def self.parse(source)
+      Tags.register_tags!
       Liquid::Template.parse(
         source,
         line_numbers: true,
         error_mode: :warn,
+        disable_liquid_c_nodes: true,
       )
     end
   end