cirrus 0.0.3

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/.rvmrc

@@ -0,0 +1 @@
+rvm --create use "ruby-1.9.3-p194@cirrus"

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cirrus.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Duncan Grazier
+
+MIT License
+
+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,41 @@
+# Cirrus ![Travis-CI status](https://secure.travis-ci.org/itsmeduncan/cirrus.png)
+
+A simple tool that leverages Redis to allow you to safetly lock your blocks of code
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cirrus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cirrus
+
+## Usage
+
+    Cirrus.lock(me.id, you.id) do
+      "Yay!"
+    end
+
+    # => Yay!
+
+    Cirrus.lock(me.id, you.id) do
+      Cirrus.lock(me.id, you.id) do
+        "Yay!"
+      end
+    end
+
+    # => Cirrus::UnlockableExecption
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :default => :test

data/cirrus.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cirrus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Duncan Grazier"]
+  gem.email         = ["itsmeduncan@gmail.com"]
+  gem.description   = %q{Transactional-like locking for your blocks of code}
+  gem.summary       = %q{A simple tool that leverages Redis to allow you to safetly lock your blocks of code}
+  gem.homepage      = "https://github.com/itsmeduncan/cirrus"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+  gem.name          = "cirrus"
+  gem.require_paths = ["lib"]
+  gem.version       = Cirrus::VERSION
+
+  gem.add_development_dependency("minitest",  "~> 3.3.0")
+
+  gem.add_dependency("rake", "~> 0.9.2.2")
+  gem.add_dependency("redis", "~> 3.0.1")
+end

data/lib/cirrus.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+
+require "securerandom"
+require "redis"
+
+require "cirrus/version"
+require "cirrus/lock"
+
+module Cirrus
+  class UnlockableException < Exception; end
+
+  def self.lock(redis, *ids)
+    lock = Cirrus::Lock.new(redis, ids)
+
+    raise UnlockableException.new("Could not set lock: #{ids.inspect}") unless lock.set
+
+    yield
+
+  ensure
+    lock.release
+
+  end
+
+end

data/lib/cirrus/lock.rb

@@ -0,0 +1,46 @@
+class Cirrus::Lock
+  attr_accessor :id, :redis, :values
+
+  LOCKED = "cirrus:locked"
+  LOCKS  = "cirrus:locks"
+
+  def initialize(redis, *values)
+    @redis  = redis
+
+    @id     = SecureRandom.hex(8)
+    @values = values
+  end
+
+  def set
+    redis.multi do
+      redis.sadd(LOCKS, id)
+      redis.sadd(LOCKED, values)
+      redis.sadd(pointer, values)
+    end.all? { |result| result.is_a?(Integer) ? result > 0 : result == true }
+  end
+
+  def release
+    releasable_ids = redis.smembers(pointer)
+
+    redis.multi do
+      redis.srem(pointer, releasable_ids)
+      redis.srem(LOCKED, values)
+      redis.srem(LOCKS, id)
+    end.all? { |result| result.is_a?(Integer) ? result > 0 : result == true }
+  end
+
+  def locked?
+    redis.multi do
+      values.each do |value|
+        redis.sismember(LOCKED, value)
+      end
+    end.any? { |result| result == true }
+  end
+
+  private
+
+  def pointer
+    "cirrus:#{id}:pointers"
+  end
+
+end

data/lib/cirrus/version.rb

@@ -0,0 +1,3 @@
+module Cirrus
+  VERSION = "0.0.3"
+end

data/test/cirrus/test_cirrus.rb

@@ -0,0 +1,28 @@
+require 'minitest_helper'
+
+class TestCirrus < MiniTest::Unit::TestCase
+
+  def setup
+    @redis = Redis.new
+    @redis.flushall
+  end
+
+  def test_cirrus_runs_the_block
+    assert_equal(:foo, Cirrus.lock(@redis, 1,2) { :foo })
+  end
+
+  def test_cirrus_raises_because_it_is_locked
+    lambda {
+      Cirrus.lock(@redis, 1, 2) { Cirrus.lock(@redis, 1, 2) { :foo } }
+    }.must_raise Cirrus::UnlockableException
+  end
+
+  def test_it_releases_if_there_is_an_error
+    lambda {
+      Cirrus.lock(@redis, 1, 2) { raise ArgumentError }
+    }.must_raise ArgumentError
+
+    assert_equal(:foo, Cirrus.lock(@redis, 1, 2) { :foo })
+  end
+
+end

data/test/cirrus/test_lock.rb

@@ -0,0 +1,66 @@
+require 'minitest_helper'
+
+class TestLock < MiniTest::Unit::TestCase
+
+  def setup
+    @redis = Redis.new
+    @redis.flushall
+  end
+
+  def test_lock_generates_an_id
+    Cirrus::Lock.new(@redis, :foo).id.wont_be_nil
+  end
+
+  def test_lock_sets_up_redis
+    Cirrus::Lock.new(@redis, :foo).redis.wont_be_nil
+  end
+
+  def test_lock_sets_up_values
+    assert_equal([:foo, :bar], Cirrus::Lock.new(@redis, :foo, :bar).values)
+  end
+
+  def test_set_returns_true
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+
+    assert_equal(true, lock.set)
+  end
+
+  def test_set_returns_false_if_it_is_already_set
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    lock.set
+
+    assert_equal(false, lock.set)
+  end
+
+  def test_release_frees_the_lock
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    lock.set
+    assert_equal(true, lock.release)
+  end
+
+  def test_release_returns_false
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    assert_equal(false, lock.release)
+  end
+
+  def test_release_frees_the_lock
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    lock.set
+
+    lock.release
+    assert_equal(false, lock.locked?)
+  end
+
+  def test_locked_returns_true
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    lock.set
+
+    assert_equal(true, lock.locked?)
+  end
+
+  def test_locked_returns_false
+    lock = Cirrus::Lock.new(@redis, :foo, :bar)
+    assert_equal(false, lock.locked?)
+  end
+
+end

data/test/minitest_helper.rb

@@ -0,0 +1,3 @@
+require "minitest/autorun"
+
+require "#{File.dirname(__FILE__)}/../lib/cirrus"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cirrus
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Duncan Grazier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: Transactional-like locking for your blocks of code
+email:
+- itsmeduncan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cirrus.gemspec
+- lib/cirrus.rb
+- lib/cirrus/lock.rb
+- lib/cirrus/version.rb
+- test/cirrus/test_cirrus.rb
+- test/cirrus/test_lock.rb
+- test/minitest_helper.rb
+homepage: https://github.com/itsmeduncan/cirrus
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple tool that leverages Redis to allow you to safetly lock your blocks
+  of code
+test_files:
+- test/cirrus/test_cirrus.rb
+- test/cirrus/test_lock.rb
+- test/minitest_helper.rb