theme-check 1.5.1 → 1.6.2

data/lib/theme_check/checks/nested_snippet.rb

@@ -26,12 +26,12 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @templates[node.template.name] = TemplateInfo.new(Set.new)
+      @templates[node.theme_file.name] = TemplateInfo.new(Set.new)
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @templates[node.template.name].includes << node
+        @templates[node.theme_file.name].includes << node
       end
     end
     alias_method :on_render, :on_include

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/required_layout_theme_object.rb

@@ -14,7 +14,7 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @layout_theme_node = node if node.template.name == LAYOUT_FILENAME
+      @layout_theme_node = node if node.theme_file.name == LAYOUT_FILENAME
     end
 
     def on_variable(node)
@@ -25,7 +25,7 @@ module ThemeCheck
     end
 
     def after_document(node)
-      return unless node.template.name == LAYOUT_FILENAME
+      return unless node.theme_file.name == LAYOUT_FILENAME
 
       add_missing_object_offense("content_for_layout") unless @content_for_layout_found
       add_missing_object_offense("content_for_header") unless @content_for_header_found

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/syntax_error.rb

@@ -7,23 +7,23 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_document(node)
-      node.template.warnings.each do |warning|
-        add_exception_as_offense(warning, template: node.template)
+      node.theme_file.warnings.each do |warning|
+        add_exception_as_offense(warning, theme_file: node.theme_file)
       end
     end
 
     def on_error(exception)
-      add_exception_as_offense(exception, template: theme[exception.template_name])
+      add_exception_as_offense(exception, theme_file: theme[exception.template_name])
     end
 
     private
 
-    def add_exception_as_offense(exception, template:)
+    def add_exception_as_offense(exception, theme_file:)
       add_offense(
         exception.to_s(false).sub(/ in ".*"$/, ''),
         line_number: exception.line_number,
         markup: exception.markup_context&.sub(/^in "(.*)"$/, '\1'),
-        template: template,
+        theme_file: theme_file,
       )
     end
   end

data/lib/theme_check/checks/template_length.rb

@@ -29,9 +29,9 @@ module ThemeCheck
     end
 
     def after_document(node)
-      lines = node.template.source.count("\n") - @excluded_lines
+      lines = node.theme_file.source.count("\n") - @excluded_lines
       if lines > @max_length
-        add_offense("Template has too many lines [#{lines}/#{@max_length}]", template: node.template)
+        add_offense("Template has too many lines [#{lines}/#{@max_length}]", theme_file: node.theme_file)
       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/undefined_object.rb

@@ -62,22 +62,22 @@ module ThemeCheck
 
     def on_document(node)
       return if ignore?(node)
-      @files[node.template.name] = TemplateInfo.new
+      @files[node.theme_file.name] = TemplateInfo.new
     end
 
     def on_assign(node)
       return if ignore?(node)
-      @files[node.template.name].all_assigns[node.value.to] = node
+      @files[node.theme_file.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
       return if ignore?(node)
-      @files[node.template.name].all_captures[node.value.instance_variable_get('@to')] = node
+      @files[node.theme_file.name].all_captures[node.value.instance_variable_get('@to')] = node
     end
 
     def on_for(node)
       return if ignore?(node)
-      @files[node.template.name].all_forloops[node.value.variable_name] = node
+      @files[node.theme_file.name].all_forloops[node.value.variable_name] = node
     end
 
     def on_include(_node)
@@ -90,7 +90,7 @@ module ThemeCheck
       return unless node.value.template_name_expr.is_a?(String)
 
       snippet_name = "snippets/#{node.value.template_name_expr}"
-      @files[node.template.name].add_render(
+      @files[node.theme_file.name].add_render(
         name: snippet_name,
         node: node,
       )
@@ -98,7 +98,7 @@ module ThemeCheck
 
     def on_variable_lookup(node)
       return if ignore?(node)
-      @files[node.template.name].add_variable_lookup(
+      @files[node.theme_file.name].add_variable_lookup(
         name: node.value.name,
         node: node,
       )
@@ -130,7 +130,7 @@ module ThemeCheck
     private
 
     def ignore?(node)
-      @exclude_snippets && node.template.snippet?
+      @exclude_snippets && node.theme_file.snippet?
     end
 
     def each_template

data/lib/theme_check/checks/unused_assign.rb

@@ -25,21 +25,21 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @templates[node.template.name] = TemplateInfo.new(Set.new, {}, Set.new)
+      @templates[node.theme_file.name] = TemplateInfo.new(Set.new, {}, Set.new)
     end
 
     def on_assign(node)
-      @templates[node.template.name].assign_nodes[node.value.to] = node
+      @templates[node.theme_file.name].assign_nodes[node.value.to] = node
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @templates[node.template.name].includes << "snippets/#{node.value.template_name_expr}"
+        @templates[node.theme_file.name].includes << "snippets/#{node.value.template_name_expr}"
       end
     end
 
     def on_variable_lookup(node)
-      @templates[node.template.name].used_assigns << node.value.name
+      @templates[node.theme_file.name].used_assigns << node.value.name
     end
 
     def on_end

data/lib/theme_check/checks/unused_snippet.rb

@@ -8,28 +8,30 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def initialize
-      @used_templates = Set.new
+      @used_snippets = Set.new
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @used_templates << "snippets/#{node.value.template_name_expr}"
+        @used_snippets << "snippets/#{node.value.template_name_expr}"
       else
         # Can't reliably track unused snippets if an expression is used, ignore this check
-        @used_templates.clear
+        @used_snippets.clear
         ignore!
       end
     end
     alias_method :on_render, :on_include
 
     def on_end
-      missing_snippets.each do |template|
-        add_offense("This template is not used", template: template)
+      missing_snippets.each do |theme_file|
+        add_offense("This snippet is not used", theme_file: theme_file) do |corrector|
+          corrector.remove(@theme, theme_file.relative_path.to_s)
+        end
       end
     end
 
     def missing_snippets
-      theme.snippets.reject { |t| @used_templates.include?(t.name) }
+      theme.snippets.reject { |t| @used_snippets.include?(t.name) }
     end
   end
 end

data/lib/theme_check/checks/valid_json.rb

@@ -8,7 +8,7 @@ module ThemeCheck
     def on_file(file)
       if file.parse_error
         message = format_json_parse_error(file.parse_error)
-        add_offense(message, template: file)
+        add_offense(message, theme_file: file)
       end
     end
   end

data/lib/theme_check/checks.rb

@@ -47,9 +47,10 @@ module ThemeCheck
       raise
     rescue => e
       node = args.first
-      template = node.respond_to?(:template) ? node.template.relative_path : "?"
+      theme_file = node.respond_to?(:theme_file) ? node.theme_file.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}`:
@@ -58,12 +59,13 @@ module ThemeCheck
           #{e.backtrace.join("\n  ")}
         ```
 
-        Template: `#{template}`
+        Theme File: `#{theme_file}`
         Node: `#{node_class}`
         Markup:
         ```
         #{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
@@ -186,12 +186,15 @@ module ThemeCheck
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
-        raise Abort, "No templates found."
+        raise Abort, "No theme files found."
       end
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      output_with_format(theme, analyzer, out_stream)
+      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
@@ -211,7 +214,7 @@ module ThemeCheck
       STDERR.puts "Profiling is only available in development"
     end
 
-    def output_with_format(theme, analyzer, out_stream)
+    def print_with_format(theme, analyzer, out_stream)
       case @format
       when :text
         ThemeCheck::Printer.new(out_stream).print(theme, analyzer.offenses, @config.auto_correct)

data/lib/theme_check/corrector.rb

@@ -2,30 +2,25 @@
 
 module ThemeCheck
   class Corrector
-    def initialize(template:)
-      @template = template
+    def initialize(theme_file:)
+      @theme_file = theme_file
     end
 
     def insert_after(node, content)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[1] + 1, content)
+      @theme_file.rewriter.insert_after(node, content)
     end
 
     def insert_before(node, content)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[0], content)
+      @theme_file.rewriter.insert_before(node, content)
     end
 
     def replace(node, content)
-      line = @template.full_line(node.line_number)
-      line[node.range[0]..node.range[1]] = content
+      @theme_file.rewriter.replace(node, content)
       node.markup = content
     end
 
     def wrap(node, insert_before, insert_after)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[0], insert_before)
-      line.insert(node.range[1] + 1 + insert_before.length, insert_after)
+      @theme_file.rewriter.wrap(node, insert_before, insert_after)
     end
 
     def create(theme, relative_path, content)
@@ -34,7 +29,25 @@ module ThemeCheck
 
     def create_default_locale_json(theme)
       theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
-      theme.default_locale_json.update_contents('{}')
+      theme.default_locale_json.update_contents({})
+    end
+
+    def remove(theme, relative_path)
+      theme.storage.remove(relative_path)
+    end
+
+    def mkdir(theme, relative_path)
+      theme.storage.mkdir(relative_path)
+    end
+
+    def add_default_translation_key(file, key, value)
+      hash = file.content
+      key.reduce(hash) do |pointer, token|
+        return pointer[token] = value if token == key.last
+        pointer[token] = {} unless pointer.key?(token)
+        pointer[token]
+      end
+      file.update_contents(hash)
     end
   end
 end