rubocop 0.35.1 → 0.36.0

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/colorizable.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter
@@ -9,7 +10,11 @@ module RuboCop
       def rainbow
         @rainbow ||= begin
           rainbow = Rainbow.new
-          rainbow.enabled = false unless output.tty?
+          if options[:color]
+            rainbow.enabled = true
+          elsif options[:color] == false || !output.tty?
+            rainbow.enabled = false
+          end
           rainbow
         end
       end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter
@@ -16,19 +17,20 @@ module RuboCop
         .join("\n")
 
       @config_to_allow_offenses = {}
+      @detected_styles = {}
 
       COPS = Cop::Cop.all.group_by(&:cop_name)
 
       class << self
-        attr_accessor :config_to_allow_offenses
+        attr_accessor :config_to_allow_offenses, :detected_styles
       end
 
-      def file_started(_file, file_info)
-        @exclude_limit_option =
-          file_info.fetch(:cli_options, {})[:exclude_limit]
+      def file_started(_file, _file_info)
+        @exclude_limit_option = @options[:exclude_limit]
         @exclude_limit = (
           @exclude_limit_option ||
           RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS).to_i
+        @show_offense_counts = !@options[:no_offense_counts]
       end
 
       def file_finished(file, offenses)
@@ -53,18 +55,18 @@ module RuboCop
 
         @cops_with_offenses.sort.each do |cop_name, offense_count|
           output.puts
-          cfg = self.class.config_to_allow_offenses[cop_name]
-          cfg ||= {}
+          cfg = self.class.config_to_allow_offenses[cop_name] || {}
+
           output_cop_comments(output, cfg, cop_name, offense_count)
           output_cop_config(output, cfg, cop_name)
         end
         puts "Created #{output.path}."
-        puts "Run `rubocop --config #{output.path}`, or"
-        puts "add inherit_from: #{output.path} in a .rubocop.yml file."
+        puts "Run `rubocop --config #{output.path}`, or add `inherit_from: " \
+             "#{output.path}` in a .rubocop.yml file."
       end
 
       def output_cop_comments(output, cfg, cop_name, offense_count)
-        output.puts "# Offense count: #{offense_count}"
+        output.puts "# Offense count: #{offense_count}" if @show_offense_counts
         if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
           output.puts '# Cop supports --auto-correct.'
         end
@@ -73,11 +75,19 @@ module RuboCop
         return unless default_cfg
 
         params = default_cfg.keys -
-                 %w(Description StyleGuide Reference Enabled) -
+                 %w(Description StyleGuide Reference Enabled Exclude) -
                  cfg.keys
         return if params.empty?
 
         output.puts "# Configuration parameters: #{params.join(', ')}."
+
+        params.each do |param|
+          value = default_cfg[param]
+          if value.is_a?(Array)
+            next if value.empty?
+            output.puts "# #{param}: #{value.join(', ')}"
+          end
+        end
       end
 
       def output_cop_config(output, cfg, cop_name)
@@ -104,13 +114,17 @@ module RuboCop
         require 'pathname'
         parent = Pathname.new(Dir.pwd)
 
-        # Exclude properties in .rubocop_todo.yml override default ones, so in
-        # order to retain the default excludes we must copy them.
-        default_cfg = RuboCop::ConfigLoader.default_configuration[cop_name]
-        default_excludes = default_cfg ? default_cfg['Exclude'] || [] : []
+        # Exclude properties in .rubocop_todo.yml override default ones, as well
+        # as any custom excludes in .rubocop.yml, so in order to retain those
+        # excludes we must copy them.
+        # There can be multiple .rubocop.yml files in subdirectories, but we
+        # just look at the current working directory
+        config = ConfigStore.new.for(parent)
+        cfg = config[cop_name] || {}
+        excludes = ((cfg['Exclude'] || []) + offending_files).uniq
 
         output.puts '  Exclude:'
-        (default_excludes + offending_files).each do |file|
+        excludes.each do |file|
           file_path = Pathname.new(file)
           begin
             relative = file_path.relative_path_from(parent)

data/lib/rubocop/formatter/disabled_lines_formatter.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 module RuboCop
   module Formatter
     # A basic formatter that displays the lines disabled
@@ -33,7 +35,7 @@ module RuboCop
           disabled_cops.each do |cop, line_ranges|
             line_ranges.each do |line_range|
               file = cyan(smart_path(file))
-              summary << "#{file}:#{line_range}: #{cop}\n"
+              summary += "#{file}:#{line_range}: #{cop}\n"
             end
           end
         end

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter
@@ -8,12 +9,15 @@ module RuboCop
     class EmacsStyleFormatter < BaseFormatter
       def file_finished(file, offenses)
         offenses.each do |o|
-          message = o.corrected? ? '[Corrected] ' : ''
-          message << o.message
+          message = if o.corrected?
+                      "[Corrected] #{o.message}"
+                    else
+                      o.message
+                    end
 
           output.printf("%s:%d:%d: %s: %s\n",
                         file, o.line, o.real_column, o.severity.code,
-                        message)
+                        message.tr("\n", ' '))
         end
       end
     end

data/lib/rubocop/formatter/file_list_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/formatter_set.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'fileutils'
 
@@ -18,10 +19,11 @@ module RuboCop
         'html'     => HTMLFormatter,
         'files'    => FileListFormatter,
         'offenses' => OffenseCountFormatter,
-        'disabled' => DisabledLinesFormatter
-      }
+        'disabled' => DisabledLinesFormatter,
+        'worst'    => WorstOffendersFormatter
+      }.freeze
 
-      FORMATTER_APIS = [:started, :finished]
+      FORMATTER_APIS = [:started, :finished].freeze
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|
@@ -29,28 +31,17 @@ module RuboCop
         end
       end
 
+      def initialize(options = {})
+        @options = options # CLI options
+      end
+
       def file_started(file, options)
-        @cop_disabled_line_ranges = options[:cop_disabled_line_ranges]
-        @comments = options[:comments]
         @options = options[:cli_options]
         @config_store = options[:config_store]
         each { |f| f.file_started(file, options) }
       end
 
       def file_finished(file, offenses)
-        if @cop_disabled_line_ranges.any? &&
-           # Don't check unneeded disable if --only or --except option is
-           # given, because these options override configuration.
-           (@options[:except] || []).empty? && (@options[:only] || []).empty?
-          config = @config_store.for(file)
-          if config['Lint/UnneededDisable']['Enabled']
-            cop = Cop::Lint::UnneededDisable.new(config, @options)
-            cop.check(offenses, @cop_disabled_line_ranges, @comments)
-            offenses += cop.offenses
-          end
-        end
-
-        offenses = offenses.sort.reject(&:disabled?)
         each { |f| f.file_finished(file, offenses) }
         offenses
       end
@@ -73,7 +64,7 @@ module RuboCop
           output = $stdout
         end
 
-        self << formatter_class.new(output)
+        self << formatter_class.new(output, @options)
       end
 
       def close_output_files

data/lib/rubocop/formatter/fuubar_style_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'ruby-progressbar'
 
@@ -9,7 +10,7 @@ module RuboCop
     # This is inspired by the Fuubar formatter for RSpec by Jeff Kreeftmeijer.
     # https://github.com/jeffkreeftmeijer/fuubar
     class FuubarStyleFormatter < ClangStyleFormatter
-      RESET_SEQUENCE = "\e[0m"
+      RESET_SEQUENCE = "\e[0m".freeze
 
       def started(target_files)
         super

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'cgi'
 require 'erb'
@@ -13,9 +14,21 @@ module RuboCop
       TEMPLATE_PATH =
         File.expand_path('../../../../assets/output.html.erb', __FILE__)
 
+      Color = Struct.new(:red, :green, :blue, :alpha) do
+        def to_s
+          "rgba(#{values.join(', ')})"
+        end
+
+        def fade_out(amount)
+          dup.tap do |color|
+            color.alpha -= amount
+          end
+        end
+      end
+
       attr_reader :files, :summary
 
-      def initialize(output)
+      def initialize(output, options = {})
         super
         @files = []
         @summary = OpenStruct.new(offense_count: 0)
@@ -46,18 +59,6 @@ module RuboCop
         output.write html
       end
 
-      Color = Struct.new(:red, :green, :blue, :alpha) do
-        def to_s
-          "rgba(#{values.join(', ')})"
-        end
-
-        def fade_out(amount)
-          dup.tap do |color|
-            color.alpha -= amount
-          end
-        end
-      end
-
       # This class provides helper methods used in the ERB template.
       class ERBContext
         include PathUtil, TextUtil
@@ -68,7 +69,7 @@ module RuboCop
           warning:    Color.new(0x96, 0x28, 0xEF, 1.0),
           error:      Color.new(0xD2, 0x32, 0x2D, 1.0),
           fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
-        }
+        }.freeze
 
         LOGO_IMAGE_PATH =
           File.expand_path('../../../../assets/logo.png', __FILE__)

data/lib/rubocop/formatter/json_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'json'
 require 'pathname'
@@ -11,7 +12,7 @@ module RuboCop
 
       attr_reader :output_hash
 
-      def initialize(output)
+      def initialize(output, options = {})
         super
         @output_hash = {
           metadata: metadata_hash,

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/progress_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter
@@ -9,11 +10,10 @@ module RuboCop
       include TextUtil
 
       DOT = '.'.freeze
-      GREEN_DOT = Rainbow(DOT).green.freeze
 
-      def initialize(output)
+      def initialize(output, options = {})
         super
-        @dot = @output.tty? ? GREEN_DOT : DOT
+        @dot = green(DOT)
       end
 
       def started(target_files)

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubocop/formatter/colorizable'
 require 'rubocop/formatter/text_util'
@@ -9,7 +10,7 @@ module RuboCop
     # Offenses are displayed at compact form - just the
     # location of the problem and the associated message.
     class SimpleTextFormatter < BaseFormatter
-      include Colorizable, PathUtil, TextUtil
+      include Colorizable, PathUtil
 
       COLOR_FOR_SEVERITY = {
         refactor:   :yellow,
@@ -47,23 +48,13 @@ module RuboCop
       end
 
       def report_summary(file_count, offense_count, correction_count)
-        summary = pluralize(file_count, 'file')
-        summary << ' inspected, '
-
-        offenses_text = pluralize(offense_count, 'offense', no_for_zero: true)
-        offenses_text << ' detected'
-        summary << colorize(offenses_text, offense_count.zero? ? :green : :red)
-
-        if correction_count > 0
-          summary << ', '
-          correction_text = pluralize(correction_count, 'offense')
-          correction_text << ' corrected'
-          color = correction_count == offense_count ? :green : :cyan
-          summary << colorize(correction_text, color)
-        end
+        report = Report.new(file_count,
+                            offense_count,
+                            correction_count,
+                            rainbow)
 
         output.puts
-        output.puts summary
+        output.puts report.summary
       end
 
       private
@@ -95,7 +86,49 @@ module RuboCop
 
       def message(offense)
         message = offense.corrected? ? green('[Corrected] ') : ''
-        message << annotate_message(offense.message)
+        "#{message}#{annotate_message(offense.message)}"
+      end
+
+      # A helper class for building the report summary text.
+      class Report
+        include Colorizable, TextUtil
+
+        def initialize(file_count, offense_count, correction_count, rainbow)
+          @file_count = file_count
+          @offense_count = offense_count
+          @correction_count = correction_count
+          @rainbow = rainbow
+        end
+
+        def summary
+          if @correction_count > 0
+            "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+          else
+            "#{files} inspected, #{offenses} detected"
+          end
+        end
+
+        private
+
+        attr_reader :rainbow
+
+        def files
+          pluralize(@file_count, 'file')
+        end
+
+        def offenses
+          text = pluralize(@offense_count, 'offense', no_for_zero: true)
+          color = @offense_count.zero? ? :green : :red
+
+          colorize(text, color)
+        end
+
+        def corrections
+          text = pluralize(@correction_count, 'offense')
+          color = @correction_count == @offense_count ? :green : :cyan
+
+          colorize(text, color)
+        end
       end
     end
   end

data/lib/rubocop/formatter/text_util.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Formatter
@@ -7,16 +8,13 @@ module RuboCop
       module_function
 
       def pluralize(number, thing, options = {})
-        text = if number == 0 && options[:no_for_zero]
-                 'no'
-               else
-                 number.to_s
-               end
-
-        text << " #{thing}"
-        text << 's' unless number == 1
-
-        text
+        if number == 0 && options[:no_for_zero]
+          "no #{thing}s"
+        elsif number == 1
+          "1 #{thing}"
+        else
+          "#{number} #{thing}s"
+        end
       end
     end
   end