Class: RuboCop::Cop::Naming::FileName
- Defined in:
- lib/rubocop/cop/naming/file_name.rb
Overview
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`.
When ‘ExpectMatchingDefinition` (default: `false`) is `true`, the cop requires each file to have a class, module or `Struct` defined in it that matches the filename. This can be further configured using `CheckDefinitionPathHierarchy` (default: `true`) to determine whether the path should match the namespace of the above definition.
When ‘IgnoreExecutableScripts` (default: `true`) is `true`, files that start with a shebang line are not considered by the cop.
When ‘Regex` is set, the cop will flag any filename that does not match the regular expression.
Constant Summary collapse
- 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
Instance Attribute Summary
Attributes inherited from Base
Instance Method Summary collapse
Methods inherited from Base
#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #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_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version
Methods included from ExcludeLimit
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
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#on_new_investigation ⇒ Object
54 55 56 57 58 59 |
# File 'lib/rubocop/cop/naming/file_name.rb', line 54 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) end |
#struct_definition(node) ⇒ Object
47 48 49 50 51 52 |
# File 'lib/rubocop/cop/naming/file_name.rb', line 47 def_node_matcher :struct_definition, <<~PATTERN { (casgn $_ $_ (send (const {nil? cbase} :Struct) :new ...)) (casgn $_ $_ (block (send (const {nil? cbase} :Struct) :new ...) ...)) } PATTERN |