rubocop 1.71.1 → 1.92.0

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

@@ -5,6 +5,7 @@ module RuboCop
     # Common functionality for modifier cops.
     module StatementModifier
       include LineLengthHelp
+      include AllowedPattern
 
       private
 
@@ -34,17 +35,58 @@ module RuboCop
         condition.each_node.any?(&:lvasgn_type?)
       end
 
+      # The rendered modifier form is compared against the bare maximum, not
+      # `acceptable_line_length?`: `Layout/LineLength`'s exemptions describe
+      # long lines the user tolerates, not permission to manufacture new ones,
+      # so collapsing to modifier form must never push a line past the maximum.
       def modifier_fits_on_single_line?(node)
         return true unless max_line_length
 
-        length_in_modifier_form(node) <= max_line_length
+        line_length(line_in_modifier_form(node)) <= max_line_length
       end
 
-      def length_in_modifier_form(node)
+      def line_in_modifier_form(node)
         keyword_element = node.loc.keyword
         code_before = keyword_element.source_line[0...keyword_element.column]
-        expression = to_modifier_form(node)
-        line_length("#{code_before}#{expression}#{code_after(node)}")
+
+        "#{code_before}#{to_modifier_form(node)}#{code_after(node)}"
+      end
+
+      # Whether an existing line is acceptable to `Layout/LineLength`,
+      # exemptions (the cop disabled at that line, an allowed pattern, an
+      # allowed cop directive, an allowed URI) included. Only for judging
+      # lines already in the source as too long - see
+      # `modifier_fits_on_single_line?` for why the exemptions must not apply
+      # when deciding whether a modifier line may be created.
+      def acceptable_line_length?(line, line_number)
+        return true unless max_line_length
+        return true if line_length(line) <= max_line_length
+        return true unless line_length_enabled_at_line?(line_number)
+        return true if matches_allowed_pattern?(line)
+
+        if allow_cop_directives? && directive_on_source_line?(line_number - 1)
+          return line_length_without_directive(line) <= max_line_length
+        end
+
+        allowed_by_uri?(line)
+      end
+
+      def allowed_by_uri?(line)
+        return false unless allow_uri?
+
+        uri_range = find_excessive_range(line, :uri)
+        !uri_range.nil? && allowed_position?(line, uri_range)
+      end
+
+      def line_length_enabled_at_line?(line)
+        processed_source.comment_config.cop_enabled_at_line?('Layout/LineLength', line)
+      end
+
+      # `Layout/LineLength`'s allowed patterns, so a modifier line that the
+      # user has configured that cop to accept is not flagged for length here.
+      def allowed_patterns
+        line_length_config = config.for_cop('Layout/LineLength')
+        line_length_config['AllowedPatterns'] || line_length_config['IgnoredPatterns'] || []
       end
 
       def to_modifier_form(node)
@@ -54,9 +96,15 @@ module RuboCop
         [parenthesized, first_line_comment(node)].compact.join(' ')
       end
 
+      # rubocop:disable-next Metrics/AbcSize
       def if_body_source(if_body)
         if if_body.call_type? && !if_body.method?(:[]=) && omitted_value_in_last_hash_arg?(if_body)
           "#{method_source(if_body)}(#{if_body.arguments.map(&:source).join(', ')})"
+        elsif (value = wrapped_value(if_body))
+          prefix = if_body.source_range.begin.join(value.source_range.begin).source
+          suffix = value.source_range.end.join(if_body.source_range.end).source
+
+          "#{prefix}#{if_body_source(value)}#{suffix}"
         else
           if_body.source
         end
@@ -74,8 +122,16 @@ module RuboCop
         if_body.source_range.begin.join(end_range).source
       end
 
+      def wrapped_value(if_body)
+        if if_body.type?(:return, :next, :break)
+          if_body.first_argument if if_body.arguments.one?
+        elsif if_body.type?(:lvasgn, :ivasgn, :cvasgn, :gvasgn, :casgn)
+          if_body.expression
+        end
+      end
+
       def first_line_comment(node)
-        comment = processed_source.comments.find { |c| same_line?(c, node) }
+        comment = processed_source.comment_at_line(node.first_line)
         return unless comment
 
         comment_source = comment.source
@@ -95,15 +151,15 @@ module RuboCop
         parent = node.parent
         return false if parent.nil?
         return true if parent.assignment? || parent.operator_keyword?
-        return true if %i[array pair].include?(parent.type)
+        return true if parent.type?(:array, :pair, :call, :yield, :super)
 
-        node.parent.send_type?
+        ternary_branch_or_endless_method_body?(parent)
       end
 
-      def max_line_length
-        return unless config.cop_enabled?('Layout/LineLength')
+      def ternary_branch_or_endless_method_body?(parent)
+        return parent.ternary? if parent.if_type?
 
-        config.for_cop('Layout/LineLength')['Max']
+        parent.any_def_type? && parent.endless?
       end
 
       def comment_disables_cop?(comment)

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

@@ -10,7 +10,7 @@ module RuboCop
       def on_str(node)
         # Constants like __FILE__ are handled as strings,
         # but don't respond to begin.
-        return unless node.loc.respond_to?(:begin) && node.loc.begin
+        return unless node.loc?(:begin)
         return if part_of_ignored_node?(node)
 
         if offense?(node)

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

@@ -29,7 +29,7 @@ module RuboCop
         min = required_minimum_ruby_version || 0
         max = required_maximum_ruby_version || Float::INFINITY
 
-        min <= version && max >= version
+        version.between?(min, max)
       end
     end
   end

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

@@ -4,6 +4,7 @@ module RuboCop
   module Cop
     # Common methods shared by Style/TrailingCommaInArguments,
     # Style/TrailingCommaInArrayLiteral and Style/TrailingCommaInHashLiteral
+    # rubocop:disable-next Metrics/ModuleLength
     module TrailingComma
       include ConfigurableEnforcedStyle
       include RangeHelp
@@ -57,6 +58,8 @@ module RuboCop
           ', unless each item is on its own line'
         when :consistent_comma
           ', unless items are split onto multiple lines'
+        when :diff_comma
+          ', unless that item immediately precedes a newline'
         else
           ''
         end
@@ -68,6 +71,8 @@ module RuboCop
           multiline?(node) && no_elements_on_same_line?(node)
         when :consistent_comma
           multiline?(node) && !method_name_and_arguments_on_same_line?(node)
+        when :diff_comma
+          multiline?(node) && last_item_precedes_newline?(node)
         else
           false
         end
@@ -90,19 +95,21 @@ module RuboCop
         node.multiline? && !allowed_multiline_argument?(node)
       end
 
+      # rubocop:disable-next Metrics/AbcSize
       def method_name_and_arguments_on_same_line?(node)
-        return false unless node.call_type?
+        return false if !node.call_type? || node.last_line != node.last_argument.last_line
+        return true if node.last_argument.hash_type? && node.last_argument.braces?
 
-        line = node.loc.selector.nil? ? node.loc.line : node.loc.selector.line
+        line = node.loc.selector&.line || node.loc.line
 
-        line == node.last_argument.last_line && node.last_line == node.last_argument.last_line
+        line == node.last_argument.last_line
       end
 
       # A single argument with the closing bracket on the same line as the end
       # of the argument is not considered multiline, even if the argument
       # itself might span multiple lines.
       def allowed_multiline_argument?(node)
-        elements(node).one? && !Util.begins_its_line?(node.loc.end)
+        elements(node).one? && !Util.begins_its_line?(node_end_location(node))
       end
 
       def elements(node)
@@ -122,14 +129,24 @@ module RuboCop
 
       def no_elements_on_same_line?(node)
         items = elements(node).map(&:source_range)
-        items << node.loc.end
+        items << node_end_location(node)
         items.each_cons(2).none? { |a, b| on_same_line?(a, b) }
       end
 
+      def node_end_location(node)
+        node.loc.end || node.source_range.end.adjust(begin_pos: -1)
+      end
+
       def on_same_line?(range1, range2)
         range1.last_line == range2.line
       end
 
+      def last_item_precedes_newline?(node)
+        after_last_item = node.children.last.source_range.end.join(node.source_range.end)
+
+        after_last_item.source.start_with?(/,?\s*(#.*)?\n/)
+      end
+
       def avoid_comma(kind, comma_begin_pos, extra_info)
         range = range_between(comma_begin_pos, comma_begin_pos + 1)
         article = kind.include?('array') ? 'an' : 'a'
@@ -170,7 +187,7 @@ module RuboCop
 
       def heredoc?(node)
         return false unless node.is_a?(RuboCop::AST::Node)
-        return true if node.loc.respond_to?(:heredoc_body)
+        return true if node.loc?(:heredoc_body)
 
         return heredoc_send?(node) if node.send_type?
 

data/lib/rubocop/cop/mixin.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop # rubocop:disable Style/Documentation -- a namespace that only autoloads the mixins below
+    # Autoloads mixin modules included by cops. Mixins are autoloaded to reduce the number of
+    # requires because they're used only when the relevant cop class is loaded.
+
+    autoload :ArrayMinSize, "#{__dir__}/mixin/array_min_size"
+    autoload :ArraySyntax, "#{__dir__}/mixin/array_syntax"
+    autoload :Alignment, "#{__dir__}/mixin/alignment"
+    autoload :AllowedIdentifiers, "#{__dir__}/mixin/allowed_identifiers"
+    autoload :AllowedMethods, "#{__dir__}/mixin/allowed_methods"
+    autoload :AllowedPattern, "#{__dir__}/mixin/allowed_pattern"
+    autoload :AllowedReceivers, "#{__dir__}/mixin/allowed_receivers"
+    autoload :ForbiddenIdentifiers, "#{__dir__}/mixin/forbidden_identifiers"
+    autoload :ForbiddenPattern, "#{__dir__}/mixin/forbidden_pattern"
+    autoload :AutoCorrector, "#{__dir__}/mixin/auto_corrector" # rubocop:todo Naming/InclusiveLanguage -- the file is named `auto_corrector.rb`
+    autoload :CheckAssignment, "#{__dir__}/mixin/check_assignment"
+    autoload :CheckLineBreakable, "#{__dir__}/mixin/check_line_breakable"
+    autoload :CheckSingleLineSuitability, "#{__dir__}/mixin/check_single_line_suitability"
+    autoload :ConfigurableMax, "#{__dir__}/mixin/configurable_max"
+    autoload :CodeLength, "#{__dir__}/mixin/code_length"
+    autoload :ConfigurableEnforcedStyle, "#{__dir__}/mixin/configurable_enforced_style"
+    autoload :ConfigurableFormatting, "#{__dir__}/mixin/configurable_formatting"
+    autoload :ConfigurableNaming, "#{__dir__}/mixin/configurable_naming"
+    autoload :ConfigurableNumbering, "#{__dir__}/mixin/configurable_numbering"
+    autoload :DigHelp, "#{__dir__}/mixin/dig_help"
+    autoload :DocumentationComment, "#{__dir__}/mixin/documentation_comment"
+    autoload :Duplication, "#{__dir__}/mixin/duplication"
+    autoload :RangeHelp, "#{__dir__}/mixin/range_help"
+    autoload :ProjectIndexHelp, "#{__dir__}/mixin/project_index_help"
+    autoload :AnnotationComment, "#{__dir__}/mixin/annotation_comment"
+    autoload :EmptyParameter, "#{__dir__}/mixin/empty_parameter"
+    autoload :EndKeywordAlignment, "#{__dir__}/mixin/end_keyword_alignment"
+    autoload :EndlessMethodBodyHelp, "#{__dir__}/mixin/endless_method_body_help"
+    autoload :EndlessMethodRewriter, "#{__dir__}/mixin/endless_method_rewriter"
+    autoload :EnforceSuperclass, "#{__dir__}/mixin/enforce_superclass"
+    autoload :FirstElementLineBreak, "#{__dir__}/mixin/first_element_line_break"
+    autoload :FrozenStringLiteral, "#{__dir__}/mixin/frozen_string_literal"
+    autoload :GemDeclaration, "#{__dir__}/mixin/gem_declaration"
+    autoload :GemspecHelp, "#{__dir__}/mixin/gemspec_help"
+    autoload :HashAlignmentStyles, "#{__dir__}/mixin/hash_alignment_styles"
+    autoload :HashSubset, "#{__dir__}/mixin/hash_subset"
+    autoload :HashTransformMethod, "#{__dir__}/mixin/hash_transform_method"
+    # Deprecated aliases of `AllowedMethods` and `AllowedPattern`, defined in those files.
+    autoload :IgnoredMethods, "#{__dir__}/mixin/allowed_methods"
+    autoload :IgnoredPattern, "#{__dir__}/mixin/allowed_pattern"
+    autoload :IndexedMethodArity, "#{__dir__}/mixin/indexed_method_arity"
+    autoload :IntegerNode, "#{__dir__}/mixin/integer_node"
+    autoload :Interpolation, "#{__dir__}/mixin/interpolation"
+    autoload :LineLengthHelp, "#{__dir__}/mixin/line_length_help"
+    autoload :MatchRange, "#{__dir__}/mixin/match_range"
+    autoload :HashShorthandSyntax, "#{__dir__}/mixin/hash_shorthand_syntax"
+    autoload :MethodComplexity, "#{__dir__}/mixin/method_complexity"
+    autoload :MethodPreference, "#{__dir__}/mixin/method_preference"
+    autoload :MinBodyLength, "#{__dir__}/mixin/min_body_length"
+    autoload :MinBranchesCount, "#{__dir__}/mixin/min_branches_count"
+    autoload :MultilineElementIndentation, "#{__dir__}/mixin/multiline_element_indentation"
+    autoload :MultilineElementLineBreaks, "#{__dir__}/mixin/multiline_element_line_breaks"
+    autoload :MultilineExpressionIndentation, "#{__dir__}/mixin/multiline_expression_indentation"
+    autoload :MultilineLiteralBraceLayout, "#{__dir__}/mixin/multiline_literal_brace_layout"
+    autoload :NegativeConditional, "#{__dir__}/mixin/negative_conditional"
+    autoload :Heredoc, "#{__dir__}/mixin/heredoc"
+    autoload :NilMethods, "#{__dir__}/mixin/nil_methods"
+    autoload :OnNormalIfUnless, "#{__dir__}/mixin/on_normal_if_unless"
+    autoload :OrderedGemNode, "#{__dir__}/mixin/ordered_gem_node"
+    autoload :Parentheses, "#{__dir__}/mixin/parentheses"
+    autoload :PatternMatchingHelp, "#{__dir__}/mixin/pattern_matching_help"
+    autoload :PercentArray, "#{__dir__}/mixin/percent_array"
+    autoload :PercentLiteral, "#{__dir__}/mixin/percent_literal"
+    autoload :PrecedingFollowingAlignment, "#{__dir__}/mixin/preceding_following_alignment"
+    autoload :PreferredDelimiters, "#{__dir__}/mixin/preferred_delimiters"
+    autoload :RationalLiteral, "#{__dir__}/mixin/rational_literal"
+    autoload :ReparsedEquivalence, "#{__dir__}/mixin/reparsed_equivalence"
+    autoload :RequireLibrary, "#{__dir__}/mixin/require_library"
+    autoload :RescueNode, "#{__dir__}/mixin/rescue_node"
+    autoload :SafeAssignment, "#{__dir__}/mixin/safe_assignment"
+    autoload :SpaceAfterPunctuation, "#{__dir__}/mixin/space_after_punctuation"
+    autoload :SpaceBeforePunctuation, "#{__dir__}/mixin/space_before_punctuation"
+    autoload :SurroundingSpace, "#{__dir__}/mixin/surrounding_space"
+    autoload :StatementModifier, "#{__dir__}/mixin/statement_modifier"
+    autoload :StringHelp, "#{__dir__}/mixin/string_help"
+    autoload :StringLiteralsHelp, "#{__dir__}/mixin/string_literals_help"
+    autoload :SymbolHelp, "#{__dir__}/mixin/symbol_help"
+    autoload :TargetRubyVersion, "#{__dir__}/mixin/target_ruby_version"
+    autoload :TrailingBody, "#{__dir__}/mixin/trailing_body"
+    autoload :TrailingComma, "#{__dir__}/mixin/trailing_comma"
+    autoload :UncommunicativeName, "#{__dir__}/mixin/uncommunicative_name"
+    autoload :VisibilityHelp, "#{__dir__}/mixin/visibility_help"
+    autoload :CommentsHelp, "#{__dir__}/mixin/comments_help"
+    autoload :DefNode, "#{__dir__}/mixin/def_node"
+  end
+end

data/lib/rubocop/cop/naming/accessor_method_name.rb

@@ -11,6 +11,11 @@ module RuboCop
       # Getters (`get_attribute`) must have no arguments to be registered,
       # and setters (`set_attribute(value)`) must have exactly one.
       #
+      # When `AllCops/UseProjectIndex` is enabled and the `rubydex` gem is
+      # installed, methods that override a method defined by an ancestor
+      # elsewhere in the project are not reported, since renaming an override
+      # breaks the inherited contract.
+      #
       # @example
       #   # bad
       #   def set_attribute(value)
@@ -36,12 +41,15 @@ module RuboCop
       #   def set_value
       #   end
       class AccessorMethodName < Base
+        include ProjectIndexHelp
+
         MSG_READER = 'Do not prefix reader method names with `get_`.'
         MSG_WRITER = 'Do not prefix writer method names with `set_`.'
 
         def on_def(node)
           return unless proper_attribute_name?(node)
           return unless bad_reader_name?(node) || bad_writer_name?(node)
+          return if overrides_inherited_method?(node)
 
           message = message(node)
 

data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Naming
       # Makes sure that certain binary operator methods have their
-      # sole  parameter named `other`.
+      # sole parameter named `other`.
       #
       # @example
       #
@@ -33,6 +33,7 @@ module RuboCop
               node.each_descendant(:lvar, :lvasgn) do |lvar|
                 lvar_location = lvar.loc.name
                 next unless lvar_location.source == arg.source
+                next if shadowed?(lvar, arg.source, node)
 
                 corrector.replace(lvar_location, 'other')
               end
@@ -47,6 +48,21 @@ module RuboCop
 
           !/\A[[:word:]]/.match?(name) || OP_LIKE_METHODS.include?(name)
         end
+
+        # A reference is shadowed when an enclosing block within the method redeclares the
+        # parameter name (as a block parameter or block-local). Such a reference points to
+        # the block's variable, not the operator's parameter, so it must not be renamed.
+        def shadowed?(node, name, def_node)
+          node.each_ancestor(:block).any? do |block|
+            def_node.source_range.contains?(block.source_range) && redeclares?(block, name)
+          end
+        end
+
+        def redeclares?(block, name)
+          block.arguments.any? do |argument|
+            argument.respond_to?(:name) && argument.name.to_s == name
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/naming/block_forwarding.rb

@@ -14,10 +14,10 @@ module RuboCop
       # autocorrected.
       #
       # [NOTE]
-      # --
+      # ====
       # Because of a bug in Ruby 3.3.0, when a block is referenced inside of another block,
       # no offense will be registered until Ruby 3.4:
-
+      #
       # [source,ruby]
       # ----
       # def foo(&block)
@@ -25,7 +25,7 @@ module RuboCop
       #   block_method { bar(&block) }
       # end
       # ----
-      # --
+      # ====
       #
       # @example EnforcedStyle: anonymous (default)
       #
@@ -62,7 +62,10 @@ module RuboCop
         MSG = 'Use %<style>s block forwarding.'
 
         def self.autocorrect_incompatible_with
-          [Lint::AmbiguousOperator, Style::ArgumentsForwarding, Style::ExplicitBlockArgument]
+          [
+            Lint::AmbiguousOperator, Style::ArgumentsForwarding, Style::EndlessMethod,
+            Style::ExplicitBlockArgument, Style::MethodDefParentheses
+          ]
         end
 
         def on_def(node)

data/lib/rubocop/cop/naming/block_parameter_name.rb

@@ -38,7 +38,7 @@ module RuboCop
       class BlockParameterName < Base
         include UncommunicativeName
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler -- there are no parameter names to check
           return unless node.arguments?
 
           check(node, node.arguments)

data/lib/rubocop/cop/naming/file_name.rb

@@ -152,7 +152,7 @@ module RuboCop
 
             const_namespace, const_name = *const
             next if name != const_name && !match_acronym?(name, const_name)
-            next unless namespace.empty? || match_namespace(child, const_namespace, namespace)
+            next unless namespace.empty? || namespace_matches?(child, const_namespace, namespace)
 
             return node
           end
@@ -169,7 +169,7 @@ module RuboCop
           s(:const, namespace, name) if name
         end
 
-        def match_namespace(node, namespace, expected)
+        def namespace_matches?(node, namespace, expected)
           match_partial = partial_matcher!(expected)
 
           match_partial.call(namespace)
@@ -203,9 +203,10 @@ module RuboCop
 
         def match_acronym?(expected, name)
           expected = expected.to_s
-          name = name.to_s
-
-          allowed_acronyms.any? { |acronym| expected.gsub(acronym.capitalize, acronym) == name }
+          name = allowed_acronyms.reduce(name.to_s) do |result, acronym|
+            result.gsub(acronym, acronym.capitalize)
+          end
+          expected == name
         end
 
         def to_namespace(path) # rubocop:disable Metrics/AbcSize

data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb

@@ -35,7 +35,7 @@ module RuboCop
         MSG = 'Use %<style>s heredoc delimiters.'
 
         def on_heredoc(node)
-          return if correct_case_delimiters?(node)
+          return if correct_case_delimiters?(node) || corrected_delimiter_in_body?(node)
 
           add_offense(node.loc.heredoc_end) do |corrector|
             expr = node.source_range
@@ -52,7 +52,14 @@ module RuboCop
         end
 
         def correct_case_delimiters?(node)
-          delimiter_string(node) == correct_delimiters(delimiter_string(node))
+          delimiters = delimiter_string(node)
+          delimiters == correct_delimiters(delimiters)
+        end
+
+        def corrected_delimiter_in_body?(node)
+          corrected = correct_delimiters(delimiter_string(node))
+
+          node.loc.heredoc_body.source.each_line.any? { |line| line.strip == corrected }
         end
 
         def correct_delimiters(source)

data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb

@@ -43,9 +43,11 @@ module RuboCop
 
           return false unless /\w/.match?(delimiters)
 
-          forbidden_delimiters.none? do |forbidden_delimiter|
-            Regexp.new(forbidden_delimiter).match?(delimiters)
-          end
+          forbidden_delimiter_regexps.none? { |regexp| regexp.match?(delimiters) }
+        end
+
+        def forbidden_delimiter_regexps
+          @forbidden_delimiter_regexps ||= forbidden_delimiters.map { |d| Regexp.new(d) }
         end
 
         def forbidden_delimiters

data/lib/rubocop/cop/naming/inclusive_language.rb

@@ -91,6 +91,8 @@ module RuboCop
         end
 
         def on_new_investigation
+          return unless @flagged_terms_regex
+
           investigate_filepath if cop_config['CheckFilepaths']
           investigate_tokens
         end
@@ -144,7 +146,7 @@ module RuboCop
         def preprocess_flagged_terms
           allowed_strings = []
           flagged_term_strings = []
-          cop_config['FlaggedTerms'].each do |term, term_definition|
+          (cop_config['FlaggedTerms'] || {}).each do |term, term_definition|
             next if term_definition.nil?
 
             allowed_strings.concat(process_allowed_regex(term_definition['AllowedRegex']))
@@ -181,7 +183,11 @@ module RuboCop
         end
 
         def set_regexes(flagged_term_strings, allowed_strings)
-          @flagged_terms_regex = array_to_ignorecase_regex(flagged_term_strings)
+          # With no flagged terms an empty regex would match everything, so leave the
+          # regex nil and let `on_new_investigation` treat the cop as a no-op.
+          unless flagged_term_strings.empty?
+            @flagged_terms_regex = array_to_ignorecase_regex(flagged_term_strings)
+          end
           @allowed_regex = array_to_ignorecase_regex(allowed_strings) unless allowed_strings.empty?
         end
 

data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb

@@ -109,7 +109,7 @@ module RuboCop
       #     @_foo = calculate_expensive_thing
       #   end
       #
-      # @example EnforcedStyleForLeadingUnderscores :optional
+      # @example EnforcedStyleForLeadingUnderscores: optional
       #   # bad
       #   def foo
       #     @something ||= calculate_expensive_thing
@@ -167,13 +167,14 @@ module RuboCop
         PATTERN
 
         # rubocop:disable Metrics/AbcSize
-        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable-next Metrics/MethodLength
         def on_or_asgn(node)
           lhs = node.lhs
           return unless lhs.ivasgn_type?
 
           method_node, method_name = find_definition(node)
           return unless method_node
+          return unless nameable_method?(method_name)
 
           body = method_node.body
           return unless body == node || body.children.last == node
@@ -191,7 +192,6 @@ module RuboCop
             corrector.replace(lhs.loc.name, "@#{suggested_var}")
           end
         end
-        # rubocop:enable Metrics/MethodLength
         # rubocop:enable Metrics/AbcSize
 
         # @!method defined_memoized?(node, ivar)
@@ -202,13 +202,14 @@ module RuboCop
             $(ivasgn %1 _))
         PATTERN
 
-        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # rubocop:disable-next Metrics/AbcSize, Metrics/MethodLength
         def on_defined?(node)
           arg = node.first_argument
           return false unless arg.ivar_type?
 
           method_node, method_name = find_definition(node)
           return false unless method_node
+          return false unless nameable_method?(method_name)
 
           defined_memoized?(method_node.body, arg.name) do |defined_ivar, return_ivar, ivar_assign|
             return false if matches?(method_name, ivar_assign)
@@ -231,7 +232,6 @@ module RuboCop
             end
           end
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
         private
 
@@ -242,7 +242,7 @@ module RuboCop
         def find_definition(node)
           # Methods can be defined in a `def` or `defs`,
           # or dynamically via a `block` node.
-          node.each_ancestor(:def, :defs, :block).each do |ancestor|
+          node.each_ancestor(:any_def, :block).each do |ancestor|
             method_node, method_name = method_definition?(ancestor)
             return [method_node, method_name] if method_node
           end
@@ -250,6 +250,13 @@ module RuboCop
           nil
         end
 
+        # Operator and other non-word method names (e.g. `[]`, `+`, `<=>`) cannot form a
+        # valid instance variable name, so there is no matching ivar to enforce and a
+        # suggested correction like `@[]` would be invalid Ruby.
+        def nameable_method?(method_name)
+          /\A[a-zA-Z_]\w*\z/.match?(method_name.to_s.delete('!?='))
+        end
+
         def matches?(method_name, ivar_assign)
           return true if ivar_assign.nil? || INITIALIZE_METHODS.include?(method_name)