redis_queued_locks 1.0.0 → 1.2.0

data/lib/redis_queued_locks/acquier.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Acquier
   require_relative 'acquier/acquire_lock'
   require_relative 'acquier/release_lock'

data/lib/redis_queued_locks/client.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 # rubocop:disable Metrics/ClassLength
 class RedisQueuedLocks::Client
-  # @since 0.1.0
+  # @since 1.0.0
   include Qonfig::Configurable
 
   configuration do
@@ -41,7 +41,7 @@ class RedisQueuedLocks::Client
   # @return [RedisClient]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   attr_reader :redis_client
 
   # NOTE: attr_access here is chosen intentionally in order to have an ability to change
@@ -49,7 +49,7 @@ class RedisQueuedLocks::Client
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   attr_accessor :uniq_identity
 
   # @param redis_client [RedisClient]
@@ -60,7 +60,7 @@ class RedisQueuedLocks::Client
   # @return [void]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def initialize(redis_client, &configs)
     configure(&configs)
     @uniq_identity = config[:uniq_identifier].call
@@ -116,7 +116,7 @@ class RedisQueuedLocks::Client
   #   - If block is given the result of block's yeld will be returned.
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def lock(
     lock_name,
     ttl: config[:default_lock_ttl],
@@ -164,7 +164,7 @@ class RedisQueuedLocks::Client
   # @note See #lock method signature.
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def lock!(
     lock_name,
     ttl: config[:default_lock_ttl],
@@ -219,7 +219,7 @@ class RedisQueuedLocks::Client
   #   }
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def unlock(
     lock_name,
     logger: config[:logger],
@@ -238,7 +238,7 @@ class RedisQueuedLocks::Client
   # @return [Boolean]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def locked?(lock_name)
     RedisQueuedLocks::Acquier::IsLocked.locked?(redis_client, lock_name)
   end
@@ -247,7 +247,7 @@ class RedisQueuedLocks::Client
   # @return [Boolean]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def queued?(lock_name)
     RedisQueuedLocks::Acquier::IsQueued.queued?(redis_client, lock_name)
   end
@@ -256,7 +256,7 @@ class RedisQueuedLocks::Client
   # @return [Hash<String,String|Numeric>,NilClass]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def lock_info(lock_name)
     RedisQueuedLocks::Acquier::LockInfo.lock_info(redis_client, lock_name)
   end
@@ -265,7 +265,7 @@ class RedisQueuedLocks::Client
   # @return [Hash<String|Array<Hash<String,String|Numeric>>,NilClass]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def queue_info(lock_name)
     RedisQueuedLocks::Acquier::QueueInfo.queue_info(redis_client, lock_name)
   end
@@ -288,7 +288,7 @@ class RedisQueuedLocks::Client
   #   - { ok: false, result: :async_expire_or_no_lock }
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def extend_lock_ttl(lock_name, milliseconds, logger: config[:logger])
     RedisQueuedLocks::Acquier::ExtendLockTTL.extend_lock_ttl(
       redis_client,
@@ -311,7 +311,7 @@ class RedisQueuedLocks::Client
   #   Example: { ok: true, result { rel_key_cnt: 100, rel_time: 0.01 } }
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def clear_locks(
     batch_size: config[:lock_release_batch_size],
     logger: config[:logger],
@@ -345,7 +345,7 @@ class RedisQueuedLocks::Client
   # @return [Set<String>,Set<Hash<Symbol,Any>>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def locks(scan_size: config[:key_extraction_batch_size], with_info: false)
     RedisQueuedLocks::Acquier::Locks.locks(redis_client, scan_size:, with_info:)
   end
@@ -356,7 +356,7 @@ class RedisQueuedLocks::Client
   # @return [Set<Hash<String,Any>>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def locks_info(scan_size: config[:key_extraction_batch_size])
     locks(scan_size:, with_info: true)
   end
@@ -376,7 +376,7 @@ class RedisQueuedLocks::Client
   # @return [Set<String>,String<Hash<Symbol,Any>>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def queues(scan_size: config[:key_extraction_batch_size], with_info: false)
     RedisQueuedLocks::Acquier::Queues.queues(redis_client, scan_size:, with_info:)
   end
@@ -387,7 +387,7 @@ class RedisQueuedLocks::Client
   # @return [Set<Hash<Symbol,Any>>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def queues_info(scan_size: config[:key_extraction_batch_size])
     queues(scan_size:, with_info: true)
   end
@@ -396,17 +396,18 @@ class RedisQueuedLocks::Client
   # @return [Set<String>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   def keys(scan_size: config[:key_extraction_batch_size])
     RedisQueuedLocks::Acquier::Keys.keys(redis_client, scan_size:)
   end
 
   # @option dead_ttl [Integer]
-  #  - the time period (in millsiecnds) after whcih the lock request is
-  #    considered as dead;
-  #  - `config[:dead_request_ttl]` is used by default;
+  #   - the time period (in millsiecnds) after whcih the lock request is
+  #     considered as dead;
+  #   - `config[:dead_request_ttl]` is used by default;
   # @option scan_size [Integer]
-  #   The batch of scanned keys for Redis'es SCAN command.
+  #   - the batch of scanned keys for Redis'es SCAN command;
+  #   - `config[:lock_release_batch_size]` is used by default;
   # @option logger [::Logger,#debug]
   # @option instrumenter [#notify]
   # @option instrument [NilClass,Any]
@@ -414,10 +415,11 @@ class RedisQueuedLocks::Client
   #   Format: { ok: true, result: { processed_queus: Set<String> } }
   #
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
+  # @version 1.1.0
   def clear_dead_requests(
     dead_ttl: config[:dead_request_ttl],
-    scan_size: config[:key_extraction_batch_size],
+    scan_size: config[:lock_release_batch_size],
     logger: config[:logger],
     instrumenter: config[:instrumenter],
     instrument: nil

data/lib/redis_queued_locks/debugger/interface.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Debugger::Interface
   # @param message [String]
   # @return [void]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   def debug(message)
     RedisQueuedLocks::Debugger.debug(message)
   end
@@ -15,7 +15,7 @@ module RedisQueuedLocks::Debugger::Interface
   # @return [void]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   def enable_debugger!
     RedisQueuedLocks::Debugger.enable!
   end
@@ -23,7 +23,7 @@ module RedisQueuedLocks::Debugger::Interface
   # @return [void]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   def disable_debugger!
     RedisQueuedLocks::Debugger.disable!
   end

data/lib/redis_queued_locks/debugger.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Debugger
   require_relative 'debugger/interface'
 
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   DEBUG_ENABLED_METHOD = <<~METHOD_DECLARATION.strip.freeze
     def debug(message) = STDOUT.write("#\{message}\n")
   METHOD_DECLARATION
@@ -16,20 +16,20 @@ module RedisQueuedLocks::Debugger
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   DEBUG_DISABLED_MEHTOD = <<~METHOD_DECLARATION.strip.freeze
     def debug(message); end
   METHOD_DECLARATION
 
   class << self
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     instance_variable_set(:@enabled, false)
 
     # @return [void]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def enable!
       @enabled = true
       eval(DEBUG_ENABLED_METHOD)
@@ -38,7 +38,7 @@ module RedisQueuedLocks::Debugger
     # @return [void]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def disable!
       @enabled = false
       eval(DEBUG_DISABLED_MEHTOD)
@@ -47,7 +47,7 @@ module RedisQueuedLocks::Debugger
     # @return [Boolean]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def enabled?
       @enabled
     end
@@ -56,7 +56,7 @@ module RedisQueuedLocks::Debugger
     # @return [void]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def debug(message); end
   end
 end

data/lib/redis_queued_locks/errors.rb

@@ -2,26 +2,26 @@
 
 module RedisQueuedLocks
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   Error = Class.new(::StandardError)
 
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   ArgumentError = Class.new(::ArgumentError)
 
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   LockAlreadyObtainedError = Class.new(Error)
 
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   LockAcquiermentTimeoutError = Class.new(Error)
 
   # @api public
-  # @since 0.1.0
+  # @since 1.0.0
   LockAcquiermentRetryLimitError = Class.new(Error)
 
   # @api pulic
-  # @since 0.1.0
+  # @since 1.0.0
   TimedLockTimeoutError = Class.new(Error)
 end

data/lib/redis_queued_locks/instrument/active_support.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Instrument::ActiveSupport
   class << self
     # @param event [String]
@@ -9,7 +9,7 @@ module RedisQueuedLocks::Instrument::ActiveSupport
     # @return [void]
     #
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def notify(event, payload = {})
       ::ActiveSupport::Notifications.instrument(event, payload)
     end

data/lib/redis_queued_locks/instrument/void_notifier.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Instrument::VoidNotifier
   class << self
     # @param event [String]
@@ -9,7 +9,7 @@ module RedisQueuedLocks::Instrument::VoidNotifier
     # @return [void]
     #
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def notify(event, payload = {}); end
   end
 end

data/lib/redis_queued_locks/instrument.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Instrument
   require_relative 'instrument/void_notifier'
   require_relative 'instrument/active_support'
@@ -11,7 +11,7 @@ module RedisQueuedLocks::Instrument
     # @return [Boolean]
     #
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def valid_interface?(instrumenter)
       if instrumenter == RedisQueuedLocks::Instrument::ActiveSupport
         # NOTE: active_support should be required in your app

data/lib/redis_queued_locks/logging/void_logger.rb

@@ -1,43 +1,43 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Logging::VoidLogger
   class << self
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def warn(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def unknown(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def log(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def info(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def error(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def fatal(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def debug(progname = nil, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def add(*, &block); end
 
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
     def <<(message); end
   end
 end

data/lib/redis_queued_locks/logging.rb

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Logging
   require_relative 'logging/void_logger'
 
   class << self
-    # @param logger [::Logger,#debug]
+    # @param logger [::Logger,#debug,::SemanticLogger::Logger]
     # @return [Boolean]
     #
     # @api public
-    # @since 0.1.0
+    # @since 1.0.0
+    # @version 1.2.0
     def valid_interface?(logger)
       return true if logger.is_a?(::Logger)
 
+      # NOTE:
+      #   - convinient/conventional way to support the popular`semantic_logger` library
+      #   - see https://logger.rocketjob.io/
+      #   - see https://github.com/reidmorrison/semantic_logger
+      return true if defined?(::SemanticLogger::Logger) && logger.is_a?(::SemanticLogger::Logger)
+
       # NOTE: should provide `#debug` method.
       return false unless logger.respond_to?(:debug)
 

data/lib/redis_queued_locks/resource.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Resource
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   KEY_PATTERN = 'rql:lock*'
 
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   LOCK_PATTERN = 'rql:lock:*'
 
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   LOCK_QUEUE_PATTERN = 'rql:lock_queue:*'
 
   class << self
@@ -29,7 +29,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def calc_uniq_identity
       SecureRandom.hex(8)
     end
@@ -42,7 +42,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def acquier_identifier(process_id, thread_id, fiber_id, ractor_id, identity)
       "rql:acq:#{process_id}/#{thread_id}/#{fiber_id}/#{ractor_id}/#{identity}"
     end
@@ -51,7 +51,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def prepare_lock_key(lock_name)
       "rql:lock:#{lock_name}"
     end
@@ -60,7 +60,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def prepare_lock_queue(lock_name)
       "rql:lock_queue:#{lock_name}"
     end
@@ -68,7 +68,7 @@ module RedisQueuedLocks::Resource
     # @return [Float] Redis's <Set> score that is calculated from the time (epoch) as a float.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def calc_initial_acquier_position
       Time.now.to_f
     end
@@ -77,7 +77,7 @@ module RedisQueuedLocks::Resource
     # @return [Float] Redis's <Set> score barrier for acquiers that should be removed from queue.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def acquier_dead_score(queue_ttl)
       Time.now.to_f - queue_ttl
     end
@@ -91,7 +91,7 @@ module RedisQueuedLocks::Resource
     #   Is the lock request time limit has reached or not.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def dead_score_reached?(acquier_position, queue_ttl)
       (acquier_position + queue_ttl) < Time.now.to_f
     end
@@ -100,7 +100,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def lock_key_from_queue(lock_queue)
       # NOTE: 15 is a start position of the lock name
       "rql:lock:#{lock_queue[15..]}"
@@ -109,7 +109,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_thread_id
       ::Thread.current.object_id
     end
@@ -117,7 +117,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_fiber_id
       ::Fiber.current.object_id
     end
@@ -125,7 +125,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_ractor_id
       ::Ractor.current.object_id
     end
@@ -133,7 +133,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_process_id
       ::Process.pid
     end

data/lib/redis_queued_locks/utilities.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Utilities
   module_function
 
@@ -9,7 +9,7 @@ module RedisQueuedLocks::Utilities
   # @return [Any]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   def run_non_critical(&block)
     yield rescue nil
   end

data/lib/redis_queued_locks/version.rb

@@ -5,6 +5,6 @@ module RedisQueuedLocks
   #
   # @api public
   # @since 0.0.1
-  # @version 1.0.0
-  VERSION = '1.0.0'
+  # @version 1.2.0
+  VERSION = '1.2.0'
 end

data/lib/redis_queued_locks.rb

@@ -7,7 +7,7 @@ require 'securerandom'
 require 'logger'
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks
   require_relative 'redis_queued_locks/version'
   require_relative 'redis_queued_locks/errors'
@@ -20,6 +20,6 @@ module RedisQueuedLocks
   require_relative 'redis_queued_locks/instrument'
   require_relative 'redis_queued_locks/client'
 
-  # @since 0.1.0
+  # @since 1.0.0
   extend RedisQueuedLocks::Debugger::Interface
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Queued distributed locks based on Redis.