Class: RuboCop::Cop::Lint::NestedMethodDefinition

Inherits:
Cop
  • Object
show all
Extended by:
NodePattern::Macros
Includes:
OnMethodDef
Defined in:
lib/rubocop/cop/lint/nested_method_definition.rb

Overview

This cop checks for nested method definitions.

Examples:


# bad

# `bar` definition actually produces methods in the same scope
# as the outer `foo` method. Furthermore, the `bar` method
# will be redefined every time `foo` is invoked.
def foo
  def bar
  end
end

# good

def foo
  bar = -> { puts 'hello' }
  bar.call
end

# good

def foo
  self.class_eval do
    def bar
    end
  end
end

Constant Summary collapse

MSG = 
'Method definitions must not be nested. ' \
'Use `lambda` instead.'.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 included from NodePattern::Macros

def_node_matcher, def_node_search, node_search, node_search_all, node_search_body, node_search_first

Methods included from OnMethodDef

#method_def_node_parts, #on_def, #on_defs

Methods inherited from Cop

#add_offense, all, 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, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

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_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#find_nested_defs(node, &block) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 52

def find_nested_defs(node, &block)
  node.each_child_node do |child|
    if child.def_type?
      yield child
    elsif child.defs_type?
      subject, = *child
      next if subject.lvar_type?
      yield child
    elsif !ignored_child?(child)
      find_nested_defs(child, &block)
    end
  end
end

#on_method_def(node, _method_name, _args, _body) ⇒ Object 



46
47
48
49
50
 
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 46

def on_method_def(node, _method_name, _args, _body)
  find_nested_defs(node) do |nested_def_node|
    add_offense(nested_def_node, :expression)
  end
end