theme-check 1.5.0 → 1.6.1

data/lib/theme_check/analyzer.rb

@@ -86,6 +86,11 @@ module ThemeCheck
     def correct_offenses
       if @auto_correct
         offenses.each(&:correct)
+      end
+    end
+
+    def write_corrections
+      if @auto_correct
         @theme.liquid.each(&:write)
         @theme.json.each(&:write)
       end

data/lib/theme_check/asset_file.rb

@@ -9,10 +9,21 @@ module ThemeCheck
       @content = nil
     end
 
-    alias_method :content, :source
+    def rewriter
+      @rewriter ||= TemplateRewriter.new(@relative_path, source)
+    end
+
+    def write
+      content = rewriter.to_s
+      if source != content
+        @storage.write(@relative_path, content.gsub("\n", @eol))
+        @source = content
+        @rewriter = nil
+      end
+    end
 
     def gzipped_size
-      @gzipped_size ||= Zlib.gzip(content).bytesize
+      @gzipped_size ||= Zlib.gzip(source).bytesize
     end
 
     def name

data/lib/theme_check/check.rb

@@ -46,7 +46,7 @@ module ThemeCheck
       end
 
       def severity_value(severity)
-        SEVERITY_VALUES[severity]
+        SEVERITY_VALUES[severity] || -1
       end
 
       def categories(*categories)

data/lib/theme_check/checks/asset_size_css.rb

@@ -22,5 +22,20 @@ module ThemeCheck
         node: node
       )
     end
+
+    def href_to_file_size(href)
+      # asset_url (+ optional stylesheet_tag) variables
+      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{^(https?:)?//}
+        asset = RemoteAssetFile.from_src(href)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/asset_size_css_stylesheet_tag.rb

@@ -13,12 +13,29 @@ module ThemeCheck
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }
       return unless used_filters.include?("stylesheet_tag")
-      file_size = href_to_file_size('{{' + node.markup + '}}')
+      file_size = stylesheet_tag_pipeline_to_file_size(node.markup)
+      return if file_size.nil?
       return if file_size <= @threshold_in_bytes
       add_offense(
         "CSS on every page load exceeding compressed size threshold (#{@threshold_in_bytes} Bytes).",
         node: node
       )
     end
+
+    def stylesheet_tag_pipeline_to_file_size(href)
+      # asset_url
+      if href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{(https?:)?//[^'"]+}
+        url = Regexp.last_match(0)
+        asset = RemoteAssetFile.from_src(url)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -8,7 +8,8 @@ module ThemeCheck
 
     def on_include(node)
       add_offense("`include` is deprecated - convert it to `render`", node: node) do |corrector|
-        corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
+        # We need to fix #445 and pass the variables from the context or don't replace at all.
+        # corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
       end
     end
   end

data/lib/theme_check/checks/liquid_tag.rb

@@ -13,7 +13,7 @@ module ThemeCheck
     end
 
     def on_tag(node)
-      if !node.inside_liquid_tag?
+      if node.inside_liquid_tag?
         reset_consecutive_statements
       # Ignore comments
       elsif !node.comment?

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -9,19 +9,33 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     REQUIRED_LIQUID_FILES = %w(layout/theme)
-    REQUIRED_TEMPLATE_FILES = %w(
-      index product collection cart blog article page list-collections search 404
+
+    REQUIRED_LIQUID_TEMPLATE_FILES = %w(
       gift_card customers/account customers/activate_account customers/addresses
-      customers/login customers/order customers/register customers/reset_password password
-    )
-      .map { |file| "templates/#{file}" }
+      customers/login customers/order customers/register customers/reset_password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_JSON_TEMPLATE_FILES = %w(
+      index product collection cart blog article page list-collections search 404
+      password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_TEMPLATE_FILES = (REQUIRED_LIQUID_TEMPLATE_FILES + REQUIRED_JSON_TEMPLATE_FILES)
 
     def on_end
       (REQUIRED_LIQUID_FILES - theme.liquid.map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' is missing")
+        add_offense("'#{file}.liquid' is missing") do |corrector|
+          corrector.create(@theme, "#{file}.liquid", "")
+        end
       end
       (REQUIRED_TEMPLATE_FILES - (theme.liquid + theme.json).map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' or '#{file}.json' is missing")
+        add_offense("'#{file}.liquid' or '#{file}.json' is missing") do |corrector|
+          if REQUIRED_LIQUID_TEMPLATE_FILES.include?(file)
+            corrector.create(@theme, "#{file}.liquid", "")
+          else
+            corrector.create(@theme, "#{file}.json", "")
+          end
+        end
       end
     end
   end

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/checks/required_directories.rb

@@ -18,7 +18,9 @@ module ThemeCheck
     private
 
     def add_missing_directories_offense(directory)
-      add_offense("Theme is missing '#{directory}' directory")
+      add_offense("Theme is missing '#{directory}' directory") do |corrector|
+        corrector.mkdir(@theme, directory)
+      end
     end
   end
 end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -15,52 +15,57 @@ module ThemeCheck
       return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk, chunk_start|
-        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)(  +)/) do |_match|
           add_offense(
             "Too many spaces after '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(2),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(2)
           )
         end
         chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
           add_offense(
             "Space missing after '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
+            markup: Regexp.last_match(1),
             node_markup_offset: chunk_start + Regexp.last_match.begin(0),
           )
         end
-        chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+        chunk.scan(/(  +)(\||==|<>|<=|>=|<|>|!=)+/) do |_match|
           add_offense(
-            "Too many spaces before '#{Regexp.last_match(1)}'",
+            "Too many spaces before '#{Regexp.last_match(2)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(1),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(1)
           )
         end
         chunk.scan(/(\A|\S)(?<match>\||==|<>|<=|>=|<|\b>|!=)/) do |_match|
           add_offense(
             "Space missing before '#{Regexp.last_match(1)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(:match),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(:match)
           )
         end
       end
     end
 
     def on_tag(node)
-      if node.inside_liquid_tag?
-        markup = if node.whitespace_trimmed?
-          "-%}"
-        else
-          "%}"
-        end
+      unless node.inside_liquid_tag?
         if node.markup[-1] != " " && node.markup[-1] != "\n"
-          add_offense("Space missing before '#{markup}'", node: node, markup: node.markup[-1] + markup)
+          add_offense(
+            "Space missing before '#{node.end_token}'",
+            node: node,
+            markup: node.markup[-1],
+            node_markup_offset: node.markup.size - 1,
+          )
         elsif node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
-          add_offense("Too many spaces before '#{markup}'", node: node, markup: Regexp.last_match(2) + markup)
+          add_offense(
+            "Too many spaces before '#{node.end_token}'",
+            node: node,
+            markup: Regexp.last_match(2),
+            node_markup_offset: node.markup.size - Regexp.last_match(2).size
+          )
         end
       end
       @ignore = true
@@ -73,22 +78,40 @@ module ThemeCheck
     def on_variable(node)
       return if @ignore || node.markup.empty?
       if node.markup[0] != " "
-        add_offense("Space missing after '{{'", node: node) do |corrector|
+        add_offense(
+          "Space missing after '#{node.start_token}'",
+          node: node,
+          markup: node.markup[0]
+        ) do |corrector|
           corrector.insert_before(node, " ")
         end
       end
       if node.markup[-1] != " " && node.markup[-1] != "\n"
-        add_offense("Space missing before '}}'", node: node) do |corrector|
+        add_offense(
+          "Space missing before '#{node.end_token}'",
+          node: node,
+          markup: node.markup[-1],
+          node_markup_offset: node.markup.size - 1,
+        ) do |corrector|
           corrector.insert_after(node, " ")
         end
       end
-      if node.markup[0] == " " && node.markup[1] == " "
-        add_offense("Too many spaces after '{{'", node: node) do |corrector|
+      if node.markup =~ /\A(  +)/m
+        add_offense(
+          "Too many spaces after '#{node.start_token}'",
+          node: node,
+          markup: Regexp.last_match(1),
+        ) do |corrector|
           corrector.replace(node, " #{node.markup.lstrip}")
         end
       end
-      if node.markup[-1] == " " && node.markup[-2] == " "
-        add_offense("Too many spaces before '}}'", node: node) do |corrector|
+      if node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
+        add_offense(
+          "Too many spaces before '#{node.end_token}'",
+          node: node,
+          markup: Regexp.last_match(2),
+          node_markup_offset: node.markup.size - Regexp.last_match(2).size
+        ) do |corrector|
           corrector.replace(node, "#{node.markup.rstrip} ")
         end
       end

data/lib/theme_check/checks/translation_key_exists.rb

@@ -29,7 +29,9 @@ module ThemeCheck
           "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}'",
           node: node,
           markup: key_node.value,
-        )
+        ) do |corrector|
+          corrector.add_default_translation_key(@theme.default_locale_json, key_node.value.split("."), "TODO")
+        end
       end
     end
 

data/lib/theme_check/checks/unused_snippet.rb

@@ -24,7 +24,9 @@ module ThemeCheck
 
     def on_end
       missing_snippets.each do |template|
-        add_offense("This template is not used", template: template)
+        add_offense("This template is not used", template: template) do |corrector|
+          corrector.remove(@theme, template.relative_path.to_s)
+        end
       end
     end
 

data/lib/theme_check/checks.rb

@@ -50,6 +50,7 @@ module ThemeCheck
       template = node.respond_to?(:template) ? node.template.relative_path : "?"
       markup = node.respond_to?(:markup) ? node.markup : ""
       node_class = node.respond_to?(:value) ? node.value.class : "?"
+      line_number = node.respond_to?(:line_number) ? node.line_number : "?"
 
       ThemeCheck.bug(<<~EOS)
         Exception while running `#{check.code_name}##{method}`:
@@ -64,6 +65,7 @@ module ThemeCheck
         ```
         #{markup}
         ```
+        Line number: #{line_number}
         Check options: `#{check.options.pretty_inspect}`
       EOS
     end

data/lib/theme_check/cli.rb

@@ -49,7 +49,7 @@ module ThemeCheck
         "Automatically fix offenses"
       ) { @auto_correct = true }
       @option_parser.on(
-        "--fail-level SEVERITY", Check::SEVERITIES,
+        "--fail-level SEVERITY", [:crash] + Check::SEVERITIES,
         "Minimum severity (error|suggestion|style) for exit with error code"
       ) do |severity|
         @fail_level = severity.to_sym
@@ -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,35 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      output_with_format(theme, analyzer)
+      print_with_format(theme, analyzer, out_stream)
+      # corrections are committed after printing so that the
+      # source_excerpts are still pointing to the uncorrected source.
+      analyzer.write_corrections
       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 print_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