ar_lock 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Roland Guem
+
+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.rdoc

@@ -0,0 +1,66 @@
+= ArLock for Rails3
+
+This Rails3 Gem implements an atomic locking model based on ActiveRecord.
+
+== Install
+
+Inside your Gemfile:
+
+  gem "ar_record"
+
+and then run:
+
+* bundle install
+
+=== Gem Dependencies
+
+Please check if all those requirements are satisfied on your environment.
+
+* rails >= 3.0.0
+
+=== Inside your Application:
+
+Geting a lock is always an atomic operation. If you try to get more than one lock (by specifying an array), this is also executed atomic.
+
+==== Get lock(s):
+  Lock.get :lock_name
+or
+  Lock.get [:lock_name1, :lock_name2]
+
+optional you can specify a value (for example the user, which acquired the lock):
+  Lock.get :lock_name, :value => 'value'
+or
+  Lock.get [:lock_name1, :lock_name2], :value => 'value'
+
+You can let Lock.get block, until the lock was acquired:
+  Lock.get :lock_name, :blocking => true
+or
+  Lock.get [:lock_name1, :lock_name2], :blocking => true
+
+==== Release lock(s):
+  Lock.release :lock_name
+or
+  Lock.release [:lock_name1, :lock_name2]
+
+Only release a lock, if the value matches:
+  Lock.release :lock_name, :value => 'value'
+or
+  Lock.release [:lock_name1, :lock_name2], :value => 'value'
+
+== Generators
+
+* rails generate ar_lock:migration
+
+=== Database Setup
+
+Use
+
+  rails g ar_lock:migration
+
+This will create a database migration:
+
+  TIMESTAMP_add_ar_lock_table.rb
+
+== Copyright
+
+Copyright (c) 2011 Philip Kurmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/models/lock.rb

@@ -0,0 +1,119 @@
+class Lock < ActiveRecord::Base
+
+  # Get an atomic lock if value matches or is nil. Block until lock was successful if args[:blocking] was set to true
+  def self.get name, args = {}
+    poll_time = args[:poll_time] || 10
+    until (lock = get_lock_for(name, args)) || args[:blocking] != true do
+      sleep poll_time
+    end
+    lock
+  end
+
+
+  # Release an atomic lock if value matches or is nil
+  def self.release names, args = {}
+    successful = false
+
+    if name
+      # If names is a single string, transorm it to an array
+      names = [names.to_s] if names.class == String || names.class == Symbol
+
+      self.transaction do
+        locks = self.where(:name => names).lock(true).all
+
+        unless locks.blank?
+          successful = true
+          # Check, if the value of every selected lock matches the args[:value] unless no args[:value] was specified
+          locks.each{ |l| successful = false unless (args[:value].nil? || (args[:value] != nil && args[:value] == l.value)) }
+          # Now destroy the locks, if it is successful
+          locks.each{ |l| l.destroy } if successful
+        end
+      end
+    end
+
+    successful
+  end
+
+
+  # Release all locks for a given task. This is only working, if the value was set to "task #{task.id}"
+  def self.release_for_task task
+    self.transaction do
+      locks = self.where(:value => "task #{task.id}").lock(true).all
+      locks.each{ |l| l.destroy }
+    end
+  end
+
+
+  # Return value of a lock. When no lock was found, nil will be returned.
+  def self.get_value name
+    lock = self.where(:name => name).first
+    if lock
+      lock.value.nil? ? '' : lock.value
+    else
+      nil
+    end
+  end
+
+
+  # Destroy all locks in one atomic operation
+  def self.release_all
+    self.transaction do
+      self.all.each { |l| l.destroy }
+    end
+  end
+
+
+private
+
+
+  # Get an atomic lock if value matches or is nil
+  def self.get_lock_for names, args = {}
+    successful_if_value_matches = args[:successful_if].to_s == 'value_matches'
+    successful = false
+
+    if names
+      # If names is a single string, transorm it to an array
+      names = [names.to_s] if names.class == String || names.class == Symbol
+
+      self.transaction do
+        locks = self.where(:name => names).lock(true).all
+
+        if locks.blank?
+          names.each{ |n| self.create :name => n, :value => args[:value] }
+          successful = true
+        else
+          if args[:force]
+            names.each do |n|
+              lock = locks.find{ |l| l.name == n }
+              if lock
+                lock.update_attribute :value, args[:value]
+              else
+                self.create :name => n, :value => args[:value]
+              end
+            end
+            successful = true
+          elsif successful_if_value_matches && args[:value] != nil 
+            successful = true
+            created_locks = []
+            names.each do |n|
+              lock = locks.find{ |l| l.name == n }
+              if lock
+                successful = false if lock.value != args[:value]
+              else
+                created_locks << self.create(:name => n, :value => args[:value])
+              end
+            end
+            # Rollback created locks, if the lock acquire was not successful
+            created_locks.each{ |l| l.destroy } unless successful
+          end
+        end
+
+        # Wait some secound inside the transaction for debuging and testing purposes
+        sleep args[:debug_wait].to_i if args[:debug_wait]
+      end
+    end
+
+    successful
+  end
+
+end

data/ar_lock.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ar_lock/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ar_lock"
+  s.version     = ArLock::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Philip Kurmann"]
+  s.email       = ["philip.kurmann@inwork.ch"]
+  s.homepage    = ""
+  s.summary     = %q{Atomic lock model implemented by Active Record}
+  s.description = %q{Atomic lock mode which stores its locks in the database.}
+
+  s.rubyforge_project = "ar_lock"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/ar_lock.rb

@@ -0,0 +1,7 @@
+require 'ar_lock'
+require 'rails'
+
+module ArLock
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/ar_lock/version.rb

@@ -0,0 +1,3 @@
+module ArLock
+  VERSION = "0.0.1"
+end

data/lib/generators/ar_lock/migration/migration_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ArLock
+  class MigrationGenerator < Rails::Generators::Base
+    desc "The ar_lock migration generator creates a database migration for the lock model."
+    include Rails::Generators::Migration
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    class_option :ar_lock_table_name,
+      :type => :string,
+      :desc => "Name for the ArLock Table",
+      :required => false,
+      :default => "locks"
+
+    def initialize(args = [], options = {}, config = {})
+      super
+    end
+
+    #attr_reader :lock_table_name
+
+    # Implement the required interface for Rails::Generators::Migration.
+    # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/add_ar_lock_table.rb'
+    end
+
+  end
+end

data/lib/generators/ar_lock/migration/templates/migration.rb

@@ -0,0 +1,15 @@
+class AddArLockTable < ActiveRecord::Migration
+  def self.up
+    create_table "<%= options[:ar_lock_table_name] %>", :force => true do |t|
+      t.string :name, :null => false
+      t.string :value
+
+      t.timestamps
+    end
+    add_index "<%= options[:ar_lock_table_name] %>", :name, :unique => true
+  end
+
+  def self.down
+    drop_table "<%= options[:ar_lock_table_name] %>"
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ar_lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philip Kurmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-16 00:00:00.000000000 Z
+dependencies: []
+description: Atomic lock mode which stores its locks in the database.
+email:
+- philip.kurmann@inwork.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- app/models/lock.rb
+- ar_lock.gemspec
+- lib/ar_lock.rb
+- lib/ar_lock/version.rb
+- lib/generators/ar_lock/migration/migration_generator.rb
+- lib/generators/ar_lock/migration/templates/migration.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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ar_lock
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Atomic lock model implemented by Active Record
+test_files: []