Class: RuboCop::Cop::InternalAffairs::UselessMessageAssertion

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/internal_affairs/useless_message_assertion.rb

Overview

Checks that cops are not tested using ‘described_class::MSG`.

Examples:


# bad
expect(cop.messages).to eq([described_class::MSG])

# good
expect(cop.messages).to eq(['Do not write bad code like that.'])

Constant Summary collapse

MSG = 
'Do not specify cop behavior using `described_class::MSG`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

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

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from RuboCop::Cop::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

#described_class_msg(node) ⇒ Object 



20
21
22
 
# File 'lib/rubocop/cop/internal_affairs/useless_message_assertion.rb', line 20

def_node_search :described_class_msg, <<~PATTERN
  (const (send nil? :described_class) :MSG)
PATTERN

#on_new_investigation ⇒ Object 



29
30
31
32
33
 
# File 'lib/rubocop/cop/internal_affairs/useless_message_assertion.rb', line 29

def on_new_investigation
  return if processed_source.blank?

  assertions_using_described_class_msg.each { |node| add_offense(node) }
end

#rspec_expectation_on_msg?(node) ⇒ Object 



25
26
27
 
# File 'lib/rubocop/cop/internal_affairs/useless_message_assertion.rb', line 25

def_node_matcher :rspec_expectation_on_msg?, <<~PATTERN
  (send (send nil? :expect #contains_described_class_msg?) :to ...)
PATTERN