Class: RuboCop::Cop::Style::SuperArguments

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/super_arguments.rb

Overview

Checks for redundant argument forwarding when calling super with arguments identical to the method definition.

Using zero arity ‘super` within a `define_method` block results in `RuntimeError`:

source,ruby

def m

define_method(:foo) { super() } # => OK

end

def m

define_method(:foo) { super }   # => RuntimeError

end

Furthermore, any arguments accompanied by a block may potentially be delegating to ‘define_method`, therefore, `super` used within these blocks will be allowed. This approach might result in false negatives, yet ensuring safe detection takes precedence.

Examples:

# bad
def method(*args, **kwargs)
  super(*args, **kwargs)
end

# good - implicitly passing all arguments
def method(*args, **kwargs)
  super
end

# good - forwarding a subset of the arguments
def method(*args, **kwargs)
  super(*args)
end

# good - forwarding no arguments
def method(*args, **kwargs)
  super()
end

# good - assigning to the block variable before calling super
def method(&block)
  # Assigning to the block variable would pass the old value to super,
  # under this circumstance the block must be referenced explicitly.
  block ||= proc { 'fallback behavior' }
  super(&block)
end

Constant Summary collapse

DEF_TYPES = 
%i[def defs].freeze
ASSIGN_TYPES = 
%i[or_asgn lvasgn].freeze
MSG = 
'Call `super` without arguments and parentheses when the signature is identical.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_super(super_node) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/rubocop/cop/style/super_arguments.rb', line 62

def on_super(super_node)
  def_node = super_node.ancestors.find do |node|
    # When defining dynamic methods, implicitly calling `super` is not possible.
    # Since there is a possibility of delegation to `define_method`,
    # `super` used within the block is always allowed.
    break if node.block_type?

    break node if DEF_TYPES.include?(node.type)
  end
  return unless def_node
  return unless arguments_identical?(def_node, def_node.arguments.argument_list,
                                     super_node.arguments)

  add_offense(super_node) { |corrector| corrector.replace(super_node, 'super') }
end