Class: Tapioca::Compilers::Dsl::SidekiqWorker
- Extended by:
- T::Sig
- Defined in:
- lib/tapioca/compilers/dsl/sidekiq_worker.rb
Overview
‘Tapioca::Compilers::Dsl::SidekiqWorker` generates RBI files classes that include [`Sidekiq::Worker`](github.com/mperham/sidekiq/wiki/Getting-Started).
For example, with the following class that includes ‘Sidekiq::Worker`:
~~~rb class NotifierWorker
include Sidekiq::Worker
def perform(customer_id)
# ...
end
end ~~~
this generator will produce the RBI file ‘notifier_worker.rbi` with the following content:
~~~rbi # notifier_worker.rbi # typed: true class NotifierWorker
sig { params(customer_id: T.untyped).returns(String) }
def self.perform_async(customer_id); end
sig { params(interval: T.any(DateTime, Time), customer_id: T.untyped).returns(String) }
def self.perform_at(interval, customer_id); end
sig { params(interval: Numeric, customer_id: T.untyped).returns(String) }
def self.perform_in(interval, customer_id); end
end ~~~
Instance Attribute Summary
Attributes inherited from Base
Instance Method Summary collapse
Methods inherited from Base
Constructor Details
This class inherits a constructor from Tapioca::Compilers::Dsl::Base
Instance Method Details
#decorate(root, constant) ⇒ Object
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/tapioca/compilers/dsl/sidekiq_worker.rb', line 49 def decorate(root, constant) return unless constant.instance_methods.include?(:perform) root.path(constant) do |worker| method_def = constant.instance_method(:perform) async_params = compile_method_parameters_to_parlour(method_def) # `perform_at` and is just an alias for `perform_in` so both methods technically # accept a datetime, time, or numeric but we're typing them differently so they # semantically make sense. at_params = [ Parlour::RbiGenerator::Parameter.new('interval', type: 'T.any(DateTime, Time)'), *async_params, ] in_params = [ Parlour::RbiGenerator::Parameter.new('interval', type: 'Numeric'), *async_params, ] create_method(worker, 'perform_async', parameters: async_params, return_type: 'String', class_method: true) create_method(worker, 'perform_at', parameters: at_params, return_type: 'String', class_method: true) create_method(worker, 'perform_in', parameters: in_params, return_type: 'String', class_method: true) end end |