Class: Rubocop::Cop::Style::RedundantSelf
- Defined in:
- lib/rubocop/cop/style/redundant_self.rb
Overview
This cop checks for redundant uses of self
.
self
is only needed when:
- Sending a message to same object with zero arguments in presence of a method name clash with an argument or a local variable.
Note, with using explicit self you can only send messages with public or protected scope, you cannot send private messages this way.
Example:
def bar :baz end
def foo(bar) self.bar # resolves name clash with argument end
def foo2 bar = 1 self.bar # resolves name class with local variable end
- Calling an attribute writer to prevent an local variable assignment
attr_writer :bar
def foo self.bar= 1 # Make sure above attr writer is called end
Special cases:
We allow uses of self
with operators because it would be awkward
otherwise.
Constant Summary collapse
- MSG =
'Redundant `self` detected.'
Constants inherited from Cop
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offences, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
-
#initialize(config = nil, options = nil) ⇒ RedundantSelf
constructor
A new instance of RedundantSelf.
- #on_arg(node) ⇒ Object
- #on_blockarg(node) ⇒ Object
-
#on_def(node) ⇒ Object
Using self.x to distinguish from local variable x.
- #on_defs(node) ⇒ Object
- #on_lvasgn(node) ⇒ Object
- #on_op_asgn(node) ⇒ Object
-
#on_or_asgn(node) ⇒ Object
(also: #on_and_asgn)
Assignment of self.x.
-
#on_send(node) ⇒ Object
Detect offences.
Methods inherited from Cop
#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning
Constructor Details
#initialize(config = nil, options = nil) ⇒ RedundantSelf
Returns a new instance of RedundantSelf.
48 49 50 51 52 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 48 def initialize(config = nil, = nil) super @allowed_send_nodes = [] @local_variables = [] end |
Instance Method Details
#autocorrect(node) ⇒ Object
104 105 106 107 108 109 110 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 104 def autocorrect(node) receiver, _method_name, *_args = *node @corrections << lambda do |corrector| corrector.remove(receiver.loc.expression) corrector.remove(node.loc.dot) end end |
#on_arg(node) ⇒ Object
78 79 80 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 78 def on_arg(node) on_argument(node) end |
#on_blockarg(node) ⇒ Object
82 83 84 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 82 def on_blockarg(node) on_argument(node) end |
#on_def(node) ⇒ Object
Using self.x to distinguish from local variable x
70 71 72 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 70 def on_def(node) @local_variables = [] end |
#on_defs(node) ⇒ Object
74 75 76 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 74 def on_defs(node) @local_variables = [] end |
#on_lvasgn(node) ⇒ Object
86 87 88 89 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 86 def on_lvasgn(node) lhs, _rhs = *node @local_variables << lhs end |
#on_op_asgn(node) ⇒ Object
63 64 65 66 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 63 def on_op_asgn(node) lhs, _op, _rhs = *node allow_self(lhs) end |
#on_or_asgn(node) ⇒ Object Also known as: on_and_asgn
Assignment of self.x
56 57 58 59 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 56 def on_or_asgn(node) lhs, _rhs = *node allow_self(lhs) end |
#on_send(node) ⇒ Object
Detect offences
93 94 95 96 97 98 99 100 101 102 |
# File 'lib/rubocop/cop/style/redundant_self.rb', line 93 def on_send(node) receiver, method_name, *_args = *node if receiver && receiver.type == :self unless operator?(method_name) || keyword?(method_name) || @allowed_send_nodes.include?(node) || @local_variables.include?(method_name) convention(node, :expression) end end end |