redis_queued_locks 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb745a97296f4661f7a68d7719d7bdb894521348d6aa25b92b23b4fcffce56cd
-  data.tar.gz: e12566b1c653ad97bf973887d4511482c628d8ec27fd265901d1d4bfba9c112b
+  metadata.gz: '0993079d1a7cca97094c741d65c4ef1e8a5694184212b6597960e0b3c91d83cb'
+  data.tar.gz: 22535e254fa22db6bfb0225f391e3d4606ad680bb401034fcbdfcd8e93a1fc5c
 SHA512:
-  metadata.gz: c3e6f4c421c8e6fb9b3933c01ebcd23d5762f0bdb0581333e2d85ab478a8002d8bce360bfabaab29d819c92a4f148e6562d0fa426e5999b0fc2d1c9b59f3eaa7
-  data.tar.gz: 42a5800757191ea80797c7462b765c5dd4187771ce73c6c9af70f6653dea5599710d8569b5a2fc1a0c30cb0b3483abfac557bd888a7f4bcbde4ac4a7de308021
+  metadata.gz: 7db77251aefc59a83a9727d756774f5eb6b30a156fd058d69ec5170d252cc8fb875b2f213da2e15a4bdf9f5565565aa5ca699545ac0a83dcbc333fbed8c7aec1
+  data.tar.gz: 659c47a6aaa421ade9c7ffaea000a7133c1ba72f5ab0a2e66bc56f5ad72f84f4d9525fc86024e5d52b8196a6dfc7b0a714100462915a91405c97c3b3d77d3e26

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.0.18] - 2024-03-04
+### Changed
+- Semantic results for methods returning `{ ok: true/false, result: Any }` hash objects.
+  Now these objects are represented as `RedisQueuedLocks::Data` objects inherited from `Hash`;
+
 ## [0.0.17] - 2024-02-29
 ### Added
 - `RedisQueuedLocks::Client#locks` - list of obtained locks;

data/README.md

@@ -1,4 +1,4 @@
-# RedisQueuedLocks · [![Gem Version](https://badge.fury.io/rb/redis_queued_locks.svg)](https://badge.fury.io/rb/redis_queued_locks)
+# RedisQueuedLocks
 
 Distributed locks with "lock acquisition queue" capabilities based on the Redis Database.
 
@@ -244,6 +244,7 @@ Return value:
 #### #lock! - exceptional lock obtaining
 
 - fails when (and with):
+  - (`RedisQueuedLocks::LockAlreadyObtainedError`) when `fail_fast` is `true` and lock is already obtained;
   - (`RedisQueuedLocks::LockAcquiermentTimeoutError`) `timeout` limit reached before lock is obtained;
   - (`RedisQueuedLocks::LockAcquiermentRetryLimitError`) `retry_count` limit reached before lock is obtained;
 

data/lib/redis_queued_locks/acquier/release.rb

@@ -8,7 +8,7 @@ module RedisQueuedLocks::Acquier::Release
   # @param redis [RedisClient]
   # @param lock_key [String]
   # @param lock_key_queue [String]
-  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
+  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
   #
   # @api private
   # @since 0.1.0
@@ -18,14 +18,14 @@ module RedisQueuedLocks::Acquier::Release
       transact.call('EXPIRE', lock_key, '0')
     end
 
-    { ok: true, result: }
+    RedisQueuedLocks::Data[ok: true, result:]
   end
 
   # Release all locks: clear all lock queus and expire all locks.
   #
   # @param redis [RedisClient]
   # @param batch_size [Integer]
-  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
+  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
   #
   # @api private
   # @since 0.1.0
@@ -55,6 +55,6 @@ module RedisQueuedLocks::Acquier::Release
 
     rel_keys = result.count { |red_res| red_res == 0 }
 
-    { ok: true, result: { rel_keys: rel_keys } }
+    RedisQueuedLocks::Data[ok: true, result: { rel_keys: rel_keys }]
   end
 end

data/lib/redis_queued_locks/acquier/try.rb

@@ -130,13 +130,13 @@ module RedisQueuedLocks::Acquier::Try
     case
     when fail_fast && inter_result == :fail_fast_no_try
       # Step 7.a: lock is still acquired and we should exit from the logic as soon as possible
-      { ok: false, result: inter_result }
+      RedisQueuedLocks::Data[ok: false, result: inter_result]
     when inter_result == :lock_is_still_acquired || inter_result == :acquier_is_not_first_in_queue
       # Step 7.b: lock is still acquired by another process => failed to acquire
-      { ok: false, result: inter_result }
+      RedisQueuedLocks::Data[ok: false, result: inter_result]
     when result == nil || (result.is_a?(::Array) && result.empty?)
       # Step 7.c: lock is already acquired durign the acquire race => failed to acquire
-      { ok: false, result: :lock_is_acquired_during_acquire_race }
+      RedisQueuedLocks::Data[ok: false, result: :lock_is_acquired_during_acquire_race]
     when result.is_a?(::Array) && result.size == 3 # NOTE: 3 is a count of redis lock commands
       # TODO:
       #   => (!) analyze the command result and do actions with the depending on it;
@@ -147,10 +147,13 @@ module RedisQueuedLocks::Acquier::Try
       #   3. pexpire should return 1 (expiration time is successfully applied)
 
       # Step 7.d: locked! :) let's go! => successfully acquired
-      { ok: true, result: { lock_key: lock_key, acq_id: acquier_id, ts: timestamp, ttl: ttl } }
+      RedisQueuedLocks::Data[
+        ok: true,
+        result: { lock_key: lock_key, acq_id: acquier_id, ts: timestamp, ttl: ttl }
+      ]
     else
       # Ste 7.3: unknown behaviour :thinking:
-      { ok: false, result: :unknown }
+      RedisQueuedLocks::Data[ok: false, result: :unknown]
     end
     # rubocop:enable Lint/DuplicateBranch
   end
@@ -170,6 +173,6 @@ module RedisQueuedLocks::Acquier::Try
       "Step ~ [СМЕРТЬ ПРОЦЕССА]: [#{acquier_id} :: #{lock_key_queue}] РЕЗУЛЬТАТ: #{result}"
     )
 
-    { ok: true, result: result }
+    RedisQueuedLocks::Data[ok: true, result: result]
   end
 end

data/lib/redis_queued_locks/acquier.rb

@@ -63,7 +63,7 @@ module RedisQueuedLocks::Acquier
     #   already obtained.
     # @param [Block]
     #   A block of code that should be executed after the successfully acquired lock.
-    # @return [Hash<Symbol,Any>,yield]
+    # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>,yield]
     #  - Format: { ok: true/false, result: Any }
     #  - If block is given the result of block's yeld will be returned.
     #
@@ -232,7 +232,7 @@ module RedisQueuedLocks::Acquier
             end
           end
         else
-          { ok: true, result: acq_process[:lock_info] }
+          RedisQueuedLocks::Data[ok: true, result: acq_process[:lock_info]]
         end
       else
         if acq_process[:result] != :retry_limit_reached &&
@@ -245,7 +245,7 @@ module RedisQueuedLocks::Acquier
           acq_process[:result] = :timeout_reached
         end
         # Step 3.b: lock is not acquired (acquier is dequeued by timeout callback)
-        { ok: false, result: acq_process[:result] }
+        RedisQueuedLocks::Data[ok: false, result: acq_process[:result]]
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/BlockNesting
@@ -257,10 +257,14 @@ module RedisQueuedLocks::Acquier
     # It is safe because the lock obtain logic is transactional and
     # watches the original lock for changes.
     #
-    # @param redis [RedisClient] Redis connection client.
-    # @param lock_name [String] The lock name that should be released.
-    # @param isntrumenter [#notify] See RedisQueuedLocks::Instrument::ActiveSupport for example.
-    # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Hash<Symbil,Numeric|String> }
+    # @param redis [RedisClient]
+    #   Redis connection client.
+    # @param lock_name [String]
+    #   The lock name that should be released.
+    # @param isntrumenter [#notify]
+    #   See RedisQueuedLocks::Instrument::ActiveSupport for example.
+    # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>]
+    #   Format: { ok: true/false, result: Hash<Symbil,Numeric|String> }
     #
     # @api private
     # @since 0.1.0
@@ -283,17 +287,24 @@ module RedisQueuedLocks::Acquier
         })
       end
 
-      { ok: true, result: { rel_time: rel_time, rel_key: lock_key, rel_queue: lock_key_queue } }
+      RedisQueuedLocks::Data[
+        ok: true,
+        result: { rel_time: rel_time, rel_key: lock_key, rel_queue: lock_key_queue }
+      ]
     end
 
     # Release all locks:
     # - 1. clear all lock queus: drop them all from Redis database by the lock queue pattern;
     # - 2. delete all locks: drop lock keys from Redis by the lock key pattern;
     #
-    # @param redis [RedisClient] Redis connection client.
-    # @param batch_size [Integer] The number of lock keys that should be released in a time.
-    # @param isntrumenter [#notify] See RedisQueuedLocks::Instrument::ActiveSupport for example.
-    # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Hash<Symbol,Numeric> }
+    # @param redis [RedisClient]
+    #   Redis connection client.
+    # @param batch_size [Integer]
+    #   The number of lock keys that should be released in a time.
+    # @param isntrumenter [#notify]
+    #   See RedisQueuedLocks::Instrument::ActiveSupport for example.
+    # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>]
+    #   Format: { ok: true/false, result: Hash<Symbol,Numeric> }
     #
     # @api private
     # @since 0.1.0
@@ -312,7 +323,10 @@ module RedisQueuedLocks::Acquier
         })
       end
 
-      { ok: true, result: { rel_key_cnt: result[:rel_keys], rel_time: rel_time } }
+      RedisQueuedLocks::Data[
+        ok: true,
+        result: { rel_key_cnt: result[:rel_keys], rel_time: rel_time }
+      ]
     end
 
     # @param redis_client [RedisClient]

data/lib/redis_queued_locks/client.rb

@@ -92,7 +92,7 @@ class RedisQueuedLocks::Client
   #   by another process while the lock request queue was initially empty;
   # @param block [Block]
   #   A block of code that should be executed after the successfully acquired lock.
-  # @return [Hash<Symbol,Any>,yield]
+  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>,yield]
   #   - Format: { ok: true/false, result: Symbol/Hash }.
   #   - If block is given the result of block's yeld will be returned.
   #
@@ -163,8 +163,10 @@ class RedisQueuedLocks::Client
     )
   end
 
-  # @param lock_name [String] The lock name that should be released.
-  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
+  # @param lock_name [String]
+  #   The lock name that should be released.
+  # @return [RedisQueuedLocks::Data, Hash<Symbol,Any>]
+  #   Format: { ok: true/false, result: Symbol/Hash }.
   #
   # @api public
   # @since 0.1.0
@@ -219,7 +221,8 @@ class RedisQueuedLocks::Client
   end
 
   # @option batch_size [Integer]
-  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
+  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>]
+  #   Format: { ok: true/false, result: Symbol/Hash }.
   #
   # @api public
   # @since 0.1.0

data/lib/redis_queued_locks/data.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# NOTE: wiill be rewritten with Ruby's 3.2 "Data" class;
+class RedisQueuedLocks::Data < Hash
+end

data/lib/redis_queued_locks/version.rb

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

data/lib/redis_queued_locks.rb

@@ -10,6 +10,7 @@ require 'securerandom'
 module RedisQueuedLocks
   require_relative 'redis_queued_locks/version'
   require_relative 'redis_queued_locks/errors'
+  require_relative 'redis_queued_locks/data'
   require_relative 'redis_queued_locks/debugger'
   require_relative 'redis_queued_locks/resource'
   require_relative 'redis_queued_locks/acquier'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -61,6 +61,7 @@ files:
 - lib/redis_queued_locks/acquier/release.rb
 - lib/redis_queued_locks/acquier/try.rb
 - lib/redis_queued_locks/client.rb
+- lib/redis_queued_locks/data.rb
 - lib/redis_queued_locks/debugger.rb
 - lib/redis_queued_locks/debugger/interface.rb
 - lib/redis_queued_locks/errors.rb