migration-lock-timeout 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a619d10f5989579b9e6b7b9fecbbabe1da870e2
+  data.tar.gz: 2a8684a0d10cb2f62bdf61e267b01ac47e235e23
+SHA512:
+  metadata.gz: 5ecc4823ab9b5a7c8e252c632225c2d009eb7fe3a560526ad3ac9407525c6943cb207b6cba02c269ffa4c8dfdea7ba983e97757620fe7a72192dc9d6d7906327
+  data.tar.gz: af060b85d9066224932b22b5f05412bb26680222ffe80f523af9a17e01fa337eca69aeeb6670dd5d7a09ccf0536b5779a185488b44884171114d0ffc50d5bd1b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at opensource@procore.com All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Procore Technologies, Inc.
+
+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,117 @@
+# Migration Lock Timeout
+
+[![CircleCI](https://circleci.com/gh/procore/migration-lock-timeout/tree/master.svg?style=svg&circle-token=db5501175f384dfa477f8bfa2bdc628efe781e98)](https://circleci.com/gh/procore/migration-lock-timeout/tree/master)
+
+Migration Lock Timeout is a Ruby gem that adds a lock timeout to all Active
+Record migrations in your Ruby on Rails project. A lock timeout sets a timeout
+on how long PostgreSQL will wait to acquire a lock on tables being altered
+before failing and rolling back. This prevents migrations from creating
+additional lock contention that can take down your site when it's under heavy
+load. Migration Lock Timeout currently only supports [PostgreSQL](https://www.postgresql.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'migration-lock-timeout'
+```
+
+## Usage
+
+Configure the default lock timeout in a Rails initializer
+
+```ruby
+#config/initializers/migration_lock_timeout.rb
+
+MigrationLockTimeout.configure |config|
+  config.default_lock_timeout = 5 #timeout in seconds
+end
+```
+
+And that's all! Now every migration will execute
+```psql
+SET LOCAL lock_timeout = '5s';
+```
+inside the migration transaction before your migration code runs. No lock
+timeout will be used for the `down` migration.
+
+## Disabling
+
+You can disable the lock timeout by using:
+```ruby
+  class AddFoo < ActiveRecord::Migration
+
+    disable_lock_timeout!
+
+    def change
+      create_table :foo do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+
+## Custom lock timeout
+
+You can change the duration of the lock timeout by using:
+```ruby
+  class AddBar < ActiveRecord::Migration
+
+    set_lock_timeout 10
+
+    def change
+      create_table :bar do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+Additionally, if you have not set a default lock timeout, you can use this to
+set a timeout for a particular migration.
+
+## disable_ddl_transaction!
+
+If you use `disable_ddl_transaction!`, no lock timeout will occur
+```ruby
+  class AddMonkey < ActiveRecord::Migration
+
+    disable_ddl_transaction!
+
+    def change
+      create_table :monkey do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+
+## Running the specs
+
+To run the specs you must have [PostgreSQL](https://www.postgresql.org/)
+installed. Create a database called `migration_lock_timeout_test` and set the
+environment variables `POSTGRES_DB_USERNAME` and `POSTGRES_DB_PASSWORD` then run
+`rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/procore/migration-lock-timeout. 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).
+
+## About Procore
+
+<img
+  src="https://www.procore.com/images/procore_logo.png"
+  alt="Procore Logo"
+  width="250px"
+/>
+
+Migration Lock Timeout is maintained by Procore Technologies.
+
+Procore - building the software that builds the world.
+
+Learn more about the #1 most widely used construction management software at [procore.com](https://www.procore.com/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+machine:
+  environment:
+    POSTGRES_DB_DATABASE: circle_test
+    POSTGRES_DB_USERNAME: ubuntu
+    POSTGRES_DB_PASSWORD: ''
+database:
+  override: 
+    - echo 'using circle_test'

data/lib/migration-lock-timeout.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+module MigrationLockTimeout
+end
+
+Dir[File.join(File.dirname(__FILE__), 'migration_lock_timeout', '*.rb')].each {|file| require file }
+
+::ActiveRecord::Migration.prepend(MigrationLockTimeout::LockManager)
+::ActiveRecord::Migration.extend(MigrationLockTimeout::MigrationExtensions)

data/lib/migration_lock_timeout/config.rb

@@ -0,0 +1,18 @@
+module MigrationLockTimeout
+  mattr_accessor :config
+
+  def self.configure
+    @@config = Configurator.new
+    yield @@config
+  end
+
+  class Configurator
+    attr_accessor :default_timeout
+
+    def initialize
+      @default_timeout = nil
+    end
+
+  end
+
+end

data/lib/migration_lock_timeout/lock_manager.rb

@@ -0,0 +1,14 @@
+module MigrationLockTimeout
+  module LockManager
+
+    def migrate(direction)
+      timeout_disabled = self.class.disable_lock_timeout
+      time = self.class.lock_timeout_override || 
+        MigrationLockTimeout.try(:config).try(:default_timeout)
+      if !timeout_disabled && direction == :up && time && !disable_ddl_transaction
+        execute "SET LOCAL lock_timeout = '#{time}s'"
+      end
+      super
+    end
+  end
+end

data/lib/migration_lock_timeout/migration_extensions.rb

@@ -0,0 +1,14 @@
+module MigrationLockTimeout
+  module MigrationExtensions
+    attr_accessor :disable_lock_timeout
+    attr_accessor :lock_timeout_override
+
+    def disable_lock_timeout!
+      self.disable_lock_timeout = true
+    end
+
+    def set_lock_timeout(seconds)
+      self.lock_timeout_override = seconds
+    end
+  end
+end

data/lib/migration_lock_timeout/version.rb

@@ -0,0 +1,3 @@
+module MigrationLockTimeout
+  VERSION = "1.0.0"
+end

data/migration-lock-timeout.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'migration_lock_timeout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "migration-lock-timeout"
+  spec.version       = MigrationLockTimeout::VERSION
+  spec.authors       = ["Brad Urani"]
+  spec.email         = ["bradurani@gmail.com", "opensource@procore.com"]
+
+  spec.summary       = "Ruby gem that adds a lock timeout to Active Record migrations"
+  spec.description   = "Ruby gem that automatically adds a lock timeout to all Active Record migrations"
+  spec.homepage      = "http://github.com/procore/migration-lock-timeout"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "activerecord", "~>4.2"
+end

data/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ActiveRecord::Base.establish_connection(
+      adapter: "postgresql",
+      database: ENV["POSTGRES_DB_DATABASE"] || "migration_lock_timeout_test",
+      username: ENV['POSTGRES_DB_USERNAME'],
+      password: ENV['POSTGRES_DB_PASSWORD'],
+      host: 'localhost'
+    )
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end 
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end 
+  end
+end
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: migration-lock-timeout
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brad Urani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: database_cleaner
+  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: pry
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Ruby gem that automatically adds a lock timeout to all Active Record
+  migrations
+email:
+- bradurani@gmail.com
+- opensource@procore.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/migration-lock-timeout.rb
+- lib/migration_lock_timeout/config.rb
+- lib/migration_lock_timeout/lock_manager.rb
+- lib/migration_lock_timeout/migration_extensions.rb
+- lib/migration_lock_timeout/version.rb
+- migration-lock-timeout.gemspec
+- spec_helper.rb
+homepage: http://github.com/procore/migration-lock-timeout
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Ruby gem that adds a lock timeout to Active Record migrations
+test_files: []