rubocop 1.3.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4238df3546a63ce2c279ced4bba228a61c137b083a3fad76b45365954555f690
-  data.tar.gz: bf3bd7a2409203b911212906d013aec7219f1a21825352bc92e0b897faafbd66
+  metadata.gz: 6385e74786dea3c867437d18cb40ed5715ed391e14c05f9589b9029b5d8e3b82
+  data.tar.gz: 56ca46faf293f235cecc7e9efc3590f355889b837bf2a9d27c224eb62e5a5ac5
 SHA512:
-  metadata.gz: a87bd4426855a7278963b8c3e4373b7c995994b5685318aad04bc2b0832c0db44e705d50d4ea21d81eb47074137fde56665f8317121caae8a81e208e044ce4a7
-  data.tar.gz: 3bb4cb7794129ac95c70876bc009a4ed07425a7a346acaf77279c4e0fc8b1c20f31e82e9590e1d880fa011ddddc08c93bb3851f6f815718b9de8ff7a0dd78c6f
+  metadata.gz: 1f7dd2432b886b8a843fb168179d51a1f2944c045261d461a35e3a40942d55de8a837051bb06635482cf29db50f6bb8f4be16bf284a9596d70ab3e1235a296ec
+  data.tar.gz: 3cdc1f213db45d58d9ae5f2b05a6ed93d9c5cb18bf096e7ff2c848bdf191f70b1af011401a97c70f54a0a63107a24bb60c7eea50284a3f7b9467e522c3d9b183

data/README.md

@@ -51,7 +51,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.3', require: false
+gem 'rubocop', '~> 1.5', require: false
 ```
 
 See [versioning](https://docs.rubocop.org/rubocop/1.0/versioning.html) for further details.

data/config/default.yml

@@ -139,6 +139,16 @@ AllCops:
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
   # use the oldest officially supported Ruby version (currently Ruby 2.4).
   TargetRubyVersion: ~
+  # Determines if a notification for extension libraries should be shown when
+  # rubocop is run. Keys are the name of the extension, and values are an array
+  # of gems in the Gemfile that the extension is suggested for, if not already
+  # included.
+  SuggestExtensions:
+    rubocop-rails: [rails]
+    rubocop-rspec: [rspec, rspec-rails]
+    rubocop-minitest: [minitest]
+    rubocop-sequel: [sequel]
+    rubocop-rake: [rake]
 
 #################### Bundler ###############################
 
@@ -459,10 +469,14 @@ Layout/EmptyLineAfterMultilineCondition:
     - https://github.com/airbnb/ruby#multiline-if-newline
 
 Layout/EmptyLineBetweenDefs:
-  Description: 'Use empty lines between defs.'
+  Description: 'Use empty lines between class/module/method defs.'
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.4'
+  EmptyLineBetweenMethodDefs: true
+  EmptyLineBetweenClassDefs: true
+  EmptyLineBetweenModuleDefs: true
   # If `true`, this parameter means that single line method definitions don't
   # need an empty line between them.
   AllowAdjacentOneLineDefs: false
@@ -891,8 +905,8 @@ Layout/LineLength:
   StyleGuide: '#max-line-length'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '1.3'
-  AutoCorrect: false
+  VersionChanged: '1.4'
+  AutoCorrect: true
   Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
   # containing a URI to be longer than Max.
@@ -1684,6 +1698,7 @@ Lint/MissingSuper:
                   without calls to `super`'.
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.4'
 
 Lint/MixedRegexpCaptureTypes:
   Description: 'Do not mix named captures and numbered captures in a Regexp literal.'
@@ -1993,6 +2008,23 @@ Lint/UnderscorePrefixedVariableName:
   VersionAdded: '0.21'
   AllowKeywordBlockArguments: false
 
+Lint/UnexpectedBlockArity:
+  Description: 'Looks for blocks that have fewer arguments that the calling method expects.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.5'
+  Methods:
+    chunk_while: 2
+    each_with_index: 2
+    each_with_object: 2
+    inject: 2
+    max: 2
+    min: 2
+    minmax: 2
+    reduce: 2
+    slice_when: 2
+    sort: 2
+
 Lint/UnifiedInteger:
   Description: 'Use Integer instead of Fixnum or Bignum.'
   Enabled: true
@@ -2002,6 +2034,7 @@ Lint/UnmodifiedReduceAccumulator:
   Description: Checks for `reduce` or `inject` blocks that do not update the accumulator each iteration.
   Enabled: pending
   VersionAdded: '1.1'
+  VersionChanged: '1.5'
 
 Lint/UnreachableCode:
   Description: 'Unreachable code.'
@@ -2105,21 +2138,23 @@ Metrics/AbcSize:
     - https://en.wikipedia.org/wiki/ABC_Software_Metric
   Enabled: true
   VersionAdded: '0.27'
-  VersionChanged: '0.81'
+  VersionChanged: '1.5'
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
   IgnoredMethods: []
+  CountRepeatedAttributes: true
   Max: 17
 
 Metrics/BlockLength:
   Description: 'Avoid long blocks with many lines.'
   Enabled: true
   VersionAdded: '0.44'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 25
   CountAsOne: []
-  ExcludedMethods:
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
@@ -2160,11 +2195,12 @@ Metrics/MethodLength:
   StyleGuide: '#short-methods'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 10
   CountAsOne: []
-  ExcludedMethods: []
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods: []
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
@@ -2180,8 +2216,10 @@ Metrics/ParameterLists:
   StyleGuide: '#too-many-params'
   Enabled: true
   VersionAdded: '0.25'
+  VersionChanged: '1.5'
   Max: 5
   CountKeywordArgs: true
+  MaxOptionalParameters: 3
 
 Metrics/PerceivedComplexity:
   Description: >-
@@ -2451,7 +2489,7 @@ Naming/VariableNumber:
   StyleGuide: '#snake-case-symbols-methods-vars-with-numbers'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '1.3'
+  VersionChanged: '1.4'
   EnforcedStyle: normalcase
   SupportedStyles:
     - snake_case
@@ -2459,7 +2497,13 @@ Naming/VariableNumber:
     - non_integer
   CheckMethodNames: true
   CheckSymbols: true
-  AllowedIdentifiers: []
+  AllowedIdentifiers:
+    - capture3     # Open3.capture3
+    - iso8601      # Time#iso8601
+    - rfc1123_date # CGI.rfc1123_date
+    - rfc822       # Time#rfc822
+    - rfc2822      # Time#rfc2822
+    - rfc3339      # DateTime.rfc3339
 
 #################### Security ##############################
 
@@ -3976,6 +4020,17 @@ Style/RandomWithOffset:
   Enabled: true
   VersionAdded: '0.52'
 
+Style/RedundantArgument:
+  Description: 'Check for a redundant argument passed to certain methods.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.4'
+  Methods:
+    # Array#join
+    join: ''
+    # String#split
+    split: ' '
+
 Style/RedundantAssignment:
   Description: 'Checks for redundant assignment before returning.'
   Enabled: true
@@ -4246,6 +4301,7 @@ Style/SoleNestedConditional:
                   which can be merged into outer conditional node.
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.5'
   AllowModifier: false
 
 Style/SpecialGlobalVars:
@@ -4378,7 +4434,7 @@ Style/SymbolProc:
   Enabled: true
   Safe: false
   VersionAdded: '0.26'
-  VersionChanged: '0.64'
+  VersionChanged: '1.5'
   # A list of method names to be ignored by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:

data/lib/rubocop.rb

@@ -18,6 +18,7 @@ require_relative 'rubocop/ext/regexp_node'
 require_relative 'rubocop/ext/regexp_parser'
 
 require_relative 'rubocop/core_ext/string'
+require_relative 'rubocop/core_ext/hash'
 require_relative 'rubocop/ext/processed_source'
 
 require_relative 'rubocop/path_util'
@@ -88,6 +89,7 @@ require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
 require_relative 'rubocop/cop/mixin/match_range'
 require_relative 'rubocop/cop/metrics/utils/repeated_csend_discount'
+require_relative 'rubocop/cop/metrics/utils/repeated_attribute_discount'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
@@ -341,6 +343,7 @@ require_relative 'rubocop/cop/lint/to_json'
 require_relative 'rubocop/cop/lint/top_level_return_with_argument'
 require_relative 'rubocop/cop/lint/trailing_comma_in_attribute_declaration'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
+require_relative 'rubocop/cop/lint/unexpected_block_arity'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unmodified_reduce_accumulator'
 require_relative 'rubocop/cop/lint/unreachable_code'
@@ -529,6 +532,7 @@ require_relative 'rubocop/cop/style/preferred_hash_methods'
 require_relative 'rubocop/cop/style/proc'
 require_relative 'rubocop/cop/style/raise_args'
 require_relative 'rubocop/cop/style/random_with_offset'
+require_relative 'rubocop/cop/style/redundant_argument'
 require_relative 'rubocop/cop/style/redundant_begin'
 require_relative 'rubocop/cop/style/redundant_capital_w'
 require_relative 'rubocop/cop/style/redundant_condition'
@@ -645,6 +649,7 @@ require_relative 'rubocop/cli/command/auto_genenerate_config'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/show_cops'
+require_relative 'rubocop/cli/command/suggest_extensions'
 require_relative 'rubocop/cli/command/version'
 require_relative 'rubocop/config_regeneration'
 require_relative 'rubocop/options'

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/execute_runner.rb

@@ -22,12 +22,13 @@ module RuboCop
         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 = with_redirect do
+            all_passed = runner.run(paths)
+            display_summary(runner)
+            all_passed || @options[:auto_gen_config]
+          end
 
-          all_pass_or_excluded = all_passed || @options[:auto_gen_config]
+          maybe_print_corrected_source
 
           if runner.aborting?
             STATUS_INTERRUPTED
@@ -38,6 +39,25 @@ module RuboCop
           end
         end
 
+        def with_redirect
+          if @options[:stderr]
+            orig_stdout = $stdout.dup
+            $stdout.reopen($stderr)
+
+            result = yield
+
+            $stdout.reopen(orig_stdout)
+            result
+          else
+            yield
+          end
+        end
+
+        def display_summary(runner)
+          display_warning_summary(runner.warnings)
+          display_error_summary(runner.errors)
+        end
+
         def display_warning_summary(warnings)
           return if warnings.empty?
 
@@ -69,14 +89,9 @@ module RuboCop
           # See: https://github.com/rubocop-hq/rubocop/issues/8673
           return if INTEGRATION_FORMATTERS.include?(@options[:format])
 
-          # 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
+          (@options[:stderr] ? $stderr : $stdout).puts '=' * 20
           print @options[:stdin]
         end
       end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Run all the selected cops and report the result.
+      # @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 self.dependent_gems
+          return [] unless defined?(Bundler)
+
+          # This only includes gems in Gemfile, not in lockfile
+          Bundler.load.dependencies.map(&:name)
+        rescue Bundler::GemfileNotFound
+          []
+        end
+
+        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 dependent_gems.any?
+
+          @extensions ||= begin
+            extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions'] || {}
+            extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys - dependent_gems
+          end
+        end
+
+        def puts(*args)
+          output = (@options[:stderr] ? $stderr : $stdout)
+          output.puts(*args)
+        end
+
+        def dependent_gems
+          @dependent_gems ||= self.class.dependent_gems
+        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

@@ -104,6 +104,7 @@ module RuboCop
     OBSOLETE_COPS = Hash[*(RENAMED_COPS + MOVED_COPS + REMOVED_COPS +
                            REMOVED_COPS_WITH_REASON + SPLIT_COPS).flatten]
 
+    # Parameters can be deprecated but not disabled by setting `severity: :warning`
     OBSOLETE_PARAMETERS = [
       {
         cops: %w[Layout/SpaceAroundOperators Style/SpaceAroundOperators],
@@ -201,6 +202,12 @@ module RuboCop
         parameters: 'NameWhitelist',
         alternative: '`NameWhitelist` has been renamed to ' \
                      '`AllowedMethods`.'
+      },
+      {
+        cops: %w[Metrics/BlockLength Metrics/MethodLength],
+        parameters: 'ExcludedMethods',
+        alternative: '`ExcludedMethods` has been renamed to `IgnoredMethods`.',
+        severity: :warning
       }
     ].freeze
 
@@ -214,8 +221,11 @@ module RuboCop
       }
     ].freeze
 
+    attr_reader :warnings
+
     def initialize(config)
       @config = config
+      @warnings = []
     end
 
     def reject_obsolete_cops_and_parameters
@@ -256,9 +266,17 @@ module RuboCop
     end
 
     def obsolete_parameters
-      OBSOLETE_PARAMETERS.map do |params|
-        obsolete_parameter_message(params[:cops], params[:parameters],
-                                   params[:alternative])
+      OBSOLETE_PARAMETERS.collect do |params|
+        messages = obsolete_parameter_message(params[:cops], params[:parameters],
+                                              params[:alternative])
+
+        # Warnings are collected separately and not added to the error message
+        if messages && params.fetch(:severity, :error) == :warning
+          @warnings.concat(messages)
+          next
+        end
+
+        messages
       end
     end