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

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

Overview

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

This cop has `IgnoredPatterns` configuration option.

Naming/MethodName:
  IgnoredPatterns:
    - '\A\s*onSelectionBulkChange\s*'
    - '\A\s*onSelectionCleared\s*'

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 included from Util

Util::LITERAL_REGEX

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

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

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


52
53
54
55
56
57
# File 'lib/rubocop/cop/naming/method_name.rb', line 52

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

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

#on_send(node) ⇒ Object


41
42
43
44
45
46
47
48
49
50
# File 'lib/rubocop/cop/naming/method_name.rb', line 41

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_ignored_pattern?(name)

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