Class: RuboCop::Cop::Style::FileName

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/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.

Constant Summary collapse

MSG_SNAKE_CASE = 
'Use snake_case for source file names.'.freeze
MSG_NO_DEFINITION = 
'%s should define a class or module ' \
'called `%s`.'.freeze
MSG_REGEX = 
'`%s` should match `%s`.'.freeze
SNAKE_CASE = 
/^[\da-z_.?!]+$/

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#investigate(processed_source) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rubocop/cop/style/file_name.rb', line 20

def investigate(processed_source)
  file_path = processed_source.buffer.name
  return if config.file_to_include?(file_path)

  basename = File.basename(file_path)
  if filename_good?(basename)
    return unless expect_matching_definition?
    return if find_class_or_module(processed_source.ast,
                                   to_namespace(file_path))
    range = source_range(processed_source.buffer, 1, 0)
    msg   = format(MSG_NO_DEFINITION,
                   basename,
                   to_namespace(file_path).join('::'))
  else
    first_line = processed_source.lines.first
    return if cop_config['IgnoreExecutableScripts'] &&
              shebang?(first_line)

    range = source_range(processed_source.buffer, 1, 0)
    msg = regex ? format(MSG_REGEX, basename, regex) : MSG_SNAKE_CASE
  end

  add_offense(nil, range, msg)
end