Class: Tapioca::Dsl::Compilers::ActiveJob
- Inherits:
-
Tapioca::Dsl::Compiler
- Object
- Tapioca::Dsl::Compiler
- Tapioca::Dsl::Compilers::ActiveJob
- Extended by:
- T::Sig
- Defined in:
- lib/tapioca/dsl/compilers/active_job.rb
Overview
‘Tapioca::Dsl::Compilers::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 compiler 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 collapse
- ConstantType =
type_member(fixed: T.class_of(::ActiveJob::Base))
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::SINGLETON_CLASS_METHOD, Runtime::Reflection::SUPERCLASS_METHOD
Instance Attribute Summary
Attributes inherited from Tapioca::Dsl::Compiler
Class Method Summary collapse
Instance Method Summary collapse
Methods inherited from Tapioca::Dsl::Compiler
#add_error, #compiler_enabled?, handles?, #initialize, processable_constants
Methods included from T::Generic::TypeStoragePatch
#[], #type_member, #type_template
Methods included from Runtime::Reflection
#ancestors_of, #are_equal?, #class_of, #constantize, #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
Methods included from Helpers::ParamHelper
#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
Constructor Details
This class inherits a constructor from Tapioca::Dsl::Compiler
Class Method Details
.gather_constants ⇒ Object
71 72 73 |
# File 'lib/tapioca/dsl/compilers/active_job.rb', line 71 def self.gather_constants descendants_of(::ActiveJob::Base) end |
Instance Method Details
#decorate ⇒ Object
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 46 def decorate 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(#{name_of(constant)}, FalseClass)", class_method: true ) job.create_method( "perform_now", parameters: parameters, return_type: return_type, class_method: true ) end end |