redis_batch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d205bf5fdc9bfb375f6666e1017413f9bb2ecbdb8d696912cb9b658f3910ffed
+  data.tar.gz: 8b7521a379d318634fa2a6c8e5cf42398af416414b2fec89e1a0f9bd40e18087
+SHA512:
+  metadata.gz: 357499ea517316f46c7b80dc43d14269656141f345afb8db1cc56a8dab790bcf6fbef8b95121b7480dbdd6fb6162c572182830550ba9637c191d13a99e5ec82d
+  data.tar.gz: 685246ee83f7a97946efebf7193477cd6aee5c75ace9b92e5f5bb75cf134a4d36968e11519bd3458b8da4b65c622701193e3b622c25615fd19bfb17c747646a4

data/lib/redis_batch/client.rb

@@ -0,0 +1,31 @@
+require './lib/redis_batch/configurable'
+require 'singleton'
+
+module RedisBatch
+  class Client
+    include Singleton
+    extend RedisBatch::Configurable
+
+    def initialize(configuration)
+      if configuration.redis.respond_to?(:with)
+        @connection_pool = configuration.redis
+      else
+        @connection_pool = ConnectionPool.new(size: 1, timeout: 1) {
+          configuration.redis
+        }
+      end
+    end
+
+    def ping
+      @connection_pool.with(&:ping)
+    end
+
+    def with(...)
+      @connection_pool.with(...)
+    end
+
+    def pool
+      @connection_pool
+    end
+  end
+end

data/lib/redis_batch/configurable.rb

@@ -0,0 +1,38 @@
+require 'ostruct'
+
+module RedisBatch
+  # Add configuration to a Singleton
+  module Configurable
+    class Configuration
+      def initialize(redis:)
+        @redis = redis
+      end
+
+      attr_accessor :redis
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration
+      @configuration = nil
+    end
+
+    def configuration
+      @configuration ||= Configuration.new(**default_configuration)
+    end
+
+    private
+
+    def new
+      super(configuration)
+    end
+
+    def default_configuration
+      {
+        redis: Redis.new
+      }
+    end
+  end
+end

data/lib/redis_batch/queue.rb

@@ -0,0 +1,60 @@
+module RedisBatch
+  class Queue
+    def initialize(namespace = self.class.name)
+      @namespace = namespace
+      @client = Client.instance
+    end
+
+    def add(*items)
+      @client.with { |redis| redis.rpush(queue_key, items) }
+    end
+
+    def count
+      @client.with { |redis| redis.llen(queue_key) }
+    end
+
+    def self.processing?
+      @client.with { |redis| redis.keys("#{@namespace}_takeout_*").any? }
+    end
+
+    def abort_all
+      return unless processing?
+      keys = @client.with { |redis| redis.keys("#{@namespace}_takeout_*") }
+      client.with do |redis|
+        keys.each do |key|
+          abort_processing(key, redis)
+        end
+      end
+    end
+
+    def take(count: 1, client: @client)
+      values = client.with do |redis|
+        redis.multi do |transaction|
+          count.times.map { transaction.lmove(queue_key, take_key, :left, :right) }
+        end
+      end
+      yield values
+      client.with { |redis| redis.del(take_key) }
+    rescue => error
+      client.with { |redis| abort_processing(take_key, redis) }
+      raise error
+    end
+
+    private
+
+    def abort_processing(key, redis)
+      recover_count = redis.llen(key)
+      redis.multi do |transaction|
+        recover_count.times { transaction.lmove(take_key, queue_key, :right, :left) }
+      end
+    end
+
+    def queue_key
+      @queue_key ||= "RedisBatch/#{@namespace}_queue"
+    end
+
+    def take_key
+      @take_key ||= "RedisBatch/#{@namespace}_takeout_#{Thread.current.native_thread_id}"
+    end
+  end
+end

data/lib/redis_batch.rb

@@ -0,0 +1,16 @@
+require 'redis'
+require './lib/redis_batch/configurable'
+require './lib/redis_batch/client'
+require './lib/redis_batch/queue'
+
+module RedisBatch
+  Error = Class.new(StandardError)
+
+  def self.configure(&block)
+    Client.configure { |config| block.call(config) }
+  end
+
+  def self.configuration
+    Client.configuration
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: redis_batch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Avemark
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+description: A minimal gem for safely pushing data onto redis and taking it back out
+  in batches of any size. Designed to work well in a multi host/thread environment.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis_batch.rb
+- lib/redis_batch/client.rb
+- lib/redis_batch/configurable.rb
+- lib/redis_batch/queue.rb
+homepage: https://github.com/avemark/redis_batch_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Redis based work queue.
+test_files: []