Module: SimpleMutex

Defined in:
lib/simple_mutex.rb,
lib/simple_mutex/mutex.rb,
lib/simple_mutex/helper.rb,
lib/simple_mutex/version.rb,
lib/simple_mutex/base_cleaner.rb,
lib/simple_mutex/sidekiq_support/batch.rb,
lib/simple_mutex/sidekiq_support/job_mixin.rb,
lib/simple_mutex/sidekiq_support/job_cleaner.rb,
lib/simple_mutex/sidekiq_support/job_wrapper.rb,
lib/simple_mutex/sidekiq_support/batch_cleaner.rb,
lib/simple_mutex/sidekiq_support/batch_callbacks.rb

Defined Under Namespace

Modules: SidekiqSupport Classes: BaseCleaner, Error, Helper, Mutex

Constant Summary collapse

VERSION = 
"1.0.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



22
23
24
 
# File 'lib/simple_mutex.rb', line 22

def logger
  @logger
end

.redis ⇒ Object

Returns the value of attribute redis.



22
23
24
 
# File 'lib/simple_mutex.rb', line 22

def redis
  @redis
end

Class Method Details

.no_redis_error ⇒ Object 



37
38
39
 
# File 'lib/simple_mutex.rb', line 37

def no_redis_error
  "You should set SimpleMutex.redis before using any functions of this gem."
end

.no_sidekiq_pro_error ⇒ Object 



41
42
43
 
# File 'lib/simple_mutex.rb', line 41

def no_sidekiq_pro_error
  "Batch related functionality requires Sidekiq Pro to be installed."
end

.redis_check! ⇒ Object

Raises:



25
26
27
 
# File 'lib/simple_mutex.rb', line 25

def redis_check!
  raise Error, no_redis_error unless redis
end

.sidekiq_pro_check! ⇒ Object

Raises:



29
30
31
 
# File 'lib/simple_mutex.rb', line 29

def sidekiq_pro_check!
  raise Error, no_sidekiq_pro_error unless sidekiq_pro_installed?
end

.sidekiq_pro_installed? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/simple_mutex.rb', line 33

def sidekiq_pro_installed?
  Object.const_defined?("Sidekiq::Pro::VERSION")
end