theme-check 1.11.0 → 1.12.0

data/lib/theme_check/remote_asset_file.rb

@@ -31,13 +31,7 @@ module ThemeCheck
       return if @uri.nil?
       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
+      @content = request(@uri)
 
     rescue OpenSSL::SSL::SSLError, Zlib::StreamError, *NET_HTTP_EXCEPTIONS
       @contents = ''
@@ -47,5 +41,17 @@ module ThemeCheck
       return if @uri.nil?
       @gzipped_size ||= content.bytesize
     end
+
+    private
+
+    def request(uri)
+      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
+
+      res.body
+    end
   end
 end

data/lib/theme_check/shopify_liquid/documentation/markdown_template.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class Documentation
+      class MarkdownTemplate
+        MARKDOWN_RELATIVE_LINK = %r{(\[([^\[]+)\]\((/[^\)]+)\))*}
+
+        def render(entry)
+          [
+            title(entry),
+            body(entry),
+          ].reject(&:empty?).join("\n")
+        end
+
+        private
+
+        def title(entry)
+          "### #{entry.name}"
+        end
+
+        def body(entry)
+          [entry.deprecation_reason, entry.summary, entry.description]
+            .reject(&:nil?)
+            .reject(&:empty?)
+            .join(horizontal_rule)
+            .tap { |body| break(patch_urls!(body)) }
+        end
+
+        def horizontal_rule
+          "\n\n---\n\n"
+        end
+
+        def patch_urls!(body)
+          body.gsub(MARKDOWN_RELATIVE_LINK) do |original_link|
+            match = Regexp.last_match
+
+            text = match[2]
+            path = match[3]
+
+            if text && path
+              "[#{text}](https://shopify.dev#{path})"
+            else
+              original_link
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/documentation.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'documentation/markdown_template'
+
+module ThemeCheck
+  module ShopifyLiquid
+    class Documentation
+      class << self
+        def filter_doc(filter_name)
+          render_doc(SourceIndex.filters.find { |entry| entry.name == filter_name })
+        end
+
+        def object_doc(object_name)
+          render_doc(SourceIndex.objects.find { |entry| entry.name == object_name })
+        end
+
+        def tag_doc(tag_name)
+          render_doc(SourceIndex.tags.find { |entry| entry.name == tag_name })
+        end
+
+        def object_property_doc(object_name, property_name)
+          property_entry = SourceIndex
+            .objects
+            .find { |entry| entry.name == object_name }
+            &.properties
+            &.find { |prop| prop.name == property_name }
+
+          render_doc(property_entry)
+        end
+
+        def render_doc(entry)
+          return nil unless entry
+          markdown_template.render(entry)
+        end
+
+        private
+
+        def markdown_template
+          @markdown_template ||= MarkdownTemplate.new
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/filter.rb

@@ -3,6 +3,10 @@ require 'yaml'
 
 module ThemeCheck
   module ShopifyLiquid
+    # TODO: (6/6) https://github.com/Shopify/theme-check/issues/656
+    # -
+    # Remove 'filters.yml' in favor of 'SourceIndex.filters'
+    # -
     module Filter
       extend self
 

data/lib/theme_check/shopify_liquid/object.rb

@@ -3,6 +3,10 @@ require 'yaml'
 
 module ThemeCheck
   module ShopifyLiquid
+    # TODO: (4/6) https://github.com/Shopify/theme-check/issues/656
+    # -
+    # Remove 'objects.yml' in favor of 'SourceIndex.objects'
+    # -
     module Object
       extend self
 

data/lib/theme_check/shopify_liquid/source_index/base_entry.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class BaseEntry
+        extend Forwardable
+
+        attr_reader :hash
+
+        def_delegators :return_type_instance, :generic_type?, :array_type?, :array_type, :to_s
+
+        def initialize(hash = {})
+          @hash = hash || {}
+          @return_type = nil
+        end
+
+        def name
+          hash['name']
+        end
+
+        def summary
+          hash['summary'] || ''
+        end
+
+        def description
+          hash['description'] || ''
+        end
+
+        def deprecated?
+          hash['deprecated']
+        end
+
+        def deprecation_reason
+          return nil unless deprecated?
+
+          hash['deprecation_reason'] || nil
+        end
+
+        attr_writer :return_type
+
+        def return_type
+          @return_type || to_s
+        end
+
+        def return_type_instance
+          ReturnTypeEntry.new(return_type_hash)
+        end
+
+        private
+
+        def return_type_hash
+          hash['return_type']&.first
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/base_state.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class BaseState
+        class << self
+          def mark_outdated
+            @up_to_date = false
+          end
+
+          def mark_up_to_date
+            @up_to_date = true
+          end
+
+          def outdated?
+            @up_to_date == false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/filter_entry.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class FilterEntry < BaseEntry
+        def parameters
+          (hash['parameters'] || [])
+            .map { |hash| ParameterEntry.new(hash) }
+        end
+
+        def input_type
+          hash['syntax'].split(' | ')[0]
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/filter_state.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class FilterState < BaseState
+        @up_to_date = false
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/object_entry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class ObjectEntry < BaseEntry
+        def properties
+          (hash['properties'] || [])
+            .map { |hash| PropertyEntry.new(hash) }
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/object_state.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class ObjectState < BaseState
+        @up_to_date = false
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/parameter_entry.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class ParameterEntry < BaseEntry
+        def summary
+          nil
+        end
+
+        private
+
+        def return_type_hash
+          {
+            'type' => (hash['types'] || ['untyped']).first,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/property_entry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class PropertyEntry < BaseEntry; end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/return_type_entry.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class ReturnTypeEntry < BaseEntry
+        def summary
+          nil
+        end
+
+        def to_s
+          hash['type']
+        end
+
+        def generic_type?
+          hash['type'] == 'generic'
+        end
+
+        def array_type?
+          !array_type.nil? && !array_type.empty?
+        end
+
+        def array_type
+          hash['array_value']
+        end
+
+        private
+
+        def return_type_hash
+          {
+            'type' => "type<#{self}>",
+          }
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/tag_entry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class TagEntry < BaseEntry
+        def parameters
+          (hash['parameters'] || [])
+            .map { |hash| ParameterEntry.new(hash) }
+        end
+
+        def return_type_hash
+          {
+            'type' => "tag<#{name}>",
+          }
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index/tag_state.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class TagState < BaseState
+        @up_to_date = false
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_index.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceIndex
+      class << self
+        def filters
+          @filters = nil if FilterState.outdated?
+
+          @filters ||= FilterState.mark_up_to_date &&
+            load_file(:filters)
+              .map { |hash| FilterEntry.new(hash) }
+        end
+
+        def objects
+          @objects = nil if ObjectState.outdated?
+
+          @objects ||= ObjectState.mark_up_to_date &&
+            load_file(:objects)
+              .concat(built_in_objects)
+              .map { |hash| ObjectEntry.new(hash) }
+        end
+
+        def tags
+          @tags = nil if TagState.outdated?
+
+          @tags ||= TagState.mark_up_to_date &&
+            load_file(:tags)
+              .map { |hash| TagEntry.new(hash) }
+        end
+
+        private
+
+        def load_file(file_name)
+          read_json(local_path!(file_name))
+        end
+
+        def local_path!(file_name)
+          SourceManager.download unless SourceManager.has_required_files?
+          SourceManager.local_path(file_name)
+        end
+
+        def read_json(path)
+          JSON.parse(path.read)
+        end
+
+        def built_in_objects
+          load_file('../built_in_liquid_objects')
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/source_manager.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'pathname'
+require 'tmpdir'
+
+module ThemeCheck
+  module ShopifyLiquid
+    class SourceManager
+      REQUIRED_FILE_NAMES = [:filters, :objects, :tags, :latest].freeze
+
+      class << self
+        def download_or_refresh_files(destination = default_destination)
+          if has_required_files?(destination)
+            refresh(destination)
+          else
+            download(destination)
+          end
+        end
+
+        def download(destination = default_destination)
+          Dir.mkdir(destination) unless destination.exist?
+
+          REQUIRED_FILE_NAMES.each do |file_name|
+            download_file(local_path(file_name, destination), remote_path(file_name))
+          end
+        end
+
+        def refresh(destination = default_destination)
+          refresh_threads << Thread.new { refresh_thread(destination) }
+        end
+
+        def local_path(file_name, destination = default_destination)
+          destination + "#{file_name}.json"
+        end
+
+        def has_required_files?(destination = default_destination)
+          REQUIRED_FILE_NAMES.all? { |file_name| local_path(file_name, destination).exist? }
+        end
+
+        def wait_downloads
+          refresh_threads.each(&:join)
+        end
+
+        private
+
+        def refresh_thread(destination)
+          return unless refresh_needed?(destination)
+
+          Dir.mktmpdir do |tmp_dir|
+            download(Pathname.new(tmp_dir))
+
+            FileUtils.cp_r("#{tmp_dir}/.", destination)
+
+            mark_all_indexes_outdated
+          end
+        end
+
+        def refresh_needed?(destination)
+          local_latest_content = local_path(:latest, destination).read
+          remote_latest_content = open_uri(remote_path(:latest))
+
+          revision(local_latest_content) != revision(remote_latest_content)
+        end
+
+        def revision(json_content)
+          # Raise an error if revision isn't found to avoid returning nil
+          JSON.parse(json_content).fetch('revision')
+        end
+
+        def remote_path(file_name)
+          "https://raw.githubusercontent.com/Shopify/theme-liquid-docs/main/data/#{file_name}.json"
+        end
+
+        def download_file(local_path, remote_uri)
+          File.open(local_path, "wb") do |file|
+            content = open_uri(remote_uri)
+            file.write(content)
+          end
+        end
+
+        def mark_all_indexes_outdated
+          SourceIndex::FilterState.mark_outdated
+          SourceIndex::ObjectState.mark_outdated
+          SourceIndex::TagState.mark_outdated
+        end
+
+        # State
+
+        def default_destination
+          @default_destination ||= Pathname.new("#{__dir__}/../../../data/shopify_liquid/documentation")
+        end
+
+        def refresh_threads
+          @refresh_threads ||= []
+        end
+
+        def open_uri(uri_str)
+          uri = URI.parse(uri_str)
+
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+            req = Net::HTTP::Get.new(uri)
+            http.request(req)
+          end
+
+          res.body
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/tag.rb

@@ -37,6 +37,10 @@ module ThemeCheck
         label.keys[0]
       end
 
+      # TODO: (5/6) https://github.com/Shopify/theme-check/issues/656
+      # -
+      # Remove 'tags.yml' in favor of 'SourceIndex.tags'
+      # -
       def tags_file_contents
         @tags_file_contents ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
       end

data/lib/theme_check/shopify_liquid.rb

@@ -1,6 +1,22 @@
 # frozen_string_literal: true
+
 require_relative 'shopify_liquid/deprecated_filter'
+require_relative 'shopify_liquid/documentation'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'
-require_relative 'shopify_liquid/tag'
+require_relative 'shopify_liquid/source_manager'
+require_relative 'shopify_liquid/source_index'
 require_relative 'shopify_liquid/system_translations'
+require_relative 'shopify_liquid/tag'
+
+require_relative 'shopify_liquid/source_index/base_entry'
+require_relative 'shopify_liquid/source_index/filter_entry'
+require_relative 'shopify_liquid/source_index/object_entry'
+require_relative 'shopify_liquid/source_index/parameter_entry'
+require_relative 'shopify_liquid/source_index/property_entry'
+require_relative 'shopify_liquid/source_index/return_type_entry'
+require_relative 'shopify_liquid/source_index/tag_entry'
+require_relative 'shopify_liquid/source_index/base_state'
+require_relative 'shopify_liquid/source_index/filter_state'
+require_relative 'shopify_liquid/source_index/object_state'
+require_relative 'shopify_liquid/source_index/tag_state'

data/lib/theme_check/version.rb

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

data/shipit.rubygems.yml

@@ -0,0 +1,3 @@
+deploy:
+  pre:
+    - bundle exec rake download_theme_liquid_docs

data/theme-check.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    %x{git ls-files -z}.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    # Load all files tracked in git except files in test directory
+    # Include untracked files in liquid documentation folder
+    %x{git ls-files -z}.split("\x0").reject { |f| f.match(%r{^test/}) } + Dir['data/shopify_liquid/documentation/**']
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }