lockable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--order random
+--colour
+--format nested
+--drb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+gem 'rspec'
+gem 'redis'

data/README.md

@@ -0,0 +1 @@
+# Lockable

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+task :default do
+  system "rake -T"
+end
+
+desc 'cleanup working copy'
+task :clean do
+  FileUtils.rm_rf %w(coverage pkg) + Dir['log/*.log'] + Dir['tmp/*']
+end

data/lib/lockable/version.rb

@@ -0,0 +1,3 @@
+module Lockable
+  VERSION = '0.0.1'
+end

data/lib/lockable.rb

@@ -0,0 +1,64 @@
+require 'lockable/version'
+
+module Lockable
+
+  class << self
+
+    attr_accessor :redis
+    attr_writer :lock_timeout
+
+    DEFAULT_LOCK_TIMEOUT = 5 * 60 * 60
+
+    def lock_timeout
+      @lock_timeout || DEFAULT_LOCK_TIMEOUT
+    end
+
+  end
+
+  def lock!(holder)
+    raise ArgumentError unless holder
+
+    return true if acquire_lock(holder)
+
+    if locked? and lock_holder == holder.to_s
+      return extend_lock
+    end
+
+    false
+  end
+
+  def locked?
+    !!lock_holder
+  end
+
+  def unlock!
+    !!redis.del(lock_key)
+  end
+
+  def lock_holder
+    redis.get(lock_key)
+  end
+
+  def lock_timeout
+    redis.ttl(lock_key).to_i
+  end
+
+  private
+
+  def acquire_lock(holder)
+    !!redis.set(lock_key, holder, ex: Lockable.lock_timeout, nx: true)
+  end
+
+  def extend_lock
+    !!redis.expire(lock_key, Lockable.lock_timeout)
+  end
+
+  def lock_key
+    "lock:#{self.class.name.downcase}:#{id}"
+  end
+
+  def redis
+    Lockable.redis
+  end
+
+end

data/lockable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift lib
+
+require 'lockable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lockable'
+  spec.version       = Lockable::VERSION
+  spec.authors       = ['cmertz']
+  spec.email         = ['chris@nimel.de']
+  spec.description   = 'minimalist locking using redis'
+  spec.summary       = 'minimalist locking using redis'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'redis'
+end

data/spec/lockable_spec.rb

@@ -0,0 +1,114 @@
+require 'ostruct'
+
+describe Lockable do
+
+  subject do
+    OpenStruct.new(id: 1).extend(Lockable)
+  end
+
+  before do
+    Lockable.redis.del(subject.send(:lock_key))
+  end
+
+  describe '#lock!' do
+
+    it 'needs a lock holder' do
+      expect { subject.lock!(nil) }.to raise_error(ArgumentError)
+    end
+
+    it 'locks' do
+      subject.lock!('toto').should be_true
+    end
+
+    context 'already locked' do
+
+      before do
+        Lockable.lock_timeout = 10
+        subject.lock!('toto')
+      end
+
+      it 'does not lock again' do
+        subject.lock!('tata')
+        subject.lock_holder.should eq 'toto'
+      end
+
+      it 'extends the ttl' do
+        Lockable.lock_timeout = 100
+        subject.lock!('toto')
+        subject.lock_timeout.should eq 100
+      end
+
+      it 'does not extend the ttl' do
+        Lockable.lock_timeout = 100
+        subject.lock!('tata')
+        subject.lock_timeout.should eq 10
+      end
+
+    end
+  end
+
+  describe '#lock_timeout' do
+
+    it 'does not have a timeout if not locked' do
+      subject.lock_timeout.should == -1
+    end
+
+    it 'sets a ttl' do
+      subject.lock!('toto')
+      subject.lock_timeout.should_not be_nil
+    end
+
+  end
+
+  describe '#locked?' do
+
+    it { should_not be_locked }
+
+    it 'should be locked' do
+      expect { subject.lock!('toto') }.to change{
+        subject.locked?
+      }.from(false).to(true)
+    end
+
+  end
+
+  describe '#unlock!' do
+
+    before do
+      subject.lock!('toto')
+    end
+
+    it 'is not locked anymore' do
+      expect { subject.unlock! }.to change{
+        subject.locked?
+      }.from(true).to(false)
+    end
+
+    it 'does not have a lock_holder anymore' do
+      expect { subject.unlock! }.to change{
+        subject.lock_holder
+      }.from('toto').to(nil)
+    end
+
+    it 'does not have a lock_timeout anymore' do
+      expect { subject.unlock! }.to change{
+        subject.lock_timeout
+      }.to(-1)
+    end
+
+  end
+
+  describe '#lock_holder' do
+
+    it 'does not have one' do
+      subject.lock_holder.should be nil
+    end
+
+    it 'does have one' do
+      subject.lock!('toto')
+      subject.lock_holder.should eq 'toto'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+Bundler.require
+
+require 'lockable'
+
+Lockable.redis = Redis.new

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: lockable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- cmertz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: minimalist locking using redis
+email:
+- chris@nimel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/lockable.rb
+- lib/lockable/version.rb
+- lockable.gemspec
+- spec/lockable_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3763012555333573935
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3763012555333573935
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: minimalist locking using redis
+test_files:
+- spec/lockable_spec.rb
+- spec/spec_helper.rb