Class: RuboCop::Cop::Naming::FileName

Inherits:

Base

• Object
• Base
• RuboCop::Cop::Naming::FileName

Includes:

RangeHelp

Defined in:

lib/rubocop/cop/naming/file_name.rb

Overview

This cop makes sure that Ruby source files have snake_case names. Ruby scripts (i.e. source files with a shebang in the first line) are ignored.

The cop also ignores ‘.gemspec` files, because Bundler recommends using dashes to separate namespaces in nested gems (i.e. `bundler-console` becomes `Bundler::Console`). As such, the gemspec is supposed to be named `bundler-console.gemspec`.

Examples:

# bad
lib/layoutManager.rb

anything/usingCamelCase

# good
lib/layout_manager.rb

anything/using_snake_case.rake

Constant Summary

MSG_SNAKE_CASE =

'The name of this source file (`%<basename>s`) ' \
'should use snake_case.'

MSG_NO_DEFINITION =

'%<basename>s should define a class or module ' \
'called `%<namespace>s`.'

MSG_REGEX =

'`%<basename>s` should match `%<regex>s`.'

SNAKE_CASE =

/^[\d[[:lower:]]_.?!]+$/.freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary

• #on_new_investigation ⇒ Object

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, 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, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #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?, #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_new_investigation ⇒ Object

# File 'lib/rubocop/cop/naming/file_name.rb', line 38

def on_new_investigation
  file_path = processed_source.file_path
  return if config.file_to_exclude?(file_path) ||
            config.allowed_camel_case_file?(file_path)

  for_bad_filename(file_path) do |range, msg|
    add_offense(range, message: msg)
  end
end