Class: RuboCop::Cop::Naming::ClassAndModuleCamelCase

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/naming/class_and_module_camel_case.rb

Overview

Checks for class and module names with an underscore in them.

AllowedNames config takes an array of permitted names. Its default value is ['module_parent']. These names can be full class/module names or part of the name. eg. Adding my_class to the AllowedNames config will allow names like my_class, my_class::User, App::my_class, App::my_class::User, etc.

Examples:

# bad
class My_Class
end
module My_Module
end

# good
class MyClass
end
module MyModule
end
class module_parent::MyModule
end

Constant Summary collapse

MSG = 
'Use CamelCase for classes and modules.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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_class(node) ⇒ Object Also known as: on_module 



32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/cop/naming/class_and_module_camel_case.rb', line 32

def on_class(node)
  return unless node.loc.name.source.include?('_')

  allowed = /#{cop_config['AllowedNames'].join('|')}/
  name = node.loc.name.source.gsub(allowed, '')
  return unless name.include?('_')

  add_offense(node.loc.name)
end