theme-check 0.7.2 → 0.8.3

data/lib/theme_check/config.rb

@@ -91,7 +91,11 @@ module ThemeCheck
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
-        check = check_class.new(**options_for_check)
+        check = if options_for_check.empty?
+          check_class.new
+        else
+          check_class.new(**options_for_check)
+        end
         check.options = options_for_check
         check
       end.compact
@@ -104,7 +108,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,39 @@
+# 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, :ranges
+    attr_accessor :first_line
+
+    def initialize(name)
+      @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)
+      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,36 @@ 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 = {}
     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_checks[check_name] ||= DisabledCheck.new(check_name)
+          @disabled_checks[check_name].start_index = node.start_index
+          @disabled_checks[check_name].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|
+          next unless @disabled_checks.key?(check_name)
+          @disabled_checks[check_name].end_index = node.end_index
+        end
       end
     end
 
-    # Whether any checks are currently disabled
-    def any?
-      !@disabled.empty? || @all_disabled
-    end
-
-    # Whether all checks should be disabled
-    def all_disabled?
-      @all_disabled
-    end
-
-    # Get a list of all the individual disabled checks
-    def all
-      @disabled
+    def disabled?(key, index)
+      @disabled_checks[:all]&.disabled?(index) ||
+        @disabled_checks[key]&.disabled?(index)
     end
 
-    # If the first line of the document is a theme-check-disable comment
-    def full_document_disabled?
-      @full_document_disabled
+    def checks_missing_end_index
+      @disabled_checks.values
+        .select(&:missing_end_index?)
+        .map(&:name)
     end
 
     private
@@ -69,9 +55,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/json_file.rb

@@ -20,6 +20,10 @@ module ThemeCheck
       @relative_pathname ||= Pathname.new(@relative_path)
     end
 
+    def source
+      @source ||= @storage.read(@relative_path)
+    end
+
     def content
       load!
       @content
@@ -39,7 +43,7 @@ module ThemeCheck
     def load!
       return if @loaded
 
-      @content = JSON.parse(@storage.read(@relative_path))
+      @content = JSON.parse(source)
     rescue JSON::ParserError => e
       @parser_error = e
     ensure

data/lib/theme_check/language_server.rb

@@ -4,7 +4,7 @@ require_relative "language_server/constants"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"
-require_relative "language_server/position_helper"
+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"

data/lib/theme_check/language_server/completion_engine.rb

@@ -12,7 +12,7 @@ module ThemeCheck
 
       def completions(relative_path, line, col)
         buffer = @storage.read(relative_path)
-        cursor = from_line_column_to_index(buffer, line, col)
+        cursor = from_row_column_to_index(buffer, line, col)
         token = find_token(buffer, cursor)
         return [] if token.nil?
 

data/lib/theme_check/language_server/completion_providers/object_completion_provider.rb

@@ -4,18 +4,20 @@ module ThemeCheck
   module LanguageServer
     class ObjectCompletionProvider < CompletionProvider
       def completions(content, cursor)
-        return [] unless can_complete?(content, cursor)
-        partial = first_word(content) || ''
+        return [] unless (variable_lookup = variable_lookup_at_cursor(content, cursor))
+        return [] unless variable_lookup.lookups.empty?
+        return [] if content[cursor - 1] == "."
         ShopifyLiquid::Object.labels
-          .select { |w| w.start_with?(partial) }
+          .select { |w| w.start_with?(partial(variable_lookup)) }
           .map { |object| object_to_completion(object) }
       end
 
-      def can_complete?(content, cursor)
-        content.match?(Liquid::VariableStart) && (
-          cursor_on_first_word?(content, cursor) ||
-          cursor_on_start_content?(content, cursor, Liquid::VariableStart)
-        )
+      def variable_lookup_at_cursor(content, cursor)
+        VariableLookupFinder.lookup(content, cursor)
+      end
+
+      def partial(variable_lookup)
+        variable_lookup.name || ''
       end
 
       private

data/lib/theme_check/language_server/constants.rb

@@ -4,7 +4,11 @@ module ThemeCheck
   module LanguageServer
     PARTIAL_RENDER = %r{
       \{\%-?\s*render\s+'(?<partial>[^']*)'|
-      \{\%-?\s*render\s+"(?<partial>[^"]*)"
+      \{\%-?\s*render\s+"(?<partial>[^"]*)"|
+
+      # in liquid tags the whole line is white space until render
+      ^\s*render\s+'(?<partial>[^']*)'|
+      ^\s*render\s+"(?<partial>[^"]*)"
     }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -14,12 +14,12 @@ module ThemeCheck
         buffer = @storage.read(relative_path)
         return [] unless buffer
         matches(buffer, PARTIAL_RENDER).map do |match|
-          start_line, start_character = from_index_to_line_column(
+          start_line, start_character = from_index_to_row_column(
             buffer,
             match.begin(:partial),
           )
 
-          end_line, end_character = from_index_to_line_column(
+          end_line, end_character = from_index_to_row_column(
             buffer,
             match.end(:partial)
           )

data/lib/theme_check/language_server/handler.rb

@@ -23,17 +23,17 @@ module ThemeCheck
       end
 
       def on_initialize(id, params)
-        @root_path = params["rootPath"]
+        @root_path = path_from_uri(params["rootUri"]) || params["rootPath"]
+
+        # Tell the client we don't support anything if there's no rootPath
+        return send_response(id, { capabilities: {} }) if @root_path.nil?
         @storage = in_memory_storage(@root_path)
         @completion_engine = CompletionEngine.new(@storage)
         @document_link_engine = DocumentLinkEngine.new(@storage)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#responseMessage
-        send_response(
-          id: id,
-          result: {
-            capabilities: CAPABILITIES,
-          }
-        )
+        send_response(id, {
+          capabilities: CAPABILITIES,
+        })
       end
 
       def on_exit(_id, _params)
@@ -63,20 +63,14 @@ module ThemeCheck
 
       def on_text_document_document_link(id, params)
         relative_path = relative_path_from_text_document_uri(params)
-        send_response(
-          id: id,
-          result: document_links(relative_path)
-        )
+        send_response(id, document_links(relative_path))
       end
 
       def on_text_document_completion(id, params)
         relative_path = relative_path_from_text_document_uri(params)
         line = params.dig('position', 'line')
         col = params.dig('position', 'character')
-        send_response(
-          id: id,
-          result: completions(relative_path, line, col)
-        )
+        send_response(id, completions(relative_path, line, col))
       end
 
       private
@@ -99,7 +93,11 @@ module ThemeCheck
       end
 
       def text_document_uri(params)
-        params.dig('textDocument', 'uri').sub('file://', '')
+        path_from_uri(params.dig('textDocument', 'uri'))
+      end
+
+      def path_from_uri(uri)
+        uri&.sub('file://', '')
       end
 
       def relative_path_from_text_document_uri(params)
@@ -167,13 +165,10 @@ module ThemeCheck
 
       def send_diagnostic(path, offenses)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
-        send_response(
-          method: 'textDocument/publishDiagnostics',
-          params: {
-            uri: "file://#{path}",
-            diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
-          },
-        )
+        send_notification('textDocument/publishDiagnostics', {
+          uri: "file://#{path}",
+          diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
+        })
       end
 
       def offense_to_diagnostic(offense)
@@ -220,11 +215,24 @@ module ThemeCheck
         }
       end
 
-      def send_response(message)
+      def send_message(message)
         message[:jsonrpc] = '2.0'
         @server.send_response(message)
       end
 
+      def send_response(id, result = nil, error = nil)
+        message = { id: id }
+        message[:result] = result if result
+        message[:error] = error if error
+        send_message(message)
+      end
+
+      def send_notification(method, params)
+        message = { method: method }
+        message[:params] = params
+        send_message(message)
+      end
+
       def log(message)
         @server.log(message)
       end

data/lib/theme_check/language_server/variable_lookup_finder.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    module VariableLookupFinder
+      extend self
+
+      UNCLOSED_SQUARE_BRACKET = /\[[^\]]*\Z/
+      ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED = %r{
+        (
+          # quotes not preceded by a [
+          (?<!\[)['"]|
+          # closing ]
+          \]|
+          # opening [
+          \[
+        )$
+      }x
+
+      VARIABLE_LOOKUP_CHARACTERS = /[a-z0-9_.'"\]\[]/i
+      VARIABLE_LOOKUP = /#{VARIABLE_LOOKUP_CHARACTERS}+/o
+      SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS = %r{
+        (?:
+          \s(?:
+            if|elsif|unless|and|or|#{Liquid::Condition.operators.keys.join("|")}
+            |echo
+            |case|when
+            |cycle
+            |in
+          )
+          |[:,=]
+        )
+        \s+
+      }omix
+      ENDS_WITH_BLANK_POTENTIAL_LOOKUP = /#{SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS}$/oimx
+      ENDS_WITH_POTENTIAL_LOOKUP = /#{SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS}#{VARIABLE_LOOKUP}$/oimx
+
+      def lookup(content, cursor)
+        return if cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
+        potential_lookup = lookup_liquid_variable(content, cursor) || lookup_liquid_tag(content, cursor)
+
+        # And we only return it if it's parsed by Liquid as VariableLookup
+        return unless potential_lookup.is_a?(Liquid::VariableLookup)
+        potential_lookup
+      end
+
+      private
+
+      def cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
+        content[0..cursor - 1] =~ ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED
+      end
+
+      def cursor_is_on_liquid_variable_lookup_position(content, cursor)
+        previous_char = content[cursor - 1]
+        is_liquid_variable = content =~ Liquid::VariableStart
+        is_in_variable_segment = previous_char =~ VARIABLE_LOOKUP_CHARACTERS
+        is_on_blank_variable_lookup_position = content[0..cursor - 1] =~ /[{:,-]\s+$/
+        (
+          is_liquid_variable && (
+            is_in_variable_segment ||
+            is_on_blank_variable_lookup_position
+          )
+        )
+      end
+
+      def lookup_liquid_variable(content, cursor)
+        return unless cursor_is_on_liquid_variable_lookup_position(content, cursor)
+        start_index = content.match(/#{Liquid::VariableStart}-?/o).end(0) + 1
+        end_index = cursor - 1
+
+        # We take the following content
+        # - start after the first two {{
+        # - end at cursor position
+        #
+        # That way, we'll have a partial liquid variable that
+        # can be parsed such that the "last" variable_lookup
+        # will be the one we're trying to complete.
+        markup = content[start_index..end_index]
+
+        # Early return for incomplete variables
+        return empty_lookup if markup =~ /\s+$/
+
+        # Now we go to hack city... The cursor might be in the middle
+        # of a string/square bracket lookup. We need to close those
+        # otherwise the variable parse won't work.
+        markup += "'" if markup.count("'").odd?
+        markup += '"' if markup.count('"').odd?
+        markup += "]" if markup =~ UNCLOSED_SQUARE_BRACKET
+
+        variable = variable_from_markup(markup)
+
+        variable_lookup_for_liquid_variable(variable)
+      end
+
+      def cursor_is_on_liquid_tag_lookup_position(content, cursor)
+        markup = content[0..cursor - 1]
+        is_liquid_tag = content.match?(Liquid::TagStart)
+        is_in_variable_segment = markup =~ ENDS_WITH_POTENTIAL_LOOKUP
+        is_on_blank_variable_lookup_position = markup =~ ENDS_WITH_BLANK_POTENTIAL_LOOKUP
+        (
+          is_liquid_tag && (
+            is_in_variable_segment ||
+            is_on_blank_variable_lookup_position
+          )
+        )
+      end
+
+      # Context:
+      #
+      # We know full well that the code as it is being typed is probably not
+      # something that can be parsed by liquid.
+      #
+      # How this works:
+      #
+      # 1. Attempt to turn the code of the token until the cursor position into
+      #    valid liquid code with some hacks.
+      # 2. If the code ends in space at a "potential lookup" spot
+      #   a. Then return an empty variable lookup
+      # 3. Parse the valid liquid code
+      # 4. Attempt to extract a VariableLookup from Liquid::Template
+      def lookup_liquid_tag(content, cursor)
+        return unless cursor_is_on_liquid_tag_lookup_position(content, cursor)
+
+        markup = parseable_markup(content, cursor)
+        return empty_lookup if markup == :empty_lookup_markup
+
+        template = Liquid::Template.parse(markup)
+        current_tag = template.root.nodelist[0]
+
+        case current_tag.tag_name
+        when "if", "unless"
+          variable_lookup_for_if_tag(current_tag)
+        when "case"
+          variable_lookup_for_case_tag(current_tag)
+        when "cycle"
+          variable_lookup_for_cycle_tag(current_tag)
+        when "for"
+          variable_lookup_for_for_tag(current_tag)
+        when "tablerow"
+          variable_lookup_for_tablerow_tag(current_tag)
+        when "render"
+          variable_lookup_for_render_tag(current_tag)
+        when "assign"
+          variable_lookup_for_assign_tag(current_tag)
+        when "echo"
+          variable_lookup_for_echo_tag(current_tag)
+        end
+
+      # rubocop:disable Style/RedundantReturn
+      rescue Liquid::SyntaxError
+        # We don't complete variable for liquid syntax errors
+        return
+      end
+      # rubocop:enable Style/RedundantReturn
+
+      def parseable_markup(content, cursor)
+        start_index = 0
+        end_index = cursor - 1
+        markup = content[start_index..end_index]
+
+        # Welcome to Hackcity
+        markup += "'" if markup.count("'").odd?
+        markup += '"' if markup.count('"').odd?
+        markup += "]" if markup =~ UNCLOSED_SQUARE_BRACKET
+
+        # Now check if it's a liquid tag
+        is_liquid_tag = markup =~ tag_regex('liquid')
+        ends_with_blank_potential_lookup = markup =~ ENDS_WITH_BLANK_POTENTIAL_LOOKUP
+        last_line = markup.rstrip.lines.last
+        markup = "{% #{last_line}" if is_liquid_tag
+
+        # Close the tag
+        markup += ' %}'
+
+        # if statements
+        is_if_tag = markup =~ tag_regex('if')
+        return :empty_lookup_markup if is_if_tag && ends_with_blank_potential_lookup
+        markup += '{% endif %}' if is_if_tag
+
+        # unless statements
+        is_unless_tag = markup =~ tag_regex('unless')
+        return :empty_lookup_markup if is_unless_tag && ends_with_blank_potential_lookup
+        markup += '{% endunless %}' if is_unless_tag
+
+        # elsif statements
+        is_elsif_tag = markup =~ tag_regex('elsif')
+        return :empty_lookup_markup if is_elsif_tag && ends_with_blank_potential_lookup
+        markup = '{% if x %}' + markup + '{% endif %}' if is_elsif_tag
+
+        # case statements
+        is_case_tag = markup =~ tag_regex('case')
+        return :empty_lookup_markup if is_case_tag && ends_with_blank_potential_lookup
+        markup += "{% endcase %}" if is_case_tag
+
+        # when
+        is_when_tag = markup =~ tag_regex('when')
+        return :empty_lookup_markup if is_when_tag && ends_with_blank_potential_lookup
+        markup = "{% case x %}" + markup + "{% endcase %}" if is_when_tag
+
+        # for statements
+        is_for_tag = markup =~ tag_regex('for')
+        return :empty_lookup_markup if is_for_tag && ends_with_blank_potential_lookup
+        markup += "{% endfor %}" if is_for_tag
+
+        # tablerow statements
+        is_tablerow_tag = markup =~ tag_regex('tablerow')
+        return :empty_lookup_markup if is_tablerow_tag && ends_with_blank_potential_lookup
+        markup += "{% endtablerow %}" if is_tablerow_tag
+
+        markup
+      end
+
+      def variable_lookup_for_if_tag(if_tag)
+        condition = if_tag.blocks.last
+        variable_lookup_for_condition(condition)
+      end
+
+      def variable_lookup_for_condition(condition)
+        return variable_lookup_for_condition(condition.child_condition) if condition.child_condition
+        return condition.right if condition.right
+        condition.left
+      end
+
+      def variable_lookup_for_case_tag(case_tag)
+        return variable_lookup_for_case_block(case_tag.blocks.last) unless case_tag.blocks.empty?
+        case_tag.left
+      end
+
+      def variable_lookup_for_case_block(condition)
+        condition.right
+      end
+
+      def variable_lookup_for_cycle_tag(cycle_tag)
+        cycle_tag.variables.last
+      end
+
+      def variable_lookup_for_for_tag(for_tag)
+        for_tag.collection_name
+      end
+
+      def variable_lookup_for_tablerow_tag(tablerow_tag)
+        tablerow_tag.collection_name
+      end
+
+      def variable_lookup_for_render_tag(render_tag)
+        return empty_lookup if render_tag.raw =~ /:\s*$/
+        render_tag.attributes.values.last
+      end
+
+      def variable_lookup_for_assign_tag(assign_tag)
+        variable_lookup_for_liquid_variable(assign_tag.from)
+      end
+
+      def variable_lookup_for_echo_tag(echo_tag)
+        variable_lookup_for_liquid_variable(echo_tag.variable)
+      end
+
+      def variable_lookup_for_liquid_variable(variable)
+        has_filters = !variable.filters.empty?
+
+        # Can complete after trailing comma or :
+        if has_filters && variable.raw =~ /[:,]\s*$/
+          empty_lookup
+        elsif has_filters
+          last_filter_argument(variable.filters)
+        elsif variable.name.nil?
+          empty_lookup
+        else
+          variable.name
+        end
+      end
+
+      def empty_lookup
+        Liquid::VariableLookup.parse('')
+      end
+
+      # We want the last thing in variable.filters which is at most
+      # an array that looks like [name, positional_args, hash_arg]
+      def last_filter_argument(filters)
+        filter = filters.last
+        return filter[2].values.last if filter.size == 3
+        return filter[1].last if filter.size == 2
+        nil
+      end
+
+      def variable_from_markup(markup, parse_context = Liquid::ParseContext.new)
+        Liquid::Variable.new(markup, parse_context)
+      end
+
+      def tag_regex(tag)
+        ShopifyLiquid::Tag.tag_regex(tag)
+      end
+    end
+  end
+end