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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::RuboCop::Cop::AutoCorrector`, `::RuboCop::Cop::Base`, `::RuboCop::ExcludeLimit`, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain: self, `::RuboCop::Cop::RangeHelp`, `::RuboCop::Cop::ConfigurableEnforcedStyle`, `::RuboCop::Cop::Alignment`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::ClassAndModuleChildren
Defined in:	lib/rubocop/cop/style/class_and_module_children.rb

Overview

Checks that namespaced classes and modules are defined with a consistent style.

With nested style, classes and modules should be defined separately (one constant on each line, without ::). With compact style, classes and modules should be defined with fully qualified names (using :: for namespaces).

Note	The style chosen will affect `Module.nesting` for the class or module. Using `nested` style will result in each level being added, whereas `compact` style will only include the fully qualified class or module name.

By default, EnforcedStyle applies to both classes and modules. If desired, separate styles can be defined for classes and modules by using EnforcedStyleForClasses and EnforcedStyleForModules respectively. If not set, or set to nil, the EnforcedStyle value will be used.

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

Examples:

EnforcedStyle: nested (default)

# bad
class Foo::Bar
end

# good
class Foo
  class Bar
  end
end

EnforcedStyle: compact

# bad
class Foo
  class Bar
  end
end

# good
class Foo::Bar
end

Cop Safety Information:

Autocorrection is unsafe.

Moving from compact to nested children requires knowledge of whether the outer parent is a module or a class. Moving from nested to compact requires verification that the outer parent is defined elsewhere. RuboCop does not have the knowledge to perform either operation safely and thus requires manual oversight.

Constant Summary

COMPACT_MSG =
# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 60
```
'Use compact module/class definition instead of nested style.'
```
NESTED_MSG =
# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 59
```
'Use nested module/class definitions instead of compact style.'
```

Class Attribute Summary

`::RuboCop::Cop::AutoCorrector` - Extended

support_autocorrect?

`::RuboCop::Cop::Base` - Inherited

.gem_requirements, .lint?,
.support_autocorrect?	Returns if class supports autocorrect.
.support_multiple_source?	Override if your cop should be called repeatedly for multiple investigations Between calls to `on_new_investigation` and `on_investigation_end`, the result of `processed_source` will remain constant.

Class Method Summary

`::RuboCop::Cop::Base` - Inherited

.autocorrect_incompatible_with	List of cops that should not try to autocorrect at the same time as this cop.
.badge	Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url	Returns a url to view this cops documentation online.
.exclude_from_registry	Call for abstract Cop classes.
.inherited,
.joining_forces	Override and return the Force class(es) you need to join.
.match?	Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem	Register a version requirement for the given gem name.
.restrict_on_send

`::RuboCop::ExcludeLimit` - Extended

exclude_limit	Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

`::RuboCop::Cop::Alignment` - Included

#column_delta

`::RuboCop::Cop::Base` - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

`::RuboCop::Cop::AutocorrectLogic` - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

#on_class(node)
#on_module(node)
#add_trailing_end(corrector, node, padding) private
#autocorrect(corrector, node) private
#check_compact_style(node, body) private
#check_nested_style(node) private
#check_style(node, body, style) private
#compact_definition(corrector, node) private
#compact_identifier_name(node) private
#compact_node(corrector, node) private
#compact_node_name?(node) ⇒ Boolean private
#compact_replacement(node) private
#leading_spaces(node) private
#needs_compacting?(body) ⇒ Boolean private
#nest_definition(corrector, node) private
#nest_or_compact(corrector, node) private
#remove_end(corrector, body) private
#replace_namespace_keyword(corrector, node) private
#spaces_size(spaces_string) private
#split_on_double_colon(corrector, node, padding) private
#style_for_classes private
#style_for_modules private
#tab_indentation_width private
#unindent(corrector, node) private

`::RuboCop::Cop::RangeHelp` - Included

#add_range,
#arguments_range	A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range	A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column	Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

`::RuboCop::Cop::Alignment` - Included

#check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within?

`::RuboCop::Cop::Base` - Inherited

#add_global_offense	Adds an offense that has no particular location.
#add_offense	Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation	Called before any investigation.
#callbacks_needed,
#cop_config	Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum	This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message	Gets called if no message is specified when calling `add_offense` or `add_global_offense` Cops are discouraged to override this; instead pass your message directly.
#name	Alias for Base#cop_name.
#offenses,
#on_investigation_end	Called after all on_…
#on_new_investigation	Called before all on_…
#on_other_file	Called instead of all on_…
#parse	There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready	Called between investigations.
#relevant_file?,
#target_gem_version	Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument	Reserved for Cop::Cop.
#complete_investigation	Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations	Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation	Actually private methods.
#use_corrector

`::RuboCop::Cop::AutocorrectLogic` - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines	Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

`::RuboCop::Cop::IgnoredNode` - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#add_trailing_end(corrector, node, padding) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 111


def add_trailing_end(corrector, node, padding)
  replacement = "#{padding}end\n#{leading_spaces(node)}end"
  corrector.replace(node.loc.end, replacement)
end

#autocorrect(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 212


def autocorrect(corrector, node)
  return if node.class_type? && node.parent_class && style != :nested

  nest_or_compact(corrector, node)
end

#check_compact_style(node, body) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 201


def check_compact_style(node, body)
  parent = node.parent
  return if parent&.type?(:class, :module)

  return unless needs_compacting?(body)

  add_offense(node.loc.name, message: COMPACT_MSG) do |corrector|
    autocorrect(corrector, node)
  end
end

#check_nested_style(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 192


def check_nested_style(node)
  return unless compact_node_name?(node)
  return if node.parent&.type?(:class, :module)

  add_offense(node.loc.name, message: NESTED_MSG) do |corrector|
    autocorrect(corrector, node)
  end
end

#check_style(node, body, style) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 182


def check_style(node, body, style)
  return if node.identifier.namespace&.cbase_type?

  if style == :nested
    check_nested_style(node)
  else
    check_compact_style(node, body)
  end
end

#compact_definition(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 116


def compact_definition(corrector, node)
  compact_node(corrector, node)
  remove_end(corrector, node.body)
  unindent(corrector, node)
end

#compact_identifier_name(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 137


def compact_identifier_name(node)
  "#{node.identifier.const_name}::" \
    "#{node.body.children.first.const_name}"
end

#compact_node(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 122


def compact_node(corrector, node)
  range = range_between(node.loc.keyword.begin_pos, node.body.loc.name.end_pos)
  corrector.replace(range, compact_replacement(node))
end

#compact_node_name?(node) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 222


def compact_node_name?(node)
  node.identifier.source.include?('::')
end

#compact_replacement(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 127


def compact_replacement(node)
  replacement = "#{node.body.type} #{compact_identifier_name(node)}"

  body_comments = processed_source.ast_with_comments[node.body]
  unless body_comments.empty?
    replacement = body_comments.map(&:text).push(replacement).join("\n")
  end
  replacement
end

#leading_spaces(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 168


def leading_spaces(node)
  node.source_range.source_line[/\A\s*/]
end

#needs_compacting?(body) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 218


def needs_compacting?(body)
  body && %i[module class].include?(body.type)
end

#nest_definition(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 84


def nest_definition(corrector, node)
  padding = indentation(node) + leading_spaces(node)
  padding_for_trailing_end = padding.sub(' ' * node.loc.end.column, '')

  replace_namespace_keyword(corrector, node)
  split_on_double_colon(corrector, node, padding)
  add_trailing_end(corrector, node, padding_for_trailing_end)
end

#nest_or_compact(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 74


def nest_or_compact(corrector, node)
  style = node.class_type? ? style_for_classes : style_for_modules

  if style == :nested
    nest_definition(corrector, node)
  else
    compact_definition(corrector, node)
  end
end

#on_class(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 62


def on_class(node)
  return if node.parent_class && style != :nested

  check_style(node, node.body, style_for_classes)
end

#on_module(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 68


def on_module(node)
  check_style(node, node.body, style_for_modules)
end

#remove_end(corrector, body) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 143


def remove_end(corrector, body)
  remove_begin_pos = if same_line?(body.loc.name, body.loc.end)
                       body.loc.name.end_pos
                     else
                       body.loc.end.begin_pos - leading_spaces(body).size
                     end
  adjustment = processed_source.raw_source[remove_begin_pos] == ';' ? 0 : 1
  range = range_between(remove_begin_pos, body.loc.end.end_pos + adjustment)

  corrector.remove(range)
end

#replace_namespace_keyword(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 93


def replace_namespace_keyword(corrector, node)
  class_definition = node.left_sibling&.each_node(:class)&.find do |class_node|
    class_node.identifier == node.identifier.namespace
  end
  namespace_keyword = class_definition ? 'class' : 'module'

  corrector.replace(node.loc.keyword, namespace_keyword)
end

#spaces_size(spaces_string) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 172


def spaces_size(spaces_string)
  mapping = { "\t" => tab_indentation_width }
  spaces_string.chars.sum { |character| mapping.fetch(character, 1) }
end

#split_on_double_colon(corrector, node, padding) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 102


def split_on_double_colon(corrector, node, padding)
  children_definition = node.children.first
  range = range_between(children_definition.loc.double_colon.begin_pos,
                        children_definition.loc.double_colon.end_pos)
  replacement = "\n#{padding}#{node.loc.keyword.source} "

  corrector.replace(range, replacement)
end

#style_for_classes (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 226


def style_for_classes
  cop_config['EnforcedStyleForClasses'] || style
end

#style_for_modules (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 230


def style_for_modules
  cop_config['EnforcedStyleForModules'] || style
end

#tab_indentation_width (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 177


def tab_indentation_width
  config.for_cop('Layout/IndentationStyle')['IndentationWidth'] ||
    configured_indentation_width
end

#unindent(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/class_and_module_children.rb', line 156


def unindent(corrector, node)
  return unless node.body.children.last

  last_child_leading_spaces = leading_spaces(node.body.children.last)
  return if spaces_size(leading_spaces(node)) == spaces_size(last_child_leading_spaces)

  column_delta = configured_indentation_width - spaces_size(last_child_leading_spaces)
  return if column_delta.zero?

  AlignmentCorrector.correct(corrector, processed_source, node, column_delta)
end

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

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::RangeHelp - Included

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Method Details

#add_trailing_end(corrector, node, padding) (private)

#autocorrect(corrector, node) (private)

#check_compact_style(node, body) (private)

#check_nested_style(node) (private)

#check_style(node, body, style) (private)

#compact_definition(corrector, node) (private)

#compact_identifier_name(node) (private)

#compact_node(corrector, node) (private)

#compact_node_name?(node) ⇒ Boolean (private)

#compact_replacement(node) (private)

#leading_spaces(node) (private)

#needs_compacting?(body) ⇒ Boolean (private)

#nest_definition(corrector, node) (private)

#nest_or_compact(corrector, node) (private)

#on_class(node)

#on_module(node)

#remove_end(corrector, body) (private)

#replace_namespace_keyword(corrector, node) (private)

#spaces_size(spaces_string) (private)

#split_on_double_colon(corrector, node, padding) (private)

#style_for_classes (private)

#style_for_modules (private)

#tab_indentation_width (private)

#unindent(corrector, node) (private)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::AutoCorrector` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#compact_node_name?(node) ⇒ `Boolean` (private)

#needs_compacting?(body) ⇒ `Boolean` (private)