rubocop 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e78bdb76ac54d034e71f715292180a9982c1c08096fd8546c52f8786b703bd
-  data.tar.gz: e94b644cff4449332cd0be3dda1e41d2911f3bfd88fb14862534c0e29736a374
+  metadata.gz: fe0d2cef28b14b92436ce28d483594398761fe11474f23e2577630e4c74d877d
+  data.tar.gz: 4c06f9d71ffc6b08ad14e9fbb574bcca19cfccc231c36aee75f23c7753643893
 SHA512:
-  metadata.gz: 54d96669e8524f0fc27ccc4ed75c44c2ce6c143298ed26affe5739eff1dd3aa9f24d0278e9df8e764c6ceb53b7f868764df783ccfd51d8a9bd633623124e150c
-  data.tar.gz: f6516450c7473cf56f6d330da24fd2b73827a07603ecda6bba672c470ae7490e97071a118d168f4288e37792289e97cb4503362915e9daa0ce1c79bd1d0def28
+  metadata.gz: a395e4004802da434ac704d5aec675b16637d464edc7d9305ec03c739a8d85f57f59d19f31187e93c7f37e9bcd7df6ec0b92df951de8e4508b169637cc7fb190
+  data.tar.gz: bac84ae15f62dafabde785bb46bf9e67d4554979fc09a431ee949b61ae03edac8897a6a914f153667eb6abdf803e73efe0a117c691d36d3ff73599ca3b41a13c

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.6', require: false
+gem 'rubocop', '~> 1.7', require: false
 ```
 
 See [versioning](https://docs.rubocop.org/rubocop/1.0/versioning.html) for further details.

data/config/default.yml

@@ -473,7 +473,7 @@ Layout/EmptyLineBetweenDefs:
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
-  VersionChanged: '1.4'
+  VersionChanged: '1.7'
   EmptyLineBetweenMethodDefs: true
   EmptyLineBetweenClassDefs: true
   EmptyLineBetweenModuleDefs: true
@@ -1192,6 +1192,13 @@ Layout/SpaceBeforeBlockBraces:
     - no_space
   VersionChanged: '0.52'
 
+Layout/SpaceBeforeBrackets:
+  Description: 'Checks for receiver with a space before the opening brackets.'
+  StyleGuide: '#space-in-brackets-access'
+  Enabled: pending
+  VersionAdded: '1.7'
+  Safe: false
+
 Layout/SpaceBeforeComma:
   Description: 'No spaces before commas.'
   Enabled: true
@@ -1354,6 +1361,11 @@ Layout/TrailingWhitespace:
 #################### Lint ##################################
 ### Warnings
 
+Lint/AmbiguousAssignment:
+  Description: 'Checks for mistyped shorthand assignments.'
+  Enabled: pending
+  VersionAdded: '1.7'
+
 Lint/AmbiguousBlockAssociation:
   Description: >-
                  Checks for ambiguous block association with method when param passed without
@@ -1396,6 +1408,7 @@ Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
   Safe: false
   VersionAdded: '0.89'
+  VersionChanged: '1.7'
 
 Lint/BooleanSymbol:
   Description: 'Check for `:true` and `:false` symbols.'
@@ -1472,6 +1485,9 @@ Lint/DuplicateBranch:
   Description: Checks that there are no repeated bodies within `if/unless`, `case-when` and `rescue` constructs.
   Enabled: pending
   VersionAdded: '1.3'
+  VersionChanged: '1.7'
+  IgnoreLiteralBranches: false
+  IgnoreConstantBranches: false
 
 Lint/DuplicateCaseCondition:
   Description: 'Do not repeat values in case conditionals.'
@@ -1842,6 +1858,8 @@ Lint/RedundantSplatExpansion:
   Description: 'Checks for splat unnecessarily being called on literals.'
   Enabled: true
   VersionAdded: '0.76'
+  VersionChanged: '1.7'
+  AllowPercentLiteralArrayArgument: true
 
 Lint/RedundantStringCoercion:
   Description: 'Checks for Object#to_s usage in string interpolation.'
@@ -2045,6 +2063,11 @@ Lint/UnreachableLoop:
   Description: 'This cop checks for loops that will have at most one iteration.'
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.7'
+  IgnoredPatterns:
+    # RSpec uses `times` in its message expectations
+    # eg. `exactly(2).times`
+    - !ruby/regexp /(exactly|at_least|at_most)\(\d+\)\.times/
 
 Lint/UnusedBlockArgument:
   Description: 'Checks for unused block arguments.'
@@ -2895,7 +2918,7 @@ Style/CollectionMethods:
   StyleGuide: '#map-find-select-reduce-include-size'
   Enabled: false
   VersionAdded: '0.9'
-  VersionChanged: '0.27'
+  VersionChanged: '1.7'
   Safe: false
   # Mapping from undesired method to desired method
   # e.g. to use `detect` over `find`:
@@ -2910,6 +2933,11 @@ Style/CollectionMethods:
     detect: 'find'
     find_all: 'select'
     member?: 'include?'
+  # Methods in this array accept a final symbol as an implicit block
+  # eg. `inject(:+)`
+  MethodsAcceptingSymbol:
+    - inject
+    - reduce
 
 Style/ColonMethodCall:
   Description: 'Do not use :: for method call.'
@@ -2969,6 +2997,7 @@ Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'
   Enabled: true
   VersionAdded: '0.51'
+  VersionChanged: '1.7'
 
 Style/ConditionalAssignment:
   Description: >-
@@ -3328,6 +3357,13 @@ Style/HashEachMethods:
   VersionAdded: '0.80'
   Safe: false
 
+Style/HashExcept:
+  Description: >-
+                 Checks for usages of `Hash#reject`, `Hash#select`, and `Hash#filter` methods
+                 that can be replaced with `Hash#except` method.
+  Enabled: pending
+  VersionAdded: '1.7'
+
 Style/HashLikeCase:
   Description: >-
                   Checks for places where `case-when` represents a simple 1:1
@@ -3482,6 +3518,7 @@ Style/KeywordParametersOrder:
   StyleGuide: '#keyword-parameters-order'
   Enabled: true
   VersionAdded: '0.90'
+  VersionChanged: '1.7'
 
 Style/Lambda:
   Description: 'Use the new lambda literal syntax for single-line blocks.'
@@ -3520,7 +3557,7 @@ Style/MethodCallWithArgsParentheses:
   StyleGuide: '#method-invocation-parens'
   Enabled: false
   VersionAdded: '0.47'
-  VersionChanged: '0.61'
+  VersionChanged: '1.7'
   IgnoreMacros: true
   IgnoredMethods: []
   IgnoredPatterns: []
@@ -3554,7 +3591,7 @@ Style/MethodDefParentheses:
   StyleGuide: '#method-parens'
   Enabled: true
   VersionAdded: '0.16'
-  VersionChanged: '0.35'
+  VersionChanged: '1.7'
   EnforcedStyle: require_parentheses
   SupportedStyles:
     - require_parentheses
@@ -3660,6 +3697,7 @@ Style/MultilineMethodSignature:
   Description: 'Avoid multi-line method signatures.'
   Enabled: false
   VersionAdded: '0.59'
+  VersionChanged: '1.7'
 
 Style/MultilineTernaryOperator:
   Description: >-
@@ -4026,12 +4064,16 @@ Style/RedundantArgument:
   Enabled: pending
   Safe: false
   VersionAdded: '1.4'
-  VersionChanged: '1.6'
+  VersionChanged: '1.7'
   Methods:
     # Array#join
     join: ''
     # String#split
     split: ' '
+    # String#chomp
+    chomp: "\n"
+    # String#chomp!
+    chomp!: "\n"
 
 Style/RedundantAssignment:
   Description: 'Checks for redundant assignment before returning.'
@@ -4288,7 +4330,7 @@ Style/SingleLineMethods:
   StyleGuide: '#no-single-line-methods'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.19'
+  VersionChanged: '1.7'
   AllowIfMethodIsEmpty: true
 
 Style/SlicingWithRange:

data/lib/rubocop.rb

@@ -28,6 +28,7 @@ require_relative 'rubocop/name_similarity'
 require_relative 'rubocop/string_interpreter'
 require_relative 'rubocop/error'
 require_relative 'rubocop/warning'
+require_relative 'rubocop/util'
 
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
@@ -230,6 +231,7 @@ require_relative 'rubocop/cop/layout/space_around_keyword'
 require_relative 'rubocop/cop/layout/space_around_method_call_operator'
 require_relative 'rubocop/cop/layout/space_around_operators'
 require_relative 'rubocop/cop/layout/space_before_block_braces'
+require_relative 'rubocop/cop/layout/space_before_brackets'
 require_relative 'rubocop/cop/layout/space_before_comma'
 require_relative 'rubocop/cop/layout/space_before_comment'
 require_relative 'rubocop/cop/layout/space_before_first_arg'
@@ -247,6 +249,7 @@ require_relative 'rubocop/cop/layout/space_inside_string_interpolation'
 require_relative 'rubocop/cop/layout/trailing_empty_lines'
 require_relative 'rubocop/cop/layout/trailing_whitespace'
 
+require_relative 'rubocop/cop/lint/ambiguous_assignment'
 require_relative 'rubocop/cop/lint/ambiguous_block_association'
 require_relative 'rubocop/cop/lint/ambiguous_operator'
 require_relative 'rubocop/cop/lint/ambiguous_regexp_literal'
@@ -460,6 +463,7 @@ require_relative 'rubocop/cop/style/global_vars'
 require_relative 'rubocop/cop/style/guard_clause'
 require_relative 'rubocop/cop/style/hash_as_last_array_item'
 require_relative 'rubocop/cop/style/hash_each_methods'
+require_relative 'rubocop/cop/style/hash_except'
 require_relative 'rubocop/cop/style/hash_like_case'
 require_relative 'rubocop/cop/style/hash_syntax'
 require_relative 'rubocop/cop/style/hash_transform_keys'

data/lib/rubocop/config.rb

@@ -50,8 +50,8 @@ module RuboCop
       self
     end
 
-    def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :fetch, :map, :merge, :to_h, :to_hash, :transform_values
+    def_delegators :@hash, :[], :[]=, :delete, :dig, :each, :key?, :keys, :each_key,
+                   :fetch, :map, :merge, :replace, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -281,6 +281,9 @@ module RuboCop
     end
 
     def enable_cop?(qualified_cop_name, cop_options)
+      # If the cop is explicitly enabled, the other checks can be skipped.
+      return true if cop_options['Enabled'] == true
+
       department = department_of(qualified_cop_name)
       cop_enabled = cop_options.fetch('Enabled') do
         !for_all_cops['DisabledByDefault']
@@ -292,10 +295,10 @@ module RuboCop
     end
 
     def department_of(qualified_cop_name)
-      cop_department, cop_name = qualified_cop_name.split('/')
-      return nil if cop_name.nil?
+      *cop_department, _ = qualified_cop_name.split('/')
+      return nil if cop_department.empty?
 
-      self[cop_department]
+      self[cop_department.join('/')]
     end
   end
 end

data/lib/rubocop/config_loader.rb

@@ -31,6 +31,7 @@ module RuboCop
 
       def clear_options
         @debug = nil
+        @loaded_features = []
         FileFinder.root_level = nil
       end
 
@@ -177,12 +178,9 @@ module RuboCop
         @loaded_features.flatten.compact
       end
 
-      private
-
-      def file_path(file)
-        File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
-      end
-
+      # @api private
+      # Used to add features that were required inside a config or from
+      # the CLI using `--require`.
       def add_loaded_features(loaded_features)
         if instance_variable_defined?(:@loaded_features)
           instance_variable_get(:@loaded_features) << loaded_features
@@ -191,6 +189,12 @@ module RuboCop
         end
       end
 
+      private
+
+      def file_path(file)
+        File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
+      end
+
       def find_project_dotfile(target_dir)
         find_file_upwards(DOTFILE, target_dir, project_root)
       end

data/lib/rubocop/config_loader_resolver.rb

@@ -20,12 +20,13 @@ module RuboCop
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def resolve_inheritance(path, hash, file, debug)
+    def resolve_inheritance(path, hash, file, debug) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       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)
+        override_enabled_for_disabled_departments(base_config, hash)
+
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
 
@@ -39,7 +40,6 @@ module RuboCop
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
@@ -75,6 +75,7 @@ module RuboCop
       end
 
       config = handle_disabled_by_default(config, default_configuration) if disabled_by_default
+      override_enabled_for_disabled_departments(default_configuration, config)
 
       opts = { inherit_mode: config['inherit_mode'] || {},
                unset_nil: unset_nil }
@@ -122,10 +123,26 @@ module RuboCop
       end
     end
 
+    # If a cop was previously explicitly enabled, but then superseded by the
+    # department being disabled, disable it.
+    def override_enabled_for_disabled_departments(base_hash, derived_hash)
+      cops_to_disable = derived_hash.each_key.with_object([]) do |key, cops|
+        next unless disabled?(derived_hash, key)
+
+        cops.concat(base_hash.keys.grep(Regexp.new("^#{key}/")))
+      end
+
+      cops_to_disable.each do |cop_name|
+        next unless base_hash.dig(cop_name, 'Enabled') == true
+
+        derived_hash.replace(merge({ cop_name => { 'Enabled' => false } }, derived_hash))
+      end
+    end
+
     private
 
     def disabled?(hash, department)
-      hash[department] && hash[department]['Enabled'] == false
+      hash[department].is_a?(Hash) && hash[department]['Enabled'] == false
     end
 
     def duplicate_setting?(base_hash, derived_hash, key, inherited_file)

data/lib/rubocop/config_obsoletion.rb

@@ -63,9 +63,11 @@ module RuboCop
     # 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
+        data.map do |cop_name, configuration|
+          next unless configuration # allow configurations to be disabled with `CopName: ~`
+
+          COP_RULE_CLASSES[rule_type].new(@config, cop_name, configuration)
+        end.compact
       end
     end
 

data/lib/rubocop/cop/gemspec/required_ruby_version.rb

@@ -36,12 +36,13 @@ module RuboCop
       #     spec.required_ruby_version = '>= 2.5'
       #   end
       #
-      #   # good
+      #   # accepted but not recommended
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = ['>= 2.5.0', '< 2.7.0']
       #   end
       #
-      #   # good
+      #   # accepted but not recommended, since
+      #   # Ruby does not really follow semantic versionning
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '~> 2.5'
       #   end

data/lib/rubocop/cop/internal_affairs.rb

@@ -6,4 +6,5 @@ require_relative 'internal_affairs/node_type_predicate'
 require_relative 'internal_affairs/offense_location_keyword'
 require_relative 'internal_affairs/redundant_message_argument'
 require_relative 'internal_affairs/redundant_location_argument'
+require_relative 'internal_affairs/style_detected_api_use'
 require_relative 'internal_affairs/useless_message_assertion'

data/lib/rubocop/cop/internal_affairs/style_detected_api_use.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks for correct use of the style_detected API provided by
+      # `ConfigurableEnforcedStyle`. If `correct_style_detected` is used
+      # then `opposite_style_detected`, `unexpected_style_detected`,
+      # `ambiguous_style_detected`, `conflicting_styles_detected`,
+      # `unrecognized_style_detected` or `no_acceptable_style!` should be
+      # used too, and vice versa.  The `xxx_style_detected` methods
+      # should not be used as predicates either.
+      #
+      # @example
+      #
+      #   # bad
+      #   def on_send(node)
+      #     return add_offense(node) if opposite_style_detected
+      #
+      #     correct_style_detected
+      #   end
+      #
+      #   def on_send(node)
+      #     if offense?
+      #       add_offense(node)
+      #     else
+      #       correct_style_detected
+      #     end
+      #   end
+      #
+      #   def on_send(node)
+      #     return unless offense?
+      #
+      #     add_offense(node)
+      #     opposite_style_detected
+      #   end
+      #
+      #   # good
+      #   def on_send(node)
+      #     if offense?
+      #       add_offense(node)
+      #       opposite_style_detected
+      #     else
+      #       correct_style_detected
+      #     end
+      #   end
+      #
+      #   def on_send(node)
+      #     add_offense(node) if offense?
+      #   end
+      #
+      class StyleDetectedApiUse < Base
+        include RangeHelp
+
+        MSG_FOR_POSITIVE_WITHOUT_NEGATIVE =
+          '`correct_style_detected` method called without ' \
+          'calling a negative `*_style_detected` method.'
+        MSG_FOR_NEGATIVE_WITHOUT_POSITIVE =
+          'negative `*_style_detected` methods called without ' \
+          'calling `correct_style_detected` method.'
+        MSG_FOR_CONDITIONAL_USE =
+          '`*_style_detected` method called in conditional.'
+        RESTRICT_ON_SEND = %i[
+          correct_style_detected opposite_style_detected
+          unexpected_style_detected ambiguous_style_detected
+          conflicting_styles_detected unrecognized_style_detected
+          no_acceptable_style! style_detected
+        ].freeze
+
+        def_node_matcher :correct_style_detected_check, <<~PATTERN
+          (send nil? :correct_style_detected)
+        PATTERN
+
+        def_node_matcher :negative_style_detected_method_check, <<~PATTERN
+          (send nil? /(?:opposite|unexpected|ambiguous|unrecognized)_style_detected|conflicting_styles_detected/ ...)
+        PATTERN
+
+        def_node_matcher :no_acceptable_style_check, <<~PATTERN
+          (send nil? :no_acceptable_style!)
+        PATTERN
+
+        def_node_matcher :style_detected_check, <<~PATTERN
+          (send nil? :style_detected ...)
+        PATTERN
+
+        def on_new_investigation
+          @correct_style_detected_called = false
+          @negative_style_detected_methods_called = false
+          @style_detected_called = false
+        end
+
+        def on_investigation_end
+          return if style_detected_called
+          return unless correct_style_detected_called ^ negative_style_detected_methods_called
+
+          add_global_offense(MSG_FOR_POSITIVE_WITHOUT_NEGATIVE) if positive_without_negative?
+          add_global_offense(MSG_FOR_NEGATIVE_WITHOUT_POSITIVE) if negative_without_positive?
+        end
+
+        def on_send(node)
+          if correct_style_detected_check(node)
+            @correct_style_detected_called = true
+          elsif negative_style_detected_method_check(node) || no_acceptable_style_check(node)
+            @negative_style_detected_methods_called = true
+          elsif style_detected_check(node)
+            @style_detected_called = true
+          end
+        end
+
+        def on_if(node)
+          traverse_condition(node.condition) do |cond|
+            add_offense(cond, message: MSG_FOR_CONDITIONAL_USE) if style_detected_api_used?(cond)
+          end
+        end
+
+        private
+
+        attr_reader :correct_style_detected_called,
+                    :negative_style_detected_methods_called,
+                    :style_detected_called
+
+        def positive_without_negative?
+          correct_style_detected_called && !negative_style_detected_methods_called
+        end
+
+        def negative_without_positive?
+          negative_style_detected_methods_called && !correct_style_detected_called
+        end
+
+        def style_detected_api_used?(node)
+          correct_style_detected_check(node) ||
+            negative_style_detected_method_check(node) ||
+            no_acceptable_style_check(node) ||
+            style_detected_check(node)
+        end
+
+        def traverse_condition(condition, &block)
+          yield condition if condition.send_type?
+
+          condition.each_child_node { |child| traverse_condition(child, &block) }
+        end
+      end
+    end
+  end
+end