theme-check 0.1.2 → 0.3.2

data/lib/theme_check/packager.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class Packager
+    ROOT = File.expand_path('../../..', __FILE__)
+    PACKAGING_DIR = File.join(ROOT, 'packaging')
+    BUILDS_DIR = File.join(PACKAGING_DIR, 'builds', ThemeCheck::VERSION)
+
+    def initialize
+      FileUtils.mkdir_p(BUILDS_DIR)
+    end
+
+    def build_homebrew
+      root_dir = File.join(PACKAGING_DIR, 'homebrew')
+
+      build_path = File.join(BUILDS_DIR, "theme-check.rb")
+      puts "\nBuilding Homebrew package"
+
+      puts "Generating formula..."
+      File.delete(build_path) if File.exist?(build_path)
+
+      spec_contents = File.read(File.join(root_dir, 'theme_check.base.rb'))
+      spec_contents = spec_contents.gsub('THEME_CHECK_VERSION', ThemeCheck::VERSION)
+
+      puts "Grabbing sha256 checksum from Rubygems.org"
+      require 'digest/sha2'
+      require 'open-uri'
+      gem_checksum = open("https://rubygems.org/downloads/theme-check-#{ThemeCheck::VERSION}.gem") do |io|
+        Digest::SHA256.new.hexdigest(io.read)
+      end
+
+      puts "Got sha256 checksum for gem: #{gem_checksum}"
+      spec_contents = spec_contents.gsub('THEME_CHECK_GEM_CHECKSUM', gem_checksum)
+
+      puts "Writing generated formula\n  To: #{build_path}\n\n"
+      File.write(build_path, spec_contents)
+    end
+
+    private
+
+    def ensure_program_installed(program, installation_cmd)
+      unless system(program, '--version', out: File::NULL, err: File::NULL)
+        raise <<~MESSAGE
+
+          Could not find program #{program} which is required to build the package.
+          You can install it by running `#{installation_cmd}`.
+
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/theme_check/printer.rb

@@ -2,25 +2,34 @@
 
 module ThemeCheck
   class Printer
-    def print(theme, offenses)
+    def print(theme, offenses, auto_correct)
       offenses.each do |offense|
-        print_offense(offense)
+        print_offense(offense, auto_correct)
         puts
       end
 
-      puts "#{theme.all.size} files inspected, #{red(offenses.size.to_s + ' offenses')} detected"
+      correctable = offenses.select(&:correctable?)
+      puts "#{theme.all.size} files inspected, #{red(offenses.size.to_s + ' offenses')} detected, \
+#{yellow(correctable.size.to_s + ' offenses')} #{auto_correct ? 'corrected' : 'auto-correctable'}"
     end
 
-    def print_offense(offense)
+    def print_offense(offense, auto_correct)
       location = if offense.location
         blue(offense.location) + ": "
       else
         ""
       end
 
+      corrected = if auto_correct && offense.correctable?
+        green("[Corrected] ")
+      else
+        ""
+      end
+
       puts location +
         colorized_severity(offense.severity) + ": " +
         yellow(offense.check_name) + ": " +
+        corrected +
         offense.message + "."
       if offense.source_excerpt
         puts "\t#{offense.source_excerpt}"

data/lib/theme_check/shopify_liquid.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+require_relative 'shopify_liquid/deprecated_filter'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'

data/lib/theme_check/shopify_liquid/deprecated_filter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module ThemeCheck
+  module ShopifyLiquid
+    module DeprecatedFilter
+      extend self
+
+      def alternatives(filter)
+        all.fetch(filter, nil)
+      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
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/object.rb

@@ -11,6 +11,12 @@ module ThemeCheck
           YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/objects.yml"))
         end
       end
+
+      def plus_labels
+        @plus_labels ||= begin
+          YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/plus_objects.yml"))
+        end
+      end
     end
   end
 end

data/lib/theme_check/storage.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class Storage
+    def read(relative_path)
+      raise NotImplementedError
+    end
+
+    def write(relative_path, content)
+      raise NotImplementedError
+    end
+
+    def path(relative_path)
+      raise NotImplementedError
+    end
+
+    def files
+      raise NotImplementedError
+    end
+
+    def directories
+      raise NotImplementedError
+    end
+  end
+end

data/lib/theme_check/template.rb

@@ -3,15 +3,29 @@ require "pathname"
 
 module ThemeCheck
   class Template
-    attr_reader :path
+    def initialize(relative_path, storage)
+      @storage = storage
+      @relative_path = relative_path
+    end
 
-    def initialize(path, root)
-      @path = Pathname(path)
-      @root = Pathname(root)
+    def path
+      @storage.path(@relative_path)
     end
 
     def relative_path
-      @path.relative_path_from(@root)
+      @relative_pathname ||= Pathname.new(@relative_path)
+    end
+
+    def source
+      @source ||= @storage.read(@relative_path)
+    end
+
+    def write
+      content = updated_content
+      if source != content
+        @storage.write(@relative_path, content)
+        @source = content
+      end
     end
 
     def name
@@ -30,18 +44,26 @@ module ThemeCheck
       name.start_with?('snippets')
     end
 
-    def source
-      @source ||= @path.read
+    def lines
+      # Retain trailing newline character
+      @lines ||= source.split("\n", -1)
     end
 
-    def lines
-      @lines ||= source.split("\n")
+    # Not entirely obvious but lines is mutable, corrections are to be
+    # applied on @lines.
+    def updated_content
+      lines.join("\n")
     end
 
     def excerpt(line)
       lines[line - 1].strip
     end
 
+    def source_excerpt(line)
+      original_lines = source.split("\n")
+      original_lines[line - 1].strip
+    end
+
     def full_line(line)
       lines[line - 1]
     end
@@ -59,7 +81,7 @@ module ThemeCheck
     end
 
     def ==(other)
-      other.is_a?(Template) && @path == other.path
+      other.is_a?(Template) && relative_path == other.relative_path
     end
 
     def self.parse(source)

data/lib/theme_check/theme.rb

@@ -4,18 +4,27 @@ require "pathname"
 module ThemeCheck
   class Theme
     DEFAULT_LOCALE_REGEXP = %r{^locales/(.*)\.default$}
-    attr_reader :root
+    LIQUID_REGEX = /\.liquid$/i
+    JSON_REGEX = /\.json$/i
 
-    def initialize(root)
-      @root = Pathname.new(root)
+    def initialize(storage)
+      @storage = storage
     end
 
     def liquid
-      @liquid ||= @root.glob("**/*.liquid").map { |path| Template.new(path, @root) }
+      @liquid ||= @storage.files
+        .select { |path| LIQUID_REGEX.match?(path) }
+        .map { |path| Template.new(path, @storage) }
     end
 
     def json
-      @json ||= @root.glob("**/*.json").map { |path| JsonFile.new(path, @root) }
+      @json ||= @storage.files
+        .select { |path| JSON_REGEX.match?(path) }
+        .map { |path| JsonFile.new(path, @storage) }
+    end
+
+    def directories
+      @storage.directories
     end
 
     def default_locale_json
@@ -52,9 +61,5 @@ module ThemeCheck
     def snippets
       liquid.select(&:snippet?)
     end
-
-    def directories
-      @directories ||= @root.glob('*').select { |f| File.directory?(f) }.map { |f| f.relative_path_from(@root) }
-    end
   end
 end

data/lib/theme_check/version.rb

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

data/lib/theme_check/visitor.rb

@@ -6,12 +6,15 @@ module ThemeCheck
     end
 
     def visit_template(template)
+      @disabled_checks = DisabledChecks.new
       visit(Node.new(template.root, nil, template))
     rescue Liquid::Error => exception
       exception.template_name = template.name
       call_checks(:on_error, exception)
     end
 
+    private
+
     def visit(node)
       call_checks(:on_node, node)
       call_checks(:on_tag, node) if node.tag?
@@ -22,16 +25,24 @@ module ThemeCheck
         call_checks(:after_tag, node) if node.tag?
         call_checks(:after_node, node)
       end
-    end
 
-    private
+      @disabled_checks.update(node) if node.comment?
+    end
 
     def visit_children(node)
       node.children.each { |child| visit(child) }
     end
 
     def call_checks(method, *args)
-      @checks.call(method, *args)
+      checks.call(method, *args)
+    end
+
+    def checks
+      return @checks unless @disabled_checks.any?
+
+      return @checks.always_enabled if @disabled_checks.all_disabled?
+
+      @checks.except_for(@disabled_checks)
     end
   end
 end

data/packaging/homebrew/theme_check.base.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'formula'
+require 'fileutils'
+
+class ThemeCheck < Formula
+  module RubyBin
+    def ruby_bin
+      Formula["ruby"].opt_bin
+    end
+  end
+
+  class RubyGemsDownloadStrategy < AbstractDownloadStrategy
+    include RubyBin
+
+    def fetch
+      ohai("Fetching theme-check from gem source")
+      cache.cd do
+        ENV['GEM_SPEC_CACHE'] = "#{cache}/gem_spec_cache"
+        system("#{ruby_bin}/gem", "fetch", "theme-check", "--version", gem_version)
+      end
+    end
+
+    def cached_location
+      Pathname.new("#{cache}/theme-check-#{gem_version}.gem")
+    end
+
+    def cache
+      @cache ||= HOMEBREW_CACHE
+    end
+
+    def gem_version
+      return @version if defined?(@version) && @version
+      @version = @resource.version if defined?(@resource)
+      raise "Unable to determine version; did Homebrew change?" unless @version
+      @version
+    end
+
+    def clear_cache
+      cached_location.unlink if cached_location.exist?
+    end
+  end
+
+  include RubyBin
+
+  url "theme-check", using: RubyGemsDownloadStrategy
+  version "THEME_CHECK_VERSION"
+  sha256 'THEME_CHECK_GEM_CHECKSUM'
+  depends_on "ruby"
+
+  def install
+    # set GEM_HOME and GEM_PATH to make sure we package all the dependent gems
+    # together without accidently picking up other gems on the gem path since
+    # they might not be there if, say, we change to a different rvm gemset
+    ENV['GEM_HOME'] = prefix.to_s
+    ENV['GEM_PATH'] = prefix.to_s
+
+    # Use /usr/local/bin at the front of the path instead of Homebrew shims,
+    # which mess with Ruby's own compiler config when building native extensions
+    if defined?(HOMEBREW_SHIMS_PATH)
+      ENV['PATH'] = ENV['PATH'].sub(HOMEBREW_SHIMS_PATH.to_s, '/usr/local/bin')
+    end
+
+    system(
+      "#{ruby_bin}/gem",
+      "install",
+      cached_download,
+      "--no-document",
+      "--no-wrapper",
+      "--no-user-install",
+      "--install-dir", prefix,
+      "--bindir", bin
+    )
+
+    raise "gem install 'theme-check' failed with status #{$CHILD_STATUS.exitstatus}" unless $CHILD_STATUS.success?
+
+    bin.rmtree if bin.exist?
+    bin.mkpath
+
+    brew_gem_prefix = "#{prefix}/gems/theme-check-#{version}"
+
+    gemspec = Gem::Specification.load("#{prefix}/specifications/theme-check-#{version}.gemspec")
+    ruby_libs = Dir.glob("#{prefix}/gems/*/lib")
+    gemspec.executables.each do |exe|
+      file = Pathname.new("#{brew_gem_prefix}/#{gemspec.bindir}/#{exe}")
+      (bin + file.basename).open('w') do |f|
+        f << <<~RUBY
+          #!#{ruby_bin}/ruby --disable-gems
+          ENV['GEM_HOME']="#{prefix}"
+          ENV['GEM_PATH']="#{prefix}"
+          require 'rubygems'
+          $:.unshift(#{ruby_libs.map(&:inspect).join(',')})
+          load "#{file}"
+        RUBY
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -65,17 +65,21 @@ files:
 - ".github/workflows/theme-check.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.md
 - README.md
+- RELEASING.md
 - Rakefile
 - bin/liquid-server
 - config/default.yml
+- data/shopify_liquid/deprecated_filters.yml
 - data/shopify_liquid/filters.yml
 - data/shopify_liquid/objects.yml
+- data/shopify_liquid/plus_objects.yml
 - dev.yml
 - docs/preview.png
 - exe/theme-check
@@ -86,12 +90,15 @@ files:
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
+- lib/theme_check/checks/deprecated_filter.rb
 - lib/theme_check/checks/liquid_tag.rb
 - lib/theme_check/checks/matching_schema_translations.rb
 - lib/theme_check/checks/matching_translations.rb
+- lib/theme_check/checks/missing_enable_comment.rb
 - lib/theme_check/checks/missing_required_template_files.rb
 - lib/theme_check/checks/missing_template.rb
 - lib/theme_check/checks/nested_snippet.rb
+- lib/theme_check/checks/parser_blocking_javascript.rb
 - lib/theme_check/checks/required_directories.rb
 - lib/theme_check/checks/required_layout_theme_object.rb
 - lib/theme_check/checks/space_inside_braces.rb
@@ -108,6 +115,10 @@ files:
 - lib/theme_check/checks_tracking.rb
 - lib/theme_check/cli.rb
 - lib/theme_check/config.rb
+- lib/theme_check/corrector.rb
+- lib/theme_check/disabled_checks.rb
+- lib/theme_check/file_system_storage.rb
+- lib/theme_check/in_memory_storage.rb
 - lib/theme_check/json_check.rb
 - lib/theme_check/json_file.rb
 - lib/theme_check/json_helpers.rb
@@ -118,16 +129,20 @@ files:
 - lib/theme_check/locale_diff.rb
 - lib/theme_check/node.rb
 - lib/theme_check/offense.rb
+- lib/theme_check/packager.rb
 - lib/theme_check/parsing_helpers.rb
 - lib/theme_check/printer.rb
 - lib/theme_check/shopify_liquid.rb
+- lib/theme_check/shopify_liquid/deprecated_filter.rb
 - lib/theme_check/shopify_liquid/filter.rb
 - lib/theme_check/shopify_liquid/object.rb
+- lib/theme_check/storage.rb
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb
 - lib/theme_check/theme.rb
 - lib/theme_check/version.rb
 - lib/theme_check/visitor.rb
+- packaging/homebrew/theme_check.base.rb
 - theme-check.gemspec
 homepage: https://github.com/Shopify/theme-check
 licenses: