rubocop 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08520f6dcf324dcb95ce7191673f070e86c3b5c2613942d19e4c951119a43476'
-  data.tar.gz: 90fd28bb4692e3feb9973d0b711a181c90608b205741b4b68cc23df9a9d42142
+  metadata.gz: cf11fe2d8f8be8879d6afc63d6f3be50b970c7910c83f1d22847d1fc9654d4aa
+  data.tar.gz: fd4c7ef3838a286efe3d1729672cc7a0e72f47cfb4c8d815699d53d2a974a372
 SHA512:
-  metadata.gz: 27a14f94b096be10618d7670ff591f4443ab4e09d8fce7f2604e686a1f7ab5544aaf53136c09a6ec62198f9f56950b5ab0c3cea64ee0ccd565e328b7ba131a5d
-  data.tar.gz: 419cf3d94cf235cf31b09d26cbed550937dcb1930797e3e28c97cfb27116b160732aeec5434de8e0c3417f6900bf795c1826d7941e49cf8f12e9a15c245472b4
+  metadata.gz: 4014183525b58378a0e628ae5136d17c148a41c6c25dd51eddc810ca08fbd89d652f6c715b58eef149005af1145469936416864869b6e63a4c9e521627ab1cb4
+  data.tar.gz: 6e0e2a9a9d6fae829b73bd49814965a28d447207aaf7d1dda073f34130343557df965c77cc998d6ddb0d59eca09f1307d6ca56cbd3fcade575ca52950d1a56d3

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

data/config/default.yml

@@ -150,6 +150,7 @@ AllCops:
     rubocop-minitest: [minitest]
     rubocop-sequel: [sequel]
     rubocop-rake: [rake]
+    rubocop-graphql: [graphql]
 
 #################### Bundler ###############################
 
@@ -258,11 +259,20 @@ Gemspec/OrderedDependencies:
   Include:
     - '**/*.gemspec'
 
+Gemspec/RequireMFA:
+  Description: 'Checks that the gemspec has metadata to require MFA 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
   VersionAdded: '0.52'
-  VersionChanged: '0.89'
+  VersionChanged: '1.22'
   Include:
     - '**/*.gemspec'
 
@@ -511,13 +521,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
 
@@ -1568,6 +1578,7 @@ Lint/DeprecatedConstants:
   Description: 'Checks for deprecated constants.'
   Enabled: pending
   VersionAdded: '1.8'
+  VersionChanged: '1.22'
   # You can configure deprecated constants.
   # If there is an alternative method, you can set alternative value as `Alternative`.
   # And you can set the deprecated version as `DeprecatedVersion`.
@@ -1588,6 +1599,9 @@ Lint/DeprecatedConstants:
     'FALSE':
       Alternative: 'false'
       DeprecatedVersion: '2.4'
+    'Net::HTTPServerException':
+      Alternative: 'Net::HTTPClientException'
+      DeprecatedVersion: '2.6'
     'Random::DEFAULT':
       Alternative: 'Random.new'
       DeprecatedVersion: '3.0'
@@ -2304,6 +2318,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
@@ -2497,6 +2516,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: []
@@ -2509,6 +2529,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
@@ -2754,10 +2781,9 @@ Security/JSONLoad:
   Reference: 'https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html#method-i-load'
   Enabled: true
   VersionAdded: '0.43'
-  VersionChanged: '0.44'
+  VersionChanged: '1.22'
   # Autocorrect here will change to a method that may cause crashes depending
   # on the value of the argument.
-  AutoCorrect: false
   SafeAutoCorrect: false
 
 Security/MarshalLoad:
@@ -4213,6 +4239,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/config_loader.rb

@@ -136,7 +136,7 @@ module RuboCop
         end
       end
 
-      # Returns the path rubocop inferred as the root of the project. No file
+      # Returns the path RuboCop inferred as the root of the project. No file
       # searches will go past this directory.
       def project_root
         @project_root ||= find_project_root

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

@@ -88,7 +88,7 @@ module RuboCop
         CHECKED_OPTIONS_CONFIG = 'OnlyFor'
         VERSION_SPECIFIERS_OPTION = 'version_specifiers'
         RESTRICTIVE_VERSION_SPECIFIERS_OPTION = 'restrictive_version_specifiers'
-        RESTRICTIVE_VERSION_PATTERN = /<|~>/.freeze
+        RESTRICTIVE_VERSION_PATTERN = /\A\s*(?:<|~>|\d|=)/.freeze
         RESTRICT_ON_SEND = %i[gem].freeze
 
         def on_send(node)
@@ -152,8 +152,8 @@ module RuboCop
         def restrictive_version_specified_gem?(node)
           return unless version_specified_gem?(node)
 
-          node.arguments
-              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.to_s) }
+          node.arguments[1..-1]
+              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.value) }
         end
 
         def contains_checked_options?(node)

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

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

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # 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:
+      #
+      # * 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
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'true'
+      #     }
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'true'
+      #   end
+      #
+      #  # bad
+      #  Gem::Specification.new do |spec|
+      #    spec.metadata = {
+      #      'rubygems_mfa_required' => 'false'
+      #    }
+      #  end
+      #
+      #  # good
+      #  Gem::Specification.new do |spec|
+      #    spec.metadata = {
+      #      'rubygems_mfa_required' => 'true'
+      #    }
+      #  end
+      #
+      #  # bad
+      #  Gem::Specification.new do |spec|
+      #    spec.metadata['rubygems_mfa_required'] = 'false'
+      #  end
+      #
+      #  # good
+      #  Gem::Specification.new do |spec|
+      #    spec.metadata['rubygems_mfa_required'] = 'true'
+      #  end
+      #
+      class RequireMFA < Base
+        include GemspecHelp
+        extend AutoCorrector
+
+        MSG = "`metadata['rubygems_mfa_required']` must be set to `'true'`."
+
+        # @!method metadata(node)
+        def_node_matcher :metadata, <<~PATTERN
+          `{
+            (send _ :metadata= $_)
+            (send (send _ :metadata) :[]= (str "rubygems_mfa_required") $_)
+          }
+        PATTERN
+
+        # @!method rubygems_mfa_required(node)
+        def_node_search :rubygems_mfa_required, <<~PATTERN
+          (pair (str "rubygems_mfa_required") $_)
+        PATTERN
+
+        # @!method true_string?(node)
+        def_node_matcher :true_string?, <<~PATTERN
+          (str "true")
+        PATTERN
+
+        def on_block(node) # rubocop:disable Metrics/MethodLength
+          gem_specification(node) do |block_var|
+            metadata_value = metadata(node)
+            mfa_value = mfa_value(metadata_value)
+
+            if mfa_value
+              unless true_string?(mfa_value)
+                add_offense(mfa_value) do |corrector|
+                  change_value(corrector, mfa_value)
+                end
+              end
+            else
+              add_offense(node) do |corrector|
+                autocorrect(corrector, node, block_var, metadata_value)
+              end
+            end
+          end
+        end
+
+        private
+
+        def mfa_value(metadata_value)
+          return unless metadata_value
+          return metadata_value if metadata_value.str_type?
+
+          rubygems_mfa_required(metadata_value).first
+        end
+
+        def autocorrect(corrector, node, block_var, metadata)
+          if metadata
+            return unless metadata.hash_type?
+
+            correct_metadata(corrector, metadata)
+          else
+            correct_missing_metadata(corrector, node, block_var)
+          end
+        end
+
+        def correct_metadata(corrector, metadata)
+          if metadata.pairs.any?
+            corrector.insert_after(metadata.pairs.last, ",\n'rubygems_mfa_required' => 'true'")
+          else
+            corrector.insert_before(metadata.loc.end, "'rubygems_mfa_required' => 'true'")
+          end
+        end
+
+        def correct_missing_metadata(corrector, node, block_var)
+          corrector.insert_before(node.loc.end, <<~RUBY)
+            #{block_var}.metadata = {
+              'rubygems_mfa_required' => 'true'
+            }
+          RUBY
+        end
+
+        def change_value(corrector, value)
+          corrector.replace(value, "'true'")
+        end
+      end
+    end
+  end
+end

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

@@ -3,10 +3,11 @@
 module RuboCop
   module Cop
     module Gemspec
-      # Checks that `required_ruby_version` of gemspec is specified and
-      # equal to `TargetRubyVersion` of .rubocop.yml.
-      # Thereby, RuboCop to perform static analysis working on the version
-      # required by gemspec.
+      # Checks that `required_ruby_version` in a gemspec file is set to a valid
+      # value (non-blank) and matches `TargetRubyVersion` as set in RuboCop's
+      # configuration for the gem.
+      #
+      # This ensures that RuboCop is using the same Ruby version as the gem.
       #
       # @example
       #   # When `TargetRubyVersion` of .rubocop.yml is `2.5`.
@@ -26,6 +27,11 @@ module RuboCop
       #     spec.required_ruby_version = '>= 2.6.0'
       #   end
       #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.required_ruby_version = ''
+      #   end
+      #
       #   # good
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '>= 2.5.0'
@@ -49,15 +55,15 @@ module RuboCop
       class RequiredRubyVersion < Base
         include RangeHelp
 
-        NOT_EQUAL_MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
-                        'declared in %<gemspec_filename>s) and `TargetRubyVersion` ' \
+        RESTRICT_ON_SEND = %i[required_ruby_version=].freeze
+        NOT_EQUAL_MSG = '`required_ruby_version` and `TargetRubyVersion` ' \
                         '(%<target_ruby_version>s, which may be specified in ' \
                         '.rubocop.yml) should be equal.'
         MISSING_MSG = '`required_ruby_version` should be specified.'
 
-        # @!method required_ruby_version(node)
-        def_node_search :required_ruby_version, <<~PATTERN
-          (send _ :required_ruby_version= $_)
+        # @!method required_ruby_version?(node)
+        def_node_search :required_ruby_version?, <<~PATTERN
+          (send _ :required_ruby_version= _)
         PATTERN
 
         # @!method defined_ruby_version(node)
@@ -66,27 +72,28 @@ module RuboCop
             (send (const (const nil? :Gem) :Requirement) :new $(str _))}
         PATTERN
 
-        # rubocop:disable Metrics/AbcSize
         def on_new_investigation
-          version_def = required_ruby_version(processed_source.ast).first
+          add_global_offense(MISSING_MSG) unless required_ruby_version?(processed_source.ast)
+        end
 
-          if version_def
-            ruby_version = extract_ruby_version(defined_ruby_version(version_def))
-            return if !ruby_version || ruby_version == target_ruby_version.to_s
+        def on_send(node)
+          version_def = node.first_argument
+          return if dynamic_version?(version_def)
 
-            add_offense(
-              version_def.loc.expression,
-              message: not_equal_message(ruby_version, target_ruby_version)
-            )
-          else
-            range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, message: MISSING_MSG)
-          end
+          ruby_version = extract_ruby_version(defined_ruby_version(version_def))
+          return if ruby_version == target_ruby_version.to_s
+
+          add_offense(version_def, message: not_equal_message(ruby_version, target_ruby_version))
         end
-        # rubocop:enable Metrics/AbcSize
 
         private
 
+        def dynamic_version?(node)
+          (node.send_type? && !node.receiver) ||
+            node.variable? ||
+            node.each_descendant(:send, *RuboCop::AST::Node::VARIABLES).any?
+        end
+
         def extract_ruby_version(required_ruby_version)
           return unless required_ruby_version
 

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

@@ -26,20 +26,13 @@ module RuboCop
       #   end
       #
       class RubyVersionGlobalsUsage < Base
+        include GemspecHelp
+
         MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
 
         # @!method ruby_version?(node)
         def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'
 
-        # @!method gem_specification?(node)
-        def_node_search :gem_specification?, <<~PATTERN
-          (block
-            (send
-              (const
-                (const {cbase nil?} :Gem) :Specification) :new)
-            ...)
-        PATTERN
-
         def on_const(node)
           return unless gem_spec_with_ruby_version?(node)
 
@@ -49,7 +42,7 @@ module RuboCop
         private
 
         def gem_spec_with_ruby_version?(node)
-          gem_specification?(processed_source.ast) && ruby_version?(node)
+          gem_specification(processed_source.ast) && ruby_version?(node)
         end
       end
     end

data/lib/rubocop/cop/generator.rb

@@ -150,7 +150,7 @@ module RuboCop
             1. Modify the description of #{badge} in config/default.yml
             2. Implement your new cop in the generated file!
             3. Commit your new cop with a message such as
-               e.g. "Add new `#{badge}` cop."
+               e.g. "Add new `#{badge}` cop"
             4. Run `bundle exec rake changelog:new` to generate a changelog entry
                for your new cop.
         TODO

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # This cop enforces the use of `same_line?` instead of location line comparison for equality.
+      #
+      # @example
+      #   # bad
+      #   node.loc.line == node.parent.loc.line
+      #
+      #   # bad
+      #   node.loc.first_line == node.parent.loc.first_line
+      #
+      #   # good
+      #   same_line?(node, node.parent)
+      #
+      class LocationLineEqualityComparison < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<preferred>s`.'
+
+        # @!method line_send(node)
+        def_node_matcher :line_send, <<~PATTERN
+          {
+            (send (send _ {:loc :source_range}) {:line :first_line})
+            (send _ :first_line)
+          }
+        PATTERN
+
+        # @!method location_line_equality_comparison?(node)
+        def_node_matcher :location_line_equality_comparison?, <<~PATTERN
+          (send #line_send :== #line_send)
+        PATTERN
+
+        def on_send(node)
+          return unless location_line_equality_comparison?(node)
+
+          lhs, _op, rhs = *node
+
+          lhs_receiver = extract_receiver(lhs)
+          rhs_receiver = extract_receiver(rhs)
+          preferred = "same_line?(#{lhs_receiver}, #{rhs_receiver})"
+
+          add_offense(node, message: format(MSG, preferred: preferred)) do |corrector|
+            corrector.replace(node, preferred)
+          end
+        end
+
+        private
+
+        def extract_receiver(node)
+          receiver = node.receiver
+          receiver = receiver.receiver if receiver.method?(:loc) || receiver.method?(:source_range)
+          receiver.source
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs.rb

@@ -3,6 +3,7 @@
 require_relative 'internal_affairs/empty_line_between_expect_offense_and_correction'
 require_relative 'internal_affairs/example_description'
 require_relative 'internal_affairs/inherit_deprecated_cop_class'
+require_relative 'internal_affairs/location_line_equality_comparison'
 require_relative 'internal_affairs/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_matcher_directive'

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

@@ -33,7 +33,7 @@ module RuboCop
         def check_assignment(node, rhs)
           return unless rhs
           return unless node.loc.operator
-          return if node.loc.operator.line == rhs.first_line
+          return if same_line?(node.loc.operator, rhs)
 
           base = display_column(leftmost_multiple_assignment(node).source_range)
           check_alignment([rhs], base + configured_indentation_width)

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

@@ -101,11 +101,11 @@ module RuboCop
         def block_end_align_target(node)
           lineage = [node, *node.ancestors]
 
-          target = lineage.each_cons(2) do |current, parent|
-            break current if end_align_target?(current, parent)
+          lineage.each_cons(2) do |current, parent|
+            return current if end_align_target?(current, parent)
           end
 
-          target || lineage.last
+          lineage.last
         end
 
         def end_align_target?(node, parent)

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

@@ -68,12 +68,12 @@ module RuboCop
         end
 
         def proper_dot_position?(node)
-          receiver_line = receiver_end_line(node.receiver)
-          selector_line = selector_range(node).line
+          selector_range = selector_range(node)
 
-          # receiver and selector are on the same line
-          return true if selector_line == receiver_line
+          return true if same_line?(selector_range, end_range(node.receiver))
 
+          selector_line = selector_range.line
+          receiver_line = receiver_end_line(node.receiver)
           dot_line = node.loc.dot.line
 
           # don't register an offense if there is a line comment between the
@@ -119,7 +119,13 @@ module RuboCop
           (node.str_type? || node.dstr_type?) && node.heredoc?
         end
 
+        def end_range(node)
+          node.source_range.end
+        end
+
         def selector_range(node)
+          return node unless node.call_type?
+
           # l.(1) has no selector, so we use the opening parenthesis instead
           node.loc.selector || node.loc.begin
         end

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

@@ -96,7 +96,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           previous_token = previous_token(node)
-          range = if previous_token && node.loc.line == previous_token.line
+          range = if previous_token && same_line?(node, previous_token)
                     range_with_surrounding_space(range: node.loc.expression, newlines: false)
                   else
                     range_by_whole_lines(node.loc.expression, include_final_newline: true)