erb_lint 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bec7519ea346d89eb70e485c59015ea8faae7f4c85f4e3b450a4f8853eaa9b5
-  data.tar.gz: dba705708221bc3b5a71c57d6d9cbf1db2f7c8afbfaa7ed45fc63e71433383b5
+  metadata.gz: 63f417288a7c49d68dcd0a04bbf07d4c8fc31c424cec244ddebab39ed3e5fab4
+  data.tar.gz: 22649a4264e1c570fe4a39e4112ea402d5ae04da3aaf7c35d3ce685c6fff7e21
 SHA512:
-  metadata.gz: 770cd1f544b749a7210949b1221ec4401349cb30bf9a171c1b7677c3d051f9887e264d62e1c8b86c5b09c593bc96b24b867a35b2bf11f4dfe2d8a17f54332d5c
-  data.tar.gz: ae1f2c592fba2fce5a70eb0620024c49cdca3173388791036bb9e2ed56b3b0cbdf3e6361c0b68c94fc222640aba5422c6fd5c15d8691fa019d0a9cfc038e96a3
+  metadata.gz: c0c1a2bdef25b71c750708c661aea9504551f3bcc53e7ed2017056f15d2789be58e4f758fe3735885ff4da6d43c0501f99542ce764737a8c072c24f228239155
+  data.tar.gz: 0653d4ec366580de6a08aff33263e9415f96ecb4bc9e579db20979f8ffb0d238cc6db9e361877ca529eef2fdf45c98233ec1ddf39cb4c01d6560a2e30fa6b489

data/lib/erb_lint.rb

@@ -12,8 +12,15 @@ require 'erb_lint/processed_source'
 require 'erb_lint/runner_config'
 require 'erb_lint/runner'
 require 'erb_lint/version'
+require 'erb_lint/stats'
+require 'erb_lint/reporter'
 
 # Load linters
 Dir[File.expand_path('erb_lint/linters/**/*.rb', File.dirname(__FILE__))].each do |file|
   require file
 end
+
+# Load reporters
+Dir[File.expand_path('erb_lint/reporters/**/*.rb', File.dirname(__FILE__))].each do |file|
+  require file
+end

data/lib/erb_lint/cli.rb

@@ -14,16 +14,8 @@ module ERBLint
     DEFAULT_LINT_ALL_GLOB = "**/*.html{+*,}.erb"
 
     class ExitWithFailure < RuntimeError; end
-    class ExitWithSuccess < RuntimeError; end
 
-    class Stats
-      attr_accessor :found, :corrected, :exceptions
-      def initialize
-        @found = 0
-        @corrected = 0
-        @exceptions = 0
-      end
-    end
+    class ExitWithSuccess < RuntimeError; end
 
     def initialize
       @options = {}
@@ -51,9 +43,12 @@ module ERBLint
         failure!('no linter available with current configuration')
       end
 
-      puts "Linting #{lint_files.size} files with "\
-        "#{enabled_linter_classes.size} #{'autocorrectable ' if autocorrect?}linters..."
-      puts
+      @options[:format] ||= :multiline
+      @stats.files = lint_files.size
+      @stats.linters = enabled_linter_classes.size
+
+      reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?)
+      reporter.preview
 
       runner = ERBLint::Runner.new(file_loader, @config)
 
@@ -72,20 +67,7 @@ module ERBLint
         end
       end
 
-      if @stats.corrected > 0
-        corrected_found_diff = @stats.found - @stats.corrected
-        if corrected_found_diff > 0
-          warn(Rainbow(
-            "#{@stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files"
-          ).red)
-        else
-          puts Rainbow("#{@stats.corrected} error(s) corrected in ERB files").green
-        end
-      elsif @stats.found > 0
-        warn(Rainbow("#{@stats.found} error(s) were found in ERB files").red)
-      else
-        puts Rainbow("No errors were found in ERB files").green
-      end
+      reporter.show
 
       @stats.found == 0 && @stats.exceptions == 0
     rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, ExitWithFailure => e
@@ -126,15 +108,12 @@ module ERBLint
         file_content = corrector.corrected_content
         runner.clear_offenses
       end
+      offenses_filename = relative_filename(filename)
+      offenses = runner.offenses || []
 
-      @stats.found += runner.offenses.size
-      runner.offenses.each do |offense|
-        puts <<~EOF
-          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect?}
-          In file: #{relative_filename(filename)}:#{offense.line_range.begin}
-
-        EOF
-      end
+      @stats.found += offenses.size
+      @stats.processed_files[offenses_filename] ||= []
+      @stats.processed_files[offenses_filename] |= offenses
     end
 
     def correct(processed_source, offenses)
@@ -258,6 +237,15 @@ module ERBLint
           end
         end
 
+        opts.on("--format FORMAT", format_options_help) do |format|
+          unless Reporter.available_format?(format)
+            error_message = invalid_format_error_message(format)
+            failure!(error_message)
+          end
+
+          @options[:format] = format
+        end
+
         opts.on("--lint-all", "Lint all files matching configured glob [default: #{DEFAULT_LINT_ALL_GLOB}]") do |config|
           @options[:lint_all] = config
         end
@@ -289,5 +277,15 @@ module ERBLint
         end
       end
     end
+
+    def format_options_help
+      "Report offenses in the given format: "\
+      "(#{Reporter.available_formats.join(', ')}) (default: multiline)"
+    end
+
+    def invalid_format_error_message(given_format)
+      formats = Reporter.available_formats.map { |format| "  - #{format}\n" }
+      "#{given_format}: is not a valid format. Available formats:\n#{formats.join}"
+    end
   end
 end

data/lib/erb_lint/linter.rb

@@ -14,6 +14,7 @@ module ERBLint
       # `ERBLint::Linters::Foo.simple_name`          #=> "Foo"
       # `ERBLint::Linters::Compass::Bar.simple_name` #=> "Compass::Bar"
       def inherited(linter)
+        super
         linter.simple_name = if linter.name.start_with?('ERBLint::Linters::')
           name_parts = linter.name.split('::')
           name_parts[2..-1].join('::')

data/lib/erb_lint/linter_registry.rb

@@ -4,19 +4,28 @@ module ERBLint
   # Stores all linters available to the application.
   module LinterRegistry
     CUSTOM_LINTERS_DIR = '.erb-linters'
-    @linters = []
+    @loaded_linters = []
 
     class << self
-      attr_reader :linters
+      def clear
+        @linters = nil
+      end
 
       def included(linter_class)
-        @linters << linter_class
+        @loaded_linters << linter_class
       end
 
       def find_by_name(name)
         linters.detect { |linter| linter.simple_name == name }
       end
 
+      def linters
+        @linters ||= begin
+          load_custom_linters
+          @loaded_linters
+        end
+      end
+
       def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
         ruby_files = Dir.glob(File.expand_path(File.join(directory, '**', '*.rb')))
         ruby_files.each { |file| require file }

data/lib/erb_lint/offense.rb

@@ -31,5 +31,13 @@ module ERBLint
     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,38 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/class'
+
+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,60 @@
+# 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.found > 0
+          warn(Rainbow("#{stats.found} error(s) were found in ERB files").red)
+        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/multiline_reporter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative "compact_reporter"
+
+module ERBLint
+  module Reporters
+    class MultilineReporter < CompactReporter
+      private
+
+      def format_offense(filename, offense)
+        <<~EOF
+
+          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect}
+          In file: #{filename}:#{offense.line_number}
+        EOF
+      end
+
+      def footer
+        puts
+      end
+    end
+  end
+end

data/lib/erb_lint/runner.rb

@@ -10,7 +10,6 @@ module ERBLint
       @config = config || RunnerConfig.default
       raise ArgumentError, 'expect `config` to be a RunnerConfig instance' unless @config.is_a?(RunnerConfig)
 
-      LinterRegistry.load_custom_linters
       linter_classes = LinterRegistry.linters.select { |klass| @config.for_linter(klass).enabled? }
       @linters = linter_classes.map do |linter_class|
         linter_class.new(@file_loader, @config.for_linter(linter_class))

data/lib/erb_lint/stats.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module ERBLint
+  class Stats
+    attr_accessor :found,
+                  :corrected,
+                  :exceptions,
+                  :linters,
+                  :files,
+                  :processed_files
+
+    def initialize(
+      found: 0,
+      corrected: 0,
+      exceptions: 0,
+      linters: 0,
+      files: 0,
+      processed_files: {}
+    )
+      @found = found
+      @corrected = corrected
+      @exceptions = exceptions
+      @linters = linters
+      @files = files
+      @processed_files = processed_files
+    end
+  end
+end

data/lib/erb_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ERBLint
-  VERSION = '0.0.35'
+  VERSION = '0.0.36'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - Justin Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html
@@ -42,16 +42,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +185,13 @@ files:
 - lib/erb_lint/linters/trailing_whitespace.rb
 - lib/erb_lint/offense.rb
 - lib/erb_lint/processed_source.rb
+- lib/erb_lint/reporter.rb
+- lib/erb_lint/reporters/compact_reporter.rb
+- lib/erb_lint/reporters/multiline_reporter.rb
 - lib/erb_lint/runner.rb
 - lib/erb_lint/runner_config.rb
 - lib/erb_lint/runner_config_resolver.rb
+- lib/erb_lint/stats.rb
 - lib/erb_lint/utils/block_map.rb
 - lib/erb_lint/utils/offset_corrector.rb
 - lib/erb_lint/utils/ruby_to_erb.rb