Class: Tapioca::Dsl::Compilers::ActiveJob

Inherits:
Tapioca::Dsl::Compiler show all
Defined in:
lib/tapioca/dsl/compilers/active_job.rb

Overview

Tapioca::Dsl::Compilers::ActiveJob generates RBI files for subclasses of ActiveJob::Base.

For example, with the following ActiveJob subclass:

class NotifyUserJob < ActiveJob::Base
  sig { params(user: User).returns(Mail) }
  def perform(user)
    # ...
  end
end

this compiler will produce the RBI file notify_user_job.rbi with the following content:

# notify_user_job.rbi
# typed: true
class NotifyUserJob
  sig do
    params(
      user: User,
      block: T.nilable(T.proc.params(job: NotifyUserJob).void),
    ).returns(T.any(NotifyUserJob, FalseClass))
  end
  def self.perform_later(user, &block); end

  sig { params(user: User).returns(Mail) }
  def self.perform_now(user); end
end

: [ConstantType = singleton(::ActiveJob::Base)]

Constant Summary

Constants included from Runtime::Reflection

Runtime::Reflection::ANCESTORS_METHOD, Runtime::Reflection::CLASS_METHOD, Runtime::Reflection::CONSTANTS_METHOD, Runtime::Reflection::EQUAL_METHOD, Runtime::Reflection::METHOD_METHOD, Runtime::Reflection::NAME_METHOD, Runtime::Reflection::OBJECT_ID_METHOD, Runtime::Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Runtime::Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Runtime::Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Runtime::Reflection::REQUIRED_FROM_LABELS, Runtime::Reflection::SINGLETON_CLASS_METHOD, Runtime::Reflection::SUPERCLASS_METHOD, Runtime::Reflection::SignatureBlockError, Runtime::Reflection::UNDEFINED_CONSTANT

Constants included from RBIHelper

RBIHelper::TYPE_PARAMETER_MATCHER

Constants included from SorbetHelper

SorbetHelper::FEATURE_REQUIREMENTS, SorbetHelper::SORBET_BIN, SorbetHelper::SORBET_EXE_PATH_ENV_VAR, SorbetHelper::SORBET_GEM_SPEC, SorbetHelper::SORBET_PAYLOAD_URL, SorbetHelper::SPOOM_CONTEXT

Instance Attribute Summary

Attributes inherited from Tapioca::Dsl::Compiler

#constant, #options, #root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tapioca::Dsl::Compiler

#add_error, #compiler_enabled?, handles?, #initialize, processable_constants, requested_constants=, reset_state

Methods included from Runtime::Reflection

#abstract_type_of, #ancestors_of, #are_equal?, #attached_class_of, #class_of, #const_source_location, #constant_defined?, #constantize, #constants_of, #descendants_of, #file_candidates_for, #final_module?, #inherited_ancestors_of, #method_of, #name_of, #name_of_type, #object_id_of, #private_instance_methods_of, #protected_instance_methods_of, #public_instance_methods_of, #qualified_name_of, #resolve_loc, #sealed_module?, #signature_of, #signature_of!, #singleton_class_of, #superclass_of

Methods included from RBIHelper

#anonymous_parameter_name?, #as_nilable_type, #as_non_nilable_type, #create_block_param, #create_kw_opt_param, #create_kw_param, #create_kw_rest_param, #create_opt_param, #create_param, #create_rest_param, #create_typed_param, #extract_type_parameters, #sanitize_signature_types, serialize_type_variable, #valid_method_name?, #valid_parameter_name?

Methods included from SorbetHelper

#sorbet, #sorbet_path, #sorbet_supports?, #sorbet_syntax_check!

Constructor Details

This class inherits a constructor from Tapioca::Dsl::Compiler

Class Method Details

.gather_constants ⇒ Object

: -> Enumerable[Module[top]]



88
89
90
 
# File 'lib/tapioca/dsl/compilers/active_job.rb', line 88

def gather_constants
  descendants_of(::ActiveJob::Base)
end

Instance Method Details

#decorate ⇒ Object

: -> void



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/tapioca/dsl/compilers/active_job.rb', line 45

def decorate
  return unless constant.method_defined?(:perform, false)

  root.create_path(constant) do |job|
    method = constant.instance_method(:perform)
    constant_name = name_of(constant)
    parameters = compile_method_parameters_to_rbi(method)
    return_type = compile_method_return_type_to_rbi(method)

    job.create_method(
      "perform_later",
      parameters: perform_later_parameters(parameters, constant_name),
      return_type: "T.any(#{constant_name}, FalseClass)",
      class_method: true,
    )

    job.create_method(
      "perform_now",
      parameters: parameters,
      return_type: return_type,
      class_method: true,
    )
  end
end