nonschema_migrations 6.0.alpha1 → 6.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6216f98f76c03cbdcd3a2bd60bcd54b7622c2a1d32b268a097e365492e6a2fd5
-  data.tar.gz: 2feb072bd145e3da6d22ebd5abddee024fb32c90ce35e9cd1847144c60b5d6ce
+  metadata.gz: c2e935824796ce13a066ffb1ae249e290b68fa98a0795b1b6030c5c29317d343
+  data.tar.gz: 6e0570efd5a054f192dcd231b66b05b241e56b9f03e46ede56f2322416c5f501
 SHA512:
-  metadata.gz: 0fe28ee8aaf9f93b693e0d18d9c3ece88b161cb81730fc239ba630eb5b3fc5fe7a24d3832018f3b2317be96bcc031eb23da1ea7b36487ae7ab7dcff8a31b0a77
-  data.tar.gz: 1f2cfc4d4613e2fa4e8775905d684512fb7ea8960f6a046a795b2aa5e30365133cb49384e491b4feebac5b2fee0e7b1369e43d6f6b90c610385d74021638bc89
+  metadata.gz: 2d8f77a424fd97f377ea19cdb52b2ce8c9633452139c2e9102d9b6345195fa6e5ae25a78eb5753f4a23fd9ba847897caf8ac9cefd19cee6003dfac7b03d45c80
+  data.tar.gz: 346ee88888703f2266f60588b5ac7ac0744740ce419c07b3c2fb464cd61fd330bc7289b8b722b655e642ebec456b3aa3b091759c5ad64a15c2f87203cea3688b

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_WITHOUT: "local_development"

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+custom: ["https://heliosdev.shop?utm_source=github.com&utm_campaign=github_nonschema_migrations_repo_funding_link",
+         "https://shop.heliosdev.shop/?utm_source=github.com&utm_campaign=github_nonschema_migrations_repo_funding_link"]
+

data/.gitignore

@@ -0,0 +1,3 @@
+nonschema_migrations-*.gem
+coverage/
+

data/.travis.yml

@@ -0,0 +1,36 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+
+env:
+  - DB=sqlite3
+  - DB=mysql
+  - DB=postgresql
+
+gemfile:
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
+  - gemfiles/rails_6_0.gemfile
+
+#cache: bundler
+before_install: gem install bundler
+install: bundle install
+script: bundle exec rake
+
+matrix:
+  fast_finish: true
+
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4-0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4-1.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails_3_2.gemfile

data/Appraisals

@@ -0,0 +1,32 @@
+
+# appraise "rails-4-0" do
+#   gem "rails", "4.0.10"
+#   gem "minitest-rails", "~> 1.0"
+# end
+#
+# appraise "rails-4-1" do
+#   gem "rails", "4.1.6"
+#   gem "minitest"
+# end
+#
+# appraise "rails-4-2" do
+#   gem "rails", "4.2.0"
+#   gem "minitest"
+# end
+#
+# appraise "rails-5-0" do
+#   gem "rails", "5.0.0"
+#   gem "minitest"
+# end
+
+appraise "rails-5-1" do
+  gem "rails", "5.1.5"
+end
+
+appraise "rails-5-2" do
+  gem "rails", "5.2.0.rc1"
+end
+
+appraise "rails-6-0" do
+  gem "rails", "6.0.0"
+end

data/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "appraisal"
+gem 'guard'
+gem 'guard-rspec'
+gem 'rake'
+
+# gem 'rails', '~> 5.2.2'
+# gem 'byebug', platform: :mri_21
+
+# gem 'sqlite3'
+# gem 'mysql2'
+# gem 'mocha'
+
+# these versions of Rails are used only when running 'rake test' without using Appraisal
+# when run with Appraisal, this version gets overwritten by appraisal
+# (also special versions of minitest or minitest-rails are used depending
+# on Rails version being tested against)
+
+# ENABLE FOR testing Rails 4.1
+# gem "rails", "5.1.6", :require => false
+
+gem 'minitest-rg'
+
+group :test do
+  gem 'simplecov', :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    nonschema_migrations (6.0.alpha1)
+      activerecord (= 7.0.0.alpha2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activerecord (7.0.0.alpha2)
+      activemodel (= 7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activesupport (7.0.0.alpha2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    minitest-rg (5.2.0)
+      minitest (~> 5.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    shellany (0.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  guard
+  guard-rspec
+  minitest-rg
+  nonschema_migrations!
+  rake
+  simplecov
+
+BUNDLED WITH
+   1.17.2

data/LICENCE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2017 Jason Fleetwood-Boldt
+
+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,166 @@
+
+
+
+
+_Please use the version number of this gem in lockstep with your Rails version._
+
+| Rails Version    |   |   Use Version of This Gem     |     |           
+|--------------|------------------|---------------------------------------------|-----|
+| Rails 4.x, 4.1.x, 4.2  |   | v1.0.1  (Released Jun 1, 2019)          |     |
+| Rails 5.0        |    | v2.0.1 (Released Jun 1, 2019)                |     |
+| Rails 5.1        |    | v3.0.1 (Released Jun 1, 2019)                |     | 
+| Rails 5.2        |    | v4.0.2 (Released Jun 2, 2019)                |     |
+| Rails 6.0        |    | v5.1.2.1 (Released Nov 17, 2021)               |    |
+| Rails 7.0.0.alpha2  |    | v6.0.alpha2 (Released Nov 17, 2021)                 |    |
+| Rails 7             |    | v6.5 (Released Jan 11, 2022)                 |    |
+
+
+## Introduction
+
+Nonschema migrations, also known as data migrations, are a alternative kind of Rails migration. The data migrations operate exactly like schema migrations, except instead of running migrations to make changes to your schema (adding fields, dropping fields, adding tables, etc), you run data migrations to manipulate data in your app, enqueue or execute Resque jobs that require long-running processes. This happens in a Rails app for different reasons, usually to clean up or supplement data or architectural changes.
+
+Splitting your data migrations from your schema migrations has a particular benefit of achieving the most consistent zero-downtime deploys you can. I recommend you switch your deployment script to allow you to do two
+types of deploys: a Zero-downtime deploy (no schema migrations) and Schema Migration deploy.
+
+You can think of data migrations like seed data for production, staging, and dev environments. It is for people who don't like using seed data in dev, and want to have 'seed-parity' between dev + prod. (For example, for a basic set of setup records.)
+
+This way, you can deploy any non-destructive (data-only) migration with a Zero-downtime strategy, and opt to make destructive (schema) migrations in a normal deployment (maintenance on, run schema changes, boot up new app,  maintenance off).  Data-only migrations can be run while the app is actually running, augmenting what you can achieve with the migration-style shortcuts provided by Rails.
+
+A word of caution: If you find yourself making a lot of data migrations, you might consider if your product/development/business process is too reliant on one-off data importing. It may be that data management tools will help you in the long run. Nonetheless, separating your schema migrations from your data migrations can be a great strategy for modern Rails development.
+
+Data migrations functional EXACTLY like schema migrations except:
+
+1) They live in db/data_migrate instead of db/migrate
+
+2) The timestamps used to record which ones have been run are in a table called data_migrations instead of the normal schema_migrations table
+
+3) You run them using `rails data:migrate` instead of `rails db:migrate`
+
+## Installation
+To add to your Rails project, follow these steps.
+
+1) Add this to your gemfile.
+```ruby
+gem 'nonschema_migrations'
+```
+
+2) Run `bundle install`
+
+3) Run the setup script:
+```
+rails generate data_migrations:install
+```
+This will create a *schema* migration that will create the data_migrations table itself. (There will be a table in your database called data_migrations which will have two columns: id, version. It works exactly like the schema_migrations table.) Now execute that schema migration (and, in turn, be sure to run this on Production):
+
+```
+rails db:migrate
+```
+
+You are now set up and ready to start making data migrations. To create your first migration, create it with a generating using a camel-case description of what your data migration does. 
+
+```
+rails generate data_migration UpdatePhoneNumbers
+```
+
+Look for a file called (something like) `db/data_migrate/20140831020834_update_phone_numbers.rb`. It will have been automatically written with an empty up and down method. Add whatever operations you want to do in your **up** method, like large data manipulation jobs, running rake tasks, or enqueuing batch process jobs. 
+
+You probably want to put `ActiveRecord::IrreversibleMigration` into the **down** method your data migration:
+
+```ruby
+class UpdatePhoneNumbers < ActiveRecord::Migration
+  def up
+    # do stuff here
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end
+```
+
+To actually tell your app to run the data migration, use:
+
+```
+rails data:migrate
+```
+
+
+You get three additional rake tasks that operate and have the same syntax as the schema migrations, but operate only on the data migrations. 
+
+## rails data:migrate
+Migrate all data migrations that haven't been migrated.
+
+## rails data:migrate:down VERSION=xxxxxxxxxxx
+Migrate down the specified version
+
+## rails data:migrate:up VERSION=xxxxxxxxxxx
+Migrate up the specified versions.
+
+## rails data:rollback
+Rollback the last version. Generally data migrations don't have any "down" associated with them so use this only under extreme circumstances. 
+
+
+#
+
+By default your data migration will run in a single transaction (just like a schema migration).
+
+To turn this off, add `disable_ddl_transaction!` to the top of your migration, like so:
+
+```ruby
+class UpdatePhoneNumbers < ActiveRecord::Migration
+  disable_ddl_transaction!
+  def up
+    # do stuff here
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end
+```
+
+## Schema-Change Deploys with Heroku
+
+1. Switch OFF preboot feature
+2. Deploy to Heroku
+3. Enable maintenance-mode
+4. Run schema migrations  (app reboots)
+5. Disable maintenance mode
+6. Run the data migrations
+7. Switch preboot feature back ON
+
+advantage: your app is down only for schema migrations and you can let the data migrations take more time while your app is back online.
+
+
+## Zero-Downtime deploys with Heroku (no schema migrations)
+
+(assuming preboot is already on)
+1. Deploy to heroku with preboot on
+2. Heroku switches the incoming requests to use the new app
+3. Run data migrations (while new app is up & running)
+
+advantage: your app is never down and you can run data migrations in the background
+
+
+
+## Heroku Pipeline
+
+
+Release tasks should dbe **db:migrate**
+in `release-tasks.sh`
+``` 
+bundle exec rails db:migrate
+```
+
+
+The postdeply task shoul dbe **data:migrate**
+in `app.json`
+```
+"scripts":  {
+   "postdeploy": "bundle exec rails data:migrate"
+}
+```
+Using data migration is like seed data.
+
+However, the above setup will run only for REVIEW APPS. You will still need to manually run the data migration for staging + production. 
+

data/Rakefile

@@ -0,0 +1,31 @@
+
+require "rubygems"
+require "bundler/setup"
+
+require 'rake/testtask'
+
+# require "minitest"
+# require 'minist/autorun'
+
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.libs << 'lib/generators'
+  t.libs << 'lib/tasks'
+  t.libs << 'lib/nonschema_migrations'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'nonschema_migrations'
+  ARGV.clear
+  IRB.start
+end
+
+

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "guard"
+gem "guard-rspec"
+gem "rake"
+gem "byebug", platform: :mri_21
+gem "sqlite3"
+gem "mysql2"
+gem "mocha"
+gem "rails", "4.0.10"
+gem "minitest-rg"
+gem "minitest-rails", "~> 1.0"
+gem "nondestructive_migrations", "1.1"
+
+group :test do
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "guard"
+gem "guard-rspec"
+gem "rake"
+gem "byebug", platform: :mri_21
+gem "sqlite3"
+gem "mysql2"
+gem "mocha"
+gem "rails", "4.1.6"
+gem "minitest-rg"
+gem "minitest"
+
+group :test do
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_4_1.gemfile.lock

@@ -0,0 +1,164 @@
+PATH
+  remote: ../
+  specs:
+    nondestructive_migrations (1.1)
+      activerecord (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    ffi (1.9.5)
+    formatador (0.2.5)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    listen (2.7.11)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (2.4.1)
+    minitest (5.4.2)
+    minitest-rg (5.1.0)
+      minitest (~> 5.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    mysql2 (0.3.16)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.5)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  byebug
+  guard
+  guard-rspec
+  minitest
+  minitest-rg
+  mocha
+  mysql2
+  nondestructive_migrations!
+  rails (= 4.1.6)
+  rake
+  simplecov
+  sqlite3

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "guard"
+gem "guard-rspec"
+gem "rake"
+gem "byebug", platform: :mri_21
+gem "sqlite3"
+gem "mysql2"
+gem "mocha"
+gem "rails", "4.2.0"
+gem "minitest-rg"
+gem "minitest"
+
+group :test do
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"