theme-check 1.5.0 → 1.5.1

data/lib/theme_check/checks/pagination_size.rb

@@ -36,16 +36,32 @@ module ThemeCheck
       # Ignored, handled in ValidSchema.
     end
 
+    ##
+    # Section settings look like:
+    #   #<Liquid::VariableLookup:0x00007fd699c50c48 @name="section", @lookups=["settings", "products_per_page"], @command_flags=0>
+    def size_is_a_section_setting?(size)
+      size.is_a?(Liquid::VariableLookup) &&
+        size.name == 'section' &&
+        size.lookups.first == 'settings'
+    end
+
+    ##
+    # We'll work with either an explicit value, or the default value of the section setting.
+    def get_value(size)
+      return size if size.is_a?(Numeric)
+      return get_setting_default_value(size) if size_is_a_section_setting?(size)
+    end
+
     def after_document(_node)
       @paginations.each_pair do |size, nodes|
-        numerical_size = if size.is_a?(Numeric)
-          size
-        else
-          get_setting_default_value(size.lookups.last)
-        end
-        if numerical_size.nil?
+        # Validate presence of default section setting.
+        if size_is_a_section_setting?(size) && !get_setting_default_value(size)
           nodes.each { |node| add_offense("Default pagination size should be defined in the section settings", node: node) }
-        elsif numerical_size > @max_size || numerical_size < @min_size || !numerical_size.is_a?(Integer)
+        end
+
+        # Validate if size is within range.
+        next unless (numerical_size = get_value(size))
+        if numerical_size > @max_size || numerical_size < @min_size || !numerical_size.is_a?(Integer)
           nodes.each { |node| add_offense("Pagination size must be a positive integer between #{@min_size} and #{@max_size}", node: node) }
         end
       end
@@ -53,11 +69,15 @@ module ThemeCheck
 
     private
 
-    def get_setting_default_value(setting_id)
-      setting = @schema_settings.find { |s| s['id'] == setting_id }
+    def get_setting_default_value(variable_lookup)
+      setting = @schema_settings.select { |s| s['id'] == variable_lookup.lookups.last }
+
+      # Setting does not exist.
       return nil if setting.empty?
-      default_value = setting['default'].to_i
+
+      default_value = setting.last['default'].to_i
       return nil if default_value == 0
+
       default_value
     end
   end

data/lib/theme_check/cli.rb

@@ -78,6 +78,15 @@ module ThemeCheck
         "Print Theme Check version"
       ) { @command = :version }
 
+      if ENV["THEME_CHECK_DEBUG"]
+        @option_parser.separator("")
+        @option_parser.separator("Debugging:")
+        @option_parser.on(
+          "--profile",
+          "Output a profile to STDOUT compatible with FlameGraph."
+        ) { @command = :profile }
+      end
+
       @option_parser.separator("")
       @option_parser.separator(<<~EOS)
         Description:
@@ -172,7 +181,7 @@ module ThemeCheck
       puts option_parser.to_s
     end
 
-    def check
+    def check(out_stream = STDOUT)
       STDERR.puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
@@ -182,18 +191,32 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      output_with_format(theme, analyzer)
+      output_with_format(theme, analyzer, out_stream)
       raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
         offense.check.severity_value <= Check.severity_value(@fail_level)
       end
     end
 
-    def output_with_format(theme, analyzer)
+    def profile
+      require 'ruby-prof-flamegraph'
+
+      result = RubyProf.profile do
+        check(STDERR)
+      end
+
+      # Print a graph profile to text
+      printer = RubyProf::FlameGraphPrinter.new(result)
+      printer.print(STDOUT, {})
+    rescue LoadError
+      STDERR.puts "Profiling is only available in development"
+    end
+
+    def output_with_format(theme, analyzer, out_stream)
       case @format
       when :text
-        ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
+        ThemeCheck::Printer.new(out_stream).print(theme, analyzer.offenses, @config.auto_correct)
       when :json
-        ThemeCheck::JsonPrinter.new.print(analyzer.offenses)
+        ThemeCheck::JsonPrinter.new(out_stream).print(analyzer.offenses)
       end
     end
   end

data/lib/theme_check/json_printer.rb

@@ -3,9 +3,13 @@ require 'json'
 
 module ThemeCheck
   class JsonPrinter
+    def initialize(out_stream = STDOUT)
+      @out = out_stream
+    end
+
     def print(offenses)
       json = offenses_by_path(offenses)
-      puts JSON.dump(json)
+      @out.puts JSON.dump(json)
     end
 
     def offenses_by_path(offenses)

data/lib/theme_check/printer.rb

@@ -2,14 +2,18 @@
 
 module ThemeCheck
   class Printer
+    def initialize(out_stream = STDOUT)
+      @out = out_stream
+    end
+
     def print(theme, offenses, auto_correct)
       offenses.each do |offense|
         print_offense(offense, auto_correct)
-        puts
+        @out.puts
       end
 
       correctable = offenses.select(&:correctable?)
-      puts "#{theme.all.size} files inspected, #{red(offenses.size.to_s + ' offenses')} detected, \
+      @out.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
 
@@ -26,15 +30,15 @@ module ThemeCheck
         ""
       end
 
-      puts location +
+      @out.puts location +
         colorized_severity(offense.severity) + ": " +
         yellow(offense.check_name) + ": " +
         corrected +
         offense.message + "."
       if offense.source_excerpt
-        puts "\t#{offense.source_excerpt}"
+        @out.puts "\t#{offense.source_excerpt}"
         if offense.markup_start_in_excerpt
-          puts "\t" + (" " * offense.markup_start_in_excerpt) + ("^" * offense.markup.size)
+          @out.puts "\t" + (" " * offense.markup_start_in_excerpt) + ("^" * offense.markup.size)
         end
       end
     end

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -118,6 +118,7 @@ files:
 - docs/checks/valid_html_translation.md
 - docs/checks/valid_json.md
 - docs/checks/valid_schema.md
+- docs/flamegraph.svg
 - docs/preview.png
 - exe/theme-check
 - exe/theme-check-language-server