rubocop 1.81.7 → 1.92.1

data/lib/rubocop/cop/lint.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Cops for the `Lint` department. The department's cops are registered for lazy loading
+    # and their files are loaded on demand.
+    module Lint
+      extend LazyLoader
+
+      register_cop :AmbiguousAssignment, "#{__dir__}/lint/ambiguous_assignment"
+      register_cop :AmbiguousBlockAssociation, "#{__dir__}/lint/ambiguous_block_association"
+      register_cop :AmbiguousOperator, "#{__dir__}/lint/ambiguous_operator"
+      register_cop :AmbiguousOperatorPrecedence, "#{__dir__}/lint/ambiguous_operator_precedence"
+      register_cop :AmbiguousRange, "#{__dir__}/lint/ambiguous_range"
+      register_cop :AmbiguousRegexpLiteral, "#{__dir__}/lint/ambiguous_regexp_literal"
+      register_cop :ArgumentMismatch, "#{__dir__}/lint/argument_mismatch"
+      register_cop :ArrayLiteralInRegexp, "#{__dir__}/lint/array_literal_in_regexp"
+      register_cop :AssignmentInCondition, "#{__dir__}/lint/assignment_in_condition"
+      register_cop :BigDecimalNew, "#{__dir__}/lint/big_decimal_new"
+      register_cop :BinaryOperatorWithIdenticalOperands, "#{__dir__}/lint/binary_operator_with_identical_operands"
+      register_cop :BooleanSymbol, "#{__dir__}/lint/boolean_symbol"
+      register_cop :CircularArgumentReference, "#{__dir__}/lint/circular_argument_reference"
+      register_cop :ConstantDefinitionInBlock, "#{__dir__}/lint/constant_definition_in_block"
+      register_cop :ConstantOverwrittenInRescue, "#{__dir__}/lint/constant_overwritten_in_rescue"
+      register_cop :ConstantReassignment, "#{__dir__}/lint/constant_reassignment"
+      register_cop :ConstantResolution, "#{__dir__}/lint/constant_resolution"
+      register_cop :CopDirectiveSyntax, "#{__dir__}/lint/cop_directive_syntax"
+      register_cop :DataDefineOverride, "#{__dir__}/lint/data_define_override"
+      register_cop :Debugger, "#{__dir__}/lint/debugger"
+      register_cop :DeprecatedClassMethods, "#{__dir__}/lint/deprecated_class_methods"
+      register_cop :DeprecatedConstants, "#{__dir__}/lint/deprecated_constants"
+      register_cop :DeprecatedOpenSSLConstant, "#{__dir__}/lint/deprecated_open_ssl_constant"
+      register_cop :DeprecatedReference, "#{__dir__}/lint/deprecated_reference"
+      register_cop :DisjunctiveAssignmentInConstructor, "#{__dir__}/lint/disjunctive_assignment_in_constructor"
+      register_cop :DuplicateBranch, "#{__dir__}/lint/duplicate_branch"
+      register_cop :DuplicateCaseCondition, "#{__dir__}/lint/duplicate_case_condition"
+      register_cop :DuplicateElsifCondition, "#{__dir__}/lint/duplicate_elsif_condition"
+      register_cop :DuplicateHashKey, "#{__dir__}/lint/duplicate_hash_key"
+      register_cop :DuplicateMagicComment, "#{__dir__}/lint/duplicate_magic_comment"
+      register_cop :DuplicateMatchPattern, "#{__dir__}/lint/duplicate_match_pattern"
+      register_cop :DuplicateMethods, "#{__dir__}/lint/duplicate_methods"
+      register_cop :DuplicateRegexpCharacterClassElement, "#{__dir__}/lint/duplicate_regexp_character_class_element"
+      register_cop :DuplicateRequire, "#{__dir__}/lint/duplicate_require"
+      register_cop :DuplicateRescueException, "#{__dir__}/lint/duplicate_rescue_exception"
+      register_cop :DuplicateSetElement, "#{__dir__}/lint/duplicate_set_element"
+      register_cop :EachWithObjectArgument, "#{__dir__}/lint/each_with_object_argument"
+      register_cop :ElseLayout, "#{__dir__}/lint/else_layout"
+      register_cop :EmptyBlock, "#{__dir__}/lint/empty_block"
+      register_cop :EmptyClass, "#{__dir__}/lint/empty_class"
+      register_cop :EmptyConditionalBody, "#{__dir__}/lint/empty_conditional_body"
+      register_cop :EmptyEnsure, "#{__dir__}/lint/empty_ensure"
+      register_cop :EmptyExpression, "#{__dir__}/lint/empty_expression"
+      register_cop :EmptyFile, "#{__dir__}/lint/empty_file"
+      register_cop :EmptyInPattern, "#{__dir__}/lint/empty_in_pattern"
+      register_cop :EmptyInterpolation, "#{__dir__}/lint/empty_interpolation"
+      register_cop :EmptyWhen, "#{__dir__}/lint/empty_when"
+      register_cop :EnsureReturn, "#{__dir__}/lint/ensure_return"
+      register_cop :SharedMutableDefault, "#{__dir__}/lint/shared_mutable_default"
+      register_cop :ErbNewArguments, "#{__dir__}/lint/erb_new_arguments"
+      register_cop :FlipFlop, "#{__dir__}/lint/flip_flop"
+      register_cop :FloatComparison, "#{__dir__}/lint/float_comparison"
+      register_cop :FloatOutOfRange, "#{__dir__}/lint/float_out_of_range"
+      register_cop :FormatParameterMismatch, "#{__dir__}/lint/format_parameter_mismatch"
+      register_cop :HashCompareByIdentity, "#{__dir__}/lint/hash_compare_by_identity"
+      register_cop :HashNewWithKeywordArgumentsAsDefault, "#{__dir__}/lint/hash_new_with_keyword_arguments_as_default"
+      register_cop :HeredocMethodCallPosition, "#{__dir__}/lint/heredoc_method_call_position"
+      register_cop :IdentityComparison, "#{__dir__}/lint/identity_comparison"
+      register_cop :ImplicitStringConcatenation, "#{__dir__}/lint/implicit_string_concatenation"
+      register_cop :IncompatibleIoSelectWithFiberScheduler, "#{__dir__}/lint/incompatible_io_select_with_fiber_scheduler"
+      register_cop :IneffectiveAccessModifier, "#{__dir__}/lint/ineffective_access_modifier"
+      register_cop :InheritException, "#{__dir__}/lint/inherit_exception"
+      register_cop :InterpolationCheck, "#{__dir__}/lint/interpolation_check"
+      register_cop :ItWithoutArgumentsInBlock, "#{__dir__}/lint/it_without_arguments_in_block"
+      register_cop :LambdaWithoutLiteralBlock, "#{__dir__}/lint/lambda_without_literal_block"
+      register_cop :LiteralAsCondition, "#{__dir__}/lint/literal_as_condition"
+      register_cop :LiteralAssignmentInCondition, "#{__dir__}/lint/literal_assignment_in_condition"
+      register_cop :LiteralInInterpolation, "#{__dir__}/lint/literal_in_interpolation"
+      register_cop :Loop, "#{__dir__}/lint/loop"
+      register_cop :MisplacedMagicComment, "#{__dir__}/lint/misplaced_magic_comment"
+      register_cop :MissingCopEnableDirective, "#{__dir__}/lint/missing_cop_enable_directive"
+      register_cop :MissingSuper, "#{__dir__}/lint/missing_super"
+      register_cop :MixedCaseRange, "#{__dir__}/lint/mixed_case_range"
+      register_cop :MixedRegexpCaptureTypes, "#{__dir__}/lint/mixed_regexp_capture_types"
+      register_cop :MultipleComparison, "#{__dir__}/lint/multiple_comparison"
+      register_cop :NameTypo, "#{__dir__}/lint/name_typo"
+      register_cop :NestedMethodDefinition, "#{__dir__}/lint/nested_method_definition"
+      register_cop :NestedPercentLiteral, "#{__dir__}/lint/nested_percent_literal"
+      register_cop :NextWithoutAccumulator, "#{__dir__}/lint/next_without_accumulator"
+      register_cop :NoReturnInBeginEndBlocks, "#{__dir__}/lint/no_return_in_begin_end_blocks"
+      register_cop :NonAtomicFileOperation, "#{__dir__}/lint/non_atomic_file_operation"
+      register_cop :NonDeterministicRequireOrder, "#{__dir__}/lint/non_deterministic_require_order"
+      register_cop :NonLocalExitFromIterator, "#{__dir__}/lint/non_local_exit_from_iterator"
+      register_cop :NumberConversion, "#{__dir__}/lint/number_conversion"
+      register_cop :NumberedParameterAssignment, "#{__dir__}/lint/numbered_parameter_assignment"
+      register_cop :NumericOperationWithConstantResult, "#{__dir__}/lint/numeric_operation_with_constant_result"
+      register_cop :OrAssignmentToConstant, "#{__dir__}/lint/or_assignment_to_constant"
+      register_cop :OrderedMagicComments, "#{__dir__}/lint/ordered_magic_comments"
+      register_cop :OutOfRangeRegexpRef, "#{__dir__}/lint/out_of_range_regexp_ref"
+      register_cop :ParenthesesAsGroupedExpression, "#{__dir__}/lint/parentheses_as_grouped_expression"
+      register_cop :PercentStringArray, "#{__dir__}/lint/percent_string_array"
+      register_cop :PercentSymbolArray, "#{__dir__}/lint/percent_symbol_array"
+      register_cop :RaiseException, "#{__dir__}/lint/raise_exception"
+      register_cop :RandOne, "#{__dir__}/lint/rand_one"
+      register_cop :RedundantCopDisableDirective, "#{__dir__}/lint/redundant_cop_disable_directive"
+      register_cop :RedundantCopEnableDirective, "#{__dir__}/lint/redundant_cop_enable_directive"
+      register_cop :RedundantDirGlobSort, "#{__dir__}/lint/redundant_dir_glob_sort"
+      register_cop :RedundantRegexpQuantifiers, "#{__dir__}/lint/redundant_regexp_quantifiers"
+      register_cop :RedundantRequireStatement, "#{__dir__}/lint/redundant_require_statement"
+      register_cop :RedundantSafeNavigation, "#{__dir__}/lint/redundant_safe_navigation"
+      register_cop :RedundantSplatExpansion, "#{__dir__}/lint/redundant_splat_expansion"
+      register_cop :RedundantStringCoercion, "#{__dir__}/lint/redundant_string_coercion"
+      register_cop :RedundantTypeConversion, "#{__dir__}/lint/redundant_type_conversion"
+      register_cop :RedundantWithIndex, "#{__dir__}/lint/redundant_with_index"
+      register_cop :RedundantWithObject, "#{__dir__}/lint/redundant_with_object"
+      register_cop :RefinementImportMethods, "#{__dir__}/lint/refinement_import_methods"
+      register_cop :RegexpAsCondition, "#{__dir__}/lint/regexp_as_condition"
+      register_cop :RequireParentheses, "#{__dir__}/lint/require_parentheses"
+      register_cop :RequireRangeParentheses, "#{__dir__}/lint/require_range_parentheses"
+      register_cop :RequireRelativeSelfPath, "#{__dir__}/lint/require_relative_self_path"
+      register_cop :RescueException, "#{__dir__}/lint/rescue_exception"
+      register_cop :RescueType, "#{__dir__}/lint/rescue_type"
+      register_cop :ReturnInVoidContext, "#{__dir__}/lint/return_in_void_context"
+      register_cop :SafeNavigationConsistency, "#{__dir__}/lint/safe_navigation_consistency"
+      register_cop :SafeNavigationChain, "#{__dir__}/lint/safe_navigation_chain"
+      register_cop :SafeNavigationWithEmpty, "#{__dir__}/lint/safe_navigation_with_empty"
+      register_cop :ScriptPermission, "#{__dir__}/lint/script_permission"
+      register_cop :SelfAssignment, "#{__dir__}/lint/self_assignment"
+      register_cop :SendWithMixinArgument, "#{__dir__}/lint/send_with_mixin_argument"
+      register_cop :ShadowedArgument, "#{__dir__}/lint/shadowed_argument"
+      register_cop :ShadowedException, "#{__dir__}/lint/shadowed_exception"
+      register_cop :ShadowingOuterLocalVariable, "#{__dir__}/lint/shadowing_outer_local_variable"
+      register_cop :StructNewOverride, "#{__dir__}/lint/struct_new_override"
+      register_cop :SuperArgumentMismatch, "#{__dir__}/lint/super_argument_mismatch"
+      register_cop :SuppressedException, "#{__dir__}/lint/suppressed_exception"
+      register_cop :SuppressedExceptionInNumberConversion, "#{__dir__}/lint/suppressed_exception_in_number_conversion"
+      register_cop :SymbolConversion, "#{__dir__}/lint/symbol_conversion"
+      register_cop :Syntax, "#{__dir__}/lint/syntax"
+      register_cop :ToEnumArguments, "#{__dir__}/lint/to_enum_arguments"
+      register_cop :ToJSON, "#{__dir__}/lint/to_json"
+      register_cop :TopLevelReturnWithArgument, "#{__dir__}/lint/top_level_return_with_argument"
+      register_cop :TrailingCommaInAttributeDeclaration, "#{__dir__}/lint/trailing_comma_in_attribute_declaration"
+      register_cop :TripleQuotes, "#{__dir__}/lint/triple_quotes"
+      register_cop :UnderscorePrefixedVariableName, "#{__dir__}/lint/underscore_prefixed_variable_name"
+      register_cop :UnescapedBracketInRegexp, "#{__dir__}/lint/unescaped_bracket_in_regexp"
+      register_cop :UnexpectedBlockArity, "#{__dir__}/lint/unexpected_block_arity"
+      register_cop :UnifiedInteger, "#{__dir__}/lint/unified_integer"
+      register_cop :UnmodifiedReduceAccumulator, "#{__dir__}/lint/unmodified_reduce_accumulator"
+      register_cop :UnreachableCode, "#{__dir__}/lint/unreachable_code"
+      register_cop :UnreachableLoop, "#{__dir__}/lint/unreachable_loop"
+      register_cop :UnreachablePatternBranch, "#{__dir__}/lint/unreachable_pattern_branch"
+      register_cop :UnusedBlockArgument, "#{__dir__}/lint/unused_block_argument"
+      register_cop :UnusedMethodArgument, "#{__dir__}/lint/unused_method_argument"
+      register_cop :UnusedPrivateMethod, "#{__dir__}/lint/unused_private_method"
+      register_cop :UriEscapeUnescape, "#{__dir__}/lint/uri_escape_unescape"
+      register_cop :UriRegexp, "#{__dir__}/lint/uri_regexp"
+      register_cop :UselessAccessModifier, "#{__dir__}/lint/useless_access_modifier"
+      register_cop :UselessAssignment, "#{__dir__}/lint/useless_assignment"
+      register_cop :UselessConstantScoping, "#{__dir__}/lint/useless_constant_scoping"
+      register_cop :UselessDefaultValueArgument, "#{__dir__}/lint/useless_default_value_argument"
+      register_cop :UselessDefined, "#{__dir__}/lint/useless_defined"
+      register_cop :UselessElseWithoutRescue, "#{__dir__}/lint/useless_else_without_rescue"
+      register_cop :UselessMethodDefinition, "#{__dir__}/lint/useless_method_definition"
+      register_cop :UselessNumericOperation, "#{__dir__}/lint/useless_numeric_operation"
+      register_cop :UselessOr, "#{__dir__}/lint/useless_or"
+      register_cop :UselessRescue, "#{__dir__}/lint/useless_rescue"
+      register_cop :UselessRuby2Keywords, "#{__dir__}/lint/useless_ruby2_keywords"
+      register_cop :UselessSetterCall, "#{__dir__}/lint/useless_setter_call"
+      register_cop :UselessTimes, "#{__dir__}/lint/useless_times"
+      register_cop :Void, "#{__dir__}/lint/void"
+
+      autoload :UnusedArgument, "#{__dir__}/mixin/unused_argument"
+
+      # Utility classes for `Lint` department cops.
+      module Utils
+        autoload :NilReceiverChecker, "#{__dir__}/lint/utils/nil_receiver_checker"
+      end
+    end
+  end
+end

data/lib/rubocop/cop/metrics/block_length.rb

@@ -17,7 +17,7 @@ module RuboCop
       #
       # NOTE: The `ExcludedMethods` configuration is deprecated and only kept
       # for backwards compatibility. Please use `AllowedMethods` and `AllowedPatterns`
-      # instead. By default, there are no methods to allowed.
+      # instead. By default, there are no allowed methods.
       #
       # @example CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
       #

data/lib/rubocop/cop/metrics/block_nesting.rb

@@ -4,6 +4,8 @@ module RuboCop
   module Cop
     module Metrics
       # Checks for excessive nesting of conditional and looping constructs.
+      # Deeply nested code is harder to read, understand, and maintain.
+      # Extracting nested logic into methods improves clarity.
       #
       # You can configure if blocks are considered using the `CountBlocks` and `CountModifierForms`
       # options. When both are set to `false` (the default) blocks and modifier forms are not
@@ -11,6 +13,27 @@ module RuboCop
       # calculation as well.
       #
       # The maximum level of nesting allowed is configurable.
+      #
+      # @example Max: 3 (default)
+      #   # bad
+      #   if condition1
+      #     if condition2
+      #       if condition3
+      #         if condition4
+      #           do_something
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   if condition1
+      #     if condition2
+      #       if condition3
+      #         do_something
+      #       end
+      #     end
+      #   end
       class BlockNesting < Base
         NESTING_BLOCKS = %i[case case_match if while while_post until until_post for resbody].freeze
 

data/lib/rubocop/cop/metrics/class_length.rb

@@ -40,6 +40,8 @@ module RuboCop
       class ClassLength < Base
         include CodeLength
 
+        LABEL = 'Class'
+
         def on_class(node)
           check_code_length(node)
         end
@@ -60,8 +62,8 @@ module RuboCop
 
         private
 
-        def message(length, max_length)
-          format('Class has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
+        def cop_label
+          LABEL
         end
 
         def find_expression_within_parent(parent)

data/lib/rubocop/cop/metrics/collection_literal_length.rb

@@ -75,7 +75,7 @@ module RuboCop
         private
 
         def collection_threshold
-          cop_config.fetch('LengthThreshold', Float::INFINITY)
+          cop_config.fetch('Max', Float::INFINITY)
         end
       end
     end

data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb

@@ -48,10 +48,6 @@ module RuboCop
 
           1
         end
-
-        def count_block?(block)
-          KNOWN_ITERATING_METHODS.include? block.method_name
-        end
       end
     end
   end

data/lib/rubocop/cop/metrics/method_length.rb

@@ -15,7 +15,7 @@ module RuboCop
       # NOTE: The `ExcludedMethods` and `IgnoredMethods` configuration is
       # deprecated and only kept for backwards compatibility.
       # Please use `AllowedMethods` and `AllowedPatterns` instead.
-      # By default, there are no methods to allowed.
+      # By default, there are no allowed methods.
       #
       # @example CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
       #
@@ -58,7 +58,7 @@ module RuboCop
           return unless node.method?(:define_method)
 
           method_name = node.send_node.first_argument
-          return if method_name.basic_literal? && allowed?(method_name.value)
+          return if method_name&.basic_literal? && allowed?(method_name.value)
 
           check_code_length(node)
         end

data/lib/rubocop/cop/metrics/module_length.rb

@@ -38,6 +38,8 @@ module RuboCop
       class ModuleLength < Base
         include CodeLength
 
+        LABEL = 'Module'
+
         def on_module(node)
           check_code_length(node)
         end
@@ -53,8 +55,8 @@ module RuboCop
           (casgn nil? _ (any_block (send (const {nil? cbase} :Module) :new) ...))
         PATTERN
 
-        def message(length, max_length)
-          format('Module has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
+        def cop_label
+          LABEL
         end
       end
     end

data/lib/rubocop/cop/metrics/perceived_complexity.rb

@@ -12,9 +12,15 @@ module RuboCop
       # nodes count. In contrast to the CyclomaticComplexity cop, this cop
       # considers `else` nodes as adding complexity.
       #
+      # A `case`/`in` branch whose pattern is a simple literal (e.g. `in 1`, `in "red"`, `in 1..10`)
+      # or a constant/type (e.g. `in Integer`) and has no guard is just as easy to read as a `when`
+      # branch, so it is discounted the same way. Branches with structural patterns (e.g. array,
+      # hash, or find patterns), bindings, alternatives, or a guard add the full complexity of
+      # a decision point.
+      #
       # @example
       #
-      #   def my_method                   # 1
+      #   def example_1                   # 1
       #     if cond                       # 1
       #       case var                    # 2 (0.8 + 4 * 0.2, rounded)
       #       when 1 then func_one
@@ -26,33 +32,57 @@ module RuboCop
       #       do_something until a && b   # 2
       #     end                           # ===
       #   end                             # 7 complexity points
+      #
+      #   def example_2                   # 1
+      #     case color                    # 1 (3 * 0.2, rounded)
+      #     in "red" then func_red
+      #     in "blue" then func_blue
+      #     in "green" then func_green
+      #     end                           # ===
+      #   end                             # 2 complexity points
       class PerceivedComplexity < CyclomaticComplexity
         MSG = 'Perceived complexity for `%<method>s` is too high. [%<complexity>d/%<max>d]'
 
-        COUNTED_NODES = (CyclomaticComplexity::COUNTED_NODES - [:when] + [:case]).freeze
+        COUNTED_NODES = (
+          CyclomaticComplexity::COUNTED_NODES - %i[when in_pattern] + %i[case case_match]
+        ).freeze
 
         private
 
+        # rubocop:disable-next Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         def complexity_score_for(node)
           case node.type
           when :case
-            # If cond is nil, that means each when has an expression that
-            # evaluates to true or false. It's just an alternative to
-            # if/elsif/elsif... so the when nodes count.
+            # If cond is nil, that means each when has an expression that evaluates to true or
+            # false. It's just an alternative to if/elsif/elsif... so the when nodes count.
             nb_branches = node.when_branches.length + (node.else_branch ? 1 : 0)
             if node.condition.nil?
               nb_branches
             else
-              # Otherwise, the case node gets 0.8 complexity points and each
-              # when gets 0.2.
+              # Otherwise, the case node gets 0.8 complexity points and each when gets 0.2.
               ((nb_branches * 0.2) + 0.8).round
             end
+          when :case_match
+            # Simple `in` branches are discounted like `when`, while structural patterns keep
+            # the full complexity of a decision point.
+            score = node.in_pattern_branches.sum { |branch| simple_in_pattern?(branch) ? 0.2 : 1 }
+            score += 0.2 if node.else_branch
+            score.round
           when :if
             node.else? && !node.elsif? ? 2 : 1
           else
             super
           end
         end
+
+        def simple_in_pattern?(in_pattern_node)
+          # `in_pattern_node.children[1]` is the guard (`if`/`unless`), or `nil`.
+          return false unless in_pattern_node.children[1].nil?
+
+          # A scalar literal, a literal range, or a constant/type is as easy to read as a `when`.
+          pattern = in_pattern_node.pattern
+          pattern.literal? || pattern.const_type?
+        end
       end
     end
   end

data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb

@@ -84,7 +84,10 @@ module RuboCop
           end
 
           def assignment?(node)
-            return compound_assignment(node) if node.masgn_type? || node.shorthand_asgn?
+            if node.masgn_type? || node.shorthand_asgn?
+              compound_assignment(node)
+              return false
+            end
 
             node.for_type? ||
               (node.respond_to?(:setter_method?) && node.setter_method?) ||
@@ -101,8 +104,6 @@ module RuboCop
               child.respond_to?(:setter_method?) && !child.setter_method?
             end
             @assignment += will_be_miscounted
-
-            false
           end
 
           def simple_assignment?(node)

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -189,7 +189,7 @@ module RuboCop
           def source_from_node_with_heredoc(node)
             last_line = -1
             node.each_descendant do |descendant|
-              next unless descendant.source
+              next if descendant.loc.nil? || descendant.source_range.nil?
 
               descendant_last_line =
                 if heredoc_node?(descendant)

data/lib/rubocop/cop/metrics/utils/iterating_block.rb

@@ -43,7 +43,7 @@ module RuboCop
             end
           end
 
-          # Returns true iff name is a known iterating type (e.g. :each, :transform_values)
+          # Returns true only when name is a known iterating type (e.g. :each, :transform_values).
           def iterating_method?(name)
             KNOWN_ITERATING_METHODS.include? name
           end

data/lib/rubocop/cop/metrics.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Cops for the `Metrics` department. The department's cops are registered for lazy loading
+    # and their files are loaded on demand.
+    module Metrics
+      extend LazyLoader
+
+      register_cop :CyclomaticComplexity, "#{__dir__}/metrics/cyclomatic_complexity"
+      register_cop :AbcSize, "#{__dir__}/metrics/abc_size"
+      register_cop :BlockLength, "#{__dir__}/metrics/block_length"
+      register_cop :BlockNesting, "#{__dir__}/metrics/block_nesting"
+      register_cop :ClassLength, "#{__dir__}/metrics/class_length"
+      register_cop :CollectionLiteralLength, "#{__dir__}/metrics/collection_literal_length"
+      register_cop :MethodLength, "#{__dir__}/metrics/method_length"
+      register_cop :ModuleLength, "#{__dir__}/metrics/module_length"
+      register_cop :ParameterLists, "#{__dir__}/metrics/parameter_lists"
+      register_cop :PerceivedComplexity, "#{__dir__}/metrics/perceived_complexity"
+
+      # Utility classes for `Metrics` department cops.
+      module Utils
+        autoload :AbcSizeCalculator, "#{__dir__}/metrics/utils/abc_size_calculator"
+        autoload :CodeLengthCalculator, "#{__dir__}/metrics/utils/code_length_calculator"
+        autoload :IteratingBlock, "#{__dir__}/metrics/utils/iterating_block"
+        autoload :RepeatedAttributeDiscount, "#{__dir__}/metrics/utils/repeated_attribute_discount"
+        autoload :RepeatedCsendDiscount, "#{__dir__}/metrics/utils/repeated_csend_discount"
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/department_name.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+# Lint/RedundantCopDisableDirective needs to be disabled so as
+# to be able to provide examples of rubocop:disable comments.
+# rubocop:disable-next Lint/RedundantCopDisableDirective -- the examples below read as real directives
 module RuboCop
   module Cop
     module Migration
-      # Check that cop names in rubocop:disable comments are given with
+      # Checks that cop names in rubocop:disable comments are given with
       # department name.
+      #
+      # @example
+      #   # bad
+      #   # rubocop:disable AbcSize
+      #
+      #   # good
+      #   # rubocop:disable Metrics/AbcSize
       class DepartmentName < Base
         include RangeHelp
         extend AutoCorrector
@@ -40,10 +50,6 @@ module RuboCop
 
         private
 
-        def disable_comment_offset
-          Regexp.last_match(1).length
-        end
-
         def check_cop_name(name, comment, offset)
           start = comment.source_range.begin_pos + offset
           range = range_between(start, start + name.length)

data/lib/rubocop/cop/migration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Cops for the `Migration` department. The department's cops are registered for lazy loading
+    # and their files are loaded on demand.
+    module Migration
+      extend LazyLoader
+
+      register_cop :DepartmentName, "#{__dir__}/migration/department_name"
+    end
+  end
+end

data/lib/rubocop/cop/mixin/alignment.rb

@@ -15,6 +15,10 @@ module RuboCop
         cop_config['IndentationWidth'] || config.for_cop('Layout/IndentationWidth')['Width'] || 2
       end
 
+      def using_tabs?
+        config.for_cop('Layout/IndentationStyle')['EnforcedStyle'] == 'tabs'
+      end
+
       def indentation(node)
         offset(node) + (SPACE * configured_indentation_width)
       end
@@ -66,7 +70,7 @@ module RuboCop
       end
 
       # @deprecated Use processed_source.line_with_comment?(line)
-      def end_of_line_comment(line) # rubocop:disable Naming/PredicateMethod
+      def end_of_line_comment(line) # rubocop:disable Naming/PredicateMethod -- a deprecated shim kept under its original name
         warn Rainbow(<<~WARNING).yellow, uplevel: 1
           `end_of_line_comment` is deprecated. Use `processed_source.line_with_comment?` instead.
         WARNING

data/lib/rubocop/cop/mixin/allowed_methods.rb

@@ -25,11 +25,11 @@ module RuboCop
 
       # @api public
       def allowed_methods
-        if cop_config_deprecated_values.any?(Regexp)
-          cop_config_allowed_methods
-        else
-          cop_config_allowed_methods + cop_config_deprecated_values
-        end
+        @allowed_methods ||= if cop_config_deprecated_values.any?(Regexp)
+                               cop_config_allowed_methods
+                             else
+                               cop_config_allowed_methods + cop_config_deprecated_values
+                             end
       end
 
       def cop_config_allowed_methods

data/lib/rubocop/cop/mixin/allowed_pattern.rb

@@ -27,7 +27,7 @@ module RuboCop
       end
 
       def matches_allowed_pattern?(line)
-        allowed_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
+        allowed_pattern_regexps.any? { |pattern| pattern.match?(line) }
       end
 
       # @deprecated Use matches_allowed_pattern? instead
@@ -49,6 +49,10 @@ module RuboCop
         end
       end
 
+      def allowed_pattern_regexps
+        @allowed_pattern_regexps ||= allowed_patterns.map { |pattern| Regexp.new(pattern) }
+      end
+
       def cop_config_patterns_values
         @cop_config_patterns_values ||=
           Array(cop_config.fetch('AllowedPatterns', [])) +

data/lib/rubocop/cop/mixin/annotation_comment.rb

@@ -45,7 +45,7 @@ module RuboCop
         match.captures
       end
 
-      KEYWORDS_REGEX_CACHE = {} # rubocop:disable Style/MutableConstant
+      KEYWORDS_REGEX_CACHE = {} # rubocop:disable Style/MutableConstant -- a cache, written to at runtime
       private_constant :KEYWORDS_REGEX_CACHE
 
       def regex