uncomplicated_mutex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dd807b45351f0f39f3a4b62ddb90f348e4cc71a
+  data.tar.gz: dd1221b4fa3d1a0414513dc06e7a91b1166b3a90
+SHA512:
+  metadata.gz: cfd9eb1d7d2828c673ce55f9534d96e1f6319b86f128b715f890c9fbda64a9a8fd7694c860c060ac0e9012c8fec8b4dc09032edcefa94762099b1545caed0cb4
+  data.tar.gz: e70f88dd37b4c0d1dca6616fbfd803953deff0cc10759980f89e5f8a5834eea5bbad9fc278c2b154ce16f8e42c87285dd66c62eb6c30f3a0f215d8270ba6273c

data/lib/uncomplicated_mutex.rb

@@ -0,0 +1,72 @@
+require 'digest/md5'
+require 'redis'
+
+class UncomplicatedMutex
+  attr_reader :lock_name
+
+  MutexTimeout = Class.new(StandardError)
+
+  LUA_ACQUIRE = "return redis.call('SET', KEYS[1], ARGV[2], 'NX', 'EX', ARGV[1]) and redis.call('expire', KEYS[1], ARGV[1]) and 1 or 0"
+  LUA_RELEASE = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end"
+
+  def initialize(obj, opts = {})
+    @verbose          = opts[:verbose]
+    @timeout          = opts[:timeout] || 300
+    @fail_on_timeout  = opts[:fail_on_timeout]
+    @ticks            = opts[:ticks] || 100
+    @wait_tick        = @timeout.to_f / @ticks.to_f
+    @redis            = opts[:redis] || Redis.new
+    @lock_name        = "lock:#{obj.class.name}:#{obj.id}".squeeze(":")
+    @token            = Digest::MD5.new.hexdigest("#{@lock_name}_#{Time.now.to_f}")
+  end
+
+  def acquire_mutex
+    puts("Running transaction to acquire the lock #{@lock_name}") if @verbose
+    @redis.eval(LUA_ACQUIRE, [ @lock_name ], [ @timeout, @token ]) == 1
+  end
+
+  def destroy_mutex
+    puts("Destroying the lock #{@lock_name}") if @verbose
+    @redis.del(@lock_name)
+  end
+
+  def lock(&block)
+    begin
+      wait_for_mutex
+      yield block
+    ensure
+      release_mutex
+    end
+  end
+
+  def overwrite_mutex
+    puts("Replacing the lock #{@lock_name} with #{@token}") if @verbose
+    @redis.set(@lock_name, @token)
+  end
+
+  def recurse_until_ready(depth = 1)
+    return false if depth == @ticks
+    wait_a_tick if depth > 1
+    acquire_mutex || recurse_until_ready(depth + 1)
+  end
+
+  def release_mutex
+    puts("Releasing the lock #{@lock_name} if it still holds the value '#{@token}'") if @verbose
+    @redis.eval(LUA_RELEASE, [ @lock_name ], [ @token ])
+  end
+
+  def wait_a_tick
+    puts("Sleeping #{@wait_tick} for the lock #{@lock_name} to become available") if @verbose
+    sleep(@wait_tick)
+  end
+
+  def wait_for_mutex
+    if recurse_until_ready
+      puts("Acquired lock #{@lock_name}") if @verbose
+    else
+      puts("Failed to acquire the lock") if @verbose
+      raise MutexTimeout.new("Failed to acquire the lock") if @fail_on_timeout
+      overwrite_mutex
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: uncomplicated_mutex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A mutex that uses Redis that is also not complicated.
+email: penguincoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/uncomplicated_mutex.rb
+homepage: https://github.com/penguincoder/uncomplicated_mutex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Redis. Lua. Mutex.
+test_files: []