Class: RuboCop::Cop::InternalAffairs::RedundantDescribedClassAsSubject

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb

Overview

Checks for redundant subject(:cop) { described_class.new }.

Examples:

# bad
RSpec.describe RuboCop::Cop::Department::Foo do
  subject(:cop) { described_class.new(config) }
end

# good
RSpec.describe RuboCop::Cop::Department::Foo, :config do
end

Constant Summary collapse

MSG = 
'Remove the redundant `subject`%<additional_message>s.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, 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, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #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?, #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_subject?(node) ⇒ Object 



25
26
27
28
29
30
31
32
33
 
# File 'lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb', line 25

def_node_matcher :described_class_subject?, <<~PATTERN
  (block
    (send nil? :subject
      (sym :cop))
    (args)
    (send
      (send nil? :described_class) :new
      $...))
PATTERN

#on_block(node) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb', line 35

def on_block(node)
  return unless (described_class_arguments = described_class_subject?(node))
  return if described_class_arguments.count >= 2

  describe = find_describe_method_node(node)

  unless (exist_config = describe.last_argument.source == ':config')
    additional_message = ' and specify `:config` in `describe`'
  end

  message = format(MSG, additional_message: additional_message)

  add_offense(node, message: message) do |corrector|
    corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))

    corrector.insert_after(describe.last_argument, ', :config') unless exist_config
  end
end