slock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2858fe738070faddd813106acfe33aec8d486f60017666fcd077f9c54d2f242
+  data.tar.gz: 8b016b82dcbf3da5624479df233c72fdbca117ee56115aa0628c0b102ba8441e
+SHA512:
+  metadata.gz: f55eec7a7a46345958bb85bfcc4282b0b5cb24156131903eacf4d7298c9506e5ffda5e92d9e02e07f5824b0a7832ea662ff8597467fe78cd0993a54f89bb3e22
+  data.tar.gz: 14e8361b3a4ea823406192f19373eb9303bfab95f35baf55e534d4d9f2dd1ff18878708aa40b3aefcb1fbcdb075ee5fcf22fcc909f00a532fd8375f0adcb88b9

data/README.md

@@ -0,0 +1,51 @@
+# Slock
+[![Build Status](https://travis-ci.org/zoer/slock.svg)](https://travis-ci.org/zoer/slock)
+[![Code Climate](https://codeclimate.com/github/zoer/slock/badges/gpa.svg)](https://codeclimate.com/github/zoer/slock)
+[![Version Eye](https://www.versioneye.com/ruby/slock/badge.png)](https://www.versioneye.com/ruby/slock)
+[![Inline docs](http://inch-ci.org/github/zoer/slock.png)](http://inch-ci.org/github/zoer/slock)
+[![Gem Version](https://badge.fury.io/rb/slock.svg)](http://badge.fury.io/rb/slock)
+
+Slock implements Semaphore via Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slock'
+```
+
+## Usage
+
+### Singleton Class
+```ruby
+class MySemaphore
+  include Slock::Semaphore::Singleton
+
+  SIZE     = 2   # max count of simultaneous locks
+  LIFETIME = 600 # max time that lock lives after acquring (in seconds)
+  TIMEOUT  = 900 # max time that semaphore waits for lock to acquire before raising an error
+
+  def semaphore_opts
+    {
+      redis:    Redis.new(url: ENV['REDIS_URL']),
+      size:     SIZE,
+      lifetime: LIFETIME,
+      timeout:  TIMEOUT
+    }
+  end
+end
+
+MySemaphore.acquire { do_something }
+```
+
+
+### Simple
+```ruby
+sempahore = Slock::Semaphore.new 'uniq_semaphore_key',
+  redis: Redis.new(ENV['REDIS_URL']),
+  lifetime: 600,
+  timeout: 900
+
+semaphroe.acquire { do_something }
+```

data/lib/slock/errors.rb

@@ -0,0 +1,8 @@
+module Slock
+  module Errors
+    class BaseError < StandardError; end
+    class TimeoutError < BaseError; end
+    class WrongLockOwnerError < BaseError; end
+    class TokenOutOffSemaphoreSizeError < BaseError; end
+  end
+end

data/lib/slock/semaphore/health.rb

@@ -0,0 +1,59 @@
+module Slock
+  class Semaphore
+    class Health
+      extend Forwardable
+
+      # @return [Integer]
+      HEALTHCHECK_TIMEOUT = 10
+
+      def_delegators :semaphore, :key, :size, :tokens_path, :client
+
+      # @return [Slock::Semaphore]
+      attr_reader :semaphore
+
+      #
+      # @param [Slock::Semaphore] semaphore
+      #
+      def initialize(semaphore)
+        @semaphore = semaphore
+      end
+
+      def check!
+        check if lock
+      end
+
+      def check
+        client.watch(tokens_path) do
+          missing_tokens.shuffle.each do |token|
+            lock = Semaphore::Lock.new(self, token)
+            lock.fix! unless lock.live?
+          end
+        end
+      ensure
+        client.del(healthlock_path)
+        client.unwatch
+      end
+
+      #
+      # @return [Array<String>]
+      #
+      def missing_tokens
+        size.times.map(&:to_s) - client.lrange(tokens_path, 0, -1)
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def lock
+        !!client.set(healthlock_path, 1, nx: true, ex: HEALTHCHECK_TIMEOUT)
+      end
+
+      #
+      # @return [String]
+      #
+      def healthlock_path
+        key(:healthlock)
+      end
+    end
+  end
+end

data/lib/slock/semaphore/lock.rb

@@ -0,0 +1,145 @@
+module Slock
+  class Semaphore
+    class Lock
+      extend Forwardable
+
+      attr_reader :id
+      attr_reader :semaphore, :token, :lifetime
+
+      def_delegators :semaphore, :key, :client, :tokens_path
+
+      #
+      # @param [Slock::Semaphore] semaphore
+      # @param [String] token
+      # @param [Hash] opts
+      # @option opts [Integer] :timeout
+      # @option opts [Integer] :lifetime
+      #
+      def initialize(semaphore, token, opts = {})
+        @semaphore = semaphore
+        @token = token
+        @id = SecureRandom.uuid
+        @lifetime = opts.delete(:lifetime) || (10 * 60)
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def locked?
+        client.get(id_path) == id
+      end
+
+      def self.lock(semaphore, opts = {})
+        _, token = semaphore.client.blpop(semaphore.tokens_path, timeout: 0)
+        raise Errors::TokenOutOffSemaphoreSizeError if token.to_i >= semaphore.size
+
+        new(semaphore, token, opts).tap(&:lock)
+      rescue Redis::TimeoutError, Errors::WrongLockOwnerError,
+             Errors::TokenOutOffSemaphoreSizeError
+
+        retry
+      end
+
+      def lock
+        change do
+          check_owner!(true)
+          renew
+          own
+        end
+      end
+
+      def release
+        change { owned? ? _release : false }
+      end
+
+      def _release
+        client.del(id_path)
+        client.del(live_path)
+        client.rpush(tokens_path, token)
+      end
+
+      def renew
+        client.set(live_path, id, ex: lifetime)
+      end
+
+      def own
+        client.set(id_path, id)
+      end
+
+      #
+      # @param [String] allow_empty
+      #
+      # @return [Boolean]
+      #
+      def owned?(allow_empty = false)
+        owner = client.get(id_path)
+        return true if owner.nil? && allow_empty
+
+        owner == id
+      end
+
+      #
+      # @param [Boolean] allow_empty
+      #
+      # @raise [Semaphore::Errors::WrongLockOwnerError]
+      #
+      def check_owner!(allow_empty = false)
+        return if owned?(allow_empty)
+
+        raise Errors::WrongLockOwnerError, token
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def live?
+        client.exists?(live_path)
+      end
+
+      def fix!
+        change do
+          client.multi do |tx|
+            tx.del(id_path)
+            tx.del(live_path)
+            tx.lpush(tokens_path, token)
+          end
+        end
+      end
+
+      def change
+        return yield if @changable
+
+        begin
+          sleep(0.1) until client.set(lock_path, 1, nx: true, ex: 3)
+          @changable = true
+
+          yield
+        ensure
+          @changable = false
+          client.del(lock_path)
+        end
+      end
+
+      #
+      # @return [String]
+      #
+      def lock_path
+        key(:tokens, token, :lock)
+      end
+
+      #
+      # @return [String]
+      #
+      def id_path
+        key(:tokens, token, :id)
+      end
+
+      #
+      # @return [String]
+      #
+      def live_path
+        key(:tokens, token, :live)
+      end
+    end
+  end
+end

data/lib/slock/semaphore/singleton.rb

@@ -0,0 +1,34 @@
+module Slock
+  class Semaphore
+    module Singleton
+      module ClassMethods
+        def acquire(*args, &block)
+          instance.semaphore.acquire(*args, &block)
+        end
+      end
+
+      def self.included(base)
+        base.include ::Singleton
+        base.extend ClassMethods
+      end
+
+      #
+      # @return [Slock::Semaphore]
+      #
+      def semaphore
+        @semaphore ||= begin
+          opts = semaphore_opts.dup
+          key = opts.delete(:key) || "semaphore:#{self.class.name.underscore}"
+          Slock::Semaphore.new(key, opts)
+        end
+      end
+
+      #
+      # @return [Hash{Symbol => Object}]
+      #
+      def semaphore_opts
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/slock/semaphore.rb

@@ -0,0 +1,103 @@
+module Slock
+  class Semaphore
+    autoload :Lock, 'slock/semaphore/lock'
+    autoload :Health, 'slock/semaphore/health'
+    autoload :Singleton, 'slock/semaphore/singleton'
+
+    # @return [Redis]
+    attr_reader :client
+    # @return [Integer]
+    attr_reader :size
+
+    #
+    # @param [String, Symbol] key
+    # @param [Hash] opts
+    # @option opts [Integer] :size
+    # @option opts [Integer] :timeout
+    # @option opts [Integer] :lifetime
+    #
+    def initialize(key, opts = {})
+      @key = key
+      @client = opts.delete(:redis) || Redis.new
+      @size = opts.delete(:size) || 1
+      @opts = opts
+
+      initialize_semaphore
+    end
+
+    def initialize_semaphore
+      return if client.getset(init_path, '1') == '1'
+
+      client.del(tokens_path) if client.exists?(tokens_path)
+      size.times { |n| client.rpush(tokens_path, n) }
+    end
+
+    #
+    # @param [Hash] opts
+    # @option opts [Integer] :timeout
+    # @option opts [Integer] :lifetime
+    #
+    # @return [Slock::Semaphore::Lock] returns lock's handler when no block is provided
+    # @return [Object] returns yielded block resulst when block is provided
+    #
+    def acquire(opts = {})
+      check_health!
+      opts = @opts.merge(opts)
+      lock = opts[:timeout] ? acquire_timeout(opts) : acquire_notimeout(opts)
+      return lock unless block_given?
+
+      yield(lock) if lock.locked?
+    ensure
+      lock&.release if block_given?
+    end
+
+    #
+    # @param [Hash] opts
+    # @option opts [Integer] :timeout
+    # @option opts [Integer] :lifetime
+    #
+    # @return [Slock::Semaphore::Lock]
+    #
+    def acquire_timeout(opts = {})
+      Timeout.timeout(opts[:timeout]) { acquire_notimeout(opts) }
+    rescue Timeout::Error
+      raise Errors::TimeoutError
+    end
+
+    #
+    # @param [Hash] opts
+    # @option opts [Integer] :timeout
+    # @option opts [Integer] :lifetime
+    #
+    # @return [Slock::Semaphore::Lock]
+    #
+    def acquire_notimeout(opts = {})
+      Semaphore::Lock.lock(self, opts)
+    end
+
+    def check_health!
+      Semaphore::Health.new(self).check!
+    end
+
+    #
+    # @param [Arra<String, Symbol, nil, Integer>] postfixes
+    #
+    def key(*postfixes)
+      [@key, *postfixes].compact.join(':')
+    end
+
+    #
+    # @return [String]
+    #
+    def tokens_path
+      key(:tokens)
+    end
+
+    #
+    # @return [String]
+    #
+    def init_path
+      key(:init)
+    end
+  end
+end

data/lib/slock/version.rb

@@ -0,0 +1,3 @@
+module Slock
+  VERSION = '0.0.1'.freeze
+end

data/lib/slock.rb

@@ -0,0 +1,7 @@
+require 'securerandom'
+require 'forwardable'
+
+module Slock
+  autoload :Semaphore, 'slock/semaphore'
+  autoload :Errors, 'slock/errors'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: slock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oleg Yashchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Gem provide Semaphore lock via Redis
+email: oazoer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/slock.rb
+- lib/slock/errors.rb
+- lib/slock/semaphore.rb
+- lib/slock/semaphore/health.rb
+- lib/slock/semaphore/lock.rb
+- lib/slock/semaphore/singleton.rb
+- lib/slock/version.rb
+homepage: https://github.com/zoer/slock
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Sempahore Lock
+test_files: []