rubocop 1.22.3 → 1.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74b024d0339618cd4782bd451e3bbe8be65eab0a5f3dbfc1d2137c74848c6fa
-  data.tar.gz: ef762c615b2d68f52d5aac425abea13a40d097f1b7885cd1558a991dd23c136d
+  metadata.gz: 10e6b8905d81b2204fd3d0bf60d3278cd902d0cefc2ed387bf2c317062b46034
+  data.tar.gz: f27011464d465728f1fa470c85c4779c2b148b3cdc872247c5a25d421f269076
 SHA512:
-  metadata.gz: bfdba4bbc01e69d2a0873272815dc9c03d5e95f2dce5f02186b38f2f9e1e28ae34df246e6b548cdccf0831bace4f02bfad334f59548b2bf67430431b5760731b
-  data.tar.gz: 662e06452c13b66a949e7a8035bc6b4b31e7af7a3cf161b9802634365a53a0b2452aeb7741ab13387186483cdf9027dc5cca736734d5d3022f78362bfabf9a5c
+  metadata.gz: 215ee2bb6f0699fdedcd82c7795c40e2350c33fdfbd48117dbb2fdcaa957bcbff9a65ad9c95b9666d4b9c70d6a2e2d8b6ec6904c3c3f01cbbfa8fee2319c9518
+  data.tar.gz: 0b33b7c3aecf2b7482e19cdbf1a94a56f21d3cb14035c68c62ce0572385edb34a59faa1ea5fb21d9504b04e18f797b0419c6ade76ff70604311b9f899e28b39d

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-21 Bozhidar Batsov
+Copyright (c) 2012-22 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,7 +9,6 @@
 [![Actions Status](https://github.com/rubocop/rubocop/workflows/CI/badge.svg?branch=master)](https://github.com/rubocop/rubocop/actions?query=workflow%3ACI)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/test_coverage)](https://codeclimate.com/github/rubocop/rubocop/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/maintainability)](https://codeclimate.com/github/rubocop/rubocop/maintainability)
-[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)
 [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/wJjWvGRDmm)
 
 > Role models are important. <br/>
@@ -54,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.22', require: false
+gem 'rubocop', '~> 1.26', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -245,5 +244,5 @@ RuboCop's changelog is available [here](CHANGELOG.md).
 
 ## Copyright
 
-Copyright (c) 2012-2021 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
+Copyright (c) 2012-2022 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
 further details.

data/config/default.yml

@@ -78,6 +78,8 @@ AllCops:
   # When specifying style guide URLs, any paths and/or fragments will be
   # evaluated relative to the base URL.
   StyleGuideBaseURL: https://rubystyle.guide
+  # Documentation URLs will be constructed using the base URL.
+  DocumentationBaseURL: https://docs.rubocop.org/rubocop
   # Extra details are not displayed in offense messages by default. Change
   # behavior by overriding ExtraDetails, or by giving the
   # `-E/--extra-details` option.
@@ -150,6 +152,7 @@ AllCops:
     rubocop-minitest: [minitest]
     rubocop-sequel: [sequel]
     rubocop-rake: [rake]
+    rubocop-graphql: [graphql]
 
 #################### Bundler ###############################
 
@@ -258,6 +261,15 @@ Gemspec/OrderedDependencies:
   Include:
     - '**/*.gemspec'
 
+Gemspec/RequireMFA:
+  Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
+  Enabled: pending
+  VersionAdded: '1.23'
+  Reference:
+    - https://guides.rubygems.org/mfa-requirement-opt-in/
+  Include:
+    - '**/*.gemspec'
+
 Gemspec/RequiredRubyVersion:
   Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
   Enabled: true
@@ -418,13 +430,13 @@ Layout/ClassStructure:
       - prepend
       - extend
   ExpectedOrder:
-      - module_inclusion
-      - constants
-      - public_class_methods
-      - initializer
-      - public_methods
-      - protected_methods
-      - private_methods
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
 
 Layout/ClosingHeredocIndentation:
   Description: 'Checks the indentation of here document closings.'
@@ -439,7 +451,11 @@ Layout/ClosingParenthesisIndentation:
 Layout/CommentIndentation:
   Description: 'Indentation of comments.'
   Enabled: true
+  # When true, allows comments to have extra indentation if that aligns them
+  # with a comment on the preceding line.
+  AllowForAlignment: false
   VersionAdded: '0.49'
+  VersionChanged: '1.24'
 
 Layout/ConditionPosition:
   Description: >-
@@ -511,13 +527,13 @@ Layout/EmptyLineBetweenDefs:
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
-  VersionChanged: '1.7'
+  VersionChanged: '1.23'
   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
+  # `AllowAdjacentOneLineDefs` means that single line method definitions don't
+  # need an empty line between them. `true` by default.
+  AllowAdjacentOneLineDefs: true
   # Can be array to specify minimum and maximum number of empty lines, e.g. [1, 2]
   NumberOfEmptyLines: 1
 
@@ -1786,7 +1802,9 @@ Lint/ImplicitStringConcatenation:
 Lint/IncompatibleIoSelectWithFiberScheduler:
   Description: 'Checks for `IO.select` that is incompatible with Fiber Scheduler.'
   Enabled: pending
+  SafeAutoCorrect: false
   VersionAdded: '1.21'
+  VersionChanged: '1.24'
 
 Lint/IneffectiveAccessModifier:
   Description: >-
@@ -1798,12 +1816,14 @@ Lint/IneffectiveAccessModifier:
 Lint/InheritException:
   Description: 'Avoid inheriting from the `Exception` class.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.41'
+  VersionChanged: '1.26'
   # The default base class in favour of `Exception`.
-  EnforcedStyle: runtime_error
+  EnforcedStyle: standard_error
   SupportedStyles:
-    - runtime_error
     - standard_error
+    - runtime_error
 
 Lint/InterpolationCheck:
   Description: 'Raise warning for interpolation in single q strs.'
@@ -1882,7 +1902,7 @@ Lint/NestedPercentLiteral:
   VersionAdded: '0.52'
 
 Lint/NextWithoutAccumulator:
-  Description:  >-
+  Description: >-
                   Do not omit the accumulator when calling `next`
                   in a `reduce`/`inject` block.
   Enabled: true
@@ -1993,6 +2013,8 @@ Lint/RedundantDirGlobSort:
   Description: 'Checks for redundant `sort` method to `Dir.glob` and `Dir[]`.'
   Enabled: pending
   VersionAdded: '1.8'
+  VersionChanged: '1.26'
+  SafeAutoCorrect: false
 
 Lint/RedundantRequireStatement:
   Description: 'Checks for unnecessary `require` statement.'
@@ -2308,6 +2330,11 @@ Lint/UselessMethodDefinition:
   Safe: false
   AllowComments: true
 
+Lint/UselessRuby2Keywords:
+  Description: 'Finds unnecessary uses of `ruby2_keywords`.'
+  Enabled: pending
+  VersionAdded: '1.23'
+
 Lint/UselessSetterCall:
   Description: 'Checks for useless setter call to a local variable.'
   Enabled: true
@@ -2464,6 +2491,17 @@ Naming/BinaryOperatorParameterName:
   VersionAdded: '0.50'
   VersionChanged: '1.2'
 
+Naming/BlockForwarding:
+  Description: 'Use anonymous block forwarding.'
+  StyleGuide: '#block-forwarding'
+  Enabled: pending
+  VersionAdded: '1.24'
+  EnforcedStyle: anonymous
+  SupportedStyles:
+    - anonymous
+    - explicit
+  BlockForwardingName: block
+
 Naming/BlockParameterName:
   Description: >-
                  Checks for block parameter names that contain capital letters,
@@ -2501,6 +2539,7 @@ Naming/FileName:
   StyleGuide: '#snake-case-files'
   Enabled: true
   VersionAdded: '0.50'
+  VersionChanged: '1.23'
   # Camel case file names listed in `AllCops:Include` and all file names listed
   # in `AllCops:Exclude` are excluded by default. Add extra excludes here.
   Exclude: []
@@ -2513,6 +2552,13 @@ Naming/FileName:
   # whether each source file's class or module name matches the file name --
   # not whether the nested module hierarchy matches the subdirectory path.
   CheckDefinitionPathHierarchy: true
+  # paths that are considered root directories, for example "lib" in most ruby projects
+  # or "app/models" in rails projects
+  CheckDefinitionPathHierarchyRoots:
+    - lib
+    - spec
+    - test
+    - src
   # If non-`nil`, expect all source file names to match the following regex.
   # Only the file name itself is matched, not the entire file path.
   # Use anchors as necessary if you want to match the entire name rather than
@@ -3111,7 +3157,7 @@ Style/ClassMethodsDefinitions:
   StyleGuide: '#def-self-class-methods'
   Enabled: false
   VersionAdded: '0.89'
-  EnforcedStyle:  def_self
+  EnforcedStyle: def_self
   SupportedStyles:
     - def_self
     - self_class
@@ -3469,6 +3515,18 @@ Style/ExponentialNotation:
     - engineering
     - integral
 
+Style/FileRead:
+  Description: 'Favor `File.(bin)read` convenience methods.'
+  StyleGuide: '#file-read'
+  Enabled: pending
+  VersionAdded: '1.24'
+
+Style/FileWrite:
+  Description: 'Favor `File.(bin)write` convenience methods.'
+  StyleGuide: '#file-write'
+  Enabled: pending
+  VersionAdded: '1.24'
+
 Style/FloatDivision:
   Description: 'For performing float division, coerce one side only.'
   StyleGuide: '#float-division'
@@ -3488,8 +3546,9 @@ Style/For:
   Description: 'Checks use of for or each in multiline loops.'
   StyleGuide: '#no-for-loops'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.13'
-  VersionChanged: '0.59'
+  VersionChanged: '1.26'
   EnforcedStyle: each
   SupportedStyles:
     - each
@@ -3627,7 +3686,7 @@ Style/HashSyntax:
   StyleGuide: '#hash-literals'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.43'
+  VersionChanged: '1.24'
   EnforcedStyle: ruby19
   SupportedStyles:
     # checks for 1.9 syntax (e.g. {a: 1}) for all symbol keys
@@ -3638,6 +3697,15 @@ Style/HashSyntax:
     - no_mixed_keys
     # enforces both ruby19 and no_mixed_keys styles
     - ruby19_no_mixed_keys
+  # Force hashes that have a hash value omission
+  EnforcedShorthandSyntax: always
+  SupportedShorthandSyntax:
+    # forces use of the 3.1 syntax (e.g. {foo:}) when the hash key and value are the same.
+    - always
+    # forces use of explicit hash literal value.
+    - never
+    # accepts both shorthand and explicit use of hash literal value.
+    - either
   # Force hashes that have a symbol value to use hash rockets
   UseHashRocketsWithSymbolValues: false
   # Do not suggest { a?: 1 } over { :a? => 1 } in ruby19 style
@@ -3752,8 +3820,8 @@ Style/InverseMethods:
     :>: :<=
     # `ActiveSupport` defines some common inverse methods. They are listed below,
     # and not enabled by default.
-    #:present?: :blank?,
-    #:include?: :exclude?
+    # :present?: :blank?,
+    # :include?: :exclude?
   # `InverseBlocks` are methods that are inverted by inverting the return
   # of the block that is passed to the method
   InverseBlocks:
@@ -3814,6 +3882,12 @@ Style/LineEndConcatenation:
   VersionAdded: '0.18'
   VersionChanged: '0.64'
 
+Style/MapToHash:
+  Description: 'Prefer `to_h` with a block over `map.to_h`.'
+  Enabled: pending
+  VersionAdded: '1.24'
+  Safe: false
+
 Style/MethodCallWithArgsParentheses:
   Description: 'Use parentheses for method calls with arguments.'
   StyleGuide: '#method-invocation-parens'
@@ -4053,6 +4127,11 @@ Style/NegatedWhile:
   Enabled: true
   VersionAdded: '0.20'
 
+Style/NestedFileDirname:
+  Description: 'Checks for nested `File.dirname`.'
+  Enabled: pending
+  VersionAdded: '1.26'
+
 Style/NestedModifier:
   Description: 'Avoid using nested modifiers.'
   StyleGuide: '#no-nested-modifiers'
@@ -4182,6 +4261,8 @@ Style/NumericLiterals:
   VersionChanged: '0.48'
   MinDigits: 5
   Strict: false
+  # You can specify allowed numbers. (e.g. port number 3000, 8080, and etc)
+  AllowedNumbers: []
 
 Style/NumericPredicate:
   Description: >-
@@ -4216,6 +4297,16 @@ Style/OneLineConditional:
   VersionAdded: '0.9'
   VersionChanged: '0.90'
 
+Style/OpenStructUse:
+  Description: >-
+                 Avoid using OpenStruct. As of Ruby 3.0, use is officially discouraged due to performance,
+                 version compatibility, and potential security issues.
+  Reference:
+    - https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats
+
+  Enabled: pending
+  VersionAdded: '1.23'
+
 Style/OptionHash:
   Description: "Don't use option hashes when you can use keyword arguments."
   Enabled: false

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

@@ -124,7 +124,7 @@ module RuboCop
           lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
           doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
           lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
-          File.open(file_name, 'w') { |f| f.write lines.join("\n") }
+          File.write(file_name, lines.join("\n"))
         end
       end
     end

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

@@ -31,7 +31,7 @@ module RuboCop
               # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
-            File.open(DOTFILE, 'w') { |f| f.write(description) }
+            File.write(DOTFILE, description)
 
             puts "Writing new #{DOTFILE} to #{path}"
 

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Prints out url to documentation of provided cops
+      # or documentation base url by default.
+      # @api private
+      class ShowDocsUrl < Base
+        self.command_name = :show_docs_url
+
+        def initialize(env)
+          super
+
+          @config = @config_store.for(Dir.pwd)
+        end
+
+        def run
+          print_documentation_url
+        end
+
+        private
+
+        def print_documentation_url
+          puts Cop::Documentation.default_base_url if cops_array.empty?
+
+          cops_array.each do |cop_name|
+            cop = registry_hash[cop_name]
+
+            next if cop.empty?
+
+            puts Cop::Documentation.url_for(cop.first, @config)
+          end
+
+          puts
+        end
+
+        def cops_array
+          @cops_array ||= @options[:show_docs_url]
+        end
+
+        def registry_hash
+          @registry_hash ||= Cop::Registry.global.to_h
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module RuboCop
                'RuboCop extension libraries might be helpful:'
 
           extensions.sort.each do |extension|
-            puts "  * #{extension} (https://github.com/rubocop/#{extension})"
+            puts "  * #{extension} (https://rubygems.org/gems/#{extension})"
           end
 
           puts

data/lib/rubocop/cli.rb

@@ -14,7 +14,7 @@ module RuboCop
       ignore_disable_comments lint only only_guide_cops require safe
     ].freeze
 
-    class Finished < RuntimeError; end
+    class Finished < StandardError; end
 
     attr_reader :options, :config_store
 
@@ -131,6 +131,7 @@ module RuboCop
 
       run_command(:version) if @options[:version] || @options[:verbose_version]
       run_command(:show_cops) if @options[:show_cops]
+      run_command(:show_docs_url) if @options[:show_docs_url]
       raise Finished
     end
 

data/lib/rubocop/config_loader_resolver.rb

@@ -74,7 +74,7 @@ module RuboCop
     # Merges the given configuration with the default one. If
     # AllCops:DisabledByDefault is true, it changes the Enabled params so that
     # only cops from user configuration are enabled. If
-    # AllCops::EnabledByDefault is true, it changes the Enabled params so that
+    # AllCops:EnabledByDefault is true, it changes the Enabled params so that
     # only cops explicitly disabled in user configuration are disabled.
     def merge_with_default(config, config_file, unset_nil:)
       default_configuration = ConfigLoader.default_configuration

data/lib/rubocop/cop/badge.rb

@@ -19,7 +19,13 @@ module RuboCop
       end
 
       def self.parse(identifier)
-        new(identifier.split('/'))
+        new(identifier.split('/').map { |i| camel_case(i) })
+      end
+
+      def self.camel_case(name_part)
+        return 'RSpec' if name_part == 'rspec'
+
+        name_part.gsub(/^\w|_\w/) { |match| match[-1, 1].upcase }
       end
 
       def initialize(class_name_parts)

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

@@ -68,7 +68,7 @@ module RuboCop
         end
 
         def conditional_declaration?(nodes)
-          parent = nodes[0].parent
+          parent = nodes[0].each_ancestor.find { |ancestor| !ancestor.begin_type? }
           return false unless parent&.if_type? || parent&.when_type?
 
           root_conditional_node = parent.if_type? ? parent : parent.parent

data/lib/rubocop/cop/correctors/each_to_for_corrector.rb

@@ -11,7 +11,7 @@ module RuboCop
 
       def initialize(block_node)
         @block_node = block_node
-        @collection_node = block_node.send_node.receiver
+        @collection_node = block_node.receiver
         @argument_node = block_node.arguments
       end
 

data/lib/rubocop/cop/correctors/if_then_corrector.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This class auto-corrects `if...then` structures to a multiline `if` statement
+    class IfThenCorrector
+      DEFAULT_INDENTATION_WIDTH = 2
+
+      def initialize(if_node, indentation: nil)
+        @if_node = if_node
+        @indentation = indentation || DEFAULT_INDENTATION_WIDTH
+      end
+
+      def call(corrector)
+        corrector.replace(if_node, replacement)
+      end
+
+      private
+
+      attr_reader :if_node, :indentation
+
+      def replacement(node = if_node, indentation = nil)
+        indentation = ' ' * node.source_range.column if indentation.nil?
+        if_branch_source = node.if_branch&.source || 'nil'
+        elsif_indentation = indentation if node.respond_to?(:elsif?) && node.elsif?
+
+        if_branch = <<~RUBY
+          #{elsif_indentation}#{node.keyword} #{node.condition.source}
+          #{indentation}#{branch_body_indentation}#{if_branch_source}
+        RUBY
+
+        else_branch = rewrite_else_branch(node.else_branch, indentation)
+        if_branch + else_branch
+      end
+
+      def rewrite_else_branch(else_branch, indentation)
+        if else_branch.nil?
+          'end'
+        elsif else_branch.if_type? && else_branch.elsif?
+          replacement(else_branch, indentation)
+        else
+          <<~RUBY.chomp
+            #{indentation}else
+            #{indentation}#{branch_body_indentation}#{else_branch.source}
+            #{indentation}end
+          RUBY
+        end
+      end
+
+      def branch_body_indentation
+        @branch_body_indentation ||= (' ' * indentation).freeze
+      end
+    end
+  end
+end

data/lib/rubocop/cop/documentation.rb

@@ -12,10 +12,27 @@ module RuboCop
       end
 
       # @api private
-      def url_for(cop_class)
+      def url_for(cop_class, config = nil)
         base = department_to_basename(cop_class.department)
         fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
-        "https://docs.rubocop.org/rubocop/#{base}.html##{fragment}"
+        base_url = base_url_for(cop_class, config)
+
+        "#{base_url}/#{base}.html##{fragment}"
+      end
+
+      # @api private
+      def base_url_for(cop_class, config)
+        return default_base_url unless config
+
+        department_name = cop_class.department.to_s
+
+        config.for_department(department_name)['DocumentationBaseURL'] ||
+          config.for_all_cops['DocumentationBaseURL']
+      end
+
+      # @api private
+      def default_base_url
+        'https://docs.rubocop.org/rubocop'
       end
     end
   end

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

@@ -21,21 +21,13 @@ module RuboCop
       #
       class DateAssignment < Base
         include RangeHelp
+        include GemspecHelp
         extend AutoCorrector
 
         MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.'
 
-        # @!method gem_specification(node)
-        def_node_matcher :gem_specification, <<~PATTERN
-          (block
-            (send
-              (const
-                (const {cbase nil?} :Gem) :Specification) :new)
-            ...)
-        PATTERN
-
         def on_block(block_node)
-          return unless gem_specification(block_node)
+          return unless gem_specification?(block_node)
 
           block_parameter = block_node.arguments.first.source
 

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

@@ -36,20 +36,11 @@ module RuboCop
       #   end
       class DuplicatedAssignment < Base
         include RangeHelp
+        include GemspecHelp
 
         MSG = '`%<assignment>s` method calls already given on line '\
               '%<line_of_first_occurrence>d of the gemspec.'
 
-        # @!method gem_specification(node)
-        def_node_search :gem_specification, <<~PATTERN
-          (block
-            (send
-              (const
-                (const {cbase nil?} :Gem) :Specification) :new)
-            (args
-              (arg $_)) ...)
-        PATTERN
-
         # @!method assignment_method_declarations(node)
         def_node_search :assignment_method_declarations, <<~PATTERN
           (send