erb_lint 0.0.35 → 0.1.1

data/lib/erb_lint/linters/right_trim.rb

@@ -8,7 +8,7 @@ module ERBLint
       include LinterRegistry
 
       class ConfigSchema < LinterConfig
-        property :enforced_style, accepts: ['-', '='], default: '-'
+        property :enforced_style, accepts: ["-", "="], default: "-"
       end
       self.config_schema = ConfigSchema
 

data/lib/erb_lint/linters/rubocop.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'tempfile'
-require 'erb_lint/utils/offset_corrector'
+require "better_html"
+require "tempfile"
+require "erb_lint/utils/offset_corrector"
 
 module ERBLint
   module Linters
@@ -25,7 +25,7 @@ module ERBLint
         super
         @only_cops = @config.only
         custom_config = config_from_hash(@config.rubocop_config)
-        @rubocop_config = ::RuboCop::ConfigLoader.merge_with_default(custom_config, '')
+        @rubocop_config = ::RuboCop::ConfigLoader.merge_with_default(custom_config, "")
       end
 
       def run(processed_source)
@@ -68,13 +68,13 @@ module ERBLint
 
       def inspect_content(processed_source, erb_node)
         indicator, _, code_node, = *erb_node
-        return if indicator&.children&.first == '#'
+        return if indicator&.children&.first == "#"
 
         original_source = code_node.loc.source
-        trimmed_source = original_source.sub(BLOCK_EXPR, '').sub(SUFFIX_EXPR, '')
+        trimmed_source = original_source.sub(BLOCK_EXPR, "").sub(SUFFIX_EXPR, "")
         alignment_column = code_node.loc.column
         offset = code_node.loc.begin_pos - alignment_column
-        aligned_source = "#{' ' * alignment_column}#{trimmed_source}"
+        aligned_source = "#{" " * alignment_column}#{trimmed_source}"
 
         source = rubocop_processed_source(aligned_source, processed_source.filename)
         return unless source.valid_syntax?
@@ -156,10 +156,10 @@ module ERBLint
       end
 
       def config_from_hash(hash)
-        inherit_from = hash&.delete('inherit_from')
+        inherit_from = hash&.delete("inherit_from")
         resolve_inheritance(hash, inherit_from)
 
-        tempfile_from('.erblint-rubocop', hash.to_yaml) do |tempfile|
+        tempfile_from(".erblint-rubocop", hash.to_yaml) do |tempfile|
           ::RuboCop::ConfigLoader.load_file(tempfile.path)
         end
       end
@@ -174,7 +174,7 @@ module ERBLint
       end
 
       def base_configs(inherit_from)
-        regex = URI::DEFAULT_PARSER.make_regexp(%w(http https))
+        regex = URI::DEFAULT_PARSER.make_regexp(["http", "https"])
         configs = Array(inherit_from).compact.map do |base_name|
           if base_name =~ /\A#{regex}\z/
             ::RuboCop::ConfigLoader.load_file(::RuboCop::RemoteConfig.new(base_name, Dir.pwd))
@@ -191,7 +191,7 @@ module ERBLint
           { rubocop_correction: correction, offset: offset, bound_range: bound_range }
         end
 
-        super(offense_range, rubocop_offense.message.strip, context)
+        super(offense_range, rubocop_offense.message.strip, context, rubocop_offense.severity.name)
       end
     end
   end

data/lib/erb_lint/linters/rubocop_text.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'rubocop'
+require_relative "rubocop"
 
 module ERBLint
   module Linters

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -11,10 +11,8 @@ module ERBLint
       end
       self.config_schema = ConfigSchema
 
-      SELF_CLOSING_TAGS = %w(
-        area base br col command embed hr input keygen
-        link menuitem meta param source track wbr img
-      )
+      SELF_CLOSING_TAGS = ["area", "base", "br", "col", "command", "embed", "hr", "input", "keygen", "link",
+                           "menuitem", "meta", "param", "source", "track", "wbr", "img",]
 
       def run(processed_source)
         processed_source.ast.descendants(:tag).each do |tag_node|
@@ -26,7 +24,7 @@ module ERBLint
             add_offense(
               start_solidus.loc,
               "Tag `#{tag.name}` is a void element, it must not start with `</`.",
-              ''
+              ""
             )
           end
 
@@ -34,7 +32,7 @@ module ERBLint
             add_offense(
               tag_node.loc.end.offset(-1),
               "Tag `#{tag.name}` is self-closing, it must end with `/>`.",
-              '/'
+              "/"
             )
           end
 
@@ -43,7 +41,7 @@ module ERBLint
           add_offense(
             end_solidus.loc,
             "Tag `#{tag.name}` is a void element, it must end with `>` and not `/>`.",
-            ''
+            ""
           )
         end
       end

data/lib/erb_lint/linters/space_around_erb_tag.rb

@@ -15,7 +15,7 @@ module ERBLint
         processed_source.ast.descendants(:erb).each do |erb_node|
           indicator_node, ltrim, code_node, rtrim = *erb_node
           indicator = indicator_node&.loc&.source
-          next if indicator == '#' || indicator == '%'
+          next if indicator == "#" || indicator == "%"
           code = code_node.children.first
 
           start_spaces = code.match(START_SPACES)&.captures&.first || ""
@@ -23,8 +23,8 @@ module ERBLint
             add_offense(
               code_node.loc.resize(start_spaces.size),
               "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` "\
-              "instead of #{start_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+              "instead of #{start_spaces.size} space#{"s" if start_spaces.size > 1}.",
+              " "
             )
           elsif start_spaces.count("\n") > 1
             lines = start_spaces.split("\n", -1)
@@ -41,8 +41,8 @@ module ERBLint
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Use 1 space before `#{rtrim&.loc&.source}%>` "\
-              "instead of #{end_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+              "instead of #{end_spaces.size} space#{"s" if start_spaces.size > 1}.",
+              " "
             )
           elsif end_spaces.count("\n") > 1
             lines = end_spaces.split("\n", -1)

data/lib/erb_lint/linters/space_in_html_tag.rb

@@ -50,7 +50,7 @@ module ERBLint
         add_offense(
           processed_source.to_source_range(range),
           "Extra space detected where there should be no space.",
-          ''
+          ""
         )
       end
 
@@ -60,24 +60,24 @@ module ERBLint
 
       def single_space(processed_source, range, accept_newline: false)
         chars = processed_source.file_content[range]
-        return if chars == ' '
+        return if chars == " "
 
         newlines = chars.include?("\n")
-        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : ' '
+        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : " "
         non_space = chars.match(/([^[[:space:]]])/m)
 
         if non_space && !non_space.captures.empty?
           add_offense(
             processed_source.to_source_range(range),
             "Non-whitespace character(s) detected: "\
-              "#{non_space.captures.map(&:inspect).join(', ')}.",
+              "#{non_space.captures.map(&:inspect).join(", ")}.",
             expected
           )
         elsif newlines && accept_newline
           if expected != chars
             add_offense(
               processed_source.to_source_range(range),
-              "#{chars.empty? ? 'No' : 'Extra'} space detected where there should be "\
+              "#{chars.empty? ? "No" : "Extra"} space detected where there should be "\
                 "a single space or a single line break.",
               expected
             )
@@ -85,7 +85,7 @@ module ERBLint
         else
           add_offense(
             processed_source.to_source_range(range),
-            "#{chars.empty? ? 'No' : 'Extra'} space detected where there should be a single space.",
+            "#{chars.empty? ? "No" : "Extra"} space detected where there should be a single space.",
             expected
           )
         end

data/lib/erb_lint/linters/space_indentation.rb

@@ -23,7 +23,7 @@ module ERBLint
             add_offense(
               processed_source.to_source_range(document_pos...(document_pos + spaces.length)),
               "Indent with spaces instead of tabs.",
-              spaces.gsub("\t", ' ' * @config.tab_width)
+              spaces.gsub("\t", " " * @config.tab_width)
             )
           end
 

data/lib/erb_lint/linters/trailing_whitespace.rb

@@ -25,7 +25,7 @@ module ERBLint
 
       def autocorrect(_processed_source, offense)
         lambda do |corrector|
-          corrector.replace(offense.source_range, '')
+          corrector.replace(offense.source_range, "")
         end
       end
     end

data/lib/erb_lint/offense.rb

@@ -3,9 +3,9 @@
 module ERBLint
   # Defines common functionality available to all linters.
   class Offense
-    attr_reader :linter, :source_range, :message, :context
+    attr_reader :linter, :source_range, :message, :context, :severity
 
-    def initialize(linter, source_range, message, context = nil)
+    def initialize(linter, source_range, message, context = nil, severity = nil)
       unless source_range.is_a?(Parser::Source::Range)
         raise ArgumentError, "expected Parser::Source::Range for arg 2"
       end
@@ -13,23 +13,34 @@ module ERBLint
       @source_range = source_range
       @message = message
       @context = context
+      @severity = severity
     end
 
     def inspect
       "#<#{self.class.name} linter=#{linter.class.name} "\
         "source_range=#{source_range.begin_pos}...#{source_range.end_pos} "\
-        "message=#{message}>"
+        "message=#{message}> "\
+        "severity=#{severity}"
     end
 
     def ==(other)
       other.class <= ERBLint::Offense &&
         other.linter == linter &&
         other.source_range == source_range &&
-        other.message == message
+        other.message == message &&
+        other.severity == severity
     end
 
     def line_range
       Range.new(source_range.line, source_range.last_line)
     end
+
+    def line_number
+      line_range.begin
+    end
+
+    def column
+      source_range.column
+    end
   end
 end

data/lib/erb_lint/reporter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require "active_support/core_ext/class"
+require "active_support/core_ext/module/delegation"
+
+module ERBLint
+  class Reporter
+    def self.create_reporter(format, *args)
+      reporter_klass = "#{ERBLint::Reporters}::#{format.to_s.camelize}Reporter".constantize
+      reporter_klass.new(*args)
+    end
+
+    def self.available_format?(format)
+      available_formats.include?(format.to_s)
+    end
+
+    def self.available_formats
+      descendants
+        .map(&:to_s)
+        .map(&:demodulize)
+        .map(&:underscore)
+        .map { |klass_name| klass_name.sub("_reporter", "") }
+        .sort
+    end
+
+    def initialize(stats, autocorrect)
+      @stats = stats
+      @autocorrect = autocorrect
+    end
+
+    def preview; end
+
+    def show; end
+
+    private
+
+    attr_reader :stats, :autocorrect
+    delegate :processed_files, to: :stats
+  end
+end

data/lib/erb_lint/reporters/compact_reporter.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Reporters
+    class CompactReporter < Reporter
+      def preview
+        puts "Linting #{stats.files} files with "\
+          "#{stats.linters} #{"autocorrectable " if autocorrect}linters..."
+      end
+
+      def show
+        processed_files.each do |filename, offenses|
+          offenses.each do |offense|
+            puts format_offense(filename, offense)
+          end
+        end
+
+        footer
+        summary
+      end
+
+      private
+
+      def format_offense(filename, offense)
+        [
+          "#{filename}:",
+          "#{offense.line_number}:",
+          "#{offense.column}: ",
+          offense.message.to_s,
+        ].join
+      end
+
+      def footer; end
+
+      def summary
+        if stats.corrected > 0
+          report_corrected_offenses
+        elsif stats.ignored > 0 || stats.found > 0
+          if stats.ignored > 0
+            warn(Rainbow("#{stats.ignored} error(s) were ignored in ERB files").yellow)
+          end
+
+          if stats.found > 0
+            warn(Rainbow("#{stats.found} error(s) were found in ERB files").red)
+          end
+        else
+          puts Rainbow("No errors were found in ERB files").green
+        end
+      end
+
+      def report_corrected_offenses
+        corrected_found_diff = stats.found - stats.corrected
+
+        if corrected_found_diff > 0
+          message = Rainbow(
+            "#{stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files"
+          ).red
+
+          warn(message)
+        else
+          puts Rainbow("#{stats.corrected} error(s) corrected in ERB files").green
+        end
+      end
+    end
+  end
+end

data/lib/erb_lint/reporters/json_reporter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ERBLint
+  module Reporters
+    class JsonReporter < Reporter
+      def preview; end
+
+      def show
+        puts formatted_data
+      end
+
+      private
+
+      def formatted_data
+        {
+          metadata: metadata,
+          files: formatted_files,
+          summary: summary,
+        }.to_json
+      end
+
+      def metadata
+        {
+          erb_lint_version: ERBLint::VERSION,
+          ruby_engine: RUBY_ENGINE,
+          ruby_version: RUBY_VERSION,
+          ruby_patchlevel: RUBY_PATCHLEVEL.to_s,
+          ruby_platform: RUBY_PLATFORM,
+        }
+      end
+
+      def summary
+        {
+          offenses: stats.found,
+          inspected_files: stats.processed_files.size,
+          corrected: stats.corrected,
+        }
+      end
+
+      def formatted_files
+        processed_files.map do |filename, offenses|
+          {
+            path: filename,
+            offenses: formatted_offenses(offenses),
+          }
+        end
+      end
+
+      def formatted_offenses(offenses)
+        offenses.map do |offense|
+          format_offense(offense)
+        end
+      end
+
+      def format_offense(offense)
+        {
+          linter: offense.linter.class.simple_name,
+          message: offense.message.to_s,
+          location: {
+            start_line: offense.line_number,
+            start_column: offense.column,
+            last_line: offense.source_range.last_line,
+            last_column: offense.source_range.last_column,
+            length: offense.source_range.length,
+          },
+        }
+      end
+    end
+  end
+end