locker 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d4fe6495ead44c7d486b9b92e2e3a1e426f544c
-  data.tar.gz: 992771712a5be9b554ca67b55c89f7817b3dcd63
+SHA256:
+  metadata.gz: 6848498a3a915838b9b0df22e796e21ac1fdf39c36ffa0256d83a2e217c82d99
+  data.tar.gz: 816eb78e162302a315944f4863b5c5373a64f69e927af60ed8d4dd8299178f18
 SHA512:
-  metadata.gz: a8118488900768eb4350649fd1e03b0ad96dcc16777975163f914b46e6b89ba25a226189e8e4ad864f4b60197d7adccd709402c04384b5ee1885771f455e63c7
-  data.tar.gz: b225d2c0d59c66ceaf30a194e76b4a58606bac879adf83e74b85cd6f60561630f1def4ae9fdd6c47f5dbc67596356f81909dca3b7d9c761fd2d13ed60f6144b6
+  metadata.gz: cc30fcb1130c337230549c235b8f7bb13bb66870a8e3a69e08e56a19cd330e52742cbb553718a6db8da3b48a0a1ddb4a087ff8c99b072ce346e7a2448f87fab1
+  data.tar.gz: 5cccbb2b52a857a052145498f9cad6001c05e8d19bb7b1eb3574ff9f1d908ffbb46af72456214814bdd2d9a0e31ad3c94a1ae419b39f7abdf07fafa091cf9769

data/.gitignore

@@ -1,6 +1,8 @@
 *.gem
 .bundle
 Gemfile.lock
+Gemfile_rails_3.lock
+Gemfile_rails_4.lock
 pkg/*
 /spec/database.yml
 .rvmrc

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.5

data/.travis.yml

@@ -1,8 +1,39 @@
 language: ruby
 gemfile:
-  - gemfiles/rails3.gemfile
+  - Gemfile_rails_3
+  - Gemfile_rails_4
+  - Gemfile_rails_5
 rvm:
-  - 2.1.5
-  - 2.2.1
-  - jruby-19mode
+  - ruby-2.1.10
+  - ruby-2.2.7
+  - ruby-2.3.4
+  - ruby-2.4.1
+  - ruby-2.5.5
+  - jruby-9.1.9.0
 script: bundle exec rspec
+matrix:
+  exclude:
+    - rvm: ruby-2.4.1
+      gemfile: Gemfile_rails_3
+    - rvm: ruby-2.1.10
+      gemfile: Gemfile_rails_5
+    - rvm: ruby-2.2.7
+      gemfile: Gemfile_rails_5
+    - rvm: ruby-2.3.4
+      gemfile: Gemfile_rails_5
+    - rvm: ruby-2.4.1
+      gemfile: Gemfile_rails_5
+    - rvm: ruby-2.5.5
+      gemfile: Gemfile_rails_3
+    - rvm: ruby-2.5.5
+      gemfile: Gemfile_rails_4
+    - rvm: jruby-9.1.9.0
+      gemfile: Gemfile_rails_5
+services:
+  - postgresql
+addons:
+  postgresql: "10"
+  apt:
+    packages:
+      - postgresql-10
+      - postgresql-client-10

data/Gemfile

@@ -1,8 +1,17 @@
 source "https://rubygems.org"
 
-gem "activerecord", ">=3.2", "<5"
+gem "activerecord", ">=3.2", "<6"
 
 group :development, :test do
-  gem "pg"
-  gem "rspec", "~> 3.2.0"
+  platform :ruby do
+    gem "pg", "~> 0.21.0", "< 1.0"
+    gem "pry", "~> 0.13.1"
+    gem "pry-byebug", "~> 3.9.0"
+  end
+
+  platform :jruby do
+    gem 'activerecord-jdbcpostgresql-adapter', '= 1.3.25'
+  end
+
+  gem "rspec", "~> 3.9.0"
 end

data/Gemfile_rails_3

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gem "activerecord", ">=3.2", "<4"
+
+group :development, :test do
+  platform :ruby do
+    gem "pg", "< 1.0"
+    gem "pry", "~> 0.10.4"
+    gem "pry-byebug", "~> 3.4.2"
+  end
+
+  platform :jruby do
+    gem 'activerecord-jdbcpostgresql-adapter', '= 1.3.25'
+  end
+
+  gem "rspec", "~> 3.2.0"
+end

data/Gemfile_rails_4

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gem "activerecord", ">=4", "<5"
+
+group :development, :test do
+  platform :ruby do
+    gem "pg", "< 1.0"
+    gem "pry", "~> 0.10.4"
+    gem "pry-byebug", "~> 3.4.2"
+  end
+
+  platform :jruby do
+    gem 'activerecord-jdbcpostgresql-adapter', '= 1.3.25'
+  end
+
+  gem "rspec", "~> 3.2.0"
+end

data/Gemfile_rails_5

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5"
+
+group :development, :test do
+  platform :ruby do
+    gem "pg", "~> 0.21.0", "< 1.0"
+    gem "pry", "~> 0.13.1"
+    gem "pry-byebug", "~> 3.9.0"
+  end
+
+  platform :jruby do
+    gem 'activerecord-jdbcpostgresql-adapter', "~> 50"
+  end
+
+  gem "rspec", "~> 3.9.0"
+end

data/README.md

@@ -2,7 +2,7 @@
 
 Locker is a locking mechanism for limiting the concurrency of ruby code using the database.
 
-Locker is dependent on Postgres and the ActiveRecord (>= 3.2.0) gem.
+Locker is dependent on Postgres and the ActiveRecord (>= 3.2.0 and < 6.0) gem.
 
 ## Supported Rubies
 
@@ -27,7 +27,7 @@ Suppose you have a process running on a server that continually performs a task.
 #### Code (lib/new_feed_checker.rb)
 
 ```ruby
-while true
+loop do
   FeedChecker.check_for_new_feeds
 end
 ```
@@ -49,7 +49,7 @@ This would work fantastic, so long as `FeedChecker.check_for_new_feeds` is safe
 ```ruby
 Locker.run("new-feed-checker") do # One server will get the lock
   # Only one server will get here
-  while true
+  loop do
     FeedChecker.check_for_new_feeds
   end
 end # Lock is released at this point
@@ -68,7 +68,7 @@ This is great! We've made sure that only one server can run the code at any give
 ```ruby
 Locker.run("new-feed-checker", :blocking => true) do
   # Only one server will get here at a time. The other server will patiently wait.
-  while true
+  loop do
     FeedChecker.check_for_new_feeds
   end
 end # Lock is released at this point
@@ -150,7 +150,7 @@ end
 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.
 
 ```ruby
-while true
+loop do
   Locker.run("new-feed-checker", :blocking => true) do
     FeedChecker.check_for_new_feeds
   end

data/lib/locker/advisory.rb

@@ -6,18 +6,24 @@ class Locker
 
     attr_reader :key, :crc, :lockspace, :blocking, :locked
 
+    # The advisory function we use from PostgreSQL needs the arguments to be
+    # INT, therefore this are the range of int numbers for PostgreSQL
     MAX_LOCK = 2147483647
     MIN_LOCK = -2147483648
+
+    # Max number that a 32bit computer can hold
     OVERFLOW_ADJUSTMENT = 2**32
 
     def initialize(key, options={})
       raise ArgumentError, "key must be a string" unless key.is_a?(String)
 
-      @key       = key
-      @crc       = convert_to_crc(key)
-      @lockspace = (options[:lockspace] || 1)
-      @blocking  = !!options[:blocking]
-      @locked    = false
+      @key             = key
+      @crc             = convert_to_crc(key)
+      @lockspace       = (options[:lockspace] || 1)
+      @blocking        = !!options[:blocking]
+      @locked          = false
+      @block_timeout   = options[:block_timeout]
+      @block_spin_wait = options[:block_spin_wait] || 0.005
 
       if !@lockspace.is_a?(Integer) || @lockspace < MIN_LOCK || @lockspace > MAX_LOCK
         raise ArgumentError, "The :lockspace option must be an integer between #{MIN_LOCK} and #{MAX_LOCK}"
@@ -32,8 +38,13 @@ class Locker
     def run(&block)
       connection = ActiveRecord::Base.connection_pool.checkout
       connection.transaction :requires_new => true do
+        if @blocking && @block_timeout
+          break_at = Time.now + @block_timeout
+        end
+
         while !get(connection) && @blocking
-          sleep 0.5
+          break if break_at && break_at < Time.now
+          sleep @block_spin_wait
         end
 
         if @locked
@@ -58,9 +69,10 @@ class Locker
             @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{}
-            if checker.alive?
-              checker.exit rescue nil
+            mutex.synchronize do
+              if checker.alive?
+                checker.exit rescue nil
+              end
             end
           end
           true
@@ -75,7 +87,13 @@ class Locker
   protected
 
     def get(connection)
-      result = exec_query(connection, "SELECT pg_try_advisory_xact_lock(#{connection.quote(@lockspace)}, #{connection.quote(@crc)})")
+      lockspace_quote = connection.quote(@lockspace)
+      crc_quote = connection.quote(@crc)
+
+      result = exec_query(
+        connection,
+        "SELECT pg_try_advisory_xact_lock(#{lockspace_quote}, #{crc_quote})"
+      )
       @locked = successful_result?(result)
     end
 
@@ -86,6 +104,8 @@ class Locker
       end
     end
 
+    # CRC32 digest to get a decimal numeric of the key used, make sure the
+    # resulting number is within PostgreSql max and min Integer numbers
     def convert_to_crc(key)
       crc = Zlib.crc32(key)
       crc -= OVERFLOW_ADJUSTMENT if crc > MAX_LOCK
@@ -93,7 +113,11 @@ class Locker
     end
 
     def successful_result?(result)
-      result.rows.size == 1 && result.rows[0].size == 1 && result.rows[0][0] == "t"
+      result.rows.size == 1 &&
+        result.rows[0].size == 1 && (
+          result.rows[0][0] == 't' || # Checking for old ActiveRecord
+          result.rows[0][0].class == TrueClass # Checking for the value true
+        )
     end
 
     def exec_query(connection, query)

data/lib/locker/locker.rb

@@ -26,6 +26,11 @@ class Locker
     ensure_key_exists
   end
 
+  def self.prune(before)
+    m = model || ::Lock
+    m.where(["locked_until < ?", before]).delete_all
+  end
+
   def self.run(key, options={}, &block)
     locker = new(key, options)
     locker.run(&block)

data/lib/locker/version.rb

@@ -1,3 +1,3 @@
 class Locker
-  VERSION = "0.3.0"
+  VERSION = "0.6.0".freeze
 end

data/locker.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "locker/version"
 
 Gem::Specification.new do |s|
@@ -7,8 +6,8 @@ Gem::Specification.new do |s|
   s.version     = Locker::VERSION
   s.authors     = ["Nathan Sutton", "Justin Greer"]
   s.email       = ["nate@zencoder.com", "justin@zencoder.com"]
-  s.summary     = %q{Locker is a locking mechanism for limiting the concurrency of ruby code using the database.}
-  s.description = %q{Locker is a locking mechanism for limiting the concurrency of ruby code using the database. It presently only works with PostgreSQL.}
+  s.summary     = 'Locker is a locking mechanism for limiting the concurrency of ruby code using the database.'
+  s.description = 'Locker is a locking mechanism for limiting the concurrency of ruby code using the database. It presently only works with PostgreSQL.'
 
   s.rubyforge_project = "locker"
 
@@ -16,7 +15,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "activerecord",  ">=3.2", "<5"
-  s.add_development_dependency "pg", "~> 0"
+  s.add_dependency "activerecord", ">=3.2", "< 6"
+  s.add_development_dependency "pg", "~> 0", "< 1"
+  s.add_development_dependency "pry", "~> 0.10.4"
+  s.add_development_dependency "pry-byebug", "~> 3.4.2"
   s.add_development_dependency "rspec", "~> 3.2"
 end

data/spec/locker/advisory_spec.rb

@@ -72,6 +72,27 @@ describe Locker::Advisory do
       expect(lock1_result).to be true
       expect(lock2_result).to be true
     end
+
+    it "blocks with a timeout" do
+      started_at = Time.now
+      t1 = Thread.new do
+        Locker::Advisory.run("foo") do
+          sleep 2
+        end
+      end
+
+      t2 = Thread.new do
+        sleep 0.5
+        Locker::Advisory.run("foo", :blocking => true, :block_timeout => 1) do
+          sleep 10 # never hits this
+        end
+      end
+
+      expect(t1.value).to be(true)
+      expect(t2.value).to be(false)
+
+      expect(Time.now - started_at).to be < 2.5
+    end
   end
 
 end

data/spec/locker/locker_spec.rb

@@ -144,4 +144,19 @@ describe Locker do
     end
   end
 
+  describe "pruning" do
+    it "deletes old locks" do
+      l1 = Lock.create!(:key => "key1", :locked_until => 2.minutes.ago)
+      l2 = Lock.create!(:key => "key2", :locked_until => 4.minutes.ago)
+      l3 = Lock.create!(:key => "key3", :locked_until => 6.minutes.ago)
+      l4 = Lock.create!(:key => "key4", :locked_until => 8.minutes.ago)
+
+      Locker.prune(5.minutes.ago)
+
+      expect( Lock.where(:key => "key1").first ).to_not be_nil
+      expect( Lock.where(:key => "key2").first ).to_not be_nil
+      expect( Lock.where(:key => "key3").first ).to be_nil
+      expect( Lock.where(:key => "key3").first ).to be_nil
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,13 @@ require 'rubygems'
 require 'bundler/setup'
 require 'active_record'
 
+begin
+  require 'pry'
+  require 'pry-byebug'
+rescue LoadError
+  # jruby won't have these
+end
+
 require 'locker'
 
 ActiveRecord::Base.time_zone_aware_attributes = true

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: locker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nathan Sutton
 - Justin Greer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,7 +20,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -45,6 +48,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -69,15 +103,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile_rails_3
+- Gemfile_rails_4
+- Gemfile_rails_5
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails3.gemfile
 - generators/locker/USAGE
 - generators/locker/locker_generator.rb
 - generators/locker/templates/migration.rb
@@ -94,10 +129,10 @@ files:
 - spec/locker/advisory_spec.rb
 - spec/locker/locker_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: locker
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Locker is a locking mechanism for limiting the concurrency of ruby code using
   the database.

data/.ruby-gemset

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

data/.ruby-version

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

data/gemfiles/rails3.gemfile

@@ -1,15 +0,0 @@
-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