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

Inherits:
Cop
  • Object
show all
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

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object


60
61
62
63
64
65
66
67
68
# File 'lib/rubocop/cop/lint/send_with_mixin_argument.rb', line 60

def autocorrect(node)
  send_with_mixin_argument?(node) do |method, module_name|
    lambda do |corrector|
      corrector.replace(
        bad_location(node), "#{method} #{module_name.source}"
      )
    end
  end
end

#on_send(node) ⇒ Object


50
51
52
53
54
55
56
57
58
# File 'lib/rubocop/cop/lint/send_with_mixin_argument.rb', line 50

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

    add_offense(node, location: bad_location(node), message: message)
  end
end