Class: SidekiqAdminEnquerer::WebApp::JobParamWrapper Private

Inherits:
Object
  • Object
show all
Defined in:
lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

  • 0.1.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job, method, name, req) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • job (Class<ActiveJob::Base>, Class<Sidekiq::Worker>)
  • method (Symbol)
  • name (Symbol)
  • req (Symbol)

Since:

  • 0.1.0



32
33
34
35
36
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 32

def initialize(job, method, name, req)
  @job = job
  @name = name
  @req = req
end

Instance Attribute Details

#job ⇒ Class<ActiveJob::Base>, Class<Sidekiq::Worker> (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Class<ActiveJob::Base>, Class<Sidekiq::Worker>)

Since:

  • 0.1.0



16
17
18
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 16

def job
  @job
end

#name ⇒ Symbol (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Symbol)

Since:

  • 0.1.0



10
11
12
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 10

def name
  @name
end

#req ⇒ Symbol (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Symbol)

Since:

  • 0.1.0



22
23
24
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 22

def req
  @req
end

Instance Method Details

#kwarg_attr? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 0.1.0



58
59
60
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 58

def kwarg_attr?
  req == :key || req == :keyreq
end

#named_attr? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 0.1.0



66
67
68
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 66

def named_attr?
  req == :opt || req == :req
end

#optional? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 0.1.0



42
43
44
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 42

def optional?
  req == :key || req == :opt
end

#required? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 0.1.0



50
51
52
 
# File 'lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb', line 50

def required?
  req == :keyreq || req == :req
end