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

Inherits:
Base
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/tapioca/compilers/dsl/active_job.rb

Overview

‘Tapioca::Compilers::Dsl::ActiveJob` generates RBI files for subclasses of [`ActiveJob::Base`](api.rubyonrails.org/classes/ActiveJob/Base.html).

For example, with the following ‘ActiveJob` subclass:

~~~rb class NotifyUserJob < ActiveJob::Base

sig { params(user: User).returns(Mail) }
def perform(user)
  # ...
end

end ~~~

this generator will produce the RBI file ‘notify_user_job.rbi` with the following content:

~~~rbi # notify_user_job.rbi # typed: true class NotifyUserJob

sig { params(user: User).returns(T.any(NotifyUserJob, FalseClass)) }
def self.perform_later(user); end

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

end ~~~

Constant Summary

Constants included from Reflection

Reflection::ANCESTORS_METHOD, Reflection::CLASS_METHOD, Reflection::CONSTANTS_METHOD, Reflection::EQUAL_METHOD, Reflection::METHOD_METHOD, Reflection::NAME_METHOD, Reflection::OBJECT_ID_METHOD, Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Reflection::SINGLETON_CLASS_METHOD, Reflection::SUPERCLASS_METHOD

Instance Attribute Summary

Attributes inherited from Base

#errors, #processable_constants

Instance Method Summary collapse

Methods inherited from Base

#add_error, #handles?, #initialize

Methods included from Reflection

#ancestors_of, #are_equal?, #class_of, #constants_of, #descendants_of, #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, #signature_of, #singleton_class_of, #superclass_of

Constructor Details

This class inherits a constructor from Tapioca::Compilers::Dsl::Base

Instance Method Details

#decorate(root, constant) ⇒ Object 



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

def decorate(root, constant)
  return unless constant.instance_methods(false).include?(:perform)

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

    job.create_method(
      "perform_later",
      parameters: parameters,
      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

#gather_constants ⇒ Object 



69
70
71
 
# File 'lib/tapioca/compilers/dsl/active_job.rb', line 69

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