rubocop 0.82.0 → 0.83.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e04c6e897293df4ef1c7bf05a0c0077512e2cba797a7caee484b1c08a7300ad
-  data.tar.gz: 92fbc98b5068e5c30bf83d058e3cfe774a1a65cc90608027ff8d6624c8c2910c
+  metadata.gz: 02ede8c9af1fb47b66ac79a0d93d577a5384f82f5076e1e64631ca761c4d3f6b
+  data.tar.gz: 2f22e7716a7068013b131636217a77189f2ca506e53c8613c407c18f8028600e
 SHA512:
-  metadata.gz: cacf128617d233de65c2061d0300d345357840b151f65c78a2463fa23830115dcaa667cc2110ef39cacd14d957e626fc3fb4857443e40a1ab0fb485ce9cbfeed
-  data.tar.gz: f7a095da673a5b32de33293c6056c580995d1b2ad913e2891c1740ab1ffb42896f1b0c69491eb75656907b60e4de6f6a58a119c8936cff26d1ed678bc1159e0c
+  metadata.gz: 936fdee12ea43542b66ab1cccc0514f1a7076dbd671386cccf376e61633b12e51c88feba3e652e77c925a2f5df4e0646bf568af453032bd2cb6eafdd9ea66d48
+  data.tar.gz: 23ec3628be52fd219206cd866c7e46757cdae9c8bd5c29334a7471c856f19becb03af7da2dd6f12a12c1f876f4eb900d10f9c8fdd7ad669c1bf2dea4cb333145

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop.svg)](https://badge.fury.io/rb/rubocop)
 [![CircleCI Status](https://circleci.com/gh/rubocop-hq/rubocop/tree/master.svg?style=svg)](https://circleci.com/gh/rubocop-hq/rubocop/tree/master)
-[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/sj3ye7n5690d0nvg?svg=true)](https://ci.appveyor.com/project/bbatsov/rubocop)
+[![Actions Status](https://github.com/rubocop-hq/rubocop/workflows/CI/badge.svg?branch=master)](https://github.com/rubocop-hq/rubocop/actions?query=workflow%3ACI)
 [![Coverage Status](https://api.codeclimate.com/v1/badges/ad6e76460499c8c99697/test_coverage)](https://codeclimate.com/github/bbatsov/rubocop)
 [![Code Climate](https://codeclimate.com/github/bbatsov/rubocop/badges/gpa.svg)](https://codeclimate.com/github/bbatsov/rubocop)
 [![Inline docs](https://inch-ci.org/github/bbatsov/rubocop.svg)](https://inch-ci.org/github/bbatsov/rubocop)
@@ -53,7 +53,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version lock in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.82.0', require: false
+gem 'rubocop', '~> 0.83.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -35,6 +35,7 @@ AllCops:
     - '**/*.watchr'
     - '**/.irbrc'
     - '**/.pryrc'
+    - '**/.simplecov'
     - '**/buildfile'
     - '**/Appraisals'
     - '**/Berksfile'
@@ -53,6 +54,7 @@ AllCops:
     - '**/Podfile'
     - '**/Puppetfile'
     - '**/Rakefile'
+    - '**/rakefile'
     - '**/Snapfile'
     - '**/Steepfile'
     - '**/Thorfile'
@@ -375,6 +377,7 @@ Layout/ConditionPosition:
   StyleGuide: '#same-line-condition'
   Enabled: true
   VersionAdded: '0.53'
+  VersionChanged: '0.83'
 
 Layout/DefEndAlignment:
   Description: 'Align ends corresponding to defs correctly.'
@@ -460,6 +463,12 @@ Layout/EmptyLinesAroundArguments:
   Enabled: true
   VersionAdded: '0.52'
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Description: "Keep blank lines around attribute accessors."
+  StyleGuide: '#empty-lines-around-attribute-accessor'
+  Enabled: pending
+  VersionAdded: '0.83'
+
 Layout/EmptyLinesAroundBeginBody:
   Description: "Keeps track of empty lines around begin-end bodies."
   StyleGuide: '#empty-lines-around-bodies'
@@ -1295,8 +1304,8 @@ Layout/TrailingWhitespace:
   StyleGuide: '#no-trailing-whitespace'
   Enabled: true
   VersionAdded: '0.49'
-  VersionChanged: '0.55'
-  AllowInHeredoc: false
+  VersionChanged: '0.83'
+  AllowInHeredoc: true
 
 #################### Lint ##################################
 ### Warnings
@@ -1316,6 +1325,7 @@ Lint/AmbiguousOperator:
   StyleGuide: '#method-invocation-parens'
   Enabled: true
   VersionAdded: '0.17'
+  VersionChanged: '0.83'
 
 Lint/AmbiguousRegexpLiteral:
   Description: >-
@@ -1323,6 +1333,7 @@ Lint/AmbiguousRegexpLiteral:
                  a method invocation without parentheses.
   Enabled: true
   VersionAdded: '0.17'
+  VersionChanged: '0.83'
 
 Lint/AssignmentInCondition:
   Description: "Don't use assignment in conditions."
@@ -1339,8 +1350,9 @@ Lint/BigDecimalNew:
 Lint/BooleanSymbol:
   Description: 'Check for `:true` and `:false` symbols.'
   Enabled: true
+  Safe: false
   VersionAdded: '0.50'
-  VersionChanged: '0.81'
+  VersionChanged: '0.83'
 
 Lint/CircularArgumentReference:
   Description: "Default values in optional keyword arguments and optional ordinal arguments should not refer back to the name of the argument."
@@ -1411,13 +1423,16 @@ Lint/EmptyInterpolation:
 Lint/EmptyWhen:
   Description: 'Checks for `when` branches with empty bodies.'
   Enabled: true
+  AllowComments: true
   VersionAdded: '0.45'
+  VersionChanged: '0.83'
 
 Lint/EnsureReturn:
   Description: 'Do not use return in an ensure block.'
   StyleGuide: '#no-return-ensure'
   Enabled: true
   VersionAdded: '0.9'
+  VersionChanged: '0.83'
 
 Lint/ErbNewArguments:
   Description: 'Use `:trim_mode` and `:eoutvar` keyword arguments to `ERB.new`.'
@@ -1565,6 +1580,7 @@ Lint/ParenthesesAsGroupedExpression:
   StyleGuide: '#parens-no-spaces'
   Enabled: true
   VersionAdded: '0.12'
+  VersionChanged: '0.83'
 
 Lint/PercentStringArray:
   Description: >-
@@ -1808,7 +1824,7 @@ Lint/UselessAccessModifier:
   Description: 'Checks for useless access modifiers.'
   Enabled: true
   VersionAdded: '0.20'
-  VersionChanged: '0.47'
+  VersionChanged: '0.83'
   ContextCreatingMethods: []
   MethodCreatingMethods: []
 
@@ -2948,6 +2964,7 @@ Style/IfWithSemicolon:
   StyleGuide: '#no-semicolon-ifs'
   Enabled: true
   VersionAdded: '0.9'
+  VersionChanged: '0.83'
 
 Style/ImplicitRuntimeError:
   Description: >-
@@ -3425,7 +3442,9 @@ Style/OptionalArguments:
                  of the argument list.
   StyleGuide: '#optional-arguments'
   Enabled: true
+  Safe: false
   VersionAdded: '0.33'
+  VersionChanged: '0.83'
 
 Style/OrAssignment:
   Description: 'Recommend usage of double pipe equals (||=) where applicable.'
@@ -3730,6 +3749,12 @@ Style/SingleLineMethods:
   VersionChanged: '0.19'
   AllowIfMethodIsEmpty: true
 
+Style/SlicingWithRange:
+  Description: 'Checks array slicing is done with endless ranges when suitable.'
+  Enabled: pending
+  VersionAdded: '0.83'
+  Safe: false
+
 Style/SpecialGlobalVars:
   Description: 'Avoid Perl-style global variables.'
   StyleGuide: '#no-cryptic-perlisms'

data/lib/rubocop.rb

@@ -14,7 +14,6 @@ require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/path_util'
 require_relative 'rubocop/file_finder'
 require_relative 'rubocop/platform'
-require_relative 'rubocop/string_util'
 require_relative 'rubocop/name_similarity'
 require_relative 'rubocop/node_pattern'
 require_relative 'rubocop/string_interpreter'
@@ -213,6 +212,7 @@ require_relative 'rubocop/cop/layout/empty_line_after_magic_comment'
 require_relative 'rubocop/cop/layout/empty_line_between_defs'
 require_relative 'rubocop/cop/layout/empty_lines_around_access_modifier'
 require_relative 'rubocop/cop/layout/empty_lines_around_arguments'
+require_relative 'rubocop/cop/layout/empty_lines_around_attribute_accessor'
 require_relative 'rubocop/cop/layout/empty_lines_around_begin_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_block_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_class_body'
@@ -542,6 +542,7 @@ require_relative 'rubocop/cop/style/send'
 require_relative 'rubocop/cop/style/signal_exception'
 require_relative 'rubocop/cop/style/single_line_block_params'
 require_relative 'rubocop/cop/style/single_line_methods'
+require_relative 'rubocop/cop/style/slicing_with_range'
 require_relative 'rubocop/cop/style/special_global_vars'
 require_relative 'rubocop/cop/style/stabby_lambda_parentheses'
 require_relative 'rubocop/cop/style/stderr_puts'

data/lib/rubocop/ast/node/send_node.rb

@@ -8,6 +8,10 @@ module RuboCop
     class SendNode < Node
       include ParameterizedNode
       include MethodDispatchNode
+
+      def_node_matcher :attribute_accessor?, <<~PATTERN
+        (send nil? ${:attr_reader :attr_writer :attr_accessor :attr} $...)
+      PATTERN
     end
   end
 end

data/lib/rubocop/cli.rb

@@ -35,8 +35,8 @@ module RuboCop
       if @options[:init]
         run_command(:init)
       else
-        validate_options_vs_config
         act_on_options
+        validate_options_vs_config
         apply_default_formatter
         execute_runners
       end

data/lib/rubocop/config.rb

@@ -261,9 +261,13 @@ module RuboCop
 
     def enable_cop?(qualified_cop_name, cop_options)
       department = department_of(qualified_cop_name)
+      cop_enabled = cop_options.fetch('Enabled') do
+        !for_all_cops['DisabledByDefault']
+      end
+      return true if cop_enabled == 'override_department'
       return false if department && department['Enabled'] == false
 
-      cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
+      cop_enabled
     end
 
     def department_of(qualified_cop_name)

data/lib/rubocop/config_loader.rb

@@ -36,7 +36,7 @@ module RuboCop
         FileFinder.root_level = nil
       end
 
-      def load_file(file)
+      def load_file(file) # rubocop:disable Metrics/AbcSize
         path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
 
         hash = load_yaml_configuration(path)
@@ -46,6 +46,7 @@ module RuboCop
 
         add_missing_namespaces(path, hash)
 
+        resolver.override_department_setting_for_cops({}, hash)
         resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
 
@@ -132,9 +133,9 @@ module RuboCop
                      '`false` in your `.rubocop.yml` file:').yellow
 
         pending_cops.each do |cop|
-          warn Rainbow(
-            " - #{cop.name} (#{cop.metadata['VersionAdded']})"
-          ).yellow
+          version = cop.metadata['VersionAdded'] || 'N/A'
+
+          warn Rainbow(" - #{cop.name} (#{version})").yellow
         end
 
         warn Rainbow('For more information: https://docs.rubocop.org/en/latest/versioning/').yellow
@@ -217,7 +218,10 @@ module RuboCop
       end
 
       def load_yaml_configuration(absolute_path)
-        yaml_code = read_file(absolute_path)
+        file_contents = read_file(absolute_path)
+        yaml_code = Dir.chdir(File.dirname(absolute_path)) do
+          ERB.new(file_contents).result
+        end
         check_duplication(yaml_code, absolute_path)
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
@@ -241,8 +245,7 @@ module RuboCop
                       "#{smart_path}:#{line1}: " \
                       "`#{value}` is concealed by line #{line2}"
                     else
-                      "#{smart_path}: " \
-                        "`#{value}` is concealed by duplicate"
+                      "#{smart_path}: `#{value}` is concealed by duplicate"
                     end
           warn Rainbow(message).yellow
         end
@@ -263,13 +266,11 @@ module RuboCop
           SafeYAML.load(yaml_code, filename, whitelisted_tags: %w[!ruby/regexp])
         # Ruby 2.6+
         elsif Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
-          YAML.safe_load(
-            yaml_code,
-            permitted_classes: [Regexp, Symbol],
-            permitted_symbols: [],
-            aliases: true,
-            filename: filename
-          )
+          YAML.safe_load(yaml_code,
+                         permitted_classes: [Regexp, Symbol],
+                         permitted_symbols: [],
+                         aliases: true,
+                         filename: filename)
         else
           YAML.safe_load(yaml_code, [Regexp, Symbol], [], true, filename)
         end

data/lib/rubocop/config_loader_resolver.rb

@@ -17,10 +17,12 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def resolve_inheritance(path, hash, file, debug)
       inherited_files = Array(hash['inherit_from'])
       base_configs(path, inherited_files, file)
         .reverse.each_with_index do |base_config, index|
+        override_department_setting_for_cops(base_config, hash)
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
 
@@ -34,6 +36,7 @@ module RuboCop
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
@@ -100,8 +103,32 @@ module RuboCop
     end
     # rubocop:enable Metrics/AbcSize
 
+    # An `Enabled: true` setting in user configuration for a cop overrides an
+    # `Enabled: false` setting for its department.
+    def override_department_setting_for_cops(base_hash, derived_hash)
+      derived_hash.each_key do |key|
+        next unless key =~ %r{(.*)/.*}
+
+        department = Regexp.last_match(1)
+        next unless disabled?(derived_hash, department) ||
+                    disabled?(base_hash, department)
+
+        # The `override_department` setting for the `Enabled` parameter is an
+        # internal setting that's not documented in the manual. It will cause a
+        # cop to be enabled later, when logic surrounding enabled/disabled it
+        # run, even though its department is disabled.
+        if derived_hash[key]['Enabled']
+          derived_hash[key]['Enabled'] = 'override_department'
+        end
+      end
+    end
+
     private
 
+    def disabled?(hash, department)
+      hash[department] && hash[department]['Enabled'] == false
+    end
+
     def duplicate_setting?(base_hash, derived_hash, key, inherited_file)
       return false if inherited_file.nil? # Not inheritance resolving merge
       return false if inherited_file.start_with?('..') # Legitimate override

data/lib/rubocop/config_validator.rb

@@ -206,7 +206,8 @@ module RuboCop
                        SafeAutoCorrect
                        AutoCorrect].include?(key) && value.is_a?(String)
 
-        next if key == 'Enabled' && value == 'pending'
+        next if key == 'Enabled' &&
+                %w[pending override_department].include?(value)
 
         raise ValidationError, msg_not_boolean(parent, key, value)
       end

data/lib/rubocop/cop/generator.rb

@@ -132,11 +132,12 @@ module RuboCop
         ).inject
       end
 
-      def inject_config(config_file_path: 'config/default.yml')
+      def inject_config(config_file_path: 'config/default.yml',
+                        version_added: bump_minor_version)
         injector =
           ConfigurationInjector.new(configuration_file_path: config_file_path,
                                     badge: badge,
-                                    version_added: bump_minor_version)
+                                    version_added: version_added)
 
         injector.inject do
           output.puts(format(CONFIGURATION_ADDED_MESSAGE,

data/lib/rubocop/cop/layout/condition_position.rb

@@ -23,6 +23,8 @@ module RuboCop
       #     do_something
       #   end
       class ConditionPosition < Cop
+        include RangeHelp
+
         MSG = 'Place the condition on the same line as `%<keyword>s`.'
 
         def on_if(node)
@@ -34,9 +36,17 @@ module RuboCop
         def on_while(node)
           check(node)
         end
+        alias on_until on_while
 
-        def on_until(node)
-          check(node)
+        def autocorrect(node)
+          lambda do |corrector|
+            range = range_by_whole_lines(
+              node.source_range, include_final_newline: true
+            )
+
+            corrector.insert_after(node.parent.loc.keyword, " #{node.source}")
+            corrector.remove(range)
+          end
         end
 
         private

data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for a newline after attribute accessor.
+      #
+      # @example
+      #   # bad
+      #   attr_accessor :foo
+      #   def do_something
+      #   end
+      #
+      #   # good
+      #   attr_accessor :foo
+      #
+      #   def do_something
+      #   end
+      #
+      #   # good
+      #   attr_accessor :foo
+      #   attr_reader :bar
+      #   attr_writer :baz
+      #   attr :qux
+      #
+      #   def do_something
+      #   end
+      #
+      class EmptyLinesAroundAttributeAccessor < Cop
+        include RangeHelp
+
+        MSG = 'Add an empty line after attribute accessor.'
+
+        def on_send(node)
+          return unless node.attribute_accessor?
+          return if next_line_empty?(node.last_line)
+
+          next_line_node = next_line_node(node)
+          return if next_line_node.nil? || attribute_accessor?(next_line_node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            range = range_by_whole_lines(node.source_range)
+
+            corrector.insert_after(range, "\n")
+          end
+        end
+
+        private
+
+        def next_line_empty?(line)
+          processed_source[line].blank?
+        end
+
+        def next_line_node(node)
+          node.parent.children[node.sibling_index + 1]
+        end
+
+        def attribute_accessor?(node)
+          node.send_type? && node.attribute_accessor?
+        end
+      end
+    end
+  end
+end