Sha256: 172d5d75435590e96deecdd672d8d50a6bc952198fee61aa488182471b35cf5a

Contents?: true

Size: 1.22 KB

Versions: 171

Compression:

Stored size: 1.22 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Naming
      # 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.
      #
      # @example
      #   # bad
      #   class My_Class
      #   end
      #   module My_Module
      #   end
      #
      #   # good
      #   class MyClass
      #   end
      #   module MyModule
      #   end
      #   class module_parent::MyModule
      #   end
      class ClassAndModuleCamelCase < Base
        MSG = 'Use CamelCase for classes and modules.'

        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
        alias on_module on_class
      end
    end
  end
end

Version data entries

171 entries across 170 versions & 19 rubygems

Version Path
rubocop-1.74.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.73.2 lib/rubocop/cop/naming/class_and_module_camel_case.rb
siteimprove_api_client-1.0.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.73.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.73.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.73.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.72.2 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.72.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.72.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.71.2 lib/rubocop/cop/naming/class_and_module_camel_case.rb
tailscale_middleware-0.0.3 vendor/cache/ruby/3.4.0/gems/rubocop-1.71.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.71.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.71.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.70.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.69.2 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.69.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.69.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.68.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.67.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.66.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb