123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::DocumentationMethod

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/documentation_method.rb

Overview

Checks for missing documentation comment for public methods. It can optionally be configured to also require documentation for non-public methods.

Note
This cop allows initialize method because initialize is a special method called from new. In some programming languages they are called constructor to distinguish it from method.

Examples:

# bad

class Foo
  def bar
    puts baz
  end
end

module Foo
  def bar
    puts baz
  end
end

def foo.bar
  puts baz
end

# good

class Foo
  # Documentation
  def bar
    puts baz
  end
end

module Foo
  # Documentation
  def bar
    puts baz
  end
end

# Documentation
def foo.bar
  puts baz
end

RequireForNonPublicMethods: false (default)

# good
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

RequireForNonPublicMethods: true

# bad
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

# good
class Foo
  protected
  # Documentation
  def do_something
  end
end

class Foo
  private
  # Documentation
  def do_something
  end
end

AllowedMethods: ['method_missing', 'respond_to_missing?']

# good
class Foo
  def method_missing(name, *args)
  end

  def respond_to_missing?(symbol, include_private)
  end
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::VisibilityHelp - Included

VISIBILITY_SCOPES

Class Attribute Summary

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

::RuboCop::Cop::VisibilityHelp - Included

::RuboCop::Cop::DocumentationComment - Included

#annotation_keywords, #documentation_comment?, #interpreter_directive_comment?,
#precede?

The args node1 & node2 may represent a RuboCop::AST::Node or a Parser::Source::Comment.

#preceding_comment?

The args node1 & node2 may represent a RuboCop::AST::Node or a Parser::Source::Comment.

#preceding_lines, #rubocop_directive_comment?

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

#require_for_non_public_methods?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/documentation_method.rb', line 138

def require_for_non_public_methods?
  cop_config['RequireForNonPublicMethods']
end

Instance Method Details

#allowed_methods (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/documentation_method.rb', line 146

def allowed_methods
  @allowed_methods ||= cop_config.fetch('AllowedMethods', []).map(&:to_sym)
end

#check(node) (private)

[ GitHub ]

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

def check(node)
  return if non_public?(node) && !require_for_non_public_methods?
  return if documentation_comment?(node)
  return if method_allowed?(node)

  add_offense(node)
end

#method_allowed?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/documentation_method.rb', line 142

def method_allowed?(node)
  allowed_methods.include?(node.method_name)
end

#modifier_node?(node)

[ GitHub ]

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

def_node_matcher :modifier_node?, <<~PATTERN
  (send nil? {:module_function :ruby2_keywords} ...)
PATTERN

#on_def(node) Also known as: #on_defs

[ GitHub ]

  
# File 'lib/rubocop/cop/style/documentation_method.rb', line 120

def on_def(node)
  return if node.method?(:initialize)

  parent = node.parent
  modifier_node?(parent) ? check(parent) : check(node)
end

#on_defs(node)

Alias for #on_def.

[ GitHub ]

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

alias on_defs on_def