Class: RuboCop::Cop::Style::ModuleFunction

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

Overview

This cops checks for use of ‘extend self` or `module_function` in a module.

Supported styles are: module_function, extend_self.

These offenses are not auto-corrected since there are different implications to each approach.

Examples:


# Good if EnforcedStyle is module_function
module Test
  module_function
  ...
end

# Good if EnforcedStyle is extend_self
module Test
  extend self
  ...
end

Constant Summary collapse

MODULE_FUNCTION_MSG = 
'Use `module_function` instead of `extend self`.'
.freeze
EXTEND_SELF_MSG = 
'Use `extend self` instead of `module_function`.'
.freeze
MODULE_FUNCTION_NODE = 
s(:send, nil, :module_function)
EXTEND_SELF_NODE = 
s(:send, nil, :extend, s(:self))

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, 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 ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, 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

#on_module(node) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/module_function.rb', line 39

def on_module(node)
  _name, body = *node
  return unless body && body.type == :begin

  body.children.each do |body_node|
    if style == :module_function && body_node == EXTEND_SELF_NODE
      add_offense(body_node, :expression, MODULE_FUNCTION_MSG)
    elsif style == :extend_self && body_node == MODULE_FUNCTION_NODE
      add_offense(body_node, :expression, EXTEND_SELF_MSG)
    end
  end
end