transactional_lock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ccd535b4afbf82dcdc3a4087dffc69a2e2a30be72d469702264d6acd684352b
+  data.tar.gz: 0bdb00b140fe468d9b12651d00c682ab38f833c78876c3419d68f29f291e82de
+SHA512:
+  metadata.gz: 1696fcc2cf3f12a8de0871fa975547d6d8f78f8792b2cd6689b7196ee3f25b785debb8538e159a486e7874e2a24774b67887b1169189de7f9374c093cbb3023c
+  data.tar.gz: 67507c3683c8248cd84f71b57eeafd6c37980fcbb464235b6ff202e8bf2ed8b188512bd4b396e313c3ceb9f866011c2200efc7988458a77b01336e3aa386b0bf

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.4
+sudo: false
+notifications:
+  email: false
+
+before_install: gem install bundler -v 1.10.6
+
+script: bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transactional_lock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jan Sandbrink
+
+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,63 @@
+[![build status](https://travis-ci.org/finnlabs/transactional_lock.svg)](https://travis-ci.org/finnlabs/transactional_lock)
+
+# TransactionalLock
+
+TransactionalLock is providing access to database advisory locks that will be automatically released
+upon the end of a transaction (`COMMIT` or `ROLLBACK`).
+
+As of now this gem only targets MySQL databases, where such locks are not available, thus they
+are emulated by ensuring that the outmost ActiveRecord transaction will release all\* locks.
+
+\* "all" refers to "one", because in MySQL a session can only hold a single advisory lock.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transactional_lock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transactional_lock
+
+## Usage
+
+While inside a transaction acquire your lock and you can be sure, that it will be released at
+the end of the transaction:
+
+````ruby
+ActiveRecord::Base.transaction do
+  TransactionalLock::AdvisoryLock.new('your_lock').acquire
+  # do your work
+end
+# the lock has been released at this point
+````
+
+It will also work for nested AR transactions (that do not really map to your SQL `COMMIT` or `ROLLBACK`):
+
+````ruby
+ActiveRecord::Base.transaction do
+  ActiveRecord::Base.transaction do
+    TransactionalLock::AdvisoryLock.new('your_lock').acquire
+  end
+
+  # lock is still acquired here...
+end # actual SQL COMMIT
+# the lock has been released at this point
+````
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/finnlabs/transactional_lock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transactional_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

data/bin/setup

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

data/lib/transactional_lock.rb

@@ -0,0 +1,12 @@
+require 'transactional_lock/active_record_patches'
+require 'transactional_lock/configuration'
+require 'transactional_lock/version'
+
+module TransactionalLock
+  class << self
+    def initialize(&block)
+      ::TransactionalLock::ActiveRecordPatches.perform!
+      ::TransactionalLock::Configuration.initialize(&block)
+    end
+  end
+end

data/lib/transactional_lock/active_record_patches.rb

@@ -0,0 +1,17 @@
+require 'transactional_lock/transaction_wrapper'
+
+module TransactionalLock
+  module ActiveRecordPatches
+    def self.perform!
+      ::ActiveRecord::Base.extend(ActiveRecordBasePatches)
+    end
+
+    module ActiveRecordBasePatches
+      def transaction(*args)
+        TransactionalLock::TransactionWrapper.new.wrap do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/transactional_lock/advisory_lock.rb

@@ -0,0 +1,97 @@
+require 'transactional_lock/configuration'
+
+module TransactionalLock
+  class LockAcquireError < StandardError
+  end
+
+  class LockConflict < LockAcquireError
+    def initialize(new_lock, old_lock)
+      super("Can't acquire lock '#{new_lock.name}'. Need to release lock '#{old_lock.name}' first.")
+    end
+  end
+
+  # Represents a database advisory lock.
+  # N.B. currently quite MySQL specific, except that its interface allows more than one active lock
+  # MySQL will only ever support one lock at a time (releasing earlier locks implicitly)
+  class AdvisoryLock
+    class << self
+      def acquired_locks
+        acquired_locks_changeable.dup.freeze
+      end
+
+      def release_all_locks
+        acquired_locks.each do |lock|
+          lock.release
+        end
+      end
+
+      def push_lock(lock)
+        acquired_locks_changeable << lock
+      end
+
+      def delete_lock(lock)
+        acquired_locks_changeable.delete(lock)
+      end
+
+      def forget_locks!
+        @acquired_locks = []
+      end
+
+      private
+
+      def acquired_locks_changeable
+        @acquired_locks ||= []
+      end
+    end
+
+    attr_reader :name, :timeout
+
+    def initialize(name, timeout: ::TransactionalLock::Configuration.default_timeout)
+      @name = name
+      @timeout = timeout
+      @acquired = false
+    end
+
+    def acquire
+      return if already_locked?
+      raise_on_lock_conflicts!
+
+      result = ActiveRecord::Base.connection.execute(
+                 "SELECT GET_LOCK('#{sql_name}', #{sql_timeout})")
+
+      unless result.first.first == 1
+        raise LockAcquireError.new "Could not acquire lock '#{@name}'."
+      end
+
+      self.class.push_lock(self)
+    end
+
+    def release
+      ActiveRecord::Base.connection.execute("SELECT RELEASE_LOCK('#{sql_name}')")
+    ensure
+      # In any case consider this lock being released (avoiding inability for new acquires)
+      self.class.delete_lock(self)
+    end
+
+    private
+
+    def already_locked?
+      self.class.acquired_locks.any? { |lock| lock.name == name }
+    end
+
+    def raise_on_lock_conflicts!
+      conflict_lock = self.class.acquired_locks.detect { |lock| lock.name != name }
+      if conflict_lock
+        raise LockConflict.new self, conflict_lock
+      end
+    end
+
+    def sql_name
+      ActiveRecord::Base.connection.quote_string(@name)
+    end
+
+    def sql_timeout
+      Integer(@timeout)
+    end
+  end
+end

data/lib/transactional_lock/configuration.rb

@@ -0,0 +1,27 @@
+module TransactionalLock
+  class Configuration
+    class << self
+      def initialize
+        config = default_configuration
+
+        if block_given?
+          yield config
+        end
+
+        @config = config
+      end
+
+      def default_timeout
+        @config[:default_timeout]
+      end
+
+      private
+
+      def default_configuration
+        {
+            default_timeout: 30
+        }
+      end
+    end
+  end
+end

data/lib/transactional_lock/transaction_wrapper.rb

@@ -0,0 +1,28 @@
+require 'transactional_lock/advisory_lock'
+
+module TransactionalLock
+  class TransactionWrapper
+    # If the root wrapper is not yet set, the specified wrapper will become the root wrapper.
+    def self.try_assign_root_wrapper(wrapper)
+      @root_wrapper ||= wrapper
+    end
+
+    # If the specified wrapper is the root wrapper, it will be deassigned and the block passed
+    # to this function will be executed
+    def self.deassign_root_wrapper(wrapper)
+      if wrapper == @root_wrapper
+        @root_wrapper = nil
+        yield
+      end
+    end
+
+    def wrap
+      self.class.try_assign_root_wrapper(self)
+      yield
+    ensure
+      self.class.deassign_root_wrapper(self) do
+        ::TransactionalLock::AdvisoryLock.release_all_locks
+      end
+    end
+  end
+end

data/lib/transactional_lock/version.rb

@@ -0,0 +1,3 @@
+module TransactionalLock
+  VERSION = "0.1.0"
+end

data/transactional_lock.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transactional_lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transactional_lock"
+  spec.version       = TransactionalLock::VERSION
+  spec.authors       = ["Jan Sandbrink"]
+  spec.email         = ["j.sandbrink@finn.de"]
+
+  spec.summary       = %q{Adds advisory locks that are automatically released at the end of a transaction.}
+  spec.homepage      = 'https://github.com/finnlabs/transactional_lock'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # N.B. Though our SQL commands are depending on a MySQL-backend, we do not depend on any
+  # specific SQL-gem. We only need activerecord to do our work, in the hope that our SQL code
+  # makes any sense to the active backend.
+  spec.add_dependency "activerecord", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: transactional_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Sandbrink
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: 
+email:
+- j.sandbrink@finn.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transactional_lock.rb
+- lib/transactional_lock/active_record_patches.rb
+- lib/transactional_lock/advisory_lock.rb
+- lib/transactional_lock/configuration.rb
+- lib/transactional_lock/transaction_wrapper.rb
+- lib/transactional_lock/version.rb
+- transactional_lock.gemspec
+homepage: https://github.com/finnlabs/transactional_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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Adds advisory locks that are automatically released at the end of a transaction.
+test_files: []