strong_migrations 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1d122ea065266614d32562e0692da6e53a44113
-  data.tar.gz: bffe96798471bf21ab7edb47a81ff4b97891b707
+SHA256:
+  metadata.gz: fe026b71dc38ab1cc40189ff8eb858baa45ec0778bd4dd640cff57349aa067ea
+  data.tar.gz: 28698d9bc1804389fc4e1fdb9e9a3ae9499cc490b15bda953f312fe434a6aa41
 SHA512:
-  metadata.gz: 28c244787f1be158f9efa4f3151a93247b1e231b3e2613d03ce5b324b00649ea7118529af59a14a9643f923ae7529435557ab5e97ffeedd8a0b7f51b83297912
-  data.tar.gz: 88d883bd199c79f143c73cfd54b1a921fbe24549b82c847793d0ea8a10544d46b8c699a1d6895d4d1ff3a1b5440bf6c61b380c2e8b119d975ee2868e07212b4c
+  metadata.gz: 3fe33582e8f6f4c0aced4f162704a9810e044e11e115ac1813892750474c118a33f0fb2ee19883d4dce98bfc6862786eaaf1c7862b4fd3398c2bb032010316fb
+  data.tar.gz: 0e5bcf7c1a42dcebe09a5f249fd2cb063549c1617d8a161ae915e882ab30e7f9a72b19b38407f5a526b59174cf04bcfa04c790888b7ce069c58c5cf7116faf00

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.3
+
+- Added check for `change_column_null`
+- Added support for alphabetize columns with Makara
+- Fixed migration reversibility with `auto_analyze`
+
 ## 0.2.2
 
 - Friendlier output

data/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Questions
+
+Use [Stack Overflow](https://stackoverflow.com/) with the tag `strong-migrations`.
+
+## Feature Requests
+
+Create an issue. Start the title with `[Idea]`.
+
+## Issues
+
+Think you’ve discovered an issue?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "strong_migrations", github: "ankane/strong_migrations"
+```
+
+If the above steps don’t help, create an issue. Include:
+
+- Detailed steps to reproduce
+- Complete backtraces for exceptions
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+- Add one or more tests if possible. Make sure existing tests pass with:
+
+```sh
+bundle exec rake test
+```
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Bob Remeika and David Waller, 2015 Andrew Kane
+Copyright (c) 2013 Bob Remeika and David Waller, 2015-2018 Andrew Kane
 
 MIT License
 

data/README.md

@@ -16,7 +16,7 @@ gem 'strong_migrations'
 
 ## How It Works
 
-Strong Migrations detects potentially dangerous operations in migrations, prevents them from running, and gives instructions on safer ways to do what you want.
+Strong Migrations detects potentially dangerous operations in migrations, prevents them from running by default, and provides instructions on safer ways to do what you want.
 
 ```
  __          __     _____ _______ _
@@ -45,6 +45,7 @@ The following operations can cause downtime or errors:
 - adding a column with a non-null default value to an existing table
 - removing a column
 - changing the type of a column
+- setting a `NOT NULL` constraint with a default value
 - renaming a column
 - renaming a table
 - adding an index non-concurrently (Postgres only)
@@ -75,6 +76,8 @@ class AddSomeColumnToUsers < ActiveRecord::Migration[5.1]
 end
 ```
 
+Don’t backfill existing rows in this migration, as it can cause downtime. See the next section for how to do it safely.
+
 ### Backfilling data
 
 To backfill data, use the Rails console or a separate migration with `disable_ddl_transaction!`. Avoid backfilling in a transaction, especially one that alters a table. See [this great article](https://wework.github.io/data/2015/11/05/add-columns-with-default-values-to-large-tables-in-rails-postgres/) on why.
@@ -166,9 +169,9 @@ class AddSomeIndexToUsers < ActiveRecord::Migration[5.1]
 end
 ```
 
-If you forget `disable_ddl_transaction!`, the migration will fail.
+If you forget `disable_ddl_transaction!`, the migration will fail. Also, note that indexes on new tables (those created in the same migration) don’t require this.
 
-Also, note that indexes on new tables (those created in the same migration) don’t require this.
+Check out [this gem](https://github.com/ankane/gindex) to quickly generate index migrations without memorizing the syntax.
 
 ### Adding a json column (Postgres)
 
@@ -261,7 +264,7 @@ StrongMigrations.auto_analyze = true
 
 ## Lock Timeout (Postgres)
 
-It’s a good idea to set a lock timeout for the database user that runs migrations. This way, if migrations can’t acquire a lock in a timely manner, other statements won’t be stuck behind it.
+It’s a good idea to set a lock timeout for the database user that runs migrations. This way, if migrations can’t acquire a lock in a timely manner, other statements won’t be stuck behind it. Here’s a great explanation of [how lock queues work](https://www.citusdata.com/blog/2018/02/15/when-postgresql-blocks/).
 
 ```sql
 ALTER ROLE myuser SET lock_timeout = '10s';
@@ -269,9 +272,13 @@ ALTER ROLE myuser SET lock_timeout = '10s';
 
 There’s also [a gem](https://github.com/gocardless/activerecord-safer_migrations) you can use for this.
 
+## Bigint Primary Keys (Postgres & MySQL)
+
+Rails 5.1+ uses `bigint` for primary keys to keep you from running out of ids. To get this in earlier versions of Rails, check out [this gem](https://github.com/Shopify/rails-bigint-primarykey).
+
 ## Additional Reading
 
-- [Rails Migrations with No Downtime](http://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/)
+- [Rails Migrations with No Downtime](https://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/)
 
 ## Credits

data/lib/strong_migrations.rb

@@ -1,9 +1,10 @@
 require "active_support"
-require "strong_migrations/version"
+
 require "strong_migrations/database_tasks"
-require "strong_migrations/unsafe_migration"
 require "strong_migrations/migration"
 require "strong_migrations/railtie" if defined?(Rails)
+require "strong_migrations/unsafe_migration"
+require "strong_migrations/version"
 
 module StrongMigrations
   class << self
@@ -122,7 +123,14 @@ Otherwise, remove the option.",
     execute:
 "The strong_migrations gem does not support inspecting what happens inside an
 execute call, so cannot help you here. Please make really sure that what
-you're doing is safe before proceeding, then wrap it in a safety_assured { ... } block."
+you're doing is safe before proceeding, then wrap it in a safety_assured { ... } block.",
+
+   change_column_null:
+"The last argument replaces existing NULLs with another value.
+This runs a single UPDATE query, which can cause downtime.
+Backfill NULLs manually in batches instead.
+
+More info: https://github.com/ankane/strong_migrations#backfilling-data"
   }
 end
 

data/lib/strong_migrations/alphabetize_columns.rb

@@ -0,0 +1,11 @@
+module StrongMigrations
+  module AlphabetizeColumns
+    def columns(*args)
+      super.sort_by(&:name)
+    end
+
+    def extensions(*args)
+      super.sort
+    end
+  end
+end

data/lib/strong_migrations/migration.rb

@@ -57,6 +57,7 @@ module StrongMigrations
         when :create_table
           options = args[1] || {}
           raise_error :create_table if options[:force]
+          (@new_tables ||= []) << args[0].to_s
         when :add_reference
           options = args[2] || {}
           index_value = options.fetch(:index, ActiveRecord::VERSION::MAJOR >= 5 ? true : false)
@@ -65,16 +66,18 @@ module StrongMigrations
           end
         when :execute
           raise_error :execute
+        when :change_column_null
+          null = args[2]
+          default = args[3]
+          if !null && !default.nil?
+            raise_error :change_column_null
+          end
         end
       end
 
-      if method == :create_table
-        (@new_tables ||= []) << args[0].to_s
-      end
-
       result = super
 
-      if StrongMigrations.auto_analyze && postgresql? && method == :add_index
+      if StrongMigrations.auto_analyze && @direction == :up && postgresql? && method == :add_index
         connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(args[0])}"
       end
 

data/lib/strong_migrations/railtie.rb

@@ -5,6 +5,10 @@ module StrongMigrations
   class Railtie < Rails::Railtie
     rake_tasks do
       load "tasks/strong_migrations.rake"
+
+      ["db:drop", "db:reset", "db:schema:load", "db:structure:load"].each do |t|
+        Rake::Task[t].enhance ["strong_migrations:safety_assured"]
+      end
     end
   end
 end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/tasks/strong_migrations.rake

@@ -10,21 +10,11 @@ namespace :strong_migrations do
     $stderr.puts "Dumping schema"
     ActiveRecord::Base.logger.level = Logger::INFO
 
-    class << ActiveRecord::Base.connection
-      alias_method :old_columns, :columns unless instance_methods.include?("old_columns")
-      alias_method :old_extensions, :extensions unless instance_methods.include?("old_extensions")
-
-      def columns(*args)
-        old_columns(*args).sort_by(&:name)
-      end
-
-      def extensions(*args)
-        old_extensions(*args).sort
-      end
+    require "strong_migrations/alphabetize_columns"
+    ActiveRecord::Base.connection.class.prepend StrongMigrations::AlphabetizeColumns
+    if ActiveRecord::ConnectionAdapters.const_defined?('PostGISAdapter')
+      ActiveRecord::ConnectionAdapters::PostGISAdapter.prepend StrongMigrations::AlphabetizeColumns
     end
+    ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend StrongMigrations::AlphabetizeColumns
   end
 end
-
-["db:drop", "db:reset", "db:schema:load", "db:structure:load"].each do |t|
-  Rake::Task[t].enhance ["strong_migrations:safety_assured"]
-end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
+- Andrew Kane
 - Bob Remeika
 - David Waller
-- Andrew Kane
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,29 +84,27 @@ dependencies:
         version: '1'
 description: 
 email:
-- bob.remeika@gmail.com
 - andrew@chartkick.com
+- bob.remeika@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/strong_migrations.rb
+- lib/strong_migrations/alphabetize_columns.rb
 - lib/strong_migrations/database_tasks.rb
 - lib/strong_migrations/migration.rb
 - lib/strong_migrations/railtie.rb
 - lib/strong_migrations/unsafe_migration.rb
 - lib/strong_migrations/version.rb
 - lib/tasks/strong_migrations.rake
-- strong_migrations.gemspec
 homepage: https://github.com/ankane/strong_migrations
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -116,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -124,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Catch unsafe migrations at dev time

data/.gitignore

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

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.1
-gemfile:
-  - Gemfile
-  - test/gemfiles/activerecord50.gemfile
-  - test/gemfiles/activerecord42.gemfile
-script: bundle exec rake test
-before_script:
-  - psql -c 'create database strong_migrations_test;' -U postgres
-  - mysql -e 'create database strong_migrations_test;'
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-matrix:
-  include:
-    - gemfile: test/gemfiles/mysql2.gemfile
-      env: ADAPTER=mysql2
-      rvm: 2.4.1

data/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "activerecord", "~> 5.1.0"

data/Rakefile

@@ -1,11 +0,0 @@
-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"]
-  t.warning = false
-end
-
-task default: :test

data/strong_migrations.gemspec

@@ -1,26 +0,0 @@
-# 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"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "pg", "< 1"
-end