redis_batch 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ead79130daaa5dd59b528e53f0069b2d7520f2b40001e611ea0e1ce97baadc33
-  data.tar.gz: c63abeed3e5f550ea5ce84356ac4183e9042fec24e12d87c72a6210240846d57
+  metadata.gz: 64bdfe75e083eae21c7aa0b366a44850903cb0911546644a0ade2f071d753a02
+  data.tar.gz: 30ea83d6a94380af5c01df6768869cd8c25dbb472d150549fda31279e74684f1
 SHA512:
-  metadata.gz: 9db50906c0891b09654a35d151096df5ebdd89b8fa6b854645d6eba5223840876f16fed94f3299bb12497f59dc92933169b4b67a73fb2609b82df810ab9d195e
-  data.tar.gz: 34ad2d47797b5e5fe7d73da4a300072e8a028ecb6f8a9fb971c42d7b67d5a0ee0cab5bf8e39ed763bc330bd0ec719a5a944e4d6d2df54525e69feeed284c19fb
+  metadata.gz: 93edb30262b55d8d1ba17e2a551cecbf8e8236c33cac3f60eb7288dfd831c3614e0565a6d448f0b25171b862021033779612e9595e55ea2e692ae6760bfa5ec8
+  data.tar.gz: 4c143ce57f44c0ae0638b4901672c06fe37278a18b7ce1b7f846a507bf71bd0b748c71f2a65b0891cd84602e7a8ca4e045aaa5e09e75b56e5545c80af547678f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Christian Avemark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+## Redis Batch
+
+![tests](https://github.com/avemark/redis_batch_rb/actions/workflows/tests.yaml/badge.svg)
+
+A redis queue with reliable multi-element dequeue, intended for work aggregation.  
+Requires redis version >= 7
+
+Common background work libraries like Resque, Sidekiq and GoodJob assume no coherence in 
+the elements of their work queues, and will act on elements one by one.
+
+Sometimes you want to asynchronously aggregate work units and later deal with them in batches, and this gem intends 
+to facilitate that kind of pattern.
+
+This gem does not try to deal with scheduling of dequeueing nor does it assist (much) with error handling.
+
+If an error is raised within the `take` block, the taken values are returned to the queue.
+
+If your process is killed for external reasons, the taken items might get stuck in the processing queue. `myqueue.abort_all` will clear all processing queues.  
+If you take out elements concurrently, there is currently no way to distinguish such stuck processing queues from healthy queues. A timestamping feature to alleviate this might be added in the future.
+### Usage
+```Shell
+gem install redis_batch
+```
+```Ruby
+MessageQueue = Class.new(RedisBatch::Queue)
+my_queue = MessageQueue.new
+
+my_queue.add "Hello", "world"
+my_queue.count => 2
+
+the_same_queue = RedisBatch::Queue.new("MessageQueue")
+the_same_queue.count => 2
+
+my_queue.take(10) { |messages| messages.join(", ") } => "Hello, world"
+my_queue.count => 0
+
+my_queue.add "uh", "oh"
+my_queue.take(10) { |messages| raise(messages.join("-")) } => StandardError: "uh-oh"
+my_queue.count => 2
+```

data/lib/redis_batch/lua.rb

@@ -0,0 +1,42 @@
+module RedisBatch
+  class Lua
+    def self.function_load(redis)
+      redis.call("FUNCTION", "LOAD", "REPLACE", redis_batch_lua)
+    end
+
+    def self.redis_batch_lua
+      <<~LUA
+        #!lua name=redis_batch
+
+        local function lmove(keys, args)
+          local count = tonumber(args[1])
+          local source = keys[1]
+          local target = keys[2]
+          local llen = redis.call("LLEN", source)
+          if llen < count then
+            count = llen
+          end
+          local values = {}
+          for i=1,count do
+            values[i] = redis.call("LMOVE", source, target, 'LEFT', 'RIGHT')
+          end 
+          return values
+        end
+
+        redis.register_function('rb_lmove', lmove)
+
+        local function lrestore(keys, args)
+          local source = keys[1]
+          local target = keys[2]
+          local llen = redis.call("LLEN", source)
+          for i=1,llen do
+            redis.call("LMOVE", source, target, 'RIGHT', 'LEFT')
+          end
+          return llen
+        end
+
+        redis.register_function('rb_lrestore', lrestore)
+      LUA
+    end
+  end
+end

data/lib/redis_batch/queue.rb

@@ -3,7 +3,7 @@ module RedisBatch
     def initialize(namespace = self.class.name)
       @namespace = namespace
       @client = Client.instance
-      @client.with  { |redis| Functions.function_load(redis) }
+      @client.with  { |redis| RedisBatch::Lua.function_load(redis) }
     end
 
     def add(*items)

data/lib/redis_batch.rb

@@ -1,8 +1,8 @@
 require 'redis'
-require './lib/redis_batch/configurable'
-require './lib/redis_batch/client'
-require './lib/redis_batch/functions'
-require './lib/redis_batch/queue'
+require 'redis_batch/configurable'
+require 'redis_batch/lua'
+require 'redis_batch/client'
+require 'redis_batch/queue'
 
 module RedisBatch
   Error = Class.new(StandardError)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_batch
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Christian Avemark
@@ -31,9 +31,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/redis_batch.rb
 - lib/redis_batch/client.rb
 - lib/redis_batch/configurable.rb
+- lib/redis_batch/lua.rb
 - lib/redis_batch/queue.rb
 homepage: https://github.com/avemark/redis_batch_rb
 licenses: