pg_advisory_lock 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466169c01607df8b0c40594fa296e1fed78308d06a5512bab01e12cbafe59c2d
-  data.tar.gz: 55fb38aafaaad466d4ef287dcb5ae9b2ad17bdd2e22cfc8ddeb6ca75e7d036e4
+  metadata.gz: 0f4f49429d7f217072b2927e3f33876f0841caf8d027725bd7981eed010e1a37
+  data.tar.gz: 4bd6514b91d8dad257d575b7147a41f8faa5006dd398a7d98d340a2612c0a4f8
 SHA512:
-  metadata.gz: cb2a78d382278811c09863faee99aca67c7fffdfb9f579b9ea96f76c3a895888b598c1bbd16c2ea5e57cbd409f6d36d60dc8b185b00c7861a83c3ac98dfe1d75
-  data.tar.gz: 8fa4803b480af658d61c4c86441e7f0e0886f573a373ab182ed2c3b5bf41f195a9f1e4d81bdecadd1881655feb28eed39b1dd84f0bb8386dfcf2c15033f72fae
+  metadata.gz: 92a9005c04a0b898ec8489027bb065ecf713ec75cc83fe0e7d0c721740874463bd80ccad2919a5be780f7b0cc5d6626593b3e5b844e9eb76b1f33851b41a6f9a
+  data.tar.gz: 8199402c1fd8ab0b8c72df92698f94912a81bc91a4af64ba2edd9385d68d9dcf3e0439ba72ce23424be5e4db3738eade36ebd2127ee6a2372539452180e5c065

data/README.md

@@ -24,8 +24,6 @@ Or install it yourself as:
 create subclass from `PgAdvisoryLock::Base` and define `model_class` for it
 
 ```ruby
-require 'pg_sql_caller'
-
 class MySqlCaller < PgAdvisoryLock::Base
   model_class 'ApplicationRecord'
 end

data/lib/pg_advisory_lock/base.rb

@@ -31,6 +31,8 @@ module PgAdvisoryLock
         self._sql_caller_class = klass
       end
 
+      # Locks specific advisory lock.
+      # If it's already locked just waits.
       # @param name [Symbol, String] - lock name (will be transformed to number).
       # @param transaction [Boolean] - if true lock will be released at the end of current transaction
       #   otherwise it will be released at the end of block.
@@ -41,7 +43,23 @@ module PgAdvisoryLock
       # @raise [ArgumentError] when lock name is invalid.
       # @return yield
       def with_lock(name, transaction: true, shared: false, id: nil, &block)
-        new(name, transaction: transaction, shared: shared, id: id).lock(&block)
+        new(name, transaction: transaction, shared: shared, id: id, wait: true).lock(&block)
+      end
+
+      # Tries to lock specific advisory lock.
+      # If it's already locked raises exception.
+      # @param name [Symbol, String] - lock name (will be transformed to number).
+      # @param transaction [Boolean] - if true lock will be released at the end of current transaction
+      #   otherwise it will be released at the end of block.
+      # @param shared [Boolean] - is lock shared or not.
+      # @param id [Integer] - number that will be used in pair with lock number to perform advisory lock.
+      # @yield - call block when lock is acquired
+      #   block must be passed if transaction argument is false.
+      # @raise [ArgumentError] when lock name is invalid.
+      # @raise [PgAdvisoryLock::LockNotObtained] when wait: false passed and lock already locked.
+      # @return yield
+      def try_lock(name, transaction: true, shared: false, id: nil, &block)
+        new(name, transaction: transaction, shared: shared, id: id, wait: false).lock(&block)
       end
     end
 
@@ -50,16 +68,19 @@ module PgAdvisoryLock
     #   otherwise it will be released at the end of block.
     # @param shared [Boolean] - is lock shared or not.
     # @param id [Integer] - number that will be used in pair with lock number to perform advisory lock.
-    def initialize(name, transaction: false, shared: false, id: nil)
+    # @param wait [Boolean] - when locked by someone else: true - wait for lock, raise PgAdvisoryLock::LockNotObtained.
+    def initialize(name, transaction:, shared:, id:, wait:)
       @name = name.to_sym
       @transaction = transaction
       @shared = shared
       @id = id
+      @wait = wait
     end
 
     # @yield - call block when lock is acquired
     #   block must be passed if transaction argument is false.
     # @raise [ArgumentError] when lock name is invalid.
+    # @raise [PgAdvisoryLock::LockNotObtained] when wait: false passed and lock already locked.
     # @return yield
     def lock(&block)
       with_logger do
@@ -70,7 +91,7 @@ module PgAdvisoryLock
 
     private
 
-    attr_reader :transaction, :shared, :name, :id
+    attr_reader :transaction, :shared, :name, :id, :wait
 
     def with_logger
       return yield if logger.nil? || !logger.respond_to?(:tagged)
@@ -109,9 +130,14 @@ module PgAdvisoryLock
     end
 
     def perform_lock(lock_number)
-      function_name = "pg_advisory#{'_xact' if transaction}_lock#{'_shared' if shared}"
+      function_name = "pg#{'_try' unless wait}_advisory#{'_xact' if transaction}_lock#{'_shared' if shared}"
 
-      sql_caller_class.execute("SELECT #{function_name}(#{lock_number})")
+      if wait
+        sql_caller_class.execute("SELECT #{function_name}(#{lock_number})")
+      else
+        result = sql_caller_class.select_value("SELECT #{function_name}(#{lock_number})")
+        raise LockNotObtained, "#{self.class} can't obtain lock (#{name}, #{id})" unless result
+      end
     end
 
     def perform_unlock(lock_number)

data/lib/pg_advisory_lock/lock_not_obtained.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PgAdvisoryLock
+  class LockNotObtained < StandardError
+  end
+end

data/lib/pg_advisory_lock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgAdvisoryLock
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/pg_advisory_lock.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pg_advisory_lock/version'
+require 'pg_advisory_lock/lock_not_obtained'
 require 'pg_advisory_lock/base'
 
 module PgAdvisoryLock

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,6 +72,7 @@ files:
 - bin/setup
 - lib/pg_advisory_lock.rb
 - lib/pg_advisory_lock/base.rb
+- lib/pg_advisory_lock/lock_not_obtained.rb
 - lib/pg_advisory_lock/version.rb
 - pg_advisory_lock.gemspec
 homepage: https://github.com/didww/pg_advisory_lock
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Postgresql Advisory Lock for ActiveRecord