rubocop 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5013f1930869ad961d7fe1cf2cd8bad7a36a15bc37f6cf42e1663fbdb61f2cc2
-  data.tar.gz: 1ac4e658406f0f6e22a068f28fab225a8e9f53c59a79f89f0e52157cdc076efc
+  metadata.gz: 4ce46e11fac05ae40731d9a49b0c4229aa719d395a3f946b294965c52513ad1b
+  data.tar.gz: 56c6f908f370d96d011287d67172e41c9a8a3a21748fb04d5235d0f957ffd64f
 SHA512:
-  metadata.gz: 555adab63cf768a150f37d2ca84e08f2322e84182528949e09bd5eda4c79348e4c41dc17d23737785ea044a78f54f99d99d512047446d7437efdeaf306147f32
-  data.tar.gz: 3fe186c044fd8733f4edef4055c036106d739e485dbfdcdbffe7882961175695edb79aafe27c1b11a8bbe9791f0754f26e7bd7534571dd09955bd5caf6aa6afe
+  metadata.gz: f58d45c385e3fcccee94a8c258dd9536fb768c8ae069201411bb22f3c33dac0806b1d177f7f5562a27b71ae25ab3896917c06c29703c1f1c7d276506442069c6
+  data.tar.gz: ca55f537a662481c1337f6301d162074138c76a36c3332715aa2304ef2b67363df4b026ec1aa4dabe6e9c6b7833c0ed48edca99ea249a152a6a563a6242beeac

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.
@@ -1176,7 +1190,7 @@ Layout/SpaceBeforeBlockBraces:
   SupportedStylesForEmptyBraces:
     - space
     - no_space
-  VersionChanged: '0.52.1'
+  VersionChanged: '0.52'
 
 Layout/SpaceBeforeComma:
   Description: 'No spaces before commas.'
@@ -1401,7 +1415,10 @@ Lint/ConstantDefinitionInBlock:
   Enabled: true
   VersionAdded: '0.91'
   VersionChanged: '1.3'
-  AllowedMethods: []
+  # `enums` for Typed Enums via T::Enum in Sorbet.
+  # https://sorbet.org/docs/tenum
+  AllowedMethods:
+    - enums
 
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
@@ -1681,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.'
@@ -1862,7 +1880,7 @@ Lint/RescueException:
   StyleGuide: '#no-blind-rescues'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.27.1'
+  VersionChanged: '0.27'
 
 Lint/RescueType:
   Description: 'Avoid rescuing from non constants that could result in a `TypeError`.'
@@ -1990,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
@@ -1999,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.'
@@ -2102,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
@@ -2157,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.'
@@ -2177,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: >-
@@ -2448,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
@@ -2456,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 ##############################
 
@@ -3917,7 +3964,7 @@ Style/PercentLiteralDelimiters:
     '%r': '{}'
     '%w': '[]'
     '%W': '[]'
-  VersionChanged: '0.48.1'
+  VersionChanged: '0.48'
 
 Style/PercentQLiterals:
   Description: 'Checks if uses of %Q/%q match the configured preference.'
@@ -3973,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
@@ -4243,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:
@@ -4324,7 +4383,7 @@ Style/StringMethods:
   Description: 'Checks if configured preferred methods are used over non-preferred.'
   Enabled: false
   VersionAdded: '0.34'
-  VersionChanged: '0.34.2'
+  VersionChanged: '0.34'
   # Mapping from undesired method to desired_method
   # e.g. to use `to_sym` over `intern`:
   #
@@ -4375,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,67 @@
+# 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 run
+          return if skip? || extensions.none?
+
+          puts
+          puts 'Tip: Based on detected gems, the following '\
+            'RuboCop extension libraries might be helpful:'
+
+          extensions.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:'
+          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
+          extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions']
+          return [] unless extensions
+
+          extensions.select { |_, v| (v & dependent_gems).any? }.keys - dependent_gems
+        end
+
+        def dependent_gems
+          # This only includes gems in Gemfile, not in lockfile
+          Bundler.load.dependencies.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
 
@@ -255,10 +255,18 @@ module RuboCop
               "Configuration file not found: #{absolute_path}"
       end
 
-      raise 'SafeYAML is unmaintained, no longer needed and should be removed' if defined?(SafeYAML)
+      def yaml_safe_load(yaml_code, filename)
+        yaml_safe_load!(yaml_code, filename)
+      rescue ::StandardError
+        if defined?(::SafeYAML)
+          raise 'SafeYAML is unmaintained, no longer needed and should be removed'
+        end
+
+        raise
+      end
 
       if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
-        def yaml_safe_load(yaml_code, filename)
+        def yaml_safe_load!(yaml_code, filename)
           YAML.safe_load(yaml_code,
                          permitted_classes: [Regexp, Symbol],
                          permitted_symbols: [],
@@ -266,7 +274,7 @@ module RuboCop
                          filename: filename)
         end
       else # Ruby < 2.6
-        def yaml_safe_load(yaml_code, filename)
+        def yaml_safe_load!(yaml_code, filename)
           YAML.safe_load(yaml_code, [Regexp, Symbol], [], true, filename)
         end
       end