Class: Reek::SmellDetectors::UncommunicativeMethodName

Inherits:
BaseDetector
  • Object
show all
Defined in:
lib/reek/smell_detectors/uncommunicative_method_name.rb

Overview

An Uncommunicative Name is a name that doesn’t communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what’s going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

Currently UncommunicativeMethodName checks for

  • 1-character names

  • names ending with a number

  • names containing a capital letter (assuming camelCase)

See Uncommunicative-Method-Name for details.

Constant Summary collapse

REJECT_KEY = 
'reject'
ACCEPT_KEY = 
'accept'
DEFAULT_REJECT_PATTERNS = 
[/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze
DEFAULT_ACCEPT_PATTERNS = 
[].freeze

Constants inherited from BaseDetector

BaseDetector::DEFAULT_EXCLUDE_SET, BaseDetector::EXCLUDE_KEY

Instance Attribute Summary

Attributes inherited from BaseDetector

#config, #context

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseDetector

#config_for, configuration_keys, contexts, descendants, #enabled?, #exception?, #expression, inherited, #initialize, #run, #smell_type, smell_type, #smell_warning, #source_line, to_detector, todo_configuration_for, #value

Constructor Details

This class inherits a constructor from Reek::SmellDetectors::BaseDetector

Class Method Details

.default_config ⇒ Object 



28
29
30
31
32
 
# File 'lib/reek/smell_detectors/uncommunicative_method_name.rb', line 28

def self.default_config
  super.merge(
    REJECT_KEY => DEFAULT_REJECT_PATTERNS,
    ACCEPT_KEY => DEFAULT_ACCEPT_PATTERNS)
end

Instance Method Details

#accept_patterns ⇒ Object (private) 



60
61
62
 
# File 'lib/reek/smell_detectors/uncommunicative_method_name.rb', line 60

def accept_patterns
  Array value(ACCEPT_KEY, context)
end

#acceptable_name?(name) ⇒ Boolean (private)

Returns:

  • (Boolean) 


51
52
53
54
 
# File 'lib/reek/smell_detectors/uncommunicative_method_name.rb', line 51

def acceptable_name?(name)
  accept_patterns.any? { |accept_pattern| name.match accept_pattern } ||
    reject_patterns.none? { |reject_pattern| name.match reject_pattern }
end

#reject_patterns ⇒ Object (private) 



56
57
58
 
# File 'lib/reek/smell_detectors/uncommunicative_method_name.rb', line 56

def reject_patterns
  Array value(REJECT_KEY, context)
end

#sniff ⇒ Array<SmellWarning>

Checks the given context for uncommunicative names.

Returns:



39
40
41
42
43
44
45
46
47
 
# File 'lib/reek/smell_detectors/uncommunicative_method_name.rb', line 39

def sniff
  name = context.name.to_s
  return [] if acceptable_name?(name)

  [smell_warning(
    lines: [source_line],
    message: "has the name '#{name}'",
    parameters: { name: name })]
end