Class: RuboCop::Cop::Naming::MethodName

Inherits:
Base
  • Object
show all
Includes:
AllowedPattern, ConfigurableNaming, RangeHelp
Defined in:
lib/rubocop/cop/naming/method_name.rb

Overview

Makes sure that all methods use the configured style, snake_case or camelCase, for their names.

This cop has ‘AllowedPatterns` configuration option.

Naming/MethodName:
  AllowedPatterns:
    - '\AonSelectionBulkChange\z'
    - '\AonSelectionCleared\z'

Method names matching patterns are always allowed.

Examples:

EnforcedStyle: snake_case (default)

# bad
def fooBar; end

# good
def foo_bar; end

EnforcedStyle: camelCase

# bad
def foo_bar; end

# good
def fooBar; end

Constant Summary collapse

MSG = 
'Use %<style>s for method names.'

Constants included from ConfigurableNaming

ConfigurableNaming::FORMATS

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableFormatting

#check_name, #class_emitter_method?, #report_opposing_styles, #valid_name?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object Also known as: on_defs 



55
56
57
58
59
 
# File 'lib/rubocop/cop/naming/method_name.rb', line 55

def on_def(node)
  return if node.operator_method? || matches_allowed_pattern?(node.method_name)

  check_name(node, node.method_name, node.loc.name)
end

#on_send(node) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rubocop/cop/naming/method_name.rb', line 44

def on_send(node)
  return unless (attrs = node.attribute_accessor?)

  attrs.last.each do |name_item|
    name = attr_name(name_item)
    next if !name || matches_allowed_pattern?(name)

    check_name(node, name, range_position(node))
  end
end

#str_name(node) ⇒ Object 



42
 
# File 'lib/rubocop/cop/naming/method_name.rb', line 42

def_node_matcher :str_name, '(str $_name)'

#sym_name(node) ⇒ Object 



39
 
# File 'lib/rubocop/cop/naming/method_name.rb', line 39

def_node_matcher :sym_name, '(sym $_name)'