lib/rubocop/cop/sorbet/signatures/signature_cop.rb



# frozen_string_literal: true

require "rubocop"

module RuboCop
  module Cop
    module Sorbet
      # Abstract cop specific to Sorbet signatures
      #
      # You can subclass it to use the `on_signature` trigger and the `signature?` node matcher.
      class SignatureCop < RuboCop::Cop::Cop
        @registry = Cop.registry # So we can properly subclass this cop

        def_node_matcher(:signature?, <<~PATTERN)
          (block (send #allowed_recv :sig) (args) ...)
        PATTERN

        def_node_matcher(:with_runtime?, <<~PATTERN)
          (const (const nil? :T) :Sig)
        PATTERN

        def_node_matcher(:without_runtime?, <<~PATTERN)
          (const (const (const nil? :T) :Sig) :WithoutRuntime)
        PATTERN

        def allowed_recv(recv)
          return true unless recv
          return true if with_runtime?(recv)
          return true if without_runtime?(recv)
          false
        end

        def on_block(node)
          on_signature(node) if signature?(node)
        end

        def on_signature(_)
          # To be defined in subclasses
        end
      end
    end
  end
end