redis_queued_locks 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e98a72e1519c54d21a6273176a7d8a3bd9fa3033b7f30ca73fdca5a4335341d
-  data.tar.gz: b2cf62db6016bd456a379feb3703989cc4a481f2eed4103c5c27a60bec624d46
+  metadata.gz: 56120a88eb6ffa4f377c014b8619cdcd227ac0efaab1c6ec6495042c74739a63
+  data.tar.gz: d1e7240b5ca0c8a18842cd609b1e9280813a0a51a62d2ed9bcacdb66d707801f
 SHA512:
-  metadata.gz: d90c848b5fb00614c3f61719d470d7a2dae008d3b6349c395674fe7bf262feea09795dafc74756a16426f499652e9cb0dcb4eef8b0dc9e2c1cc8abff2a1345d1
-  data.tar.gz: ccc6e73175a2c41988303e3ea73feeacf95833b8d318dc1318c91f800d656ea157aeca62d7eba491ca489253a01ba4489f6a4c254c32f54ef3a540c9312ca179
+  metadata.gz: f3df6ebf409fa4d97ebe51632832d6c9c64eb03a4102d68e6951def7a3d351c62e86e63014b8cc1d5c6ea4c5cd6bf9bdf5595ebdb2a3334550e7a27f2f6b0bcd
+  data.tar.gz: 6e512298fb8be556e5370574e87529b936670bec1b13250233c6ce08d9feb4c8032b1b07e90a514ff4d4687e01391424be5b546a124119c7937492baa7ef87ee

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.0.7] - 2024-02-27
+### Changed
+- Minor documentation updates;
+
 ## [0.0.6] - 2024-02-27
 ### Changed
 - Major documentation updates;

data/README.md

@@ -1,6 +1,7 @@
 # RedisQueuedLocks
 
-Distributed lock implementation with "lock acquisition queue" capabilities based on the Redis Database.
+Distributed locks with "lock acquisition queue" capabilities based on the Redis Database.
+
 Each lock request is put into a request queue and processed in order of their priority (FIFO).
 
 ---
@@ -18,7 +19,7 @@ Each lock request is put into a request queue and processed in order of their pr
   - [clear_locks](#clear_locks---release-all-locks-and-lock-queues)
 - [Instrumentation](#instrumentation)
   - [Instrumentation Events](#instrumentation-events)
-- [TODO](#todo)
+- [Todo](#todo)
 - [Contributing](#contributing)
 - [License](#license)
 - [Authors](#authors)
@@ -65,6 +66,7 @@ rq_lock_client = RedisQueuedLocks::Client.new(redis_client) do |config|
 end
 
 # Step 3: start to work with locks :)
+rq_lock_client.lock("some-lock") { puts "Hello, lock!" }
 ```
 
 ---
@@ -166,9 +168,11 @@ def lock(
 - `instrumenter` - `[#notify]`
   - See RedisQueuedLocks::Instrument::ActiveSupport for example.
 - `raise_errors` - `[Boolean]`
-  - Raise errors on library-related limits such as timeout or failed lock obtain.
+  - Raise errors on library-related limits such as timeout or retry count limit.
 - `block` - `[Block]`
   - A block of code that should be executed after the successfully acquired lock.
+  - If block is **passed** the obtained lock will be released after the block execution or it's ttl (what will happen first);
+  - If block is **not passed** the obtained lock will be released after it's ttl;
 
 Return value:
 - `[Hash<Symbol,Any>]` Format: `{ ok: true/false, result: Symbol/Hash }`;
@@ -191,7 +195,6 @@ Return value:
   { ok: false, result: :unknown }
   ```
 
-
 ---
 
 #### #lock! - exceptional lock obtaining
@@ -276,9 +279,9 @@ Return:
 
 ## Instrumentation
 
-An instrumentation layer is incapsulated in `instrumenter` object stored in configurations.
+An instrumentation layer is incapsulated in `instrumenter` object stored in [config](#configuration) (`RedisQueuedLocks::Client#config[:instrumenter]`).
 
-Instrumenter object should provide `notify(event, payload)` method with following signarue:
+Instrumenter object should provide `notify(event, payload)` method with the following signarue:
 
 - `event` - `string`;
 - `payload` - `hash<Symbol,Any>`;
@@ -286,7 +289,7 @@ Instrumenter object should provide `notify(event, payload)` method with followin
 `redis_queued_locks` provides two instrumenters:
 
 - `RedisQueuedLocks::Instrument::ActiveSupport` - `ActiveSupport::Notifications` instrumenter
-  that instrument events via `ActiveSupport::Notifications` api;
+  that instrument events via `ActiveSupport::Notifications` API;
 - `RedisQueuedLocks::Instrument::VoidNotifier` - instrumenter that does nothing;
 
 By default `RedisQueuedLocks::Client` is configured with the void notifier (which means "instrumentation is disabled").
@@ -338,11 +341,11 @@ Detalized event semantics and payload structure:
 
 ---
 
-## TODO
+## Todo
 
 - `RedisQueuedLocks::Acquier::Try.try_to_lock` - detailed successful result analization;
 - `100%` test coverage;
-- better code stylization and interesting refactorings :)
+- better code stylization and interesting refactorings;
 
 ---
 

data/lib/redis_queued_locks/acquier/release.rb

@@ -38,7 +38,7 @@ module RedisQueuedLocks::Acquier::Release
         count: batch_size
       ) do |lock_queue|
         pipeline.call('ZREMRANGEBYSCORE', lock_queue, '-inf', '+inf')
-        pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue), "0")
+        pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue), '0')
       end
 
       # Step B: release all locks

data/lib/redis_queued_locks/version.rb

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

data/redis_queued_locks.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email   = ['iamdaiver@gmail.com']
 
   spec.summary     = 'Queued distributed locks based on Redis.'
-  spec.description = 'Distributed lock implementation with "lock acquisition queue" ' \
+  spec.description = 'Distributed locks with "lock acquisition queue" ' \
                      'capabilities based on the Redis Database.'
   spec.homepage    = 'https://github.com/0exp/redis_queued_locks'
   spec.license     = 'MIT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rustam Ibragimov
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.28'
-description: Distributed lock implementation with "lock acquisition queue" capabilities
-  based on the Redis Database.
+description: Distributed locks with "lock acquisition queue" capabilities based on
+  the Redis Database.
 email:
 - iamdaiver@gmail.com
 executables: []