Sha256: 7949232c1d36f064ed14d9e634646175c694285f0337b37d83b9b62c1043fe2b

Contents?: true

Size: 1.17 KB

Versions: 75

Compression:

Stored size: 1.17 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Naming
      # This cop 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)
          allowed = /#{cop_config['AllowedNames'].join('|')}/
          name = node.loc.name.source.gsub(allowed, '')
          return unless /_/.match?(name)

          add_offense(node.loc.name)
        end
        alias on_module on_class
      end
    end
  end
end

Version data entries

75 entries across 75 versions & 8 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/naming/class_and_module_camel_case.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.29.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.29.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.28.2 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.28.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.28.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.27.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.26.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.26.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.25.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.25.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/naming/class_and_module_camel_case.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.24.1 lib/rubocop/cop/naming/class_and_module_camel_case.rb
rubocop-1.24.0 lib/rubocop/cop/naming/class_and_module_camel_case.rb