locker 0.0.3 → 0.1.0

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 /spec/database.yml
 .rvmrc
+/gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+gemfile:
+  - gemfiles/rails2.gemfile
+  - gemfiles/rails3.gemfile
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+script: bundle exec rspec

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,9 +1,19 @@
-# Locker
+# Locker [![Build Status](https://travis-ci.org/zencoder/locker.png)](https://travis-ci.org/zencoder/locker)
 
 Locker is a locking mechanism for limiting the concurrency of ruby code using the database.
 
 Locker is dependent on Postgres and the ActiveRecord (>= 2.3.14) gem.
 
+**NOTE:** In the next minor version (0.1.0), the generated Locker migration has changed to include a bigint field named `sequence` with a default of zero. Since I'm pretty sure Zencoder is the only one using this gem at the moment, I opted to not include an upgrade path. If you really must, however:
+
+In Rails 2.3.x+:
+
+    script/generate migration add_sequence_to_locks sequence:bigint
+
+In Rails 3.x+:
+
+    script/rails generate migration add_sequence_to_locks sequence:bigint
+
 ## The Basics
 
 In its simplest form it can be used as follows:
@@ -137,6 +147,14 @@ Locker.run("some-unique-key", :model => SomeOtherLockModel) do
 end
 ```
 
+If you need to know how many times the lock has been acquired, this is available as well.
+
+```ruby
+Locker.run("some-unique-key") do |sequence|
+  # sequence is the number of times the lock has been acquired
+end
+```
+
 ## A Common pattern
 
 In our use we've settled on a common pattern, one that lets us distribute the load of our processes between our application and/or utility servers while making sure we have no single point of failure. This means that no single server going down (except the database) will stop the code from executing. Continuing from the code above, we'll use the example of the RSS/Atom feed checker, `FeedChecker.check_for_new_feeds`. To improve on the previous examples, we'll make the code rotate among our servers, so over a long enough time period each server will have spent an equal amount of time running the task.

data/gemfiles/rails2.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "activerecord",  ">=2.3.14", "<3"
+
+platforms :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end
+
+platforms :ruby do
+  gem "pg"
+end
+
+group :development, :test do
+  gem "rspec"
+end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "activerecord",  ">=3.2", "<4"
+
+platforms :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end
+
+platforms :ruby do
+  gem "pg"
+end
+
+group :development, :test do
+  gem "rspec"
+end

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

@@ -1,9 +1,10 @@
 class Create<%= plural_name.camelize %> < ActiveRecord::Migration
-  <%- if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 1 -%>
+  <%- if ActiveRecord::VERSION::MAJOR > 3 || ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1 -%>
   def change
     create_table :<%= plural_name %> do |t|
       t.string :locked_by
       t.string :key
+      t.integer :sequence, :default => 0, :limit => 8
       t.datetime :locked_at
       t.datetime :locked_until
     end
@@ -15,6 +16,7 @@ class Create<%= plural_name.camelize %> < ActiveRecord::Migration
     create_table :<%= plural_name %> do |t|
       t.string :locked_by
       t.string :key
+      t.integer :sequence, :default => 0, :limit => 8
       t.datetime :locked_at
       t.datetime :locked_until
     end

data/lib/locker/locker.rb

@@ -1,10 +1,9 @@
+require "socket"
+require "securerandom"
+
 class Locker
   class LockStolen < StandardError; end
 
-  if !defined?(SecureRandom)
-    SecureRandom = ActiveSupport::SecureRandom
-  end
-
   attr_accessor :identifier, :key, :renew_every, :lock_for, :model, :locked, :blocking
 
   class << self
@@ -48,7 +47,7 @@ class Locker
           end
         end
 
-        block.call
+        block.call(sequence)
       ensure
         renewer.exit rescue nil
         release if @locked
@@ -61,7 +60,7 @@ class Locker
   end
 
   def get
-    @locked = update_all(["locked_by = ?, locked_at = clock_timestamp() at time zone 'UTC', locked_until = clock_timestamp() at time zone 'UTC' + #{lock_interval}", @identifier],
+    @locked = update_all(["locked_by = ?, locked_at = clock_timestamp() at time zone 'UTC', locked_until = clock_timestamp() at time zone 'UTC' + #{lock_interval}, sequence = sequence + 1", @identifier],
                          ["key = ? AND (locked_by IS NULL OR locked_by = ? OR locked_until < clock_timestamp() at time zone 'UTC')", @key, @identifier])
   end
 
@@ -75,6 +74,15 @@ class Locker
     @locked
   end
 
+  def sequence
+    if @sequence
+      @sequence
+    else
+      record = model.find_by_key_and_locked_by(@key, @identifier)
+      @sequence = record && record.sequence
+    end
+  end
+
 private
 
   def lock_interval

data/lib/locker/version.rb

@@ -1,3 +1,3 @@
 class Locker
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/locker.gemspec

@@ -19,5 +19,4 @@ Gem::Specification.new do |s|
   s.add_dependency "activerecord",  ">=2.3.14"
   s.add_development_dependency "pg"
   s.add_development_dependency "rspec"
-  s.add_development_dependency "autotest"
 end

data/spec/locker/locker_spec.rb

@@ -85,6 +85,25 @@ describe Locker do
         end
       end.to raise_error(Locker::LockStolen)
     end
+
+    it "should call the passed in block when the lock is aquired" do
+      value = nil
+      Locker.run("foo") do
+        value = 1
+      end
+
+      expect(value).to eq(1)
+    end
+
+    it "should pass in a sequence number representing the number of times the lock has been locked" do
+      (1..10).each do |i|
+        value = nil
+        Locker.run("foo") do |sequence|
+          value = sequence
+        end
+        expect(value).to eq(i)
+      end
+    end
   end
 
   describe "blocking" do

data/spec/spec_helper.rb

@@ -10,7 +10,19 @@ require 'locker'
 ActiveRecord::Base.time_zone_aware_attributes = true
 ActiveRecord::Base.default_timezone = "UTC"
 
-config = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
+if File.exist?(File.join(File.dirname(__FILE__), 'database.yml'))
+  config = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
+else
+  puts "database.yml did not exist, using defaults"
+  config = { "reconnect" => false,
+             "database"  => "locker_test",
+             "adapter"   => "postgresql",
+             "password"  => nil,
+             "user"      => "postgres",
+             "encoding"  => "utf8",
+             "pool"      => 5 }
+end
+
 begin
   ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
   ActiveRecord::Base.connection.create_database(config['database'], config.merge("encoding" => config['encoding'] || ENV['CHARSET'] || 'utf8'))
@@ -24,6 +36,7 @@ ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS locks")
 ActiveRecord::Base.connection.create_table(:locks) do |t|
   t.string :locked_by
   t.string :key
+  t.integer :sequence, :default => 0
   t.datetime :locked_at
   t.datetime :locked_until
 end
@@ -42,6 +55,14 @@ class FakeLock
     fake_locks[key]
   end
 
+  def self.find_by_key_and_locked_by(key, locked_by)
+    lock = fake_locks[key]
+
+    if lock && lock.locked_by == locked_by
+      lock
+    end
+  end
+
   def self.create(attributes={})
     fake_locks[attributes[:key]] = new(attributes)
     true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: locker
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nathan Sutton
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-02 00:00:00 Z
+date: 2013-04-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -62,20 +62,6 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: autotest
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
 description: Locker is a locking mechanism for limiting the concurrency of ruby code using the database. It presently only works with PostgreSQL.
 email: 
 - nate@zencoder.com
@@ -88,11 +74,14 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - autotest/discover.rb
+- gemfiles/rails2.gemfile
+- gemfiles/rails3.gemfile
 - generators/locker/USAGE
 - generators/locker/locker_generator.rb
 - generators/locker/templates/migration.rb
@@ -136,10 +125,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: locker
-rubygems_version: 1.8.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Locker is a locking mechanism for limiting the concurrency of ruby code using the database.
 test_files: 
 - spec/locker/locker_spec.rb
 - spec/spec_helper.rb
+has_rdoc: