rubocop 1.4.1 → 1.6.0

data/lib/rubocop/cli.rb

@@ -69,10 +69,14 @@ module RuboCop
       if @options[:auto_gen_config]
         run_command(:auto_gen_config)
       else
-        run_command(:execute_runner)
+        run_command(:execute_runner).tap { suggest_extensions }
       end
     end
 
+    def suggest_extensions
+      run_command(:suggest_extensions)
+    end
+
     def validate_options_vs_config
       if @options[:parallel] &&
          !@config_store.for_pwd.for_all_cops['UseCache']

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Suggest RuboCop extensions to install based on Gemfile dependencies.
+      # Only primary dependencies are evaluated, so if a dependency depends on a
+      # gem with an extension, it is not suggested. However, if an extension is
+      # a transitive dependency, it will not be suggested.
+      # @api private
+      class SuggestExtensions < Base
+        # Combination of short and long formatter names.
+        INCLUDED_FORMATTERS = %w[p progress fu fuubar pa pacman].freeze
+
+        self.command_name = :suggest_extensions
+
+        def run
+          return if skip? || extensions.none?
+
+          puts
+          puts 'Tip: Based on detected gems, the following '\
+            'RuboCop extension libraries might be helpful:'
+
+          extensions.sort.each do |extension|
+            puts "  * #{extension} (http://github.com/rubocop-hq/#{extension})"
+          end
+
+          puts
+          puts 'You can opt out of this message by adding the following to your config '\
+            '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions '\
+            'for more options):'
+          puts '  AllCops:'
+          puts '    SuggestExtensions: false'
+
+          puts if @options[:display_time]
+        end
+
+        private
+
+        def skip?
+          # Disable outputting the notification:
+          # 1. On CI
+          # 2. When given RuboCop options that it doesn't make sense for
+          # 3. For all formatters except specified in `INCLUDED_FORMATTERS'`
+          ENV['CI'] ||
+            @options[:only] || @options[:debug] || @options[:list_target_files] || @options[:out] ||
+            !INCLUDED_FORMATTERS.include?(current_formatter)
+        end
+
+        def current_formatter
+          @options[:format] || @config_store.for_pwd.for_all_cops['DefaultFormatter'] || 'p'
+        end
+
+        def extensions
+          return [] unless lockfile.dependencies.any?
+
+          extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions'] || {}
+          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys - installed_gems
+        end
+
+        def lockfile
+          @lockfile ||= Lockfile.new
+        end
+
+        def dependent_gems
+          lockfile.dependencies.map(&:name)
+        end
+
+        def installed_gems
+          lockfile.gems.map(&:name)
+        end
+
+        def puts(*args)
+          output = (@options[:stderr] ? $stderr : $stdout)
+          output.puts(*args)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/config_loader.rb

@@ -109,7 +109,7 @@ module RuboCop
         end
 
         merge_with_default(config, config_file).tap do |merged_config|
-          warn_on_pending_cops(merged_config.pending_cops) unless possible_new_cops?(config)
+          warn_on_pending_cops(merged_config.pending_cops) unless possible_new_cops?(merged_config)
         end
       end
 

data/lib/rubocop/config_loader_resolver.rb

@@ -92,7 +92,7 @@ module RuboCop
       keys_appearing_in_both.each do |key|
         if opts[:unset_nil] && derived_hash[key].nil?
           result.delete(key)
-        elsif base_hash[key].is_a?(Hash)
+        elsif merge_hashes?(base_hash, derived_hash, key)
           result[key] = merge(base_hash[key], derived_hash[key], **opts)
         elsif should_union?(base_hash, key, opts[:inherit_mode])
           result[key] = base_hash[key] | derived_hash[key]
@@ -164,6 +164,10 @@ module RuboCop
         inherit_mode['merge'].include?(key)
     end
 
+    def merge_hashes?(base_hash, derived_hash, key)
+      base_hash[key].is_a?(Hash) && derived_hash[key].is_a?(Hash)
+    end
+
     def base_configs(path, inherit_from, file)
       configs = Array(inherit_from).compact.map do |f|
         ConfigLoader.load_file(inherited_file(path, f, file))

data/lib/rubocop/config_obsoletion.rb

@@ -4,223 +4,40 @@ module RuboCop
   # This class handles obsolete configuration.
   # @api private
   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/Tab' => 'Layout/IndentationStyle',
-      'Layout/TrailingBlankLines' => 'Layout/TrailingEmptyLines',
-      'Lint/DuplicatedKey' => 'Lint/DuplicateHashKey',
-      'Lint/EndInMethod' => 'Style/EndBlock',
-      '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',
-      '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'
-    }.map do |old_name, new_name|
-      [old_name, "The `#{old_name}` cop has been renamed to `#{new_name}`."]
-    end
-
-    MOVED_COPS = {
-      'Security' => 'Lint/Eval',
-      'Naming' => %w[Style/ClassAndModuleCamelCase Style/ConstantName
-                     Style/FileName Style/MethodName Style/PredicateName
-                     Style/VariableName Style/VariableNumber
-                     Style/AccessorMethodName Style/AsciiIdentifiers],
-      'Layout' => %w[Lint/BlockAlignment Lint/EndAlignment
-                     Lint/DefEndAlignment Metrics/LineLength],
-      'Lint' => 'Style/FlipFlop'
-    }.map do |new_department, old_names|
-      Array(old_names).map do |old_name|
-        [old_name, "The `#{old_name}` cop has been moved to " \
-                   "`#{new_department}/#{old_name.split('/').last}`."]
-      end
-    end
-
-    REMOVED_COPS = {
-      'Layout/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
-      'Layout/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
-      'Lint/RescueWithoutErrorClass' => 'Style/RescueStandardError',
-      'Style/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
-      'Style/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
-      'Style/TrailingComma' => 'Style/TrailingCommaInArguments, ' \
-                               'Style/TrailingCommaInArrayLiteral, and/or ' \
-                               'Style/TrailingCommaInHashLiteral',
-      'Style/TrailingCommaInLiteral' => 'Style/TrailingCommaInArrayLiteral ' \
-                                        'and/or ' \
-                                        'Style/TrailingCommaInHashLiteral',
-      'Style/BracesAroundHashParameters' => nil
-    }.map do |old_name, other_cops|
-      if other_cops
-        more = ". Please use #{other_cops} instead".gsub(%r{[A-Z]\w+/\w+},
-                                                         '`\&`')
+    DEFAULT_RULES_FILE = File.join(ConfigLoader::RUBOCOP_HOME, 'config', 'obsoletion.yml')
+    COP_RULE_CLASSES = {
+      'renamed' => RenamedCop,
+      'removed' => RemovedCop,
+      'split' => SplitCop,
+      'extracted' => ExtractedCop
+    }.freeze
+    PARAMETER_RULE_CLASSES = {
+      'changed_parameters' => ChangedParameter,
+      'changed_enforced_styles' => ChangedEnforcedStyles
+    }.freeze
+
+    attr_reader :rules, :warnings
+
+    class << self
+      attr_accessor :files
+
+      def legacy_cop_names
+        # Used by DepartmentName#qualified_legacy_cop_name
+        new(Config.new).rules.select(&:cop_rule?).map(&:old_name)
       end
-      [old_name, "The `#{old_name}` cop has been removed#{more}."]
-    end
-
-    REMOVED_COPS_WITH_REASON = {
-      'Lint/InvalidCharacterLiteral' => 'it was never being actually triggered',
-      'Lint/SpaceBeforeFirstArg' =>
-        'it was a duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \
-        '`Layout/SpaceBeforeFirstArg` instead',
-      'Style/MethodMissingSuper' => 'it has been superseded by `Lint/MissingSuper`. Please use ' \
-        '`Lint/MissingSuper` instead',
-      'Lint/UselessComparison' => 'it has been superseded by '\
-        '`Lint/BinaryOperatorWithIdenticalOperands`. Please use '\
-        '`Lint/BinaryOperatorWithIdenticalOperands` instead'
-    }.map do |cop_name, reason|
-      [cop_name, "The `#{cop_name}` cop has been removed since #{reason}."]
     end
 
-    SPLIT_COPS = {
-      'Style/MethodMissing' =>
-        'The `Style/MethodMissing` cop has been split into ' \
-        '`Style/MethodMissingSuper` and `Style/MissingRespondToMissing`.'
-    }.to_a
-
-    OBSOLETE_COPS = Hash[*(RENAMED_COPS + MOVED_COPS + REMOVED_COPS +
-                           REMOVED_COPS_WITH_REASON + SPLIT_COPS).flatten]
-
-    OBSOLETE_PARAMETERS = [
-      {
-        cops: %w[Layout/SpaceAroundOperators Style/SpaceAroundOperators],
-        parameters: 'MultiSpaceAllowedForOperators',
-        alternative: 'If your intention was to allow extra spaces for ' \
-                     'alignment, please use AllowForAlignment: true instead.'
-      },
-      {
-        cops: 'Style/Encoding',
-        parameters: %w[EnforcedStyle SupportedStyles
-                       AutoCorrectEncodingComment],
-        alternative: 'Style/Encoding no longer supports styles. ' \
-                     'The "never" behavior is always assumed.'
-      },
-      {
-        cops: 'Style/IfUnlessModifier',
-        parameters: 'MaxLineLength',
-        alternative: '`Style/IfUnlessModifier: MaxLineLength` has been ' \
-                     'removed. Use `Layout/LineLength: Max` instead'
-      },
-      {
-        cops: 'Style/WhileUntilModifier',
-        parameters: 'MaxLineLength',
-        alternative: '`Style/WhileUntilModifier: MaxLineLength` has been ' \
-                     'removed. Use `Layout/LineLength: Max` instead'
-      },
-      {
-        cops: 'AllCops',
-        parameters: 'RunRailsCops',
-        alternative: "Use the following configuration instead:\n" \
-                     "Rails:\n  Enabled: true"
-      },
-      {
-        cops: 'Layout/CaseIndentation',
-        parameters: 'IndentWhenRelativeTo',
-        alternative: '`IndentWhenRelativeTo` has been renamed to ' \
-                     '`EnforcedStyle`'
-      },
-      {
-        cops: %w[Lint/BlockAlignment Layout/BlockAlignment Lint/EndAlignment
-                 Layout/EndAlignment Lint/DefEndAlignment
-                 Layout/DefEndAlignment],
-        parameters: 'AlignWith',
-        alternative: '`AlignWith` has been renamed to `EnforcedStyleAlignWith`'
-      },
-      {
-        cops: 'Rails/UniqBeforePluck',
-        parameters: 'EnforcedMode',
-        alternative: '`EnforcedMode` has been renamed to `EnforcedStyle`'
-      },
-      {
-        cops: 'Style/MethodCallWithArgsParentheses',
-        parameters: 'IgnoredMethodPatterns',
-        alternative: '`IgnoredMethodPatterns` has been renamed to ' \
-                     '`IgnoredPatterns`'
-      },
-      {
-        cops: %w[Performance/Count Performance/Detect],
-        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
-
-    OBSOLETE_ENFORCED_STYLES = [
-      {
-        cop: 'Layout/IndentationConsistency',
-        parameter: 'EnforcedStyle',
-        enforced_style: 'rails',
-        alternative: '`EnforcedStyle: rails` has been renamed to ' \
-                     '`EnforcedStyle: indented_internal_methods`'
-      }
-    ].freeze
+    # Can be extended by extension libraries to add their own obsoletions
+    self.files = [DEFAULT_RULES_FILE]
 
     def initialize(config)
       @config = config
+      @rules = load_rules
+      @warnings = []
     end
 
-    def reject_obsolete_cops_and_parameters
-      messages = [obsolete_cops, obsolete_parameters,
-                  obsolete_enforced_style].flatten.compact
+    def reject_obsolete!
+      messages = obsoletions.flatten.compact
       return if messages.empty?
 
       raise ValidationError, messages.join("\n")
@@ -228,56 +45,57 @@ module RuboCop
 
     private
 
-    def obsolete_cops
-      OBSOLETE_COPS.map do |cop_name, message|
-        next unless @config.key?(cop_name) ||
-                    @config.key?(Cop::Badge.parse(cop_name).cop_name)
-
-        message + "\n(obsolete configuration found in " \
-                  "#{smart_loaded_path}, please update it)"
-      end
-    end
-
-    def obsolete_enforced_style
-      OBSOLETE_ENFORCED_STYLES.map do |params|
-        obsolete_enforced_style_message(params[:cop], params[:parameter],
-                                        params[:enforced_style],
-                                        params[:alternative])
+    # Default rules for obsoletions are in config/obsoletion.yml
+    # Additional rules files can be added with `RuboCop::ConfigObsoletion.files << filename`
+    def load_rules
+      rules = self.class.files.each_with_object({}) do |filename, hash|
+        hash.merge!(YAML.safe_load(File.read(filename))) do |_key, first, second|
+          first.merge(second)
+        end
       end
-    end
-
-    def obsolete_enforced_style_message(cop, param, enforced_style, alternative)
-      style = @config[cop]&.detect { |key, _| key.start_with?(param) }
 
-      return unless style && style[1] == enforced_style
+      cop_rules = rules.slice(*COP_RULE_CLASSES.keys)
+      parameter_rules = rules.slice(*PARAMETER_RULE_CLASSES.keys)
 
-      "obsolete `#{param}: #{enforced_style}` (for #{cop}) found in " \
-      "#{smart_loaded_path}\n#{alternative}"
+      load_cop_rules(cop_rules).concat(load_parameter_rules(parameter_rules))
     end
 
-    def obsolete_parameters
-      OBSOLETE_PARAMETERS.map do |params|
-        obsolete_parameter_message(params[:cops], params[:parameters],
-                                   params[:alternative])
+    # Cop rules are keyed by the name of the original cop
+    def load_cop_rules(rules)
+      rules.flat_map do |rule_type, data|
+        data.map do |configuration|
+          COP_RULE_CLASSES[rule_type].new(@config, *configuration)
+        end
       end
     end
 
-    def obsolete_parameter_message(cops, parameters, alternative)
-      Array(cops).map do |cop|
-        obsolete_parameters = Array(parameters).select do |param|
-          @config[cop]&.key?(param)
-        end
-        next if obsolete_parameters.empty?
-
-        obsolete_parameters.map do |parameter|
-          "obsolete parameter #{parameter} (for #{cop}) found in " \
-          "#{smart_loaded_path}\n#{alternative}"
+    # Parameter rules may apply to multiple cops and multiple parameters
+    # and are given as an array. Each combination is turned into a separate
+    # rule object.
+    def load_parameter_rules(rules)
+      rules.flat_map do |rule_type, data|
+        data.flat_map do |configuration|
+          cops = Array(configuration['cops'])
+          parameters = Array(configuration['parameters'])
+
+          cops.product(parameters).map do |cop, parameter|
+            PARAMETER_RULE_CLASSES[rule_type].new(@config, cop, parameter, configuration)
+          end
         end
       end
     end
 
-    def smart_loaded_path
-      PathUtil.smart_path(@config.loaded_path)
+    def obsoletions
+      rules.map do |rule|
+        next unless rule.violated?
+
+        if rule.warning?
+          @warnings.push(rule.message)
+          next
+        end
+
+        rule.message
+      end
     end
   end
 end