123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::MixinGrouping

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/mixin_grouping.rb

Overview

Checks for grouping of mixins in class and module bodies. By default it enforces mixins to be placed in separate declarations, but it can be configured to enforce grouping them in one declaration.

Examples:

EnforcedStyle: separated (default)

# bad
class Foo
  include Bar, Qox
end

# good
class Foo
  include Qox
  include Bar
end

EnforcedStyle: grouped

# bad
class Foo
  extend Bar
  extend Qox
end

# good
class Foo
  extend Qox, Bar
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::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 an 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

Instance Method Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::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_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

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Attribute Details

#grouped_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 110

def grouped_style?
  style == :grouped
end

#separated_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 114

def separated_style?
  style == :separated
end

Instance Method Details

#check(send_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 64

def check(send_node)
  if separated_style?
    check_separated_style(send_node)
  else
    check_grouped_style(send_node)
  end
end

#check_grouped_style(send_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 72

def check_grouped_style(send_node)
  return if sibling_mixins(send_node).size == 1

  message = format(MSG, mixin: send_node.method_name, suffix: 'a single statement')

  add_offense(send_node, message: message) do |corrector|
    range = send_node.source_range
    mixins = sibling_mixins(send_node)
    if send_node == mixins.first
      correction = group_mixins(send_node, mixins)
    else
      range = range_to_remove_for_subsequent_mixin(mixins, send_node)
      correction = ''
    end

    corrector.replace(range, correction)
  end
end

#check_separated_style(send_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 91

def check_separated_style(send_node)
  return if send_node.arguments.one?

  message = format(MSG, mixin: send_node.method_name, suffix: 'separate statements')

  add_offense(send_node, message: message) do |corrector|
    range = send_node.source_range
    correction = separate_mixins(send_node)

    corrector.replace(range, correction)
  end
end

#group_mixins(node, mixins) (private)

[ GitHub ]

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

def group_mixins(node, mixins)
  mixin_names = mixins.reverse.flat_map { |mixin| mixin.arguments.map(&:source) }

  "#{node.method_name} #{mixin_names.join(', ')}"
end

#on_class(node) Also known as: #on_module

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 40

def on_class(node)
  begin_node = node.child_nodes.find(&:begin_type?) || node
  begin_node.each_child_node(:send).select(&:macro?).each do |macro|
    next if !MIXIN_METHODS.include?(macro.method_name) || macro.arguments.empty?

    check(macro)
  end
end

#on_module(node)

Alias for #on_class.

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 49

alias on_module on_class

#range_to_remove_for_subsequent_mixin(mixins, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 53

def range_to_remove_for_subsequent_mixin(mixins, node)
  range = node.source_range
  prev_mixin = mixins.each_cons(2) { |m, n| break m if n == node }
  between = prev_mixin.source_range.end.join(range.begin)
  # if separated from previous mixin with only whitespace?
  unless /\S/.match?(between.source)
    range = range.join(between) # then remove that too
  end
  range
end

#separate_mixins(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 118

def separate_mixins(node)
  arguments = node.arguments.reverse
  mixins = ["#{node.method_name} #{arguments.first.source}"]

  arguments[1..].inject(mixins) do |replacement, arg|
    replacement << "#{indent(node)}#{node.method_name} #{arg.source}"
  end.join("\n")
end

#sibling_mixins(send_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/mixin_grouping.rb', line 104

def sibling_mixins(send_node)
  siblings = send_node.parent.each_child_node(:send).select(&:macro?)

  siblings.select { |sibling_node| sibling_node.method?(send_node.method_name) }
end