rubocop 1.23.0 → 1.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf11fe2d8f8be8879d6afc63d6f3be50b970c7910c83f1d22847d1fc9654d4aa
-  data.tar.gz: fd4c7ef3838a286efe3d1729672cc7a0e72f47cfb4c8d815699d53d2a974a372
+  metadata.gz: 54b88752efa8bb84dc034391460b9071f31179dcb279550a209d31829e7b8c93
+  data.tar.gz: 31115cff5fdbf562dee62cf7e07033205d150b61ac5fd11476708f21e67000cf
 SHA512:
-  metadata.gz: 4014183525b58378a0e628ae5136d17c148a41c6c25dd51eddc810ca08fbd89d652f6c715b58eef149005af1145469936416864869b6e63a4c9e521627ab1cb4
-  data.tar.gz: 6e0e2a9a9d6fae829b73bd49814965a28d447207aaf7d1dda073f34130343557df965c77cc998d6ddb0d59eca09f1307d6ca56cbd3fcade575ca52950d1a56d3
+  metadata.gz: acdaf069659a775853b20e05734e85cd65c0c8734b09e568d4360dc9a7440a49ec8e47928b0da78866e1326a588638d18f2564e6e94023bb17b2f39493555027
+  data.tar.gz: 2765d9c9c10966c485be6cd70190b69a25aa99800c8d483bd67c1fdfe3dc5d13bb97cb1ca7f9f663776869acda5a426bc797f3b40adda17e0241ff8b62a374f1

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.23', require: false
+gem 'rubocop', '~> 1.25', 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.
@@ -428,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.'
@@ -449,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: >-
@@ -1796,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: >-
@@ -1892,7 +1900,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
@@ -2479,6 +2487,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,
@@ -3134,7 +3153,7 @@ Style/ClassMethodsDefinitions:
   StyleGuide: '#def-self-class-methods'
   Enabled: false
   VersionAdded: '0.89'
-  EnforcedStyle:  def_self
+  EnforcedStyle: def_self
   SupportedStyles:
     - def_self
     - self_class
@@ -3492,6 +3511,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'
@@ -3650,7 +3681,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
@@ -3661,6 +3692,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
@@ -3775,8 +3815,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:
@@ -3837,6 +3877,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'
@@ -4205,6 +4251,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: >-

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

@@ -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/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/require_mfa.rb

@@ -6,18 +6,18 @@ module RuboCop
       # Requires a gemspec to have `rubygems_mfa_required` metadata set.
       #
       # This setting tells RubyGems that MFA is required for accounts to
-      # be able perform any of these privileged operations:
+      # be able perform privileged operations, such as (see
+      # RubyGems' documentation for the full list of privileged operations):
       #
-      # * gem push
-      # * gem yank
-      # * gem owner --add/remove
+      # * `gem push`
+      # * `gem yank`
+      # * `gem owner --add/remove`
       # * adding or removing owners using gem ownership page
       #
       # This helps make your gem more secure, as users can be more
       # confident that gem updates were pushed by maintainers.
       #
       # @example
-      #
       #   # bad
       #   Gem::Specification.new do |spec|
       #     # no `rubygems_mfa_required` metadata specified
@@ -117,7 +117,7 @@ module RuboCop
 
             correct_metadata(corrector, metadata)
           else
-            correct_missing_metadata(corrector, node, block_var)
+            insert_mfa_required(corrector, node, block_var)
           end
         end
 
@@ -129,11 +129,9 @@ module RuboCop
           end
         end
 
-        def correct_missing_metadata(corrector, node, block_var)
+        def insert_mfa_required(corrector, node, block_var)
           corrector.insert_before(node.loc.end, <<~RUBY)
-            #{block_var}.metadata = {
-              'rubygems_mfa_required' => 'true'
-            }
+            #{block_var}.metadata['rubygems_mfa_required'] = 'true'
           RUBY
         end
 

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

@@ -68,8 +68,11 @@ module RuboCop
 
         # @!method defined_ruby_version(node)
         def_node_matcher :defined_ruby_version, <<~PATTERN
-          {$(str _) $(array (str _) (str _))
-            (send (const (const nil? :Gem) :Requirement) :new $(str _))}
+          {
+            $(str _)
+            $(array (str _) (str _))
+            (send (const (const nil? :Gem) :Requirement) :new $str+)
+          }
         PATTERN
 
         def on_new_investigation
@@ -97,7 +100,11 @@ module RuboCop
         def extract_ruby_version(required_ruby_version)
           return unless required_ruby_version
 
-          if required_ruby_version.array_type?
+          if required_ruby_version.is_a?(Array)
+            required_ruby_version = required_ruby_version.detect do |v|
+              /[>=]/.match?(v.str_content)
+            end
+          elsif required_ruby_version.array_type?
             required_ruby_version = required_ruby_version.children.detect do |v|
               /[>=]/.match?(v.str_content)
             end

data/lib/rubocop/cop/generator.rb

@@ -182,7 +182,8 @@ module RuboCop
       end
 
       def generate(template)
-        format(template, department: badge.department, cop_name: badge.cop_name)
+        format(template, department: badge.department.to_s.gsub('/', '::'),
+                         cop_name: badge.cop_name)
       end
 
       def spec_path
@@ -209,8 +210,8 @@ module RuboCop
         return 'rspec' if camel_case_string == 'RSpec'
 
         camel_case_string
-          .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
-          .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
+          .gsub(%r{([^A-Z/])([A-Z]+)}, '\1_\2')
+          .gsub(%r{([A-Z])([A-Z][^A-Z\d/]+)}, '\1_\2')
           .downcase
       end
     end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks for redundant `send_node` method dispatch node.
+      #
+      # @example
+      #
+      #   # bad
+      #   node.send_node.method_name
+      #
+      #   # good
+      #   node.method_name
+      #
+      #   # bad
+      #   node.send_node.receiver
+      #
+      #   # good
+      #   node.receiver
+      #
+      class RedundantMethodDispatchNode < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Remove the redundant `send_node`.'
+        RESTRICT_ON_SEND = %i[method_name receiver].freeze
+
+        # @!method dispatch_method(node)
+        def_node_matcher :dispatch_method, <<~PATTERN
+          (send $(send _ :send_node) _)
+        PATTERN
+
+        def on_send(node)
+          return unless (dispatch_node = dispatch_method(node))
+          return unless (dot = dispatch_node.loc.dot)
+
+          range = range_between(dot.begin_pos, dispatch_node.loc.selector.end_pos)
+
+          add_offense(range) do |corrector|
+            corrector.remove(range)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,9 @@ module RuboCop
 
         # @!method cop_class_def(node)
         def_node_search :cop_class_def, <<~PATTERN
-          (class _ (const _ {:Base :Cop}) ...)
+          (class _
+            (const {nil? (const nil? :Cop) (const (const {cbase nil?} :RuboCop) :Cop)}
+              {:Base :Cop}) ...)
         PATTERN
 
         # @!method cop_config_accessor?(node)

data/lib/rubocop/cop/internal_affairs.rb

@@ -13,6 +13,7 @@ require_relative 'internal_affairs/redundant_described_class_as_subject'
 require_relative 'internal_affairs/redundant_let_rubocop_config_new'
 require_relative 'internal_affairs/redundant_location_argument'
 require_relative 'internal_affairs/redundant_message_argument'
+require_relative 'internal_affairs/redundant_method_dispatch_node'
 require_relative 'internal_affairs/style_detected_api_use'
 require_relative 'internal_affairs/undefined_config'
 require_relative 'internal_affairs/useless_message_assertion'

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

@@ -53,23 +53,50 @@ module RuboCop
                            'following the first line of a multi-line method call.'
 
         def on_send(node)
-          first_arg = node.first_argument
-          return if !multiple_arguments?(node, first_arg) || (node.send_type? && node.method?(:[]=))
+          return if !multiple_arguments?(node) || (node.send_type? && node.method?(:[]=))
 
-          if first_arg.hash_type? && !first_arg.braces?
-            pairs = first_arg.pairs
-            check_alignment(pairs, base_column(node, pairs.first))
-          else
-            check_alignment(node.arguments, base_column(node, first_arg))
-          end
+          items = flattened_arguments(node)
+
+          check_alignment(items, base_column(node, items.first))
         end
+
         alias on_csend on_send
 
         private
 
-        def multiple_arguments?(node, first_argument)
+        def flattened_arguments(node)
+          if fixed_indentation?
+            arguments_with_last_arg_pairs(node)
+          else
+            arguments_or_first_arg_pairs(node)
+          end
+        end
+
+        def arguments_with_last_arg_pairs(node)
+          items = node.arguments[0..-2]
+          last_arg = node.arguments.last
+
+          if last_arg.hash_type? && !last_arg.braces?
+            items += last_arg.pairs
+          else
+            items << last_arg
+          end
+          items
+        end
+
+        def arguments_or_first_arg_pairs(node)
+          first_arg = node.first_argument
+          if first_arg.hash_type? && !first_arg.braces?
+            first_arg.pairs
+          else
+            node.arguments
+          end
+        end
+
+        def multiple_arguments?(node)
           return true if node.arguments.size >= 2
 
+          first_argument = node.first_argument
           first_argument&.hash_type? && first_argument.pairs.count >= 2
         end