Merge pull request #12771 from Earlopain/node-matcher-directive-followup

Fix a wrong offense message for `InternalAffairs/NodeMatcherDirective`

Author: koic

lib/rubocop/cop/internal_affairs/node_matcher_directive.rb

@@ -116,8 +116,7 @@ def directive_offense_type(directive, actual_name)
  # The method directive being prefixed by 'self.' is always an offense.
  # The matched method_name does not contain the receiver but the
  # def_node_match method name may so it must be removed.
- actual_name_without_receiver = actual_name.delete_prefix('self.')
- if directive[:method_name] != actual_name_without_receiver || directive[:receiver]
+ if directive[:method_name] != remove_receiver(actual_name) || directive[:receiver]
  :wrong_name
  end
  end
@@ -157,7 +156,8 @@ def formatted_message(offense_type, directive, actual_name, method_name)
  else
  directive[:method_name]
  end
- format(MSG_WRONG_NAME, expected: actual_name, actual: current_name)
+ # The correct name will never include a receiver, remove it
+ format(MSG_WRONG_NAME, expected: remove_receiver(actual_name), actual: current_name)
  when :wrong_scope
  MSG_WRONG_SCOPE_SELF
  when :no_scope
@@ -168,6 +168,10 @@ def formatted_message(offense_type, directive, actual_name, method_name)
  end
  # rubocop:enable Metrics/MethodLength
 
+ def remove_receiver(current)
+ current.delete_prefix('self.')
+ end
+
  def insert_method_directive(corrector, node, actual_name)
  # If the pattern matcher uses arguments (`%1`, `%2`, etc.), include them in the directive
  arguments = pattern_arguments(node.arguments[1].source)
@@ -216,7 +220,7 @@ def last_line(node)
  end
 
  def correct_method_directive(corrector, directive, actual_name)
- correct = "@!method #{actual_name.delete_prefix('self.')}"
+ correct = "@!method #{remove_receiver(actual_name)}"
  current_name = (directive[:receiver] || '') + directive[:method_name]
  regexp = /@!method\s+#{Regexp.escape(current_name)}/
 

spec/rubocop/cop/internal_affairs/node_matcher_directive_spec.rb

@@ -393,6 +393,25 @@ class MyCop
  PATTERN
  RUBY
  end
+
+ it 'gives the correct message for "self." prefix on @!method when @!scope is correctly "class"' do
+ expect_offense(<<~RUBY, method: method)
+ # @!method self.foo?(node)
+ # @!scope class
+ #{method} 'self.foo?', <<~PATTERN
+ ^{method}^^^^^^^^^^^^^^^^^^^^^^^^ `@!method` YARD directive has invalid method name, use `foo?` instead of `self.foo?`.
+ (str)
+ PATTERN
+ RUBY
+
+ expect_correction(<<~RUBY)
+ # @!method foo?(node)
+ # @!scope class
+ #{method} 'self.foo?', <<~PATTERN
+ (str)
+ PATTERN
+ RUBY
+ end
  end
  end
 end