Class: RuboCop::Cop::Style::ClassAndModuleChildren

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

Overview

This cop checks the style of children definitions at classes and modules. Basically there are two different styles:

The compact style is only forced for classes/modules with one child.

Examples:

EnforcedStyle: nested (default)

# good
# have each child on its own line
class Foo
  class Bar
  end
end

EnforcedStyle: compact

# good
# combine definitions as much as possible
class Foo::Bar
end

Constant Summary collapse

NESTED_MSG = 
'Use nested module/class definitions instead of ' \
'compact style.'.freeze
COMPACT_MSG = 
'Use compact module/class definition instead of ' \
'nested style.'.freeze

Constants included from Util

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

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

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, #initialize, #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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 44

def autocorrect(node)
  lambda do |corrector|
    if node.class_type?
      name, superclass, body = *node
      return if superclass && style != :nested
    else
      name, body = *node
    end
    nest_or_compact(corrector, node, name, body)
  end
end

#on_class(node) ⇒ Object 



33
34
35
36
37
 
# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 33

def on_class(node)
  _name, superclass, body = *node
  return if superclass && style != :nested
  check_style(node, body)
end

#on_module(node) ⇒ Object 



39
40
41
42
 
# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 39

def on_module(node)
  _name, body = *node
  check_style(node, body)
end