123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::ClassMethodsDefinitions

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::VisibilityHelp, ::RuboCop::Cop::CommentsHelp, ::RuboCop::Cop::ConfigurableEnforcedStyle, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/class_methods_definitions.rb

Overview

Enforces using def self.method_name or class << self to define class methods.

Examples:

EnforcedStyle: def_self (default)

# bad
class SomeClass
  class << self
    attr_accessor :class_accessor

    def class_method
      # ...
    end
  end
end

# good
class SomeClass
  def self.class_method
    # ...
  end

  class << self
    attr_accessor :class_accessor
  end
end

# good - contains private method
class SomeClass
  class << self
    attr_accessor :class_accessor

    private

    def private_class_method
      # ...
    end
  end
end

EnforcedStyle: self_class

# bad
class SomeClass
  def self.class_method
    # ...
  end
end

# good
class SomeClass
  class << self
    def class_method
      # ...
    end
  end
end

Constant Summary

::RuboCop::Cop::Base - Inherited

DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::RuboCop::Cop::VisibilityHelp - Included

VISIBILITY_SCOPES

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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

Reserved for Commissioner.

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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?,
#preview?

Whether the user opted in to unstable behavior, with --preview or AllCops: Preview.
#processed_source, #project_index, #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?,
#skipped_unsafe_correction_with_disable_uncorrectable?

Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while --disable-uncorrectable asks for a todo comment on everything this run cannot correct.
#contextual_autocorrect_held_back?

When LSP is enabled or the --editor-mode option is on, it is considered as editing source code, and autocorrection with AutoCorrect: contextual will not be performed.

Instance Method Summary

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

rubocop:disable-next Metrics/ParameterLists.
#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::VisibilityHelp - Included

#find_visibility_end

Navigate to find the last protected method.
#find_visibility_start, #node_visibility, #node_visibility_from_visibility_block, #node_visibility_from_visibility_inline, #node_visibility_from_visibility_inline_on_def, #node_visibility_from_visibility_inline_on_method_name, #visibility_block?, #visibility_inline_on_def?,
#visibility_inline_on_method_name?

A modifier applies to every symbol it is given, not only to a sole argument.

::RuboCop::Cop::CommentsHelp - Included

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment, #begin_pos_with_comment, #buffer, #end_position_for,
#find_end_line

Returns the end line of a node, which might be a comment and not part of the AST End line is considered either the line at which another node starts, or the line at which the parent node ends.
#start_line_position

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

rubocop:disable-next Metrics.
#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

 — grouped under the Commissioner heading above.
#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 the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked).
#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, #covering_disabled_range, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?,
#enabled_lines?

A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code.
#file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#suppression_reason

The -- reason on the directive that suppresses offenses on this range, or nil when the directive carries none.
#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 Attribute Details

#def_self_style? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


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



def def_self_style?
  style == :def_self
end


  







Instance Method Details



  

    #all_methods_public?(sclass_node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 99



def all_methods_public?(sclass_node)
  def_nodes = def_nodes(sclass_node)
  return false if def_nodes.empty?

  def_nodes.all? { |def_node| node_visibility(def_node) == :public }
end


  








  

    #autocorrect_sclass(node, corrector)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 130



def autocorrect_sclass(node, corrector)
  rewritten_defs = []

  def_nodes(node).each do |def_node|
    next unless node_visibility(def_node) == :public

    range, source = extract_def_from_sclass(def_node, node)

    corrector.remove(range)
    rewritten_defs << source
  end

  if sclass_only_has_methods?(node)
    corrector.remove(node)
    rewritten_defs.first&.strip!
  else
    corrector.insert_after(node, "\n")
  end

  corrector.insert_after(node, rewritten_defs.join("\n"))
end


  








  

    #def_nodes(sclass_node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 106



def def_nodes(sclass_node)
  sclass_def = sclass_node.body
  return [] unless sclass_def

  if sclass_def.def_type?
    [sclass_def]
  elsif sclass_def.begin_type?
    sclass_def.each_child_node(:def).to_a
  else
    []
  end
end


  








  

    #extract_def_from_sclass(def_node, sclass_node)   (private)
  

  [ GitHub ]


  

  


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



def extract_def_from_sclass(def_node, sclass_node)
  range = source_range_with_comment(def_node)
  source = prefix_def_with_self(range, def_node)
  source = source.gsub(/^ {#{indentation_diff(def_node, sclass_node)}}/, '')
  [range, source.chomp]
end


  








  

    #indentation_diff(node1, node2)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 173



def indentation_diff(node1, node2)
  node1.loc.column - node2.loc.column
end


  








  

    #inside_corrected_sclass?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 126



def inside_corrected_sclass?(node)
  node.each_ancestor(:sclass).any? { |ancestor| ignored_node?(ancestor) }
end


  








  

    #no_code_after?(range)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 119



def no_code_after?(range)
  trailing = processed_source.lines[range.last_line - 1][range.last_column..].to_s.strip
  trailing = trailing.sub(/\A;+\s*/, '')

  trailing.empty? || trailing.start_with?('#')
end


  








  

    #on_defs(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 85



def on_defs(node)
  return if def_self_style?
  return unless node.receiver.self_type?

  message = format(MSG, preferred: 'class << self')
  add_offense(node, message: message)
end


  








  

    #on_sclass(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 71



def on_sclass(node)
  return unless def_self_style?
  return unless node.identifier.self_type?
  return unless all_methods_public?(node)
  return unless def_nodes(node).all? { |def_node| no_code_after?(def_node.source_range) }

  add_offense(node, message: MSG_SCLASS) do |corrector|
    next if inside_corrected_sclass?(node)

    autocorrect_sclass(node, corrector)
    ignore_node(node)
  end
end


  








  

    #prefix_def_with_self(range, def_node)   (private)
  



  

    


Splice in self. at the actual def keyword rather than substituting the
first textual def <name>, which may appear inside a preceding comment.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 165



def prefix_def_with_self(range, def_node)
  keyword_offset = def_node.loc.keyword.begin_pos - range.begin_pos
  name_end_offset = def_node.loc.name.end_pos - range.begin_pos
  source = range.source.dup
  source[keyword_offset...name_end_offset] = "def self.#{def_node.method_name}"
  source
end


  








  

    #sclass_only_has_methods?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 152



def sclass_only_has_methods?(node)
  node.body.def_type? || node.body.each_child_node.all?(&:def_type?)
end