Class: RuboCop::Cop::Lint::RefinementImportMethods

Inherits:
Base
  • Object
show all
Extended by:
TargetRubyVersion
Defined in:
lib/rubocop/cop/lint/refinement_import_methods.rb

Overview

Checks if ‘include` or `prepend` is called in `refine` block. These methods are deprecated and should be replaced with `Refinement#import_methods`.

It emulates deprecation warnings in Ruby 3.1.

Examples:


# bad
refine Foo do
  include Bar
end

# bad
refine Foo do
  prepend Bar
end

# good
refine Foo do
  import_methods Bar
end

Constant Summary collapse

MSG = 
'Use `import_methods` instead of `%<current>s` because it is deprecated in Ruby 3.1.'
RESTRICT_ON_SEND = 
%i[include prepend].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

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



42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/lint/refinement_import_methods.rb', line 42

def on_send(node)
  return if node.receiver
  return unless (parent = node.parent)
  return unless parent.block_type? && parent.method?(:refine)

  add_offense(node.loc.selector, message: format(MSG, current: node.method_name))
end