pg_lock 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c92e38fab7329deb1a573eafce48291e38b3198baf0ce39a4500d305a1b01081
-  data.tar.gz: 3c14d574202f72524728cc3f1ffb5af3d2dc16b6980bfa9efe130fa84a6f5c00
+  metadata.gz: 1b5dc5c381b308116620ac170d1fe5f54d61d9cf73b0f7acbcb3d60b1cdc1222
+  data.tar.gz: fed6d8ba96c3afe22ff4cbe30b805f107e71452f133e8800b977e2aaf80c6756
 SHA512:
-  metadata.gz: 67be6b9ef5ff32f10cd6f8a98d6b58af010c9d03e480617372c6e43787fbdeb704d349d573d22b1e2eb7fa4c6a05c97106f6b30a7e3ff72f6247a73cba63d781
-  data.tar.gz: 17efa281393055a6facdfb44bbca361a49f00ae20454fe3557c89d3e971aeb0e6b7c742609409d6080345814bf8bc0d8ad1c09fb465d9dcacb2d37d5cd548013
+  metadata.gz: c58e6e372c93b10afce883726ac72f6ca77a08bbb1e4971714ea076a3f5b4b5afb808d0c75a6a9d22d62d7f9a6fa373ff9dcc36cb428f922c10078d352616ffe
+  data.tar.gz: 3c77cdb4e29e139a2763062d6a9957225c3fe050cd6f376deb5c60cb47211edc86a7d11b03d84d543c645defc64d441718f3209591330e40d5c247acd3acce42

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,13 @@
+
+name: Check Changelog
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # A Log of Changes!
 
-## Master - unreleased
+## Main - unreleased
+
+## 1.0.0
+
+- Fixed: Lock is now unlocked when an exception is raised in a log https://github.com/heroku/pg_lock/pull/17
+- Changed: Removed mis-spelling of "aquired" https://github.com/heroku/pg_lock/pull/17
+
+## 0.3.0
+
+- Fix method spelling (https://github.com/heroku/pg_lock/pull/16)
+
+## 0.2.1
+
+- Fix regression where a block that returned a `false` would cause the `lock!` method to incorrectly raise an error (https://github.com/heroku/pg_lock/pull/15)
 
 ## 0.2.0
 

data/CODEOWNERS

@@ -0,0 +1,2 @@
+# Comment line immediately above ownership line is reserved for related gus information. Please be careful while editing.
+#ECCN:Open Source

data/README.md

@@ -119,13 +119,13 @@ ensure
 end
 ```
 
-You can check on the status of a lock with the `aquired?` method:
+You can check on the status of a lock with the `acquired?` method:
 
 ```ruby
 begin
   lock = PgLock.new(name: "all_your_base")
   lock.create
-  if lock.aquired?
+  if lock.acquired?
     # do stuff
   end
 ensure

data/lib/pg_lock/locket.rb

@@ -11,7 +11,7 @@ class PgLock
 
     def lock
       @lock = connection.exec("select pg_try_advisory_lock($1,$2)", args)
-      return aquired?
+      return acquired?
     end
 
     def unlock
@@ -19,23 +19,32 @@ class PgLock
       @lock = false
     end
 
-    def aquired?
+    def acquired?
       TRUE_VALUES.include?(@lock[0]["pg_try_advisory_lock"])
     rescue
       false
     end
 
+    # Left the misspelled version of this method for backwards compatibility
+    def aquired?
+      acquired?
+    end
+
     def active?
-      active = connection.exec(<<-eos, args).getvalue(0,0)
+      query = <<-eos
         SELECT granted
         FROM pg_locks
         WHERE locktype = 'advisory' AND
-         pid = pg_backend_pid() AND
-         mode = 'ExclusiveLock' AND
-         classid = $1 AND
-         objid = $2
+        pid = pg_backend_pid() AND
+        mode = 'ExclusiveLock' AND
+        classid = $1 AND
+        objid = $2
       eos
 
+      result = connection.exec(query, args)
+      return false if result.ntuples == 0
+
+      active = result.getvalue(0,0)
       TRUE_VALUES.include?(active)
     end
   end

data/lib/pg_lock/version.rb

@@ -1,3 +1,3 @@
 class PgLock
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/pg_lock.rb

@@ -26,6 +26,7 @@ class PgLock
     end
   end
   UnableToLock = UnableToLockError
+  NO_LOCK = Object.new
 
   def initialize(name:, attempts: 3, attempt_interval: 1, ttl: 60, connection: DEFAULT_CONNECTION_CONNECTOR.call, log: DEFAULT_LOGGER.call, return_result: true)
     self.name               = name
@@ -41,26 +42,18 @@ class PgLock
 
   # Runs the given block if an advisory lock is able to be acquired.
   def lock(&block)
-    if create
-      result = nil
-      begin
-        result = Timeout::timeout(ttl, &block) if block_given?
-      ensure
-        delete
-      end
-      return_result ? result : true
-    else
-      return false
-    end
+    result = internal_lock(&block)
+    return false if result == NO_LOCK
+    result
   end
 
   # A PgLock::UnableToLock is raised if the lock is not acquired.
   def lock!(exception_klass = PgLock::UnableToLockError)
-    if lock { yield self if block_given? }
-      # lock successful, do nothing
-    else
+    result = internal_lock { yield self if block_given? }
+    if result == NO_LOCK
       raise exception_klass.new(name: name, attempts: max_attempts)
     end
+    return result
   end
 
   def create
@@ -86,10 +79,28 @@ class PgLock
     end
   end
 
+  # Left the misspelled version of this method for backwards compatibility
   def aquired?
+    acquired?
+  end
+
+  def acquired?
     locket.active?
   end
-  alias :has_lock? :aquired?
+
+  alias :has_lock? :acquired?
+
+  private def internal_lock(&block)
+    if create
+      result = nil
+      result = Timeout::timeout(ttl, &block) if block_given?
+      return_result ? result : true
+    else
+      return NO_LOCK
+    end
+  ensure
+    delete if locket.acquired?
+  end
 
   private
     attr_accessor :max_attempts

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pg_lock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - mikehale
 - schneems
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -89,10 +89,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -108,7 +110,7 @@ homepage: http://github.com/heroku/pg_lock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Use Postgres advisory lock to isolate code execution across machines
 test_files: []