Class: RuboCop::Cop::InternalAffairs::NodeMatcherDirective

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 222

def correct_method_directive(corrector, directive, actual_name)
  correct = "@!method #{remove_receiver(actual_name)}"
  current_name = (directive[:receiver] || '') + directive[:method_name]
  regexp = /@!method\s+#{Regexp.escape(current_name)}/

  replacement = directive[:node_method].text.gsub(regexp, correct)
  corrector.replace(directive[:node_method], replacement)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 110

def directive_offense_type(directive, actual_name)
  return :missing_directive unless directive

  return :wrong_scope if wrong_scope(directive, actual_name)
  return :no_scope if no_scope(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.
  if directive[:method_name] != remove_receiver(actual_name) || directive[:receiver]
    :wrong_name
  end
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 150

def formatted_message(offense_type, directive, actual_name, method_name)
  case offense_type
  when :wrong_name
    # Add the receiver to the name when showing an offense
    current_name = if directive[:receiver]
                     directive[:receiver] + directive[:method_name]
                   else
                     directive[:method_name]
                   end
    # 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
    MSG_MISSING_SCOPE_SELF
  when :missing_directive
    format(MSG, method: method_name)
  end
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 85

def group_comments(comments)
  result = []
  comments.each.with_index do |comment, index|
    # Grab the scope directive if it is preceded by a method directive
    if comment.text.include?('@!method')
      result << if (next_comment = comments[index + 1])&.text&.include?('@!scope')
                  [comment, next_comment]
                else
                  [comment, nil]
                end
    end
  end
  result
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 175

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)

  range = range_with_surrounding_space(node.source_range, side: :left, newlines: false)
  indentation = range.source.match(/^\s*/)[0]
  directive = "#{indentation}# @!method #{actual_name}(#{arguments.join(', ')})\n"
  directive = "\n#{directive}" if add_newline?(node)

  corrector.insert_before(range, directive)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 187

def insert_scope_directive(corrector, node)
  range = range_with_surrounding_space(node.source_range, side: :left, newlines: false)
  indentation = range.source.match(/^\s*/)[0]
  directive = "\n#{indentation}# @!scope class"

  corrector.insert_after(node, directive)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 214

def last_line(node)
  if node.last_argument.heredoc?
    node.last_argument.loc.heredoc_end.line
  else
    node.loc.last_line
  end
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 68

def method_directives(node)
  comments = processed_source.ast_with_comments[node]
  group_comments(comments).filter_map do |comment_method, comment_scope|
    match = comment_method.text.match(REGEXP_METHOD)
    next unless match

    {
      node_method: comment_method,
      node_scope: comment_scope,
      method_name: match[:method_name],
      args: match[:args],
      receiver: match[:receiver],
      has_scope_directive: comment_scope&.text&.match?(REGEXP_SCOPE)
    }
  end
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 128

def no_scope(directive, actual_name)
  actual_name.start_with?('self.') && !directive[:has_scope_directive]
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 47

def on_send(node)
  return unless node.arguments.count == 2
  return unless valid_method_name?(node)

  actual_name = node.first_argument.value.to_s

  # Ignore cases where the method has a receiver that isn't self
  return if actual_name.include?('.') && !actual_name.start_with?('self.')

  directives = method_directives(node)
  return too_many_directives(node) if directives.size > 1

  process_directive(node, actual_name, directives.first)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 195

def pattern_arguments(pattern)
  arguments = %w[node]
  max_pattern_var = pattern.scan(/(?<=%)\d+/).map(&:to_i).max
  max_pattern_var&.times { |i| arguments << "arg#{i + 1}" }
  arguments
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 43

def_node_matcher :pattern_matcher?, <<~PATTERN
  (send _ %RESTRICT_ON_SEND {str sym} {str dstr})
PATTERN

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 104

def process_directive(node, actual_name, directive)
  return unless (offense_type = directive_offense_type(directive, actual_name))

  register_offense(offense_type, node, directive, actual_name)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 132

def register_offense(offense_type, node, directive, actual_name)
  message = formatted_message(offense_type, directive, actual_name, node.method_name)

  add_offense(node, message: message) do |corrector|
    case offense_type
    when :wrong_name
      correct_method_directive(corrector, directive, actual_name)
    when :wrong_scope
      remove_scope_directive(corrector, directive)
    when :no_scope
      insert_scope_directive(corrector, directive[:node_method])
    when :missing_directive
      insert_method_directive(corrector, node, actual_name)
    end
  end
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 171

def remove_receiver(current)
  current.delete_prefix('self.')
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 231

def remove_scope_directive(corrector, directive)
  range = range_by_whole_lines(
    directive[:node_scope].source_range,
    include_final_newline: true
  )
  corrector.remove(range)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 100

def too_many_directives(node)
  add_offense(node, message: MSG_TOO_MANY)
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 64

def valid_method_name?(node)
  node.first_argument.str_type? || node.first_argument.sym_type?
end

# File 'lib/rubocop/cop/internal_affairs/node_matcher_directive.rb', line 124

def wrong_scope(directive, actual_name)
  !actual_name.start_with?('self.') && directive[:has_scope_directive]
end