locker 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  metadata.gz: b1f742b2a4f11f79b4f47ba505a8f08bc0014932806e1af33e267a580acdcae3583641ff4ed00d7ce627680ab384c3bfa044a3eabddcaf0740f631c2ed93893b
-  data.tar.gz: 093dfdf74134fd108e7dd9450b37f80544678ab3662bcb75fd25bc54899d5cafad2d11075f7df64253fab6fae0ef166eeaa1988547c9c118ddba1dfde2e65e30
-SHA1: 
-  metadata.gz: 4d31db0d4478e7101d795093e417f9189b8ceaf1
-  data.tar.gz: b92edff7f04603bfca7b4c6a87be37d3a6f9250a
+---
+SHA1:
+  metadata.gz: 8d4fe6495ead44c7d486b9b92e2e3a1e426f544c
+  data.tar.gz: 992771712a5be9b554ca67b55c89f7817b3dcd63
+SHA512:
+  metadata.gz: a8118488900768eb4350649fd1e03b0ad96dcc16777975163f914b46e6b89ba25a226189e8e4ad864f4b60197d7adccd709402c04384b5ee1885771f455e63c7
+  data.tar.gz: b225d2c0d59c66ceaf30a194e76b4a58606bac879adf83e74b85cd6f60561630f1def4ae9fdd6c47f5dbc67596356f81909dca3b7d9c761fd2d13ed60f6144b6

data/.ruby-gemset

@@ -0,0 +1 @@
+locker

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -2,13 +2,7 @@ language: ruby
 gemfile:
   - gemfiles/rails3.gemfile
 rvm:
-  - 1.8.7
-  - ree
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - jruby-18mode
+  - 2.1.5
+  - 2.2.1
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
 script: bundle exec rspec

data/Gemfile

@@ -1,3 +1,8 @@
 source "https://rubygems.org"
 
-gemspec
+gem "activerecord", ">=3.2", "<5"
+
+group :development, :test do
+  gem "pg"
+  gem "rspec", "~> 3.2.0"
+end

data/README.md

@@ -4,17 +4,6 @@ Locker is a locking mechanism for limiting the concurrency of ruby code using th
 
 Locker is dependent on Postgres and the ActiveRecord (>= 3.2.0) 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 3.x+:
-
-    script/rails generate migration add_sequence_to_locks sequence:bigint
-
-Then add a line that changes the default of the column to zero and updates the existing records:
-
-    change_column_default :locks, :sequence, 0
-    execute "UPDATE locks SET sequence = 0"
-
 ## Supported Rubies
 
 See [the travis configuration file](https://github.com/zencoder/locker/blob/master/.travis.yml) for which ruby versions we support.

data/lib/locker/advisory.rb

@@ -32,8 +32,6 @@ class Locker
     def run(&block)
       connection = ActiveRecord::Base.connection_pool.checkout
       connection.transaction :requires_new => true do
-        ensure_unlocked(connection)
-
         while !get(connection) && @blocking
           sleep 0.5
         end
@@ -57,7 +55,7 @@ class Locker
 
             block.call
           ensure
-            release(connection) if @locked
+            @locked = false
             # Using a mutex to synchronize so that we're sure we're not
             # executing a query when we kill the thread.
             mutex.synchronize{}
@@ -81,15 +79,6 @@ class Locker
       @locked = successful_result?(result)
     end
 
-    def release(connection)
-      result = exec_query(connection, "SELECT pg_advisory_unlock(#{connection.quote(@lockspace)}, #{connection.quote(@crc)})")
-      successful_result?(result)
-    end
-
-    def ensure_unlocked(connection)
-      while release(connection); end
-    end
-
     def check(connection, thread)
       if !connection.active?
         @locked = false
@@ -108,9 +97,7 @@ class Locker
     end
 
     def exec_query(connection, query)
-      silence_stderr do
-        connection.exec_query(query, "Locker::Advisory")
-      end
+      connection.exec_query(query, "Locker::Advisory")
     end
 
   end

data/lib/locker/locker.rb

@@ -60,16 +60,21 @@ 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}, sequence = sequence + 1", @identifier],
-                         ["key = ? AND (locked_by IS NULL OR locked_by = ? OR locked_until < clock_timestamp() at time zone 'UTC')", @key, @identifier])
+    @locked = updated?(model.
+                       where(["key = ? AND (locked_by IS NULL OR locked_by = ? OR locked_until < clock_timestamp() at time zone 'UTC')", @key, @identifier]).
+                       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]))
   end
 
   def release
-    @locked = update_all(["locked_by = NULL"],["key = ? and locked_by = ?", @key, @identifier])
+    @locked = updated?(model.
+                       where(["key = ? and locked_by = ?", @key, @identifier]).
+                       update_all(["locked_by = NULL"]))
   end
 
   def renew(thread=Thread.current)
-    @locked = update_all(["locked_until = clock_timestamp() at time zone 'UTC' + #{lock_interval}"], ["key = ? and locked_by = ?", @key, @identifier])
+    @locked = updated?(model.
+                       where(["key = ? and locked_by = ?", @key, @identifier]).
+                       update_all(["locked_until = clock_timestamp() at time zone 'UTC' + #{lock_interval}"]))
     thread.raise LockStolen unless @locked
     @locked
   end
@@ -96,8 +101,8 @@ private
   end
 
   # Returns a boolean. True if it updates any rows, false if it didn't.
-  def update_all(*args)
-    model.update_all(*args) > 0
+  def updated?(rows_updated)
+    rows_updated > 0
   end
 
 end

data/lib/locker/version.rb

@@ -1,3 +1,3 @@
 class Locker
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/locker.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "activerecord",  ">=3.2", "<4"
-  s.add_development_dependency "pg"
-  s.add_development_dependency "rspec"
+  s.add_dependency "activerecord",  ">=3.2", "<5"
+  s.add_development_dependency "pg", "~> 0"
+  s.add_development_dependency "rspec", "~> 3.2"
 end

data/spec/locker/advisory_spec.rb

@@ -5,17 +5,17 @@ describe Locker::Advisory do
   describe "initialization" do
     it "should have default values" do
       advisory = Locker::Advisory.new("foo")
-      advisory.key.should == "foo"
-      advisory.crc.should == -1938594527
-      advisory.lockspace.should == 1
-      advisory.blocking.should be_false
-      advisory.locked.should be_false
+      expect(advisory.key).to eq("foo")
+      expect(advisory.crc).to eq(-1938594527)
+      expect(advisory.lockspace).to eq(1)
+      expect(advisory.blocking).to be false
+      expect(advisory.locked).to be false
     end
 
     it "should have some overridable values" do
       advisory = Locker::Advisory.new("foo", :lockspace => 2, :blocking => true)
-      advisory.lockspace.should == 2
-      advisory.blocking.should be_true
+      expect(advisory.lockspace).to eq(2)
+      expect(advisory.blocking).to be true
     end
 
     it "should validate key" do
@@ -33,24 +33,26 @@ describe Locker::Advisory do
       lock1 = false
       lock2 = false
 
-      t = Thread.new do
+      t1 = Thread.new do
         Locker::Advisory.run("foo") do
           lock1 = true
-          sleep 1
+          sleep 2
         end
       end
 
-      Thread.pass
-
-      lock2_result = Locker::Advisory.run("foo") do
-        lock2 = true
+      t2 = Thread.new do
+        sleep 1
+        Locker::Advisory.run("foo") do
+          lock2 = true
+        end
       end
 
-      lock1_result = t.join
-      lock1.should be_true
-      lock2.should be_false
-      lock1_result.should be_true
-      lock2_result.should be_false
+      lock1_result = t1.value
+      lock2_result = t2.value
+      expect(lock1).to be true
+      expect(lock2).to be false
+      expect(lock1_result).to be true
+      expect(lock2_result).to be false
     end
 
     it "should release locks after the block is finished" do
@@ -65,10 +67,10 @@ describe Locker::Advisory do
         lock2 = true
       end
 
-      lock1.should be_true
-      lock2.should be_true
-      lock1_result.should be_true
-      lock2_result.should be_true
+      expect(lock1).to be true
+      expect(lock2).to be true
+      expect(lock1_result).to be true
+      expect(lock2_result).to be true
     end
   end
 

data/spec/locker/locker_spec.rb

@@ -9,30 +9,30 @@ describe Locker do
   describe "initialization" do
     it "should have default values" do
       locker = Locker.new("foo")
-      locker.key.should == "foo"
-      locker.renew_every.should == 10
-      locker.lock_for.should == 30
-      locker.model.should == Lock
-      locker.identifier.should match(/^#{Regexp.escape("host:#{Socket.gethostname} pid:#{Process.pid}")} guid:[a-f0-9]+$/)
-      locker.blocking.should be_false
-      locker.locked.should be_false
+      expect(locker.key).to eq("foo")
+      expect(locker.renew_every).to eq(10)
+      expect(locker.lock_for).to eq(30)
+      expect(locker.model).to eq(Lock)
+      expect(locker.identifier).to match(/^#{Regexp.escape("host:#{Socket.gethostname} pid:#{Process.pid}")} guid:[a-f0-9]+$/)
+      expect(locker.blocking).to be false
+      expect(locker.locked).to be false
     end
 
     it "should have some overridable values" do
       locker = Locker.new("bar", :renew_every => 20.seconds, :lock_for => 1.minute, :blocking => true, :model => FakeLock)
-      locker.key.should == "bar"
-      locker.renew_every.should == 20
-      locker.lock_for.should == 60
-      locker.model.should == FakeLock
-      locker.identifier.should match(/^#{Regexp.escape("host:#{Socket.gethostname} pid:#{Process.pid}")} guid:[a-f0-9]+$/)
-      locker.blocking.should be_true
-      locker.locked.should be_false
+      expect(locker.key).to eq("bar")
+      expect(locker.renew_every).to eq(20)
+      expect(locker.lock_for).to eq(60)
+      expect(locker.model).to eq(FakeLock)
+      expect(locker.identifier).to match(/^#{Regexp.escape("host:#{Socket.gethostname} pid:#{Process.pid}")} guid:[a-f0-9]+$/)
+      expect(locker.blocking).to be true
+      expect(locker.locked).to be false
     end
 
     it "should ensure that the key exists" do
-      Lock.find_by_key("baz").should be_nil
+      expect(Lock.find_by_key("baz")).to be_nil
       Locker.new("baz", :renew_every => 20.seconds, :lock_for => 1.minute, :blocking => true)
-      Lock.find_by_key("baz").should_not be_nil
+      expect(Lock.find_by_key("baz")).to_not be_nil
       Locker.new("baz", :renew_every => 20.seconds, :lock_for => 1.minute, :blocking => true)
     end
 
@@ -48,30 +48,31 @@ describe Locker do
   describe "locking" do
     it "should lock a record" do
       locker = Locker.new("foo")
-      locker.get.should be_true
+      expect(locker.get).to be true
+
       lock = Lock.find_by_key("foo")
-      lock.locked_until.should be <= (Time.now.utc + locker.lock_for)
-      lock.locked_by.should == locker.identifier
-      lock.locked_at.should be < Time.now.utc
+      expect(lock.locked_until).to be <= (Time.now.utc + locker.lock_for)
+      expect(lock.locked_by).to eq(locker.identifier)
+      expect(lock.locked_at).to be < Time.now.utc
     end
 
     it "should renew a lock" do
       locker = Locker.new("foo")
-      locker.get.should be_true
+      expect(locker.get).to be true
       lock = Lock.find_by_key("foo")
-      lock.locked_until.should be <= (Time.now.utc + locker.lock_for)
-      lock.locked_by.should == locker.identifier
-      lock.locked_at.should be < Time.now.utc
-      locker.renew.should be_true
+      expect(lock.locked_until).to be <= (Time.now.utc + locker.lock_for)
+      expect(lock.locked_by).to eq(locker.identifier)
+      expect(lock.locked_at).to be < Time.now.utc
+      expect(locker.renew).to be true
       lock = Lock.find_by_key("foo")
-      lock.locked_until.should be <= (Time.now.utc + locker.lock_for)
-      lock.locked_by.should == locker.identifier
-      lock.locked_at.should be < Time.now.utc
+      expect(lock.locked_until).to be <= (Time.now.utc + locker.lock_for)
+      expect(lock.locked_by).to eq(locker.identifier)
+      expect(lock.locked_at).to be < Time.now.utc
     end
 
     it "should raise when someone steals the lock" do
       locker = Locker.new("foo")
-      locker.get.should be_true
+      expect(locker.get).to be true
       lock = Lock.find_by_key("foo")
       lock.update_attribute(:locked_by, "someone else")
       expect{ locker.renew }.to raise_error(Locker::LockStolen)
@@ -91,7 +92,6 @@ describe Locker do
       Locker.run("foo") do
         value = 1
       end
-
       expect(value).to eq(1)
     end
 
@@ -118,7 +118,7 @@ describe Locker do
       @second_locker.run(true){"something innocuous"}
       end_time = Time.now.to_f
       time_ran = (end_time - start_time)
-      time_ran.should be >= 0.6, "Oops, time was #{end_time-start_time} seconds"
+      expect(time_ran).to be >= 0.6, "Oops, time was #{end_time-start_time} seconds"
     end
   end
 
@@ -130,17 +130,17 @@ describe Locker do
     end
 
     it "should return false when we can't obtain the lock" do
-      @second_locker.run{raise "SHOULD NOT RUN KTHXBAI"}.should be_false
-      @first_locker.run{ "something" }.should be_true
+      expect(@second_locker.run{raise "SHOULD NOT RUN KTHXBAI"}).to be false
+      expect(@first_locker.run{ "something" }).to be true
     end
 
     it "should take less than half a second to fail" do
       start_time = Time.now.to_f
       return_value = @second_locker.run{raise "SHOULD NOT RUN KTHXBAI"}
       end_time = Time.now.to_f
-      return_value.should be_false
+      expect(return_value).to be false
       run_time = (end_time - start_time)
-      run_time.should be < 0.5
+      expect(run_time).to be < 0.5
     end
   end
 

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ require 'active_record'
 require 'locker'
 
 ActiveRecord::Base.time_zone_aware_attributes = true
-ActiveRecord::Base.default_timezone = "UTC"
+ActiveRecord::Base.default_timezone = :utc
 
 if File.exist?(File.join(File.dirname(__FILE__), 'database.yml'))
   config = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
@@ -77,11 +77,19 @@ end
 
 RSpec.configure do |c|
   c.before do
-    ActiveRecord::Base.connection.increment_open_transactions
-    ActiveRecord::Base.connection.begin_db_transaction
+    if ActiveRecord::VERSION::MAJOR < 4
+      ActiveRecord::Base.connection.increment_open_transactions
+      ActiveRecord::Base.connection.begin_db_transaction
+    else
+      ActiveRecord::Base.connection.begin_transaction
+    end
   end
   c.after do
-    ActiveRecord::Base.connection.rollback_db_transaction
-    ActiveRecord::Base.connection.decrement_open_transactions
+    if ActiveRecord::VERSION::MAJOR < 4
+      ActiveRecord::Base.connection.rollback_db_transaction
+      ActiveRecord::Base.connection.decrement_open_transactions
+    else
+      ActiveRecord::Base.connection.rollback_transaction
+    end
   end
 end

metadata

@@ -1,62 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: locker
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Nathan Sutton
 - Justin Greer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-05-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "3.2"
-    - - <
-      - !ruby/object:Gem::Version 
-        version: "4"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: pg
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id003 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
   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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+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
 - justin@zencoder.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -81,29 +96,29 @@ files:
 - spec/spec_helper.rb
 homepage: 
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+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: locker
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Locker is a locking mechanism for limiting the concurrency of ruby code using the database.
-test_files: 
+summary: Locker is a locking mechanism for limiting the concurrency of ruby code using
+  the database.
+test_files:
 - spec/locker/advisory_spec.rb
 - spec/locker/locker_spec.rb
 - spec/spec_helper.rb
-has_rdoc: