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

Inherits:
Object
  • Object
show all
Extended by:
Macros
Defined in:
lib/rubocop/cop/style/arguments_forwarding.rb

Overview

Classifies send nodes for possible rest/kwrest/all (including block) forwarding.

Instance Method Summary collapse

Constructor Details

#initialize(def_node, send_node, referenced_lvars, forwardable_args, **config) ⇒ SendNodeClassifier

Returns a new instance of SendNodeClassifier.

[View source]

422
423
424
425
426
427
428
429
430
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 422

def initialize(def_node, send_node, referenced_lvars, forwardable_args, **config)
  @def_node = def_node
  @send_node = send_node
  @referenced_lvars = referenced_lvars
  @rest_arg, @kwrest_arg, @block_arg = *forwardable_args
  @rest_arg_name, @kwrest_arg_name, @block_arg_name =
    *forwardable_args.map { |a| a&.name }
  @config = config
end

Instance Method Details

#classificationObject

[View source]

450
451
452
453
454
455
456
457
458
459
460
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 450

def classification
  return nil unless forwarded_rest_arg || forwarded_kwrest_arg || forwarded_block_arg

  if ruby_32_only_anonymous_forwarding?
    :all_anonymous
  elsif can_forward_all?
    :all
  else
    :rest_or_kwrest
  end
end

#def_all_anonymous_args?(node) ⇒ Object

[View source]

406
407
408
409
410
411
412
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 406

def_node_matcher :def_all_anonymous_args?, <<~PATTERN
  (
    def _
    (args ... (restarg) (kwrestarg) (blockarg nil?))
    _
  )
PATTERN

#extract_forwarded_kwrest_arg(node, kwrest_name) ⇒ Object

[View source]

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

def_node_matcher :extract_forwarded_kwrest_arg, '(hash <$(kwsplat (lvar %1)) ...>)'

#forwarded_block_argObject

[View source]

444
445
446
447
448
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 444

def forwarded_block_arg
  return nil if referenced_block_arg?

  arguments.find { |arg| forwarded_block_arg?(arg, @block_arg_name) }
end

#forwarded_block_arg?(node, block_name) ⇒ Object

[View source]

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

def_node_matcher :forwarded_block_arg?, '(block_pass {(lvar %1) nil?})'

#forwarded_kwrest_argObject

[View source]

438
439
440
441
442
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 438

def forwarded_kwrest_arg
  return nil if referenced_kwrest_arg?

  arguments.filter_map { |arg| extract_forwarded_kwrest_arg(arg, @kwrest_arg_name) }.first
end

#forwarded_rest_argObject

[View source]

432
433
434
435
436
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 432

def forwarded_rest_arg
  return nil if referenced_rest_arg?

  arguments.find { |arg| forwarded_rest_arg?(arg, @rest_arg_name) }
end

#forwarded_rest_arg?(node, rest_name) ⇒ Object

[View source]

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

def_node_matcher :forwarded_rest_arg?, '(splat (lvar %1))'

#send_all_anonymous_args?(node) ⇒ Object

[View source]

415
416
417
418
419
420
# File 'lib/rubocop/cop/style/arguments_forwarding.rb', line 415

def_node_matcher :send_all_anonymous_args?, <<~PATTERN
  (
    send _ _
    ... (forwarded_restarg) (hash (forwarded_kwrestarg)) (block_pass nil?)
  )
PATTERN