rubocop 1.17.0 → 1.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f038acc03307acfc14ddf1dd971bf78978fac3401b4588b78b6bab4f4b7d8e13
-  data.tar.gz: 4f5da9053cce2f82b955f15d311d4b0d1f78396b2d49c8672c27d380804d5ba8
+  metadata.gz: ca5a85edf6c093ecee74e82617e0c618424e907cbb6a71fb1f996492073a98e4
+  data.tar.gz: 1ceb28336ce8913d79d4260000f5a86ca93190f5e36f6809d690aa20559674fa
 SHA512:
-  metadata.gz: 6c4b743259b607ed588066f260b69cfdfd03772cd89f533eaf80705e689005a771ef76cf29873d73c0e5f97e3b7b4be6e6080a5890a63ebb19150d951ae272e1
-  data.tar.gz: 7505601eb0e34cc563cb8b7efdec9b6340e709f6a29eec7a7b952f84386df60fe8912b8ebd0849d9ba59e22e7701b980276f8bd728330985d5fa9bdf99c2d9ad
+  metadata.gz: c020a6c2b13ad36e18afac1a2293f7c30fec5d2d62a36f5f7ffea8887816985ec27b94295fba1e08f9f1b7f462c8b4ca28a4949a32baadcea17e15ff4181b0e3
+  data.tar.gz: 06e9a6431dc25b8152b0b380d4de434409579fcb0b66da5335b434798889fd8f6d6a58064a044595b1a45b2bad7830e8045011c7e20e64f1337ccdd11a04e29c

data/README.md

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

data/config/default.yml

@@ -270,8 +270,8 @@ Layout/AccessModifierIndentation:
   SupportedStyles:
     - outdent
     - indent
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/ArgumentAlignment:
@@ -299,8 +299,8 @@ Layout/ArgumentAlignment:
   SupportedStyles:
     - with_first_argument
     - with_fixed_indentation
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/ArrayAlignment:
@@ -328,8 +328,8 @@ Layout/ArrayAlignment:
   SupportedStyles:
     - with_first_element
     - with_fixed_indentation
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/AssignmentIndentation:
@@ -339,8 +339,8 @@ Layout/AssignmentIndentation:
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '0.77'
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/BeginEndAlignment:
@@ -387,9 +387,9 @@ Layout/CaseIndentation:
     - case
     - end
   IndentOneStep: false
-  # By default, the indentation width from `Layout/IndentationWidth` is used.
-  # But it can be overridden by setting this parameter.
-  # This only matters if `IndentOneStep` is `true`
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
+  # This only matters if `IndentOneStep` is `true`.
   IndentationWidth: ~
 
 Layout/ClassStructure:
@@ -666,8 +666,8 @@ Layout/FirstArgumentIndentation:
     # Same as `special_for_inner_method_call` except that the special rule only
     # applies if the outer method call encloses its arguments in parentheses.
     - special_for_inner_method_call_in_parentheses
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/FirstArrayElementIndentation:
@@ -693,8 +693,8 @@ Layout/FirstArrayElementIndentation:
     - special_inside_parentheses
     - consistent
     - align_brackets
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/FirstArrayElementLineBreak:
@@ -725,8 +725,8 @@ Layout/FirstHashElementIndentation:
     - special_inside_parentheses
     - consistent
     - align_braces
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/FirstHashElementLineBreak:
@@ -761,8 +761,8 @@ Layout/FirstParameterIndentation:
   SupportedStyles:
     - consistent
     - align_parentheses
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/HashAlignment:
@@ -883,8 +883,8 @@ Layout/IndentationStyle:
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '0.82'
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   # It is used during auto-correction to determine how many spaces should
   # replace each tab.
   IndentationWidth: ~
@@ -923,6 +923,20 @@ Layout/LeadingEmptyLines:
   VersionAdded: '0.57'
   VersionChanged: '0.77'
 
+Layout/LineEndStringConcatenationIndentation:
+  Description: >-
+                 Checks the indentation of the next line after a line that
+                 ends with a string literal and a backslash.
+  Enabled: pending
+  VersionAdded: '1.18'
+  EnforcedStyle: aligned
+  SupportedStyles:
+    - aligned
+    - indented
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
+  IndentationWidth: ~
+
 Layout/LineLength:
   Description: 'Checks that line length does not exceed the configured limit.'
   StyleGuide: '#max-line-length'
@@ -1053,8 +1067,8 @@ Layout/MultilineMethodCallIndentation:
     - aligned
     - indented
     - indented_relative_to_receiver
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/MultilineMethodDefinitionBraceLayout:
@@ -1083,8 +1097,8 @@ Layout/MultilineOperationIndentation:
   SupportedStyles:
     - aligned
     - indented
-  # By default, the indentation width from `Layout/IndentationWidth` is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/ParameterAlignment:
@@ -1112,8 +1126,8 @@ Layout/ParameterAlignment:
   SupportedStyles:
     - with_first_parameter
     - with_fixed_indentation
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
+  # By default the indentation width from `Layout/IndentationWidth` is used,
+  # but it can be overridden by setting this parameter.
   IndentationWidth: ~
 
 Layout/RedundantLineBreak:
@@ -1795,7 +1809,7 @@ Lint/MissingCopEnableDirective:
 Lint/MissingSuper:
   Description: >-
                   This cop checks for the presence of constructors and lifecycle callbacks
-                  without calls to `super`'.
+                  without calls to `super`.
   Enabled: true
   VersionAdded: '0.89'
   VersionChanged: '1.4'
@@ -2520,6 +2534,31 @@ Naming/HeredocDelimiterNaming:
   ForbiddenDelimiters:
     - !ruby/regexp '/(^|\s)(EO[A-Z]{1}|END)(\s|$)/'
 
+Naming/InclusiveLanguage:
+  Description: 'Recommend the use of inclusive language instead of problematic terms.'
+  Enabled: pending
+  VersionAdded: '1.18'
+  CheckIdentifiers: true
+  CheckConstants: true
+  CheckVariables: true
+  CheckStrings: false
+  CheckSymbols: true
+  CheckComments: true
+  CheckFilepaths: true
+  FlaggedTerms:
+    whitelist:
+      Regex: !ruby/regexp '/white[-_\s]?list/'
+      Suggestions:
+        - allowlist
+        - permit
+    blacklist:
+      Regex: !ruby/regexp '/black[-_\s]?list/'
+      Suggestions:
+        - denylist
+        - block
+    slave:
+      Suggestions: ['replica', 'secondary', 'follower']
+
 Naming/MemoizedInstanceVariableName:
   Description: >-
     Memoized method name should match memo instance variable name.
@@ -3111,6 +3150,7 @@ Style/CommentAnnotation:
     - HACK
     - REVIEW
     - NOTE
+  RequireColon: true
 
 Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'
@@ -4576,7 +4616,8 @@ Style/StringConcatenation:
   Enabled: true
   Safe: false
   VersionAdded: '0.89'
-  VersionChanged: '1.6'
+  VersionChanged: '1.18'
+  Mode: aggressive
 
 Style/StringHashKeys:
   Description: 'Prefer symbols instead of strings as hash keys.'

data/lib/rubocop.rb

@@ -211,6 +211,7 @@ require_relative 'rubocop/cop/layout/indentation_width'
 require_relative 'rubocop/cop/layout/initial_indentation'
 require_relative 'rubocop/cop/layout/leading_comment_space'
 require_relative 'rubocop/cop/layout/leading_empty_lines'
+require_relative 'rubocop/cop/layout/line_end_string_concatenation_indentation'
 require_relative 'rubocop/cop/layout/line_length'
 require_relative 'rubocop/cop/layout/multiline_array_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_array_line_breaks'
@@ -400,6 +401,7 @@ require_relative 'rubocop/cop/naming/constant_name'
 require_relative 'rubocop/cop/naming/file_name'
 require_relative 'rubocop/cop/naming/heredoc_delimiter_case'
 require_relative 'rubocop/cop/naming/heredoc_delimiter_naming'
+require_relative 'rubocop/cop/naming/inclusive_language'
 require_relative 'rubocop/cop/naming/memoized_instance_variable_name'
 require_relative 'rubocop/cop/naming/method_name'
 require_relative 'rubocop/cop/naming/method_parameter_name'

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

@@ -19,7 +19,7 @@ module RuboCop
 
           puts
           puts 'Tip: Based on detected gems, the following '\
-            'RuboCop extension libraries might be helpful:'
+               'RuboCop extension libraries might be helpful:'
 
           extensions.sort.each do |extension|
             puts "  * #{extension} (https://github.com/rubocop/#{extension})"
@@ -27,8 +27,8 @@ module RuboCop
 
           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):'
+               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions '\
+               'for more options):'
           puts '  AllCops:'
           puts '    SuggestExtensions: false'
 

data/lib/rubocop/config_loader.rb

@@ -229,7 +229,7 @@ module RuboCop
                       line1 = key1.start_line + 1
                       line2 = key2.start_line + 1
                       "#{smart_path}:#{line1}: " \
-                      "`#{value}` is concealed by line #{line2}"
+                        "`#{value}` is concealed by line #{line2}"
                     else
                       "#{smart_path}: `#{value}` is concealed by duplicate"
                     end

data/lib/rubocop/config_loader_resolver.rb

@@ -23,7 +23,7 @@ module RuboCop
     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|
+        .each_with_index.reverse_each do |base_config, index|
         override_department_setting_for_cops(base_config, hash)
         override_enabled_for_disabled_departments(base_config, hash)
 

data/lib/rubocop/config_validator.rb

@@ -81,11 +81,11 @@ module RuboCop
 
       msg = if last_version
               "RuboCop found unsupported Ruby version #{target_ruby_version} " \
-              "in #{source}. #{target_ruby_version}-compatible " \
-              "analysis was dropped after version #{last_version}."
+                "in #{source}. #{target_ruby_version}-compatible " \
+                "analysis was dropped after version #{last_version}."
             else
               'RuboCop found unknown Ruby version ' \
-              "#{target_ruby_version.inspect} in #{source}."
+                "#{target_ruby_version.inspect} in #{source}."
             end
 
       msg += "\nSupported versions: #{TargetRuby.supported_versions.join(', ')}"
@@ -104,12 +104,9 @@ module RuboCop
         # to do so than to pass the value around to various methods.
         next if name == 'inherit_mode'
 
-        suggestions = NameSimilarity.find_similar_names(name, Cop::Registry.global.map(&:cop_name))
-        suggestion = "Did you mean `#{suggestions.join('`, `')}`?" if suggestions.any?
-
         message = <<~MESSAGE.rstrip
-          unrecognized cop #{name} found in #{smart_loaded_path}
-          #{suggestion}
+          unrecognized cop or department #{name} found in #{smart_loaded_path}
+          #{suggestion(name)}
         MESSAGE
 
         unknown_cops << message
@@ -117,6 +114,22 @@ module RuboCop
       raise ValidationError, unknown_cops.join("\n") if unknown_cops.any?
     end
 
+    def suggestion(name)
+      registry = Cop::Registry.global
+      departments = registry.departments.map(&:to_s)
+      suggestions = NameSimilarity.find_similar_names(name, departments + registry.map(&:cop_name))
+      if suggestions.any?
+        "Did you mean `#{suggestions.join('`, `')}`?"
+      else
+        # Department names can contain slashes, e.g. Chef/Correctness, but there's no support for
+        # the concept of higher level departments in RuboCop. It's a flat structure. So if the user
+        # tries to configure a "top level department", we hint that it's the bottom level
+        # departments that should be configured.
+        suggestions = departments.select { |department| department.start_with?("#{name}/") }
+        "#{name} is not a department. Use `#{suggestions.join('`, `')}`." if suggestions.any?
+      end
+    end
+
     def validate_syntax_cop
       syntax_config = @config['Lint/Syntax']
       default_config = ConfigLoader.default_configuration['Lint/Syntax']
@@ -179,8 +192,8 @@ module RuboCop
           next if validate_support_and_has_list(name, style, valid)
 
           msg = "invalid #{style_name} '#{style}' for #{name} found in " \
-            "#{smart_loaded_path}\n" \
-            "Valid choices are: #{valid.join(', ')}"
+                "#{smart_loaded_path}\n" \
+                "Valid choices are: #{valid.join(', ')}"
           raise ValidationError, msg
         end
       end

data/lib/rubocop/cop/base.rb

@@ -261,7 +261,7 @@ module RuboCop
       # @deprecated Make potential errors with previous API more obvious
       def offenses
         raise 'The offenses are not directly available; ' \
-          'they are returned as the result of the investigation'
+              'they are returned as the result of the investigation'
       end
 
       ### Reserved for Commissioner
@@ -441,7 +441,7 @@ module RuboCop
           severity.to_sym
         else
           message = "Warning: Invalid severity '#{severity}'. " \
-            "Valid severities are #{Severity::NAMES.join(', ')}."
+                    "Valid severities are #{Severity::NAMES.join(', ')}."
           warn(Rainbow(message).red)
         end
       end

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -39,7 +39,7 @@ module RuboCop
         include RangeHelp
 
         MSG = 'Gem `%<gem_name>s` requirements already given on line '\
-          '%<line_of_first_occurrence>d of the Gemfile.'
+              '%<line_of_first_occurrence>d of the Gemfile.'
 
         def on_new_investigation
           return if processed_source.blank?

data/lib/rubocop/cop/bundler/gem_version.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Bundler
-      # Enforce that Gem version specifications are either required
-      # or forbidden.
+      # Enforce that Gem version specifications or a commit reference (branch,
+      # ref, or tag) are either required or forbidden.
       #
       # @example EnforcedStyle: required (default)
       #  # bad
@@ -19,6 +19,15 @@ module RuboCop
       #  # good
       #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
       #
+      #  # good
+      #  gem 'rubocop', branch: 'feature-branch'
+      #
+      #  # good
+      #  gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+      #
+      #  # good
+      #  gem 'rubocop', tag: 'v1.17.0'
+      #
       # @example EnforcedStyle: forbidden
       #  # good
       #  gem 'rubocop'
@@ -32,6 +41,15 @@ module RuboCop
       #  # bad
       #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
       #
+      #  # bad
+      #  gem 'rubocop', branch: 'feature-branch'
+      #
+      #  # bad
+      #  gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+      #
+      #  # bad
+      #  gem 'rubocop', tag: 'v1.17.0'
+      #
       class GemVersion < Base
         include ConfigurableEnforcedStyle
         include GemDeclaration
@@ -45,6 +63,11 @@ module RuboCop
           (send nil? :gem <(str #version_specification?) ...>)
         PATTERN
 
+        # @!method includes_commit_reference?(node)
+        def_node_matcher :includes_commit_reference?, <<~PATTERN
+          (send nil? :gem <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
+        PATTERN
+
         def on_send(node)
           return unless gem_declaration?(node)
           return if allowed_gem?(node)
@@ -78,8 +101,19 @@ module RuboCop
         end
 
         def offense?(node)
-          (required_style? && !includes_version_specification?(node)) ||
-            (forbidden_style? && includes_version_specification?(node))
+          required_offense?(node) || forbidden_offense?(node)
+        end
+
+        def required_offense?(node)
+          return unless required_style?
+
+          !includes_version_specification?(node) && !includes_commit_reference?(node)
+        end
+
+        def forbidden_offense?(node)
+          return unless forbidden_style?
+
+          includes_version_specification?(node) || includes_commit_reference?(node)
         end
 
         def forbidden_style?