Class: RuboCop::Cop::Style::AccessModifierDeclarations

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::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::AccessModifierDeclarations
Defined in:	lib/rubocop/cop/style/access_modifier_declarations.rb

Overview

Access modifiers should be declared to apply to a group of methods or inline before each method, depending on configuration. EnforcedStyle config covers only method definitions. Applications of visibility methods to symbols can be controlled using AllowModifiersOnSymbols config.

Examples:

EnforcedStyle: group (default)

# bad
class Foo

  private def bar; end
  private def baz; end

end

# good
class Foo

  private

  def bar; end
  def baz; end

end

EnforcedStyle: inline

# bad
class Foo

  private

  def bar; end
  def baz; end

end

# good
class Foo

  private def bar; end
  private def baz; end

end

AllowModifiersOnSymbols: true (default)

# good
class Foo

  private :bar, :baz

end

AllowModifiersOnSymbols: false

# bad
class Foo

  private :bar, :baz

end

Cop Safety Information:

Autocorrection is not safe, because the visibility of dynamically defined methods can vary depending on the state determined by the group access modifier.

Constant Summary

ALLOWED_NODE_TYPES =
# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 88
```
%i[pair block].freeze
```

GROUP_STYLE_MESSAGE =
# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 76

[
  '`%<access_modifier>s` should not be',
  'inlined in method definitions.'
].join(' ')

INLINE_STYLE_MESSAGE =
# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 81

[
  '`%<access_modifier>s` should be',
  'inlined in method definitions.'
].join(' ')

RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 86
```
%i[private protected public module_function].freeze
```

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.
.builtin?

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	Cops (other than builtin) are encouraged to implement this.
.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

#group_style? ⇒ Boolean readonly private
#inline_style? ⇒ Boolean readonly private

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

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

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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #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

#access_modifier_with_symbol?(node)
#on_send(node)
#access_modifier_is_inlined?(node) ⇒ Boolean private
#access_modifier_is_not_inlined?(node) ⇒ Boolean private
#allow_modifiers_on_symbols?(node) ⇒ Boolean private
#autocorrect(corrector, node) private
#def_source(node, def_node) private
#find_argument_less_modifier_node(node) private
#find_corresponding_def_node(node) private
#insert_inline_modifier(corrector, node, modifier_name) private
#message(range) private
#offense?(node) ⇒ Boolean private
#remove_node(corrector, node) private
#replace_def(corrector, node, def_node) private
#right_siblings_same_inline_method?(node) ⇒ Boolean private
#select_grouped_def_nodes(node) private

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

#add_range, #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::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, #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, #max_line_length,
#range_by_lines	Expand the given range to include all of any lines it covers.
#range_of_first_line, #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 Attribute Details

#group_style? ⇒ `Boolean` (readonly, private)

[ GitHub ]

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


def group_style?
  style == :group
end

#inline_style? ⇒ `Boolean` (readonly, private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 141


def inline_style?
  style == :inline
end

Instance Method Details

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

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 145


def access_modifier_is_inlined?(node)
  node.arguments.any?
end

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

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 149


def access_modifier_is_not_inlined?(node)
  !access_modifier_is_inlined?(node)
end

#access_modifier_with_symbol?(node)

[ GitHub ]

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


def_node_matcher :access_modifier_with_symbol?, <<~PATTERN
  (send nil? {:private :protected :public :module_function} (sym _))
PATTERN

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

[ GitHub ]

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


def allow_modifiers_on_symbols?(node)
  cop_config['AllowModifiersOnSymbols'] && access_modifier_with_symbol?(node)
end

#autocorrect(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 112


def autocorrect(corrector, node)
  case style
  when :group
    def_node = find_corresponding_def_node(node)
    return unless def_node

    replace_def(corrector, node, def_node)
  when :inline
    remove_node(corrector, node)
    select_grouped_def_nodes(node).each do |grouped_def_node|
      insert_inline_modifier(corrector, grouped_def_node, node.method_name)
    end
  end
end

#def_source(node, def_node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 219


def def_source(node, def_node)
  [*processed_source.ast_with_comments[node].map(&:text), def_node.source].join("\n")
end

#find_argument_less_modifier_node(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 180


def find_argument_less_modifier_node(node)
  return unless (parent = node.parent)

  parent.each_child_node(:send).find do |child|
    child.method?(node.method_name) && child.arguments.empty?
  end
end

#find_corresponding_def_node(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 169


def find_corresponding_def_node(node)
  if access_modifier_with_symbol?(node)
    method_name = node.first_argument.value
    node.parent.each_child_node(:def).find do |child|
      child.method?(method_name)
    end
  else
    node.first_argument
  end
end

#insert_inline_modifier(corrector, node, modifier_name) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 211


def insert_inline_modifier(corrector, node, modifier_name)
  corrector.insert_before(node, "#{modifier_name} ")
end

#message(range) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 159


def message(range)
  access_modifier = range.source

  if group_style?
    format(GROUP_STYLE_MESSAGE, access_modifier: access_modifier)
  elsif inline_style?
    format(INLINE_STYLE_MESSAGE, access_modifier: access_modifier)
  end
end

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

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 131


def offense?(node)
  (group_style? && access_modifier_is_inlined?(node) &&
    !right_siblings_same_inline_method?(node)) ||
    (inline_style? && access_modifier_is_not_inlined?(node))
end

#on_send(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 95


def on_send(node)
  return unless node.access_modifier?
  return if ALLOWED_NODE_TYPES.include?(node.parent&.type)
  return if allow_modifiers_on_symbols?(node)

  if offense?(node)
    add_offense(node.loc.selector) do |corrector|
      autocorrect(corrector, node)
    end
    opposite_style_detected
  else
    correct_style_detected
  end
end

#remove_node(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 215


def remove_node(corrector, node)
  corrector.remove(range_with_comments_and_lines(node))
end

#replace_def(corrector, node, def_node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 194


def replace_def(corrector, node, def_node)
  source = def_source(node, def_node)
  argument_less_modifier_node = find_argument_less_modifier_node(node)
  if argument_less_modifier_node
    corrector.insert_after(argument_less_modifier_node, "\n\n#{source}")
  elsif (ancestor = node.each_ancestor(:block, :class, :module).first)

    corrector.insert_before(ancestor.loc.end, "#{node.method_name}\n\n#{source}\n")
  else
    corrector.replace(node, "#{node.method_name}\n\n#{source}")
    return
  end

  remove_node(corrector, def_node)
  remove_node(corrector, node)
end

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

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 153


def right_siblings_same_inline_method?(node)
  node.right_siblings.any? do |sibling|
    sibling.send_type? && sibling.method?(node.method_name) && !sibling.arguments.empty?
  end
end

#select_grouped_def_nodes(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/access_modifier_declarations.rb', line 188


def select_grouped_def_nodes(node)
  node.right_siblings.take_while do |sibling|
    !(sibling.send_type? && sibling.bare_access_modifier_declaration?)
  end.select(&:def_type?)
end

Class: RuboCop::Cop::Style::AccessModifierDeclarations

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::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::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Attribute Details

#group_style? ⇒ Boolean (readonly, private)

#inline_style? ⇒ Boolean (readonly, private)

Instance Method Details

#access_modifier_is_inlined?(node) ⇒ Boolean (private)

#access_modifier_is_not_inlined?(node) ⇒ Boolean (private)

#access_modifier_with_symbol?(node)

#allow_modifiers_on_symbols?(node) ⇒ Boolean (private)

#autocorrect(corrector, node) (private)

#def_source(node, def_node) (private)

#find_argument_less_modifier_node(node) (private)

#find_corresponding_def_node(node) (private)

#insert_inline_modifier(corrector, node, modifier_name) (private)

#message(range) (private)

#offense?(node) ⇒ Boolean (private)

#on_send(node)

#remove_node(corrector, node) (private)

#replace_def(corrector, node, def_node) (private)

#right_siblings_same_inline_method?(node) ⇒ Boolean (private)

#select_grouped_def_nodes(node) (private)

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

`::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::Base` - Inherited

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

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

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

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

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

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

#group_style? ⇒ `Boolean` (readonly, private)

#inline_style? ⇒ `Boolean` (readonly, private)

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

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

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

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

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