Class: RuboCop::Cop::Style::ArgumentsForwarding

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 542

def explicit_block_name?
  block_forwarding_config = config.for_cop('Naming/BlockForwarding')
  return false unless block_forwarding_config['Enabled']

  block_forwarding_config['EnforcedStyle'] == 'explicit'
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 356

def use_anonymous_forwarding?
  cop_config.fetch('UseAnonymousForwarding', false)
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 366

def add_parens_if_missing(node, corrector)
  return if parentheses?(node)
  return if node.send_type? && node.method?(:[])

  add_parentheses(node, corrector)
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 215

def add_post_ruby_32_offenses(def_node, send_classifications, forwardable_args)
  return unless use_anonymous_forwarding?
  return if send_inside_block?(send_classifications)

  rest_arg, kwrest_arg, block_arg = *forwardable_args

  send_classifications.each do |send_node, _c, forward_rest, forward_kwrest, forward_block_arg| # rubocop:disable Layout/LineLength
    if outside_block?(forward_rest)
      register_forward_args_offense(def_node.arguments, rest_arg)
      register_forward_args_offense(send_node, forward_rest)
    end

    if outside_block?(forward_kwrest)
      register_forward_kwargs_offense(!forward_rest, def_node.arguments, kwrest_arg)
      register_forward_kwargs_offense(!forward_rest, send_node, forward_kwrest)
    end

    # Prevents `anonymous block parameter is also used within block (SyntaxError)` occurs
    # in Ruby 3.3.0.
    if outside_block?(forward_block_arg)
      register_forward_block_arg_offense(!forward_rest, def_node.arguments, block_arg)
      register_forward_block_arg_offense(!forward_rest, send_node, forward_block_arg)
    end
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 340

def arguments_range(node, first_node)
  arguments = node.arguments.reject do |arg|
    next true if ADDITIONAL_ARG_TYPES.include?(arg.type) || arg.variable? || arg.call_type?

    arg.literal? && arg.each_descendant(:kwsplat).none?
  end

  start_node = first_node || arguments.first
  start_node.source_range.begin.join(arguments.last.source_range.end)
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 267

def classification_and_forwards(def_node, send_node, referenced_lvars, forwardable_args)
  classifier = SendNodeClassifier.new(
    def_node, send_node, referenced_lvars, forwardable_args,
    target_ruby_version: target_ruby_version,
    allow_only_rest_arguments: allow_only_rest_arguments?
  )

  classification = classifier.classification

  return unless classification

  [
    classification,
    classifier.forwarded_rest_arg,
    classifier.forwarded_kwrest_arg,
    classifier.forwarded_block_arg
  ]
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 252

def classify_send_nodes(def_node, send_nodes, referenced_lvars, forwardable_args)
  send_nodes.filter_map do |send_node|
    classification_and_forwards = classification_and_forwards(
      def_node,
      send_node,
      referenced_lvars,
      forwardable_args
    )

    next unless classification_and_forwards

    [send_node, *classification_and_forwards]
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 170

def extract_forwardable_args(args)
  [args.find(&:restarg_type?), args.find(&:kwrestarg_type?), args.find(&:blockarg_type?)]
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 242

def non_splat_or_block_pass_lvar_references(body)
  body.each_descendant(:lvar, :lvasgn).filter_map do |lvar|
    parent = lvar.parent

    next if lvar.lvar_type? && FORWARDING_LVAR_TYPES.include?(parent.type)

    lvar.children.first
  end.uniq
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 146

def on_def(node)
  return unless node.body

  restarg, kwrestarg, blockarg = extract_forwardable_args(node.arguments)
  forwardable_args = redundant_forwardable_named_args(restarg, kwrestarg, blockarg)
  send_nodes = node.each_descendant(:send, :csend, :super, :yield).to_a

  send_classifications = classify_send_nodes(
    node, send_nodes, non_splat_or_block_pass_lvar_references(node.body), forwardable_args
  )

  return if send_classifications.empty?

  if only_forwards_all?(send_classifications)
    add_forward_all_offenses(node, send_classifications, forwardable_args)
  elsif target_ruby_version >= 3.2
    add_post_ruby_32_offenses(node, send_classifications, forwardable_args)
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 166

alias on_defs on_def

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 182

def only_forwards_all?(send_classifications)
  all_classifications = %i[all all_anonymous].freeze
  send_classifications.all? { |_, c, _, _| all_classifications.include?(c) }
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 296

def outside_block?(node)
  return false unless node

  node.each_ancestor(:block, :numblock).none?
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 174

def redundant_forwardable_named_args(restarg, kwrestarg, blockarg)
  restarg_node = redundant_named_arg(restarg, 'RedundantRestArgumentNames', '*')
  kwrestarg_node = redundant_named_arg(kwrestarg, 'RedundantKeywordRestArgumentNames', '**')
  blockarg_node = redundant_named_arg(blockarg, 'RedundantBlockArgumentNames', '&')

  [restarg_node, kwrestarg_node, blockarg_node]
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 286

def redundant_named_arg(arg, config_name, keyword)
  return nil unless arg

  redundant_arg_names = cop_config.fetch(config_name, []).map do |redundant_arg_name|
    "#{keyword}#{redundant_arg_name}"
  end << keyword

  redundant_arg_names.include?(arg.source) ? arg : nil
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 329

def register_forward_all_offense(def_or_send, send_or_arguments, rest_or_splat)
  arg_range = arguments_range(def_or_send, rest_or_splat)

  add_offense(arg_range, message: FORWARDING_MSG) do |corrector|
    add_parens_if_missing(send_or_arguments, corrector)

    corrector.replace(arg_range, '...')
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 302

def register_forward_args_offense(def_arguments_or_send, rest_arg_or_splat)
  add_offense(rest_arg_or_splat, message: ARGS_MSG) do |corrector|
    add_parens_if_missing(def_arguments_or_send, corrector)

    corrector.replace(rest_arg_or_splat, '*')
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 318

def register_forward_block_arg_offense(add_parens, def_arguments_or_send, block_arg)
  return if target_ruby_version <= 3.0 ||
            block_arg.nil? || block_arg.source == '&' || explicit_block_name?

  add_offense(block_arg, message: BLOCK_MSG) do |corrector|
    add_parens_if_missing(def_arguments_or_send, corrector) if add_parens

    corrector.replace(block_arg, '&')
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 310

def register_forward_kwargs_offense(add_parens, def_arguments_or_send, kwrest_arg_or_splat)
  add_offense(kwrest_arg_or_splat, message: KWARGS_MSG) do |corrector|
    add_parens_if_missing(def_arguments_or_send, corrector) if add_parens

    corrector.replace(kwrest_arg_or_splat, '**')
  end
end

# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 360

def send_inside_block?(send_classifications)
  send_classifications.any? do |send_node, *|
    send_node.each_ancestor(:block, :numblock).any?
  end
end