Class: RuboCop::Cop::Style::RedundantSelf

Inherits:
Cop
  • Object
show all
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 clash with local variable

    end

    %w[x y z].select do |bar|

    self.bar == bar # resolves name clash with argument of a block

    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.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

#initialize(config = nil, options = nil) ⇒ RedundantSelf

Returns a new instance of RedundantSelf.



52
53
54
55
56
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 52

def initialize(config = nil, options = nil)
  super
  @allowed_send_nodes = []
  @local_variables_scopes = Hash.new { |hash, key| hash[key] = [] }
end

Instance Method Details

#on_args(node) ⇒ Object 



78
79
80
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 78

def on_args(node)
  node.children.each { |arg| on_argument(arg) }
end

#on_block(node) ⇒ Object 



100
101
102
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 100

def on_block(node)
  add_scope(node, @local_variables_scopes[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 Also known as: on_defs

Using self.x to distinguish from local variable x



73
74
75
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 73

def on_def(node)
  add_scope(node)
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_scopes[rhs] << lhs
end

#on_op_asgn(node) ⇒ Object 



66
67
68
69
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 66

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



60
61
62
63
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 60

def on_or_asgn(node)
  lhs, _rhs = *node
  allow_self(lhs)
end

#on_send(node) ⇒ Object 



91
92
93
94
95
96
97
98
 
# File 'lib/rubocop/cop/style/redundant_self.rb', line 91

def on_send(node)
  return unless node.self_receiver? && regular_method_call?(node)
  return if node.parent && node.parent.mlhs_type?

  return if allowed_send_node?(node)

  add_offense(node)
end