sequel-pg_advisory_lock 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b48cb4023fcc88c838d6de22714b92c61437f02f
+  data.tar.gz: f0ec5d03ce435061e6a995e999b79f34c67f0dcc
+SHA512:
+  metadata.gz: 8adac28854b26f69ecdd2324b0ed1c76028b07b1975d5317ae46e5914044bf04d8fea57f560e247c67f0dc2ecd432364c187e08293e2af99b4d2f8c228eaa523
+  data.tar.gz: 6dd7a64a7049aeb7fba91de618224cf6a9dc6909c605228e80ba771f0f9ca8cbf95047aecf5cdd353c062ae196ee3ede5c4d433be2badbb790b41779f5efeeff

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.travis.yml

@@ -0,0 +1,38 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - jruby-19mode
+  - jruby-9.0.5.0
+  - jruby-9.1.12.0
+  - jruby-head
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+
+gemfile:
+  - gemfiles/sequel-4.gemfile
+  - gemfiles/sequel-5.gemfile
+
+before_install:
+  - gem install bundler
+
+before_script:
+  - psql -c 'create database sequel_test;' -U postgres
+
+env:
+  - TEST_DB_NAME=sequel_test
+
+addons:
+  postgresql: "9.6"
+
+services:
+  - postgresql

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# `0.1.1` (2017-11-22)
+
+* Update gem summary.
+* Rebuild gem for rubygems.org.
+
+# `0.1.0` (2017-11-22)
+
+* Initial public release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yury Shchyhlinski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# sequel-pg_advisory_lock [![Build Status](https://travis-ci.org/yuryroot/sequel-pg_advisory_lock.svg?branch=master)](https://travis-ci.org/yuryroot/sequel-pg_advisory_lock)
+
+Gem `sequel-pg_advisory_lock` is an extension for ruby [Sequel](https://github.com/jeremyevans/sequel) library 
+that helps using [PostgreSQL advisory locks](https://www.postgresql.org/docs/9.6/static/explicit-locking.html#ADVISORY-LOCKS)
+in your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-pg_advisory_lock'
+```
+
+and then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install sequel-pg_advisory_lock
+```
+
+## Usage
+
+First, you should load an extension for `Sequel::Database` instance:
+
+```ruby
+DB.extension :pg_advisory_lock
+```
+
+Then, you should register new lock by specifying unique name:
+
+```ruby
+DB.register_advisory_lock(:my_lock)
+
+```
+
+By default, `pg_advisory_lock` *PostgreSQL* function will be associated with registered lock. 
+
+It's also possible to specify different function in second parameter of `register_advisory_lock` method, for example:
+
+```ruby
+DB.register_advisory_lock(:my_lock, :pg_try_advisory_lock)
+````
+
+All supported lock functions are described in [here](#available-types-of-locks). 
+
+Finally, you can use registered lock:  
+
+```ruby
+DB.with_advisory_lock(:my_lock) do
+  # do something 
+end
+
+``` 
+ 
+An optional *4-bytes integer* parameter can be passed to `with_advisory_lock` method call:
+
+```ruby
+DB.with_advisory_lock(:my_lock, 1) do
+  # do something   
+end
+
+```
+
+## Available types of locks
+
+There are 4 supported *PostgreSQL* lock functions which can be used in `register_advisory_lock`:
+
+* `pg_advisory_lock` (default)
+
+   Waits of lock releasing if someone already owns requested lock.
+
+* `pg_try_advisory_lock`
+
+   Doesn't wait of lock releasing, returns nil if someone already owns requested lock. 
+ 
+* `pg_advisory_xact_lock`
+
+   Waits of lock releasing if someone already owns requested lock.  
+   Releases lock immediately after database transaction ends.  
+   Requires manually opened transaction before using this lock.  
+
+* `pg_try_advisory_xact_lock`
+
+   Doesn't wait of lock releasing, returns nil if someone already owns requested lock.   
+   Releases lock immediately after database transaction ends.  
+   Requires manually opened transaction before using this lock.  
+
+For more information see [PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS). 
+ 
+## Contributing
+
+1. Fork the project (https://github.com/yuryroot/sequel-pg_advisory_lock).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Implement your feature or bug fix.
+4. Add tests for your feature or bug fix.
+5. Run `rake` to make sure all tests pass.
+6. Commit your changes (`git commit -am 'Add new feature'`).
+7. Push to the branch (`git push origin my-new-feature`).
+8. Create new pull request.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sequel/extensions/pg_advisory_lock'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/sequel-4.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'sequel', '~> 4.0'
+
+gemspec path: '../'

data/gemfiles/sequel-5.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'sequel', '~> 5.0'
+
+gemspec path: '../'

data/lib/sequel/extensions/pg_advisory_lock.rb

@@ -0,0 +1,89 @@
+require 'sequel'
+require 'zlib'
+
+module Sequel
+  module Postgres
+    module PgAdvisoryLock
+
+      SESSION_LEVEL_LOCKS = [
+        :pg_advisory_lock,
+        :pg_try_advisory_lock
+      ].freeze
+
+      TRANSACTION_LEVEL_LOCKS = [
+        :pg_advisory_xact_lock,
+        :pg_try_advisory_xact_lock
+      ].freeze
+
+      LOCK_FUNCTIONS = (SESSION_LEVEL_LOCKS + TRANSACTION_LEVEL_LOCKS).freeze
+
+      DEFAULT_LOCK_FUNCTION = :pg_advisory_lock
+      UNLOCK_FUNCTION = :pg_advisory_unlock
+
+      def registered_advisory_locks
+        @registered_advisory_locks ||= {}
+      end
+
+      def with_advisory_lock(name, id = nil, &block)
+        options = registered_advisory_locks.fetch(name.to_sym)
+
+        lock_key = options.fetch(:key)
+        function_params = [lock_key, id].compact
+
+        lock_function = options.fetch(:lock_function)
+        transaction_level_lock = TRANSACTION_LEVEL_LOCKS.include?(lock_function)
+
+        if transaction_level_lock
+          # TODO: It's allowed to specify additional options (in particular, :server)
+          #       while opening database transaction.
+          #       That's why this check must be smarter.
+          unless in_transaction?
+            raise Error, "Transaction must be manually opened before using transaction level lock '#{lock_function}'"
+          end
+
+          if get(Sequel.function(lock_function, *function_params))
+            yield
+          end
+        else
+          synchronize do
+            if get(Sequel.function(lock_function, *function_params))
+              begin
+                result = yield
+              ensure
+                get(Sequel.function(UNLOCK_FUNCTION, *function_params))
+                result
+              end
+            end
+          end
+        end
+      end
+
+      def register_advisory_lock(name, lock_function = DEFAULT_LOCK_FUNCTION)
+        name = name.to_sym
+
+        if registered_advisory_locks.key?(name)
+          raise Error, "Lock with name :#{name} is already registered"
+        end
+
+        key = advisory_lock_key_for(name)
+        if registered_advisory_locks.values.any? { |opts| opts.fetch(:key) == key }
+          raise Error, "Lock key #{key} is already taken"
+        end
+
+        function = lock_function.to_sym
+        unless LOCK_FUNCTIONS.include?(function)
+          raise Error, "Invalid lock function :#{function}"
+        end
+
+        registered_advisory_locks[name] = { key: key, lock_function: function }
+      end
+
+      def advisory_lock_key_for(lock_name)
+        Zlib.crc32(lock_name.to_s) % 2 ** 31
+      end
+
+    end
+  end
+
+  Database.register_extension(:pg_advisory_lock, Postgres::PgAdvisoryLock)
+end

data/sequel-pg_advisory_lock.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-pg_advisory_lock'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Yury Shchyhlinski']
+  spec.email         = ['Shchyhlinski.YL@gmail.com']
+
+  spec.summary       = "#{spec.name} is an extension for ruby Sequel library that helps using PostgreSQL advisory locks in your application"
+  spec.homepage      = "https://github.com/yuryroot/#{spec.name}"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sequel'
+
+  if RUBY_PLATFORM =~ /java/
+    spec.add_development_dependency 'jdbc-postgres', '9.4.1200'
+  elsif RUBY_VERSION < '2.0.0'
+    spec.add_development_dependency 'pg', '<0.19.0'
+  else
+    spec.add_development_dependency 'pg'
+  end
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sequel-pg_advisory_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Yury Shchyhlinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- Shchyhlinski.YL@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/sequel-4.gemfile
+- gemfiles/sequel-5.gemfile
+- lib/sequel/extensions/pg_advisory_lock.rb
+- sequel-pg_advisory_lock.gemspec
+homepage: https://github.com/yuryroot/sequel-pg_advisory_lock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: sequel-pg_advisory_lock is an extension for ruby Sequel library that helps
+  using PostgreSQL advisory locks in your application
+test_files: []