erb_lint 0.0.34 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65e35ea36e2654316241c7267aca2f9b581fa7eb5c858008a80dfc098c07a187
-  data.tar.gz: db35c2f60f85651728bec14a853fc8d7060e93e686c9cababa55bccb3dd46c49
+  metadata.gz: 20ce12719e17ebfc24ca522965e85985fe665c0cbec1d9751320b1a779ec8c9c
+  data.tar.gz: 536222d32134c71f72083c5083f575e8422024f8f5e26e0daf9b9eadd181d3e9
 SHA512:
-  metadata.gz: dbe12716e085e0baa6beef5c1395bf86874f442db6087c2d1312315cb4d60704cca5a007a3843738197d58fa0025d35b993bbbed5606ca9a3c71b81928d365e2
-  data.tar.gz: 7bb3506036e3a098cb9c688c20373a80bc413a6528fcb05b951e16996dd62eea358c01658f5b2aceb4d4b1b4bc63afa7ad53d852478b2b49d549a13f3da6ed1c
+  metadata.gz: 44f138dfdfff77b04d03f293f3b48f90744bbf3fcbcfeadc1cf3b5f0d47cae5c933b18b0e7273d64cdf549170e2a2aa33c5110cbc0aa62c84855e6e29a5f67ae
+  data.tar.gz: 1fe70e0ddb97e0930b2645b0942d5ed08e74c5b40a41af1b6b9c7b9219b4be136495a5f3a0991363e8877aaef7bab5da2eb1f4162dc85f64b2f17d6ae2ca1184

data/lib/erb_lint.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rubocop'
+
 require 'erb_lint/corrector'
 require 'erb_lint/file_loader'
 require 'erb_lint/linter_config'
@@ -10,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/corrector.rb

@@ -17,11 +17,22 @@ module ERBLint
     end
 
     def corrector
-      RuboCop::Cop::Corrector.new(@processed_source.source_buffer, corrections)
+      BASE.new(@processed_source.source_buffer, corrections)
     end
 
-    def diagnostics
-      corrector.diagnostics
+    if ::RuboCop::Version::STRING.to_f >= 0.87
+      require 'rubocop/cop/legacy/corrector'
+      BASE = ::RuboCop::Cop::Legacy::Corrector
+
+      def diagnostics
+        []
+      end
+    else
+      BASE = ::RuboCop::Cop::Corrector
+
+      def diagnostics
+        corrector.diagnostics
+      end
     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/linters/hard_coded_string.rb

@@ -63,7 +63,7 @@ module ERBLint
         string = offense.source_range.source
         return unless (klass = load_corrector)
         return unless string.strip.length > 1
-        node = RuboCop::AST::StrNode.new(:str, [string])
+        node = ::RuboCop::AST::StrNode.new(:str, [string])
         corrector = klass.new(node, processed_source.filename, corrector_i18n_load_path, offense.source_range)
         corrector.autocorrect(tag_start: '<%= ', tag_end: ' %>')
       rescue MissingCorrector, MissingI18nLoadPath

data/lib/erb_lint/linters/rubocop.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'better_html'
-require 'rubocop'
 require 'tempfile'
 require 'erb_lint/utils/offset_corrector'
 
@@ -26,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)
@@ -35,17 +34,29 @@ module ERBLint
         end
       end
 
-      def autocorrect(processed_source, offense)
-        return unless offense.context
-
-        lambda do |corrector|
-          passthrough = Utils::OffsetCorrector.new(
-            processed_source,
-            corrector,
-            offense.context[:offset],
-            offense.context[:bound_range],
-          )
-          offense.context[:rubocop_correction].call(passthrough)
+      if ::RuboCop::Version::STRING.to_f >= 0.87
+        def autocorrect(_processed_source, offense)
+          return unless offense.context
+          rubocop_correction = offense.context[:rubocop_correction]
+          return unless rubocop_correction
+
+          lambda do |corrector|
+            corrector.import!(rubocop_correction, offset: offense.context[:offset])
+          end
+        end
+      else
+        def autocorrect(processed_source, offense)
+          return unless offense.context
+
+          lambda do |corrector|
+            passthrough = Utils::OffsetCorrector.new(
+              processed_source,
+              corrector,
+              offense.context[:offset],
+              offense.context[:bound_range],
+            )
+            offense.context[:rubocop_correction].call(passthrough)
+          end
         end
       end
 
@@ -62,22 +73,23 @@ module ERBLint
         original_source = code_node.loc.source
         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}"
 
         source = rubocop_processed_source(aligned_source, processed_source.filename)
         return unless source.valid_syntax?
 
-        team = build_team
-        team.inspect_file(source)
-        team.cops.each do |cop|
-          correction_offset = 0
-          cop.offenses.reject(&:disabled?).each do |rubocop_offense|
-            if rubocop_offense.corrected?
-              correction = cop.corrections[correction_offset]
-              correction_offset += 1
-            end
+        activate_team(processed_source, source, offset, code_node, build_team)
+      end
+
+      if ::RuboCop::Version::STRING.to_f >= 0.87
+        def activate_team(processed_source, source, offset, code_node, team)
+          report = team.investigate(source)
+          report.offenses.each do |rubocop_offense|
+            next if rubocop_offense.disabled?
+
+            correction = rubocop_offense.corrector if rubocop_offense.corrected?
 
-            offset = code_node.loc.begin_pos - alignment_column
             offense_range = processed_source
               .to_source_range(rubocop_offense.location)
               .offset(offset)
@@ -85,6 +97,25 @@ module ERBLint
             add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
           end
         end
+      else
+        def activate_team(processed_source, source, offset, code_node, team)
+          team.inspect_file(source)
+          team.cops.each do |cop|
+            correction_offset = 0
+            cop.offenses.reject(&:disabled?).each do |rubocop_offense|
+              if rubocop_offense.corrected?
+                correction = cop.corrections[correction_offset]
+                correction_offset += 1
+              end
+
+              offense_range = processed_source
+                .to_source_range(rubocop_offense.location)
+                .offset(offset)
+
+              add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
+            end
+          end
+        end
       end
 
       def tempfile_from(filename, content)
@@ -97,7 +128,7 @@ module ERBLint
       end
 
       def rubocop_processed_source(content, filename)
-        RuboCop::ProcessedSource.new(
+        ::RuboCop::ProcessedSource.new(
           content,
           @rubocop_config.target_ruby_version,
           filename
@@ -106,15 +137,15 @@ module ERBLint
 
       def cop_classes
         if @only_cops.present?
-          selected_cops = RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
-          RuboCop::Cop::Registry.new(selected_cops)
+          selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+          ::RuboCop::Cop::Registry.new(selected_cops)
         else
-          RuboCop::Cop::Registry.new(RuboCop::Cop::Cop.all)
+          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all)
         end
       end
 
       def build_team
-        RuboCop::Cop::Team.new(
+        ::RuboCop::Cop::Team.new(
           cop_classes,
           @rubocop_config,
           extra_details: true,
@@ -129,7 +160,7 @@ module ERBLint
         resolve_inheritance(hash, inherit_from)
 
         tempfile_from('.erblint-rubocop', hash.to_yaml) do |tempfile|
-          RuboCop::ConfigLoader.load_file(tempfile.path)
+          ::RuboCop::ConfigLoader.load_file(tempfile.path)
         end
       end
 
@@ -137,7 +168,7 @@ module ERBLint
         base_configs(inherit_from)
           .reverse_each do |base_config|
           base_config.each do |k, v|
-            hash[k] = hash.key?(k) ? RuboCop::ConfigLoader.merge(v, hash[k]) : v if v.is_a?(Hash)
+            hash[k] = hash.key?(k) ? ::RuboCop::ConfigLoader.merge(v, hash[k]) : v if v.is_a?(Hash)
           end
         end
       end
@@ -146,7 +177,7 @@ module ERBLint
         regex = URI::DEFAULT_PARSER.make_regexp(%w(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))
+            ::RuboCop::ConfigLoader.load_file(::RuboCop::RemoteConfig.new(base_name, Dir.pwd))
           else
             config_from_hash(@file_loader.yaml(base_name))
           end

data/lib/erb_lint/linters/rubocop_text.rb

@@ -28,9 +28,9 @@ module ERBLint
       end
 
       def cop_classes
-        selected_cops = RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+        selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
 
-        RuboCop::Cop::Registry.new(selected_cops)
+        ::RuboCop::Cop::Registry.new(selected_cops)
       end
     end
   end

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,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,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.34'
+  VERSION = '0.0.37'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.37
 platform: ruby
 authors:
 - Justin Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html
@@ -42,16 +42,30 @@ 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'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: 2.7.1.4
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ERB Linter tool.
 email:
 - justin.the.c@gmail.com
@@ -157,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
@@ -177,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="