theme-check 0.3.2 → 0.7.0

data/lib/theme_check/language_server/protocol.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# Here we define the Language Server Protocol Constants we're using.
+# For complete docs, see the following:
+# https://microsoft.github.io/language-server-protocol/specifications/specification-current
+module ThemeCheck
+  module LanguageServer
+    module CompletionItemKinds
+      TEXT = 1
+      METHOD = 2
+      FUNCTION = 3
+      CONSTRUCTOR = 4
+      FIELD = 5
+      VARIABLE = 6
+      CLASS = 7
+      INTERFACE = 8
+      MODULE = 9
+      PROPERTY = 10
+      UNIT = 11
+      VALUE = 12
+      ENUM = 13
+      KEYWORD = 14
+      SNIPPET = 15
+      COLOR = 16
+      FILE = 17
+      REFERENCE = 18
+      FOLDER = 19
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+
+    module TextDocumentSyncKind
+      NONE = 0
+      FULL = 1
+      INCREMENTAL = 2
+    end
+  end
+end

data/lib/theme_check/language_server/server.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 require 'json'
 require 'stringio'
-require 'active_support/core_ext/string/inflections'
 
 module ThemeCheck
   module LanguageServer
     class DoneStreaming < StandardError; end
+
     class IncompatibleStream < StandardError; end
 
     class Server
       attr_reader :handler
+      attr_reader :should_raise_errors
 
       def initialize(
         in_stream: STDIN,
         out_stream: STDOUT,
-        err_stream: $DEBUG ? File.open('/tmp/lsp.log', 'a') : STDERR
+        err_stream: STDERR,
+        should_raise_errors: false
       )
         validate!([in_stream, out_stream, err_stream])
 
@@ -25,6 +27,8 @@ module ThemeCheck
 
         @out.sync = true # do not buffer
         @err.sync = true # do not buffer
+
+        @should_raise_errors = should_raise_errors
       end
 
       def listen
@@ -37,6 +41,7 @@ module ThemeCheck
           return 0
 
         rescue Exception => e # rubocop:disable Lint/RescueException
+          raise e if should_raise_errors
           log(e)
           log(e.backtrace)
           return 1
@@ -45,7 +50,7 @@ module ThemeCheck
 
       def send_response(response)
         response_body = JSON.dump(response)
-        log(response_body) if $DEBUG
+        log(JSON.pretty_generate(response)) if $DEBUG
 
         @out.write("Content-Length: #{response_body.size}\r\n")
         @out.write("\r\n")
@@ -93,7 +98,7 @@ module ThemeCheck
       end
 
       def to_snake_case(method_name)
-        method_name.gsub(/[^\w]/, '_').underscore
+        StringHelpers.underscore(method_name.gsub(/[^\w]/, '_'))
       end
 
       def initial_line

data/lib/theme_check/language_server/tokens.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  Token = Struct.new(
+    :content,
+    :start, # inclusive
+    :end, # exclusive
+  )
+
+  TAG_START = Liquid::TagStart
+  TAG_END = Liquid::TagEnd
+  VARIABLE_START = Liquid::VariableStart
+  VARIABLE_END = Liquid::VariableEnd
+  SPLITTER = %r{
+    (?=(?:#{TAG_START}|#{VARIABLE_START}))| # positive lookahead on tag/variable start
+    (?<=(?:#{TAG_END}|#{VARIABLE_END}))     # positive lookbehind on tag/variable end
+  }xom
+
+  # Implemented as an Enumerable so we stop iterating on the find once
+  # we have what we want. Kind of a perf thing.
+  class Tokens
+    include Enumerable
+
+    def initialize(buffer)
+      @buffer = buffer
+    end
+
+    def each(&block)
+      return to_enum(:each) unless block_given?
+
+      chunks = @buffer.split(SPLITTER)
+      chunks.shift if chunks[0]&.empty?
+
+      prev = Token.new('', 0, 0)
+      curr = Token.new('', 0, 0)
+
+      while (content = chunks.shift)
+
+        curr.start = prev.end
+        curr.end = curr.start + content.size
+
+        block.call(Token.new(
+          content,
+          curr.start,
+          curr.end,
+        ))
+
+        # recycling structs
+        tmp = prev
+        prev = curr
+        curr = tmp
+      end
+    end
+  end
+end

data/lib/theme_check/liquid_check.rb

@@ -6,6 +6,17 @@ module ThemeCheck
     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
+
     def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, &block)
       offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, correction: block)
     end

data/lib/theme_check/node.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/string/inflections'
 
 module ThemeCheck
   # A node from the Liquid AST, the result of parsing a template.
@@ -101,7 +100,7 @@ module ThemeCheck
     # The `:under_score_name` of this type of node. Used to dispatch to the `on_<type_name>`
     # and `after_<type_name>` check methods.
     def type_name
-      @type_name ||= @value.class.name.demodulize.underscore.to_sym
+      @type_name ||= StringHelpers.underscore(StringHelpers.demodulize(@value.class.name)).to_sym
     end
 
     # Is this node inside a `{% liquid ... %}` block?

data/lib/theme_check/offense.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module ThemeCheck
+  Position = Struct.new(:line, :column)
+
   class Offense
     MAX_SOURCE_EXCERPT_SIZE = 120
 
@@ -35,6 +37,9 @@ module ThemeCheck
       elsif @node
         @node.line_number
       end
+
+      @start_position = nil
+      @end_position = nil
     end
 
     def source_excerpt
@@ -50,27 +55,19 @@ module ThemeCheck
     end
 
     def start_line
-      return 0 unless line_number
-      line_number - 1
+      start_position.line
     end
 
-    def end_line
-      if markup
-        start_line + markup.count("\n")
-      else
-        start_line
-      end
+    def start_column
+      start_position.column
     end
 
-    def start_column
-      return 0 unless line_number && markup
-      template.full_line(start_line + 1).index(markup.split("\n", 2).first)
+    def end_line
+      end_position.line
     end
 
     def end_column
-      return 0 unless line_number && markup
-      markup_end = markup.split("\n").last
-      template.full_line(end_line + 1).index(markup_end) + markup_end.size
+      end_position.column
     end
 
     def code_name
@@ -86,7 +83,7 @@ module ThemeCheck
     end
 
     def check_name
-      check.class.name.demodulize
+      StringHelpers.demodulize(check.class.name)
     end
 
     def doc
@@ -116,5 +113,45 @@ module ThemeCheck
         message
       end
     end
+
+    private
+
+    def full_line(line)
+      # Liquid::Template is 1-indexed.
+      template.full_line(line + 1)
+    end
+
+    def lines_of_content
+      @lines ||= markup.lines.map { |x| x.sub(/\n$/, '') }
+    end
+
+    # 0-indexed, inclusive
+    def start_position
+      return @start_position if @start_position
+      return @start_position = Position.new(0, 0) unless line_number && markup
+
+      position = Position.new
+      position.line = line_number - 1
+      position.column = full_line(position.line).index(lines_of_content.first) || 0
+
+      @start_position = position
+    end
+
+    # 0-indexed, exclusive. It's the line + col that are exclusive.
+    # This is why it doesn't make sense to calculate them separately.
+    def end_position
+      return @end_position if @end_position
+      return @end_position = Position.new(0, 0) unless line_number && markup
+
+      position = Position.new
+      position.line = start_line + lines_of_content.size - 1
+      position.column = if start_line == position.line
+        start_column + markup.size
+      else
+        lines_of_content.last.size
+      end
+
+      @end_position = position
+    end
   end
 end

data/lib/theme_check/regex_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module RegexHelpers
+    def matches(s, re)
+      start_at = 0
+      matches = []
+      while (m = s.match(re, start_at))
+        matches.push(m)
+        start_at = m.end(0)
+      end
+      matches
+    end
+  end
+end

data/lib/theme_check/releaser.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'theme_check/version'
+
+module ThemeCheck
+  class Releaser
+    ROOT = File.expand_path('../../..', __FILE__)
+    LIB = File.join(ROOT, 'lib')
+
+    class VersionError < StandardError; end
+
+    def release(version)
+      raise VersionError, "Missing version argument." if version.nil?
+      raise VersionError, "Version should be a string." unless version.is_a?(String)
+      raise VersionError, "Version should be a valid semver version." unless version =~ /^\d+\.\d+.\d+$/
+      update_docs(version)
+      update_version(version)
+    end
+
+    def update_version(version)
+      version_file_path = File.join(LIB, 'theme_check/version.rb')
+      version_file = File.read(version_file_path)
+      updated_version_file = version_file.gsub(ThemeCheck::VERSION, version)
+
+      return if updated_version_file == version_file
+      puts "Updating version to #{version} in #{version_file_path}."
+      File.write(version_file_path, updated_version_file)
+    end
+
+    def update_docs(version)
+      Dir[ROOT + '/docs/checks/*.md'].each do |filename|
+        doc_content = File.read(filename)
+        updated_doc_content = doc_content.gsub('THEME_CHECK_VERSION', version)
+        next if updated_doc_content == doc_content
+        puts "Replacing `THEME_CHECK_VERSION` with #{version} in #{Pathname.new(filename).relative_path_from(ROOT)}"
+        File.write(filename, updated_doc_content)
+      end
+    end
+  end
+end

data/lib/theme_check/remote_asset_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "net/http"
+require "pathname"
+
+module ThemeCheck
+  class RemoteAssetFile
+    class << self
+      def cache
+        @cache ||= {}
+      end
+
+      def from_src(src)
+        key = uri(src).to_s
+        cache[key] = RemoteAssetFile.new(src) unless cache.key?(key)
+        cache[key]
+      end
+
+      def uri(src)
+        URI.parse(src.sub(%r{^//}, "https://"))
+      end
+    end
+
+    def initialize(src)
+      @uri = RemoteAssetFile.uri(src)
+      @content = nil
+    end
+
+    def content
+      return @content unless @content.nil?
+
+      res = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: @uri.scheme == 'https') do |http|
+        req = Net::HTTP::Get.new(@uri)
+        req['Accept-Encoding'] = 'gzip, deflate, br'
+        http.request(req)
+      end
+
+      @content = res.body
+    end
+
+    def gzipped_size
+      @gzipped_size ||= content.bytesize
+    end
+  end
+end

data/lib/theme_check/shopify_liquid.rb

@@ -2,3 +2,4 @@
 require_relative 'shopify_liquid/deprecated_filter'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'
+require_relative 'shopify_liquid/tag'

data/lib/theme_check/shopify_liquid/deprecated_filter.rb

@@ -10,17 +10,19 @@ module ThemeCheck
         all.fetch(filter, nil)
       end
 
+      def labels
+        @labels ||= all.keys
+      end
+
       private
 
       def all
-        @all ||= begin
-          YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/deprecated_filters.yml"))
-            .values
-            .each_with_object({}) do |filters, acc|
-              filters.each do |(filter, alternatives)|
-                acc[filter] = alternatives
-              end
-            end
+        @all ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/deprecated_filters.yml"))
+          .values
+          .each_with_object({}) do |filters, acc|
+          filters.each do |(filter, alternatives)|
+            acc[filter] = alternatives
+          end
         end
       end
     end

data/lib/theme_check/shopify_liquid/filter.rb

@@ -7,11 +7,9 @@ module ThemeCheck
       extend self
 
       def labels
-        @labels ||= begin
-          YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/filters.yml"))
-            .values
-            .flatten
-        end
+        @labels ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/filters.yml"))
+          .values
+          .flatten
       end
     end
   end