strong_migrations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0871a07d2e13749e0f984373c303dd837d7ea95
+  data.tar.gz: 146fa1034aa8c8c8d5094b0bffa5079e728e6c54
+SHA512:
+  metadata.gz: 4743a779ecede6c6fca241a2f7c0eee01e46c24c79b5af071f850fb4ced23c852f9390f49afbe97323dd247d1dd0a378a3001f0ed6ba57839a34ce3e29ab9b0c
+  data.tar.gz: 8ed8682c0b22ba7c0f7881b9036e6c6e02dc40ffd7f112c08403c0276cbc986f8672e4f3b759ddaeb2b2dd4fc6b7825923917e078c9861a4f887713098cf005c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.2
+gemfile:
+  - Gemfile
+  - test/gemfiles/activerecord32.gemfile
+  - test/gemfiles/activerecord40.gemfile
+  - test/gemfiles/activerecord41.gemfile
+script: bundle exec rake test
+before_script:
+  - psql -c 'create database strong_migrations_test;' -U postgres
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bob Remeika and David Waller, 2015 Andrew Kane
+
+MIT License
+
+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,138 @@
+# Strong Migrations
+
+Catch unsafe migrations at dev time
+
+[![Build Status](https://travis-ci.org/ankane/strong_migrations.svg)](https://travis-ci.org/ankane/strong_migrations)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'strong_migrations'
+```
+
+## Dangerous Operations
+
+- adding an index non-concurrently
+- adding a column with a non-null default value
+- changing the type of a column
+- renaming a table
+- renaming a column
+- removing a column
+- adding a `json` column (Postgres only)
+
+For more info, check out:
+
+- [Rails Migrations with No Downtime](http://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/)
+- [Safe Operations For High Volume PostgreSQL](https://www.braintreepayments.com/blog/safe-operations-for-high-volume-postgresql/) (if it’s relevant)
+
+## The Zero Downtime Way
+
+### Adding an index
+
+Add indexes concurrently.
+
+```ruby
+class AddSomeIndexToUsers < ActiveRecord::Migration
+  def change
+    commit_db_transaction
+    add_index :users, :some_index, algorithm: :concurrently
+  end
+end
+```
+
+### Adding a column with a default value
+
+1. Add the column without a default value
+2. Commit the transaction
+3. Backfill the column
+4. Add the default value
+
+```ruby
+class AddSomeColumnToUsers < ActiveRecord::Migration
+  def up
+    # 1
+    add_column :users, :some_column, :text
+
+    # 2
+    commit_db_transaction
+
+    # 3
+    User.find_in_batches do |users|
+      User.where(id: users.map(&:id)).update_all some_column: "default_value"
+    end
+
+    # 4
+    change_column_default :users, :some_column, "default_value"
+  end
+
+  def down
+    remove_column :users, :some_column
+  end
+end
+```
+
+### Renaming or changing the type of a column
+
+There’s no way to do this without downtime.
+
+If you really have to:
+
+1. Create a new column
+2. Write to both columns
+3. Backfill data from the old column to the new column
+4. Move reads from the old column to the new column
+5. Stop writing to the old column
+6. Drop the old column
+
+### Renaming a table
+
+Same as renaming a column - see above.
+
+### Removing a column
+
+Tell ActiveRecord to [ignore the column](http://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/) from its cache.
+
+```ruby
+class User
+  def self.columns
+    super.reject { |c| c.name == "some_column" }
+  end
+end
+```
+
+Once it’s deployed, create a migration to remove the column.
+
+### Adding a json column
+
+There’s no equality operator for the `json` column type. Replace all calls to `uniq` with a custom scope.
+
+```ruby
+scope :uniq_on_id, -> { select("DISTINCT ON (your_table.id) your_table.*") }
+```
+
+## Assuring Safety
+
+To mark a step in the migration as safe, despite using method that might otherwise be dangerous, wrap it in a `safety_assured` block.
+
+```ruby
+class MySafeMigration < ActiveRecord::Migration
+  def change
+    safety_assured { remove_column :users, :some_column }
+  end
+end
+```
+
+## Credits
+
+Thanks to Bob Remeika and David Waller for the [original code](https://github.com/foobarfighter/safe-migrations).
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/strong_migrations/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/strong_migrations/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

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/lib/strong_migrations.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "strong_migrations/version"
+require "strong_migrations/unsafe_migration"
+require "strong_migrations/migration"
+
+ActiveRecord::Migration.send(:prepend, StrongMigrations::Migration)

data/lib/strong_migrations/migration.rb

@@ -0,0 +1,135 @@
+module StrongMigrations
+  module Migration
+    def safety_assured
+      previous_value = @safe
+      @safe = true
+      yield
+    ensure
+      @safe = previous_value
+    end
+
+    def method_missing(method, *args, &block)
+      unless @safe || is_a?(ActiveRecord::Schema)
+        case method
+        when :remove_column
+          raise_error :remove_column
+        when :remove_timestamps
+          raise_error :remove_column
+        when :change_table
+          raise_error :change_table
+        when :rename_table
+          raise_error :rename_table
+        when :rename_column
+          raise_error :rename_column
+        when :add_index
+          options = args[2]
+          unless options && options[:algorithm] == :concurrently
+            raise_error :add_index
+          end
+        when :add_column
+          type = args[2]
+          options = args[3]
+          raise_error :add_column_default if options && !options[:default].nil?
+          raise_error :add_column_json if type.to_s == "json"
+        when :change_column
+          raise_error :change_column
+        end
+      end
+
+      super
+    end
+
+    private
+
+    def raise_error(message_key)
+      message =
+        case message_key
+        when :add_column_default
+"Adding a column with a non-null default requires
+the entire table and indexes to be rewritten. Instead:
+
+1. Add the column without a default value
+2. Commit the transaction
+3. Backfill the column
+4. Add the default value"
+        when :add_column_json
+"There's no equality operator for the json column type.
+Replace all calls to uniq with a custom scope.
+
+  scope :uniq_on_id, -> { select(\"DISTINCT ON (your_table.id) your_table.*\") }
+
+Once it's deployed, wrap this step in a safety_assured { ... } block."
+        when :change_column
+"Changing the type of an existing column requires
+the entire table and indexes to be rewritten.
+
+If you really have to:
+
+1. Create a new column
+2. Write to both columns
+3. Backfill data from the old column to the new column
+4. Move reads from the old column to the new column
+5. Stop writing to the old column
+6. Drop the old column"
+        when :remove_column
+"ActiveRecord caches attributes which causes problems
+when removing columns. Be sure to ignored the column:
+
+class User
+  def self.columns
+    super.reject { |c| c.name == \"some_column\" }
+  end
+end
+
+Once it's deployed, wrap this step in a safety_assured { ... } block."
+        when :rename_column
+"There's no way to rename a column without downtime.
+
+If you really have to:
+
+1. Create a new column
+2. Write to both columns
+3. Backfill data from the old column to new column
+4. Move reads from the old column to the new column
+5. Stop writing to the old column
+6. Drop the old column"
+        when :rename_table
+"There's no way to rename a table without downtime.
+
+If you really have to:
+
+1. Create a new table
+2. Write to both tables
+3. Backfill data from the old table to new table
+4. Move reads from the old table to the new table
+5. Stop writing to the old table
+6. Drop the old table"
+        when :add_index
+"Adding a non-concurrent index locks the table. Instead, use:
+
+  def change
+    commit_db_transaction
+    add_index :users, :some_column, algorithm: :concurrently
+  end"
+        when :change_table
+"The strong_migrations gem does not support inspecting what happens inside a
+change_table block, so cannot help you here. Please make really sure that what
+you're doing is safe before proceding, then wrap it in a safety_assured { ... } block."
+        end
+
+
+      message.prepend '
+ __          __     _____ _______ _
+ \ \        / /\   |_   _|__   __| |
+  \ \  /\  / /  \    | |    | |  | |
+   \ \/  \/ / /\ \   | |    | |  | |
+    \  /\  / ____ \ _| |_   | |  |_|
+     \/  \/_/    \_\_____|  |_|  (_)
+
+'
+      message << "\n"
+
+      raise StrongMigrations::UnsafeMigration, message
+    end
+  end
+end

data/lib/strong_migrations/unsafe_migration.rb

@@ -0,0 +1,4 @@
+module StrongMigrations
+  class UnsafeMigration < StandardError
+  end
+end

data/lib/strong_migrations/version.rb

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

data/strong_migrations.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "strong_migrations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strong_migrations"
+  spec.version       = StrongMigrations::VERSION
+  spec.authors       = ["Bob Remeika", "David Waller", "Andrew Kane"]
+  spec.email         = ["bob.remeika@gmail.com", "andrew@chartkick.com"]
+
+  spec.summary       = "Catch unsafe migrations at dev time"
+  spec.homepage      = "https://github.com/ankane/strong_migrations"
+
+  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_dependency "activerecord", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pg"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: strong_migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Remeika
+- David Waller
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.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: minitest
+  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: 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'
+description: 
+email:
+- bob.remeika@gmail.com
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/strong_migrations.rb
+- lib/strong_migrations/migration.rb
+- lib/strong_migrations/unsafe_migration.rb
+- lib/strong_migrations/version.rb
+- strong_migrations.gemspec
+homepage: https://github.com/ankane/strong_migrations
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Catch unsafe migrations at dev time
+test_files: []