Class: RuboCop::Cop::InternalAffairs::UselessRestrictOnSend

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

Overview

Check for useless `RESTRICT_ON_SEND`.

Examples:

# bad
class FooCop
  RESTRICT_ON_SEND = %i[bad_method].freeze
end

# good
class FooCop
  RESTRICT_ON_SEND = %i[bad_method].freeze
  def on_send(node)
    # ...
  end
end

# good
class FooCop
  RESTRICT_ON_SEND = %i[bad_method].freeze
  def after_send(node)
    # ...
  end
end

Constant Summary collapse

MSG =
'Useless `RESTRICT_ON_SEND` is defined.'

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, 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, 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

#defined_send_callback?(node) ⇒ Object


36
37
38
39
40
41
42
# File 'lib/rubocop/cop/internal_affairs/useless_restrict_on_send.rb', line 36

def_node_search :defined_send_callback?, <<~PATTERN
  {
    (def {:on_send :after_send} ...)
    (alias (sym {:on_send :after_send}) _source ...)
    (send nil? :alias_method {(sym {:on_send :after_send}) (str {"on_send" "after_send"})} _source ...)
  }
PATTERN

#on_casgn(node) ⇒ Object


44
45
46
47
48
49
50
# File 'lib/rubocop/cop/internal_affairs/useless_restrict_on_send.rb', line 44

def on_casgn(node)
  return if !restrict_on_send?(node) || defined_send_callback?(node.parent)

  add_offense(node) do |corrector|
    corrector.remove(node)
  end
end