Class: RuboCop::Cop::Lint::SendWithMixinArgument

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

Overview

This cop checks for `send`, `public_send`, and `__send__` methods when using mix-in.

`include` and `prepend` methods were private methods until Ruby 2.0, they were mixed-in via `send` method. This cop uses Ruby 2.1 or higher style that can be called by public methods. And `extend` method that was originally a public method is also targeted for style unification.

Examples:

# bad
Foo.send(:include, Bar)
Foo.send(:prepend, Bar)
Foo.send(:extend, Bar)

# bad
Foo.public_send(:include, Bar)
Foo.public_send(:prepend, Bar)
Foo.public_send(:extend, Bar)

# bad
Foo.__send__(:include, Bar)
Foo.__send__(:prepend, Bar)
Foo.__send__(:extend, Bar)

# good
Foo.include Bar
Foo.prepend Bar
Foo.extend Bar

Constant Summary collapse

MSG =
'Use `%<method>s %<module_name>s` instead of `%<bad_method>s`.'
MIXIN_METHODS =
%i[include prepend extend].freeze
SEND_METHODS =
%i[send public_send __send__].freeze
RESTRICT_ON_SEND =
SEND_METHODS

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#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?, #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?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from 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

#on_send(node) ⇒ Object


54
55
56
57
58
59
60
61
62
63
# File 'lib/rubocop/cop/lint/send_with_mixin_argument.rb', line 54

def on_send(node)
  send_with_mixin_argument?(node) do |method, module_name|
    message = message(method, module_name.source, bad_location(node).source)

    bad_location = bad_location(node)
    add_offense(bad_location, message: message) do |corrector|
      corrector.replace(bad_location, "#{method} #{module_name.source}")
    end
  end
end

#send_with_mixin_argument?(node) ⇒ Object


47
48
49
50
51
52
# File 'lib/rubocop/cop/lint/send_with_mixin_argument.rb', line 47

def_node_matcher :send_with_mixin_argument?, <<~PATTERN
  (send
    (const _ _) {:#{SEND_METHODS.join(' :')}}
    ({sym str} $#mixin_method?)
      $(const _ _))
PATTERN