rubocop 0.76.0 → 0.79.0

data/lib/rubocop/cli.rb

@@ -1,20 +1,9 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    include Formatter::TextUtil
-
-    PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop'
-    PHASE_2 = 'Phase 2 of 2: run all cops'
-
-    PHASE_1_OVERRIDDEN = '(skipped because the default Metrics/LineLength:Max' \
-                         ' is overridden)'
-    PHASE_1_DISABLED   = '(skipped because Metrics/LineLength is ' \
-                         'disabled)'
-
     STATUS_SUCCESS     = 0
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
@@ -41,14 +30,15 @@ module RuboCop
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
       @options, paths = Options.new.parse(args)
+      @env = Environment.new(@options, @config_store, paths)
 
       if @options[:init]
-        init_dotfile
+        run_command(:init)
       else
         validate_options_vs_config
         act_on_options
         apply_default_formatter
-        execute_runners(paths)
+        execute_runners
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
@@ -71,113 +61,18 @@ module RuboCop
 
     private
 
-    def execute_runners(paths)
-      if @options[:auto_gen_config]
-        reset_config_and_auto_gen_file
-        line_length_contents = maybe_run_line_length_cop(paths)
-        run_all_cops_auto_gen_config(line_length_contents, paths)
-      else
-        execute_runner(paths)
-      end
-    end
-
-    def maybe_run_line_length_cop(paths)
-      if !line_length_enabled?(@config_store.for(Dir.pwd))
-        skip_line_length_cop(PHASE_1_DISABLED)
-      elsif !same_max_line_length?(
-        @config_store.for(Dir.pwd), ConfigLoader.default_configuration
-      )
-        skip_line_length_cop(PHASE_1_OVERRIDDEN)
-      else
-        run_line_length_cop_auto_gen_config(paths)
-      end
-    end
-
-    def skip_line_length_cop(reason)
-      puts Rainbow("#{PHASE_1} #{reason}").yellow
-      ''
-    end
-
-    def line_length_enabled?(config)
-      line_length_cop(config)['Enabled']
-    end
-
-    def same_max_line_length?(config1, config2)
-      max_line_length(config1) == max_line_length(config2)
-    end
-
-    def max_line_length(config)
-      line_length_cop(config)['Max']
-    end
-
-    def line_length_cop(config)
-      config.for_cop('Metrics/LineLength')
+    def run_command(name)
+      @env.run(name)
     end
 
-    # Do an initial run with only Metrics/LineLength so that cops that depend
-    # on Metrics/LineLength:Max get the correct value for that parameter.
-    def run_line_length_cop_auto_gen_config(paths)
-      puts Rainbow(PHASE_1).yellow
-      @options[:only] = ['Metrics/LineLength']
-      execute_runner(paths)
-      @options.delete(:only)
-      @config_store = ConfigStore.new
-      # Save the todo configuration of the LineLength cop.
-      IO.read(ConfigLoader::AUTO_GENERATED_FILE)
-        .lines
-        .drop_while { |line| line.start_with?('#') }
-        .join
-    end
-
-    def run_all_cops_auto_gen_config(line_length_contents, paths)
-      puts Rainbow(PHASE_2).yellow
-      result = execute_runner(paths)
-      # This run was made with the current maximum length allowed, so append
-      # the saved setting for LineLength.
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
-        f.write(line_length_contents)
-      end
-      result
-    end
-
-    def init_dotfile
-      path = File.expand_path(ConfigLoader::DOTFILE)
-
-      if File.exist?(ConfigLoader::DOTFILE)
-        warn Rainbow("#{ConfigLoader::DOTFILE} already exists at #{path}").red
-
-        STATUS_ERROR
+    def execute_runners
+      if @options[:auto_gen_config]
+        run_command(:auto_gen_config)
       else
-        description = <<~DESC
-          # The behavior of RuboCop can be controlled via the .rubocop.yml
-          # configuration file. It makes it possible to enable/disable
-          # certain cops (checks) and to alter their behavior if they accept
-          # any parameters. The file can be placed either in your home
-          # directory or in some project directory.
-          #
-          # RuboCop will start looking for the configuration file in the directory
-          # where the inspected file is and continue its way up to the root directory.
-          #
-          # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
-        DESC
-
-        File.open(ConfigLoader::DOTFILE, 'w') do |f|
-          f.write(description)
-        end
-
-        puts "Writing new #{ConfigLoader::DOTFILE} to #{path}"
-
-        STATUS_SUCCESS
+        run_command(:execute_runner)
       end
     end
 
-    def reset_config_and_auto_gen_file
-      @config_store = ConfigStore.new
-      @config_store.options_config = @options[:config] if @options[:config]
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
-      ConfigLoader.add_inheritance_from_auto_generated_file
-    end
-
     def validate_options_vs_config
       if @options[:parallel] &&
          !@config_store.for(Dir.pwd).for_all_cops['UseCache']
@@ -207,31 +102,11 @@ module RuboCop
       end
     end
 
-    def execute_runner(paths)
-      runner = Runner.new(@options, @config_store)
-
-      all_passed = runner.run(paths)
-      display_warning_summary(runner.warnings)
-      display_error_summary(runner.errors)
-      maybe_print_corrected_source
-
-      all_pass_or_excluded = all_passed || @options[:auto_gen_config]
-
-      if runner.aborting?
-        STATUS_INTERRUPTED
-      elsif all_pass_or_excluded && runner.errors.empty?
-        STATUS_SUCCESS
-      else
-        STATUS_OFFENSES
-      end
-    end
-
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
-      puts RuboCop::Version.version(false) if @options[:version]
-      puts RuboCop::Version.version(true) if @options[:verbose_version]
-      print_available_cops if @options[:show_cops]
+      run_command(:version) if @options[:version] || @options[:verbose_version]
+      run_command(:show_cops) if @options[:show_cops]
       raise Finished
     end
 
@@ -247,100 +122,6 @@ module RuboCop
         end
         [[formatter, @options[:output_path]]]
       end
-
-      return unless @options[:auto_gen_config]
-
-      @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                ConfigLoader::AUTO_GENERATED_FILE]
-    end
-
-    def print_available_cops
-      # Load the configs so the require()s are done for custom cops
-      @config_store.for(Dir.pwd)
-      registry = Cop::Cop.registry
-      show_all = @options[:show_cops].empty?
-
-      if show_all
-        puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: "
-      end
-
-      registry.departments.sort!.each do |department|
-        print_cops_of_department(registry, department, show_all)
-      end
-    end
-
-    def print_cops_of_department(registry, department, show_all)
-      selected_cops = if show_all
-                        cops_of_department(registry, department)
-                      else
-                        selected_cops_of_department(registry, department)
-                      end
-
-      puts "# Department '#{department}' (#{selected_cops.length}):" if show_all
-
-      print_cop_details(selected_cops)
-    end
-
-    def print_cop_details(cops)
-      cops.each do |cop|
-        puts '# Supports --auto-correct' if cop.new.support_autocorrect?
-        puts "#{cop.cop_name}:"
-        puts config_lines(cop)
-        puts
-      end
-    end
-
-    def selected_cops_of_department(cops, department)
-      cops_of_department(cops, department).select do |cop|
-        @options[:show_cops].include?(cop.cop_name)
-      end
-    end
-
-    def cops_of_department(cops, department)
-      cops.with_department(department).sort!
-    end
-
-    def config_lines(cop)
-      cnf = @config_store.for(Dir.pwd).for_cop(cop)
-      cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
-    end
-
-    def display_warning_summary(warnings)
-      return if warnings.empty?
-
-      warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
-
-      warnings.each { |warning| warn warning }
-    end
-
-    def display_error_summary(errors)
-      return if errors.empty?
-
-      warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
-
-      errors.each { |error| warn error }
-
-      warn <<~WARNING
-        Errors are usually caused by RuboCop bugs.
-        Please, report your problems to RuboCop's issue tracker.
-        #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
-
-        Mention the following information in the issue report:
-        #{RuboCop::Version.version(true)}
-      WARNING
-    end
-
-    def maybe_print_corrected_source
-      # If we are asked to autocorrect source code read from stdin, the only
-      # reasonable place to write it is to stdout
-      # Unfortunately, we also write other information to stdout
-      # So a delimiter is needed for tools to easily identify where the
-      # autocorrected source begins
-      return unless @options[:stdin] && @options[:auto_correct]
-
-      puts '=' * 20
-      print @options[:stdin]
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/rubocop/config.rb

@@ -115,7 +115,7 @@ module RuboCop
       relative_file_path = path_relative_to_config(file)
 
       # Optimization to quickly decide if the given file is hidden (on the top
-      # level) and can not be matched by any pattern.
+      # level) and cannot be matched by any pattern.
       is_hidden = relative_file_path.start_with?('.') &&
                   !relative_file_path.start_with?('..')
       return false if is_hidden && !possibly_include_hidden?

data/lib/rubocop/config_loader.rb

@@ -91,7 +91,9 @@ module RuboCop
         else
           add_excludes_from_files(config, config_file)
         end
-        merge_with_default(config, config_file)
+        merge_with_default(config, config_file).tap do |merged_config|
+          warn_on_pending_cops(merged_config)
+        end
       end
 
       def add_excludes_from_files(config, config_file)
@@ -114,6 +116,22 @@ module RuboCop
                                    end
       end
 
+      def warn_on_pending_cops(config)
+        pending_cops = config.keys.select do |key|
+          config[key]['Enabled'] == 'pending'
+        end
+
+        return if pending_cops.none?
+
+        warn Rainbow('The following cops were added to RuboCop, but are not ' \
+                     'configured. Please set Enabled to either `true` or ' \
+                     '`false` in your `.rubocop.yml` file:').yellow
+
+        pending_cops.each do |cop|
+          warn Rainbow(" - #{cop}").yellow
+        end
+      end
+
       # Merges the given configuration with the default one. If
       # AllCops:DisabledByDefault is true, it changes the Enabled params so
       # that only cops from user configuration are enabled.
@@ -199,8 +217,6 @@ module RuboCop
           raise(TypeError, "Malformed configuration in #{absolute_path}")
         end
 
-        check_cop_config_value(hash)
-
         hash
       end
 
@@ -222,22 +238,6 @@ module RuboCop
         end
       end
 
-      def check_cop_config_value(hash, parent = nil)
-        hash.each do |key, value|
-          check_cop_config_value(value, key) if value.is_a?(Hash)
-
-          next unless %w[Enabled
-                         Safe
-                         SafeAutoCorrect
-                         AutoCorrect].include?(key) && value.is_a?(String)
-
-          abort(
-            "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
-            " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
-          )
-        end
-      end
-
       # Read the specified file, or exit with a friendly, concise message on
       # stderr. Care is taken to use the standard OS exit code for a "file not
       # found" error.

data/lib/rubocop/config_obsoletion.rb

@@ -4,22 +4,39 @@ module RuboCop
   # This class handles obsolete configuration.
   class ConfigObsoletion
     RENAMED_COPS = {
+      'Layout/AlignArguments' => 'Layout/ArgumentAlignment',
+      'Layout/AlignArray' => 'Layout/ArrayAlignment',
+      'Layout/AlignHash' => 'Layout/HashAlignment',
+      'Layout/AlignParameters' => 'Layout/ParameterAlignment',
+      'Layout/IndentArray' => 'Layout/FirstArrayElementIndentation',
+      'Layout/IndentAssignment' => 'Layout/AssignmentIndentation',
+      'Layout/IndentFirstArgument' => 'Layout/FirstArgumentIndentation',
+      'Layout/IndentFirstArrayElement' => 'Layout/FirstArrayElementIndentation',
+      'Layout/IndentFirstHashElement' => 'Layout/FirstHashElementIndentation',
+      'Layout/IndentFirstParameter' => 'Layout/FirstParameterIndentation',
+      'Layout/IndentHash' => 'Layout/FirstHashElementIndentation',
+      'Layout/IndentHeredoc' => 'Layout/HeredocIndentation',
+      'Layout/LeadingBlankLines' => 'Layout/LeadingEmptyLines',
+      'Layout/TrailingBlankLines' => 'Layout/TrailingEmptyLines',
+      'Lint/DuplicatedKey' => 'Lint/DuplicateHashKey',
+      'Lint/HandleExceptions' => 'Lint/SuppressedException',
+      'Lint/MultipleCompare' => 'Lint/MultipleComparison',
+      'Lint/StringConversionInInterpolation' => 'Lint/RedundantStringCoercion',
       'Lint/UnneededCopDisableDirective' => 'Lint/RedundantCopDisableDirective',
       'Lint/UnneededCopEnableDirective' => 'Lint/RedundantCopEnableDirective',
       'Lint/UnneededRequireStatement' => 'Lint/RedundantRequireStatement',
       'Lint/UnneededSplatExpansion' => 'Lint/RedundantSplatExpansion',
-      'Style/SingleSpaceBeforeFirstArg' => 'Layout/SpaceBeforeFirstArg',
-      'Style/MethodCallParentheses' => 'Style/MethodCallWithoutArgsParentheses',
+      'Naming/UncommunicativeBlockParamName' => 'Naming/BlockParameterName',
+      'Naming/UncommunicativeMethodParamName' => 'Naming/MethodParameterName',
       'Style/DeprecatedHashMethods' => 'Style/PreferredHashMethods',
+      'Style/MethodCallParentheses' => 'Style/MethodCallWithoutArgsParentheses',
       'Style/OpMethod' => 'Naming/BinaryOperatorParameterName',
+      'Style/SingleSpaceBeforeFirstArg' => 'Layout/SpaceBeforeFirstArg',
       'Style/UnneededCapitalW' => 'Style/RedundantCapitalW',
       'Style/UnneededCondition' => 'Style/RedundantCondition',
       'Style/UnneededInterpolation' => 'Style/RedundantInterpolation',
       'Style/UnneededPercentQ' => 'Style/RedundantPercentQ',
-      'Style/UnneededSort' => 'Style/RedundantSort',
-      'Layout/FirstParameterIndentation' => 'Layout/IndentFirstArgument',
-      'Layout/IndentArray' => 'Layout/IndentFirstArrayElement',
-      'Layout/IndentHash' => 'Layout/IndentFirstHashElement'
+      'Style/UnneededSort' => 'Style/RedundantSort'
     }.map do |old_name, new_name|
       [old_name, "The `#{old_name}` cop has been renamed to `#{new_name}`."]
     end
@@ -31,7 +48,7 @@ module RuboCop
                      Style/VariableName Style/VariableNumber
                      Style/AccessorMethodName Style/AsciiIdentifiers],
       'Layout' => %w[Lint/BlockAlignment Lint/EndAlignment
-                     Lint/DefEndAlignment],
+                     Lint/DefEndAlignment Metrics/LineLength],
       'Lint' => 'Style/FlipFlop'
     }.map do |new_department, old_names|
       Array(old_names).map do |old_name|
@@ -41,9 +58,10 @@ module RuboCop
     end
 
     REMOVED_COPS = {
-      'Rails/DefaultScope' => nil,
       'Layout/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
       'Layout/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
+      'Lint/RescueWithoutErrorClass' => 'Style/RescueStandardError',
+      'Rails/DefaultScope' => nil,
       'Style/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
       'Style/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
       'Style/TrailingComma' => 'Style/TrailingCommaInArguments, ' \
@@ -51,8 +69,7 @@ module RuboCop
                                'Style/TrailingCommaInHashLiteral',
       'Style/TrailingCommaInLiteral' => 'Style/TrailingCommaInArrayLiteral ' \
                                         'and/or ' \
-                                        'Style/TrailingCommaInHashLiteral',
-      'Lint/RescueWithoutErrorClass' => 'Style/RescueStandardError'
+                                        'Style/TrailingCommaInHashLiteral'
     }.map do |old_name, other_cops|
       if other_cops
         more = ". Please use #{other_cops} instead".gsub(%r{[A-Z]\w+/\w+},
@@ -97,13 +114,13 @@ module RuboCop
         cops: 'Style/IfUnlessModifier',
         parameters: 'MaxLineLength',
         alternative: '`Style/IfUnlessModifier: MaxLineLength` has been ' \
-                     'removed. Use `Metrics/LineLength: Max` instead'
+                     'removed. Use `Layout/LineLength: Max` instead'
       },
       {
         cops: 'Style/WhileUntilModifier',
         parameters: 'MaxLineLength',
         alternative: '`Style/WhileUntilModifier: MaxLineLength` has been ' \
-                     'removed. Use `Metrics/LineLength: Max` instead'
+                     'removed. Use `Layout/LineLength: Max` instead'
       },
       {
         cops: 'AllCops',
@@ -140,6 +157,42 @@ module RuboCop
         parameters: 'SafeMode',
         alternative: '`SafeMode` has been removed. ' \
                      'Use `SafeAutoCorrect` instead.'
+      },
+      {
+        cops: 'Bundler/GemComment',
+        parameters: 'Whitelist',
+        alternative: '`Whitelist` has been renamed to `IgnoredGems`.'
+      },
+      {
+        cops: %w[
+          Lint/SafeNavigationChain Lint/SafeNavigationConsistency
+          Style/NestedParenthesizedCalls Style/SafeNavigation
+          Style/TrivialAccessors
+        ],
+        parameters: 'Whitelist',
+        alternative: '`Whitelist` has been renamed to `AllowedMethods`.'
+      },
+      {
+        cops: 'Style/IpAddresses',
+        parameters: 'Whitelist',
+        alternative: '`Whitelist` has been renamed to `AllowedAddresses`.'
+      },
+      {
+        cops: 'Naming/HeredocDelimiterNaming',
+        parameters: 'Blacklist',
+        alternative: '`Blacklist` has been renamed to `ForbiddenDelimiters`.'
+      },
+      {
+        cops: 'Naming/PredicateName',
+        parameters: 'NamePrefixBlacklist',
+        alternative: '`NamePrefixBlacklist` has been renamed to ' \
+                     '`ForbiddenPrefixes`.'
+      },
+      {
+        cops: 'Naming/PredicateName',
+        parameters: 'NameWhitelist',
+        alternative: '`NameWhitelist` has been renamed to ' \
+                     '`AllowedMethods`.'
       }
     ].freeze