pg_advisory_lock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ddeeb1356cb650c405bbd16569ac2e2c8d7cfb3e3c4315af9f55aee4a5594bd
+  data.tar.gz: becf789c25d232dccb5ce1504f5bd6aeef9d1b491e9f6ab85a4d9b42ae5e5c77
+SHA512:
+  metadata.gz: 4e7ee3ae26d4c4413e13fad975c5dcd2adbdefc0a2b3c6b70a9b94fcffe44c4ec466b7655752dc0f98dab3951a1f2841314763d6e42ca0672a85c1b720837530
+  data.tar.gz: 9c865edbfdafd873c29e83cd731e438a3d7b504872a3853e6c724549cfeee8f79804d157271b5bc4b06cc568c45f3f5e3f94df5c79df5e036fbd04303cf9a0d0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock
+/spec/config/database.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - vendor/**/*
+    - tmp/**/*
+
+Layout/LineLength:
+  Max: 180
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - id
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at senid231@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_advisory_lock.gemspec
+gemspec
+
+gem 'database_cleaner'
+gem 'pg'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.80.1'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Denis Talakevich
+
+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,66 @@
+# PgAdvisoryLock
+
+Postgresql Advisory Lock for ActiveRecord.
+Allows to use mutex in applications that uses same database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_advisory_lock'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pg_advisory_lock
+
+## Usage
+
+create subclass from `PgAdvisoryLock::Base` and define `model_class` for it
+
+```ruby
+require 'pg_sql_caller'
+
+class MySqlCaller < PgAdvisoryLock::Base
+  model_class 'ApplicationRecord'
+end
+
+MySqlCaller.select_values 'SELECT id from users WHERE parent_name = ?', 'John Doe' # => [1, 2, 3]
+```
+
+or just define `model_class` for `PgAdvisoryLock::Base` itself
+
+```ruby
+PgAdvisoryLock::Base.model_class 'ApplicationRecord'
+
+PgAdvisoryLock::Base.select_values 'SELECT id from users WHERE parent_name = ?', 'John Doe' # => [1, 2, 3]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Create `spec/config/database.yml` (look at `spec/config/database.travis.yml` for example).
+You need to create test database, so run `psql -c 'CREATE DATABASE pg_advisory_lock_test;'`.
+Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/pg_advisory_lock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/senid231/pg_advisory_lock/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgAdvisoryLock project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/senid231/pg_advisory_lock/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require '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/lib/pg_advisory_lock.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'pg_advisory_lock/version'
+require 'pg_advisory_lock/base'
+
+module PgAdvisoryLock
+  # Your code goes here...
+end

data/lib/pg_advisory_lock/base.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'active_support/logger'
+require 'pg_sql_caller'
+
+module PgAdvisoryLock
+  class Base
+    # Encapsulates advisory lock logic.
+    # https://www.postgresql.org/docs/9.3/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS-TABLE
+    # Allows to use mutex in applications that uses same database.
+
+    class_attribute :logger, instance_writer: false, default: ActiveSupport::Logger.new(STDOUT)
+    class_attribute :_sql_caller_class, instance_writer: false, default: PgSqlCaller::Base
+    class_attribute :_lock_names, instance_writer: false, default: {}
+
+    class << self
+      def inherited(subclass)
+        subclass._lock_names = {}
+        super
+      end
+
+      # @param name [Symbol, String]
+      # @param value [Integer, Array<(Integer, Integer)>]
+      def register_lock(name, value)
+        _lock_names[name.to_sym] = value
+      end
+
+      # @param klass [Class<PgSqlCaller::Base>, String]
+      def sql_caller_class(klass)
+        self._sql_caller_class = klass
+      end
+
+      # @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.
+      # @return yield
+      def with_lock(name, transaction: false, shared: false, id: nil, &block)
+        new(name, transaction: transaction, shared: shared, id: id).lock(&block)
+      end
+    end
+
+    # @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.
+    def initialize(name, transaction: false, shared: false, id: nil)
+      @name = name.to_sym
+      @transaction = transaction
+      @shared = shared
+      @id = id
+    end
+
+    # @yield - call block when lock is acquired
+    #   block must be passed if transaction argument is false.
+    # @raise [ArgumentError] when lock name is invalid.
+    # @return yield
+    def lock(&block)
+      with_logger do
+        lock_number = name_to_number
+        advisory_lock(lock_number, &block)
+      end
+    end
+
+    private
+
+    attr_reader :transaction, :shared, :name, :id
+
+    def with_logger
+      return yield if logger.nil? || !logger.respond_to?(:tagged)
+
+      logger.tagged(self.class.to_s, name.inspect) { yield }
+    end
+
+    def advisory_lock(lock_number, &block)
+      if transaction
+        transaction_lock(lock_number, &block)
+      else
+        non_transaction_lock(lock_number, &block)
+      end
+    end
+
+    def transaction_lock(lock_number)
+      raise ArgumentError, 'block required when not within transaction' if !block_given? && !_sql_caller_class.transaction_open?
+
+      return perform_lock(lock_number) unless block_given?
+
+      _sql_caller_class.transaction do
+        perform_lock(lock_number)
+        yield
+      end
+    end
+
+    def non_transaction_lock(lock_number)
+      raise ArgumentError, 'block required on transaction: false' unless block_given?
+
+      begin
+        perform_lock(lock_number)
+        yield
+      ensure
+        perform_unlock(lock_number)
+      end
+    end
+
+    def perform_lock(lock_number)
+      function_name = "pg_advisory#{'_xact' if transaction}_lock#{'_shared' if shared}"
+
+      _sql_caller_class.execute("SELECT #{function_name}(#{lock_number})")
+    end
+
+    def perform_unlock(lock_number)
+      _sql_caller_class.select_value("SELECT pg_advisory_unlock#{'_shared' if shared}(#{lock_number})")
+    end
+
+    # Converts lock name to number, because pg advisory lock functions accept only bigint numbers.
+    # @return [String] lock number or two numbers delimited by comma.
+    def name_to_number
+      lock_number = _lock_names.fetch(name) do
+        raise ArgumentError, "lock name #{name.inspect} is invalid, see #{self.class}::NAMES"
+      end
+      lock_number = Array.wrap(lock_number)
+      lock_number.push(id) if id.present?
+      raise ArgumentError, "can't use lock name #{name.inspect} with id" if lock_number.size > 2
+
+      lock_number.join(', ')
+    end
+  end
+end

data/lib/pg_advisory_lock/version.rb

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

data/pg_advisory_lock.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/pg_advisory_lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_advisory_lock'
+  spec.version       = PgAdvisoryLock::VERSION
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = 'Postgresql Advisory Lock for ActiveRecord'
+  spec.description   = 'Postgresql Advisory Lock for ActiveRecord.'
+  spec.homepage      = 'https://github.com/senid231/pg_advisory_lock'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'pg_sql_caller'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: pg_advisory_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: activesupport
+  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_sql_caller
+  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'
+description: Postgresql Advisory Lock for ActiveRecord.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_advisory_lock.rb
+- lib/pg_advisory_lock/base.rb
+- lib/pg_advisory_lock/version.rb
+- pg_advisory_lock.gemspec
+homepage: https://github.com/senid231/pg_advisory_lock
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/senid231/pg_advisory_lock
+  source_code_uri: https://github.com/senid231/pg_advisory_lock
+  changelog_uri: https://github.com/senid231/pg_advisory_lock
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Postgresql Advisory Lock for ActiveRecord
+test_files: []