Class: Rubocop::Cop::Style::ModuleFunction

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/module_function.rb

Overview

This cops checks for use of extend self in a module.

module Test extend self

... end

Constant Summary collapse

MSG = 
'Use `module_function` instead of `extend self`.'
TARGET_NODE = 
s(:send, nil, :extend, s(:self))

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, 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?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_module(node) ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'lib/rubocop/cop/style/module_function.rb', line 20

def on_module(node)
  _name, body = *node

  if body && body.type == :begin
    body.children.each do |body_node|
      add_offense(body_node, :expression) if body_node == TARGET_NODE
    end
  end
end