module RuboCop::Cop::ConfigurableNaming

This module provides functionality for checking if names match the configured EnforcedStyle.

Constants

CAMEL_CASE
SNAKE_CASE

Public Instance Methods

check_name(node, name, name_range) click to toggle source
# File lib/rubocop/cop/mixin/configurable_naming.rb, line 13
def check_name(node, name, name_range)
  return if operator?(name)

  if valid_name?(node, name)
    correct_style_detected
  else
    add_offense(node, name_range, message(style)) do
      opposite_style_detected
    end
  end
end
class_emitter_method?(node, name) click to toggle source

A class emitter method is a singleton method in a class/module, where the method has the same name as a class defined in the class/module.

# File lib/rubocop/cop/mixin/configurable_naming.rb, line 32
def class_emitter_method?(node, name)
  return false unless node.defs_type?
  # a class emitter method may be defined inside `def self.included`,
  # `def self.extended`, etc.
  node = node.parent while node.parent && node.parent.defs_type?
  return false unless node.parent

  node.parent.children.compact.any? do |c|
    c.class_type? && c.loc.name.is?(name.to_s)
  end
end
valid_name?(node, name) click to toggle source
# File lib/rubocop/cop/mixin/configurable_naming.rb, line 25
def valid_name?(node, name)
  pattern = (style == :snake_case ? SNAKE_CASE : CAMEL_CASE)
  name.match(pattern) || class_emitter_method?(node, name)
end