Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop 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.
      #
      # @safety
      #   This cop's autocorrection is unsafe because `include M` will affect the included class
      #   if any changes are made to module `M`.
      #   On the other hand, `import_methods M` uses a snapshot of method definitions,
      #   thus it will not be affected if module `M` changes.
      #
      # @example
      #
      #   # bad
      #   refine Foo do
      #     include Bar
      #   end
      #
      #   # bad
      #   refine Foo do
      #     prepend Bar
      #   end
      #
      #   # good
      #   refine Foo do
      #     import_methods Bar
      #   end
      #
      class RefinementImportMethods < Base
        extend TargetRubyVersion

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

        minimum_target_ruby_version 3.1

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

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
rubocop-1.29.1	lib/rubocop/cop/lint/refinement_import_methods.rb
rubocop-1.29.0	lib/rubocop/cop/lint/refinement_import_methods.rb
rubocop-1.28.2	lib/rubocop/cop/lint/refinement_import_methods.rb
rubocop-1.28.1	lib/rubocop/cop/lint/refinement_import_methods.rb
rubocop-1.28.0	lib/rubocop/cop/lint/refinement_import_methods.rb
rubocop-1.27.0	lib/rubocop/cop/lint/refinement_import_methods.rb