data_migrate 3.2.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf69bd4a2c1fb2dc456bf88df16a89b06ea7b7dd
-  data.tar.gz: 0836666a623ae289792dcba1b0422c98c9cd87cc
+SHA256:
+  metadata.gz: 20f45c0a409f5eea659d56b8118d9625e3358cdd9d199978b56359d3416abe64
+  data.tar.gz: f553fd264b97b71671556ece98e9c79830223e960e7f41a46e383587a7b728c3
 SHA512:
-  metadata.gz: 93da479ae6eb63a85d954d6a140e30578e7e511b4bec44aa0c952fb09e98e7b62bfd2f3661147872e3c08d28c245197582aa49c24012fe1615e3d680241b2d40
-  data.tar.gz: 6d11fcff914918d0b2f1f5575e9f08cfcabf16ae912a98837bcc43e5407695b75f8b7300b32bf7ead08729946fb37ec7291c386ea6066a99b598962fc5e7a65d
+  metadata.gz: 8ac579c9ca5323c12e413f4c2ad228f9f36cbeb7d84624ff6fa24160f350b5e91f3ca7a8f18e469ce8e25dd4390a9d76316f40257dd9ef5bf4324c60309dd55f
+  data.tar.gz: f2fe12d32734ba839ce736d6634d2e794aad151b2719ff6e4a9bf1c9a05ccfdc4ab2a2de6bed8636a9423e89d6dddf62442ccf2f4c91ede15cf66736f36ff64f

data/Changelog.md

@@ -1,7 +1,251 @@
-Changelog
-=========
+# Changelog
+
+# 11.3.0
+- Make table_name configurable https://github.com/ilyakatz/data-migrate/pull/361
+- Use lease_connection over deprecated connection for rails 8 https://github.com/ilyakatz/data-migrate/pull/353
+- Add Ruby 3.4 to CI matrix
+
+# 11.2.0
+- Remove committed Gemfile.lock, reduce bundled file list when running `gem install` https://github.com/ilyakatz/data-migrate/pull/351
+- [Bump actionpack from 7.1.3.4 to 7.1.4.1](https://github.com/ilyakatz/data-migrate/pull/348)
+- [Bump rexml from 3.3.6 to 3.3.9](https://github.com/ilyakatz/data-migrate/pull/349)
+- Fix db_config_with_versions arity change and backport https://github.com/ilyakatz/data-migrate/pull/337
+
+# 11.1.0
+- Allow multiple data migration paths https://github.com/ilyakatz/data-migrate/pull/331
+- Fix db:prepare:with_data task on [Rails 7.2](https://github.com/ilyakatz/data-migrate/pull/339)
+- Fix ConnectionPool deprecation warnings on [Rails 7.2](https://github.com/ilyakatz/data-migrate/pull/341)
+- Add Rails 8.0 to testing grounds https://github.com/ilyakatz/data-migrate/pull/341
+- [Bump webrick from 1.8.1 to 1.8.2](https://github.com/ilyakatz/data-migrate/pull/345)
+
+# 11.0.0
+- [Update rexml to 3.3.6](https://github.com/ilyakatz/data-migrate/pull/329)
+- Fixes a bug which ignored migrations on [Rails 7.1 and higher](https://github.com/ilyakatz/data-migrate/pull/326)
+
+# 11.0.0rc
+- Remove Ruby 3.0 from build matrix
+- Support Rails 7.2.0 https://github.com/ilyakatz/data-migrate/pull/312
+- Update gemfile.lock builds
+
+## 9.4.2
+- Fix db:prepare:with_data task
+
+## 9.4.1
+- Add db:prepare task
+
+## 9.4.0
+- Reset model schema cache before each data migration https://github.com/ilyakatz/data-migrate/pull/307
+- Run load_config rake task before db:migrate:with_data https://github.com/ilyakatz/data-migrate/pull/308
+
+## 9.3.0
+- Improve with_data Rake task for multiple database https://github.com/ilyakatz/data-migrate/pull/296
+
+## 9.2.0
+- Support Rails 7.1 https://github.com/ilyakatz/data-migrate/pull/278
+- Build and test against 7.1.0.rc1 https://github.com/ilyakatz/data-migrate/pull/286
+
+## 9.1.0
+
+- Fix a bug that caused `schema_sha1` in `ar_internal_metadata` to be reset to the `data_schema.rb` file. (#272)
+- Remove the need for empty data_schema files for non-primary databases. (#273)
+
+## [YANKED] 10.0.3.rc
+
+- Remove all travis references [leoarnold](https//:github.com/leoarnold)
+- Changing to rc because of ongoing discussion how to properly handle multiple database environments
+
+## [YANKED] 10.0.2
+
+Change "rails" dependencies to "railties"
+
+## [YANKED] 10.0.1
+
+- Bug fix for Rails 6 config [chaunce](https//:github.com/chaunce)
+- Railties bug fix by [opti](https://github.com/opti)
+
+## [YANKED] 10.0.0
+
+Releasing 10.0.0
+
+!!! Breaking changes !!!
+
+- This version introduces a breaking change which may lead to undesired
+behavior in multi-database environments. See https://github.com/ilyakatz/data-migrate/issues/181
+
+## [YANKED] 10.0.0.rc1
+
+- Changes by [chaunce](https//:github.com/chaunce)
+- Multiple databases support
+- Refactor to clean things up
+- Deprecate rails 5.2 support for real
+
+## 9.0.0
+
+Ruby 3.2 support [mehanoid](https://github.com/mehanoid)
+Rails 5.2 is no longer supported
+
+## 8.5.0
+
+Allow custom templates [bazay](https://github.com/bazay)
+
+## 8.4.0
+
+Avoid Globally Accessible Functions for All Rake Tasks [berniechiu](https://github.com/berniechiu)
+
+## 8.3.0
+
+Add delegation to exists? for use by third parties [foxondo](https://github.com/foxondo)
+
+## 8.2.0
+
+Delegate to anonymous subclass of AR::SchemaMigration [foxondo](https://github.com/foxondo)
+
+## 8.1.1
+
+Revert 8.1.0 changes
+
+## 8.1.0
+
+Avoid globally accessible functions for all rake tasks [berniechiu](https://github.com/berniechiu)
+fixed `db:migrate:with_data` to compare data schema versions correctly [cadactive](https://github.com/cadactive)
+
+## 8.0.0.rc2
+
+Bug fixes [gdott9](https://github.com/gdott9)
+
+## 8.0.0.rc1
+Add support for Rails 7
+Removed support for Rails versions below 5.2. Now are supported only versions Rails 5.2 and up
+
+## 7.0.2
+
+Remove magic comment in migration files [y-yagi](https://github.com/y-yagi)
+User frozen string [jonnay](https://github.com/jonnay)
+## 7.0.1
+Use SchemaMigration.migrations_paths in main rake task [lewhit](https://github.com/lewhit)
+
+## 6.8.0
+
+Specify database name for migrations_paths [lewhit](https://github.com/lewhit)
+## 6.7.0
+
+Add configuration for which database name is to be used for database migrations [lewhit](https://github.com/lewhit)
+Add tests for Rails 6.1 [lewhit](https://github.com/lewhit)
+Migrations files should end only in .rb [kroehre](https://github.com/kroehre)
+
+## 6.6.2
+## 6.6.1
+
+configs_for deprecation notice [borama](https://github.com/borama)
+## 6.6.0
+
+Allow data dump connection to be configured [lewhit](https://github.com/lewhit)
+
+## 6.4.0
+
+Add primary key to data_migrations table [aandis](https://github.com/aandis)
+
+## 6.3.0
+
+Add `abort_if_pending_migrations` rake tasks [tomgia](https://github.com/tomgia)
+
+## 6.2.0
+
+Add `rake data:schema:load` [timkrins](https://github.com/timkrins)
+
+## 6.1.0
+
+Fixing `rake db:schema:load:with_data` for Rails 6
+
+Note:
+
+Rails 5.0 is no longer maintained. The gem will still work but it is not being
+actively tested.
+
+## 6.0.5
+
+Fixing `needs_migration?` method for Rails 5.2 and up [EnomaDebby](https://github.com/EnomaDebby)
+
+## 6.0.4.beta
+
+Fix rolling back schema migrations failing for Rails 5.2 and above
+
+## 6.0.3.beta
+
+Compatiblity with Rails 6 RC2 [y-yagi](https://github.com/y-yagi)
+
+## 6.0.1.beta
+
+Fix migrations being generated in wrong folder
+
+## 6.0.0
+
+Support for Rails 6
+No longer supporting Rails 4.2
+
+## 5.3.3
+
+Ruby 2.2 and 2.3 are no longer actively validated with tests since they are both EOL
+
+## 5.3.2
+
+Fix capistrano migration tasks to only skip migrations if there are no changes in the db/data and db/migrate folders
+
+## 5.3.1
+
+Change database task to use data_migrations_path_configuration
+
+## 5.3.0
+
+Add support to configure data migration path
+
+## 5.1.0
+
+Fixes to `db:schema:load:with_data` + `db:structure:load:with_data` definition, thanks to [craineum](https://github.com/craineum)
+
+## 5.0.0
+
+Remove support for legacy migrations (from v2).
+
+**IMPORTANT**: If you used this gem from before version 2, make sure to run migration script
+
+```
+DataMigrate::LegacyMigrator.new.migrate
+```
+
+**Failure to do so may cause re-running old migrations**
+
+## 4.0.0
+
+Support for Rails 5.2
+Deprecated support for Rails 4.1
+Internal changes to make data-migrate behavior more similar to Rails migrations
+
+## 3.5.0
+
+Deprecated support for rails 4.0
+Improvements to timestamped migrations, thanks to [Pierre-Michard](https://github.com/Pierre-Michard)
+
+## 3.4.0
+
+`rake data:migrate:status` to return result in chronological order
+
+## 3.3.1
+
+Regression fix, thanks to [subakva](https://github.com/subakva)
+
+## 3.3.0
+
+The concept of schema:dump to data migrations, thanks to
+[tobyndockerill](https://github.com/tobyndockerill)
+
+## 3.2.1
+
+data_migrate table into rails schema dump, thanks to
+[jturkel](https://github.com/jturkel)
 
 ## 3.2.0
+
 - Add support for Rails 5.1
 - No longer testing EOL rubies
 

data/README.md

@@ -1,10 +1,9 @@
-Data Migrate
-====
+# Data Migrate
 
 - [![Version](http://img.shields.io/gem/v/data_migrate.svg?style=flat-square)](https://rubygems.org/gems/data_migrate)
 - [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/MIT)
-- [![Travis](https://img.shields.io/travis/ilyakatz/data-migrate.svg)](https://travis-ci.org/ilyakatz/data-migrate)
-
+- ![.github/workflows/build.yml](https://github.com/ilyakatz/data-migrate/actions/workflows/.github/workflows/build.yml/badge.svg)
+- [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
 Run data migrations alongside schema migrations.
 
@@ -13,48 +12,16 @@ migrations, except they should be reserved for data migrations. For
 instance, if you realize you need to titleize all your titles, this
 is the place to do it.
 
-![Travis](./screenshot.png)
-
-# Why should I use this?
-
-Its seems when a project hits a certain size, I get to manipulate data
-outside the application itself.  Changing defaults, new validations,
-one-to-one to one-to-many... I found it a pain and dodgy to have to
-step up migrations one by one, run a ruby script of some sort, then
-resume migrations.  It tanks a lot of the automation of deploy.
-
-If you don't use the one off scripts, you could do it as a regular
-migration.  It'd be much better to keep concerns separate. The benefit
-of having them separate has to do with your data model.
-
-For instance, lets take an absurd example, to illustrate: You have
-a blog application that has posts with many comments.
-After some use, you decide you are going to be a trend setter,
-and want only one comment per post, and just the text.
-
-Given that you:
-- write a migration to add a comment column to `Post`
-- write a migration to move the contents of the first comments to the `Post`
-- drop the `column_id` column from `Post`
-- drop the `Comment` model
-- fix all your tests
-
-You've just got bit.  When you `rake setup:development`, the mess gets
-mad at you after it creates your database, and starts cranking through
-migrations.  It gets to the part where you iterate over the comments
-and it blows up.  You don't have a `Comment` model anymore for it to
-even try and get 'all' from.  You think you are smarter, and wrap the
-ActiveRecord call in a conditional based on the environment.
-
-That's fine until you get that QA gal, and she wants her own thing.
-Then the UI people get tired of waiting for the full stack to load on page
-refreshes, so you have to edit past migrations...
-
-With Data Migrate, you have the control.  You can generate your
-migrations as schema or data as you would as your work flow. For
-setting tasks that don't require any intermediate AR activity, like
-dev and test, you stick with `db:migrate`.  For production and QA, you
-change their scripts to `db:migrate:with_data`.  Of course you want to
+![directory tree example](./screenshot.png)
+
+## Why should I use this?
+
+With data-migrate you can generate your migrations for data as you would schema
+in your regular work flow.
+
+For setting tasks that don't require any intermediate AR activity, like
+dev and test, you stick with `db:migrate`. For production and QA, you
+change their scripts to `db:migrate:with_data`. Of course you want to
 test your migration, so you have the choice of `db:migrate:with_data` or
 `data:migrate` to just capture that data change.
 
@@ -65,28 +32,17 @@ migrations, except they should be reserved for data migrations. For
 instance, if you realize you need to titleize all yours titles, this
 is the place to do it. Running any of the provided rake tasks also
 creates a data schema table to mirror the usual schema migrations
-table to track all the goodness.
+table to track all migrations.
 
 ## Rails Support
 
-Rails 3.1: Version 1.2 supports Rails 3.1.0 and higher **but** is no longer maintained.
-
-Rails 4: Version 2.0 supports Rails 4.0 and higher
-
-Rails 5.0: Supported
-
-Rails 5.1: Supported
+Support Rails 6.1 through 8.0
 
-### Important notes for older versions
+For **Rails 6.0** support, please use gem version `9.1.x`:
 
-#### v2
-
-If you upgraded to Rails 4 while using `data_migrate` prior to version 2,
-the gem wrote data migration versions into
-`schema_migrations` table. After the fix, it was corrected to write into
-`data_migrations`.
-
-This may cause some unintended consequences. See [#22](https://github.com/ilyakatz/data-migrate/issues/22)
+```ruby
+gem 'data_migrate', '~> 9.1.0'
+```
 
 #### v1
 
@@ -94,6 +50,7 @@ If you've installed previous to v1.1.0, you'll want to delete the
 `create_data_migrations_table` migration.
 
 ## Installation
+
 Add the gem to your project
 
     # Gemfile
@@ -105,7 +62,6 @@ So you know, when you use one of the provide rake tasks, a table
 called `data_migrations` will be created in your database. This
 is to mirror the way the standard `db` rake tasks work.
 
-
 ## Usage
 
 ### Generating Migrations
@@ -117,28 +73,62 @@ You can generate a data migration as you would a schema migration:
 ### Rake Tasks
 
     $> rake -T data
-    rake data:forward                 # Pushes the schema to the next version (specify steps w/ STEP=n)
-    rake data:migrate                 # Migrate data migrations (options: VERSION=x, VERBOSE=false)
-    rake data:migrate:down            # Runs the "down" for a given migration VERSION
-    rake data:migrate:redo            # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSIO...
-    rake data:migrate:status          # Display status of data migrations
-    rake data:migrate:up              # Runs the "up" for a given migration VERSION
-    rake data:rollback                # Rolls the schema back to the previous version (specify steps w/ STEP=n)
-    rake data:version                 # Retrieves the current schema version number for data migrations
-    rake db:forward:with_data         # Pushes the schema to the next version (specify steps w/ STEP=n)
-    rake db:migrate:down:with_data    # Runs the "down" for a given migration VERSION
-    rake db:migrate:redo:with_data    # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSIO...
-    rake db:migrate:status:with_data  # Display status of data and schema migrations
-    rake db:migrate:up:with_data      # Runs the "up" for a given migration VERSION
-    rake db:migrate:with_data         # Migrate the database data and schema (options: VERSION=x, VERBOSE=false)
-    rake db:rollback:with_data        # Rolls the schema back to the previous version (specify steps w/ STEP=n)
-    rake db:version:with_data         # Retrieves the current schema version numbers for data and schema migrations
-
-Tasks work as they would with the 'vanilla' db version.  The 'with_data' addition to the 'db' tasks will run the task in the context of both the data and schema migrations.  That is, `rake db:rollback:with_data` will check to see if it was a schema or data migration invoked last, and do that.  Tasks invoked in that space also have an additional line of output, indicating if the action is performed on data or schema.
-
-With 'up' and 'down', you can specify the option 'BOTH', which defaults to false. Using true, will migrate both the data and schema (in the desired direction) if they both match the version provided.  Again, going up, schema is given precedence. Down its data.
-
-`rake db:migrate:status:with_data` provides and additional column to indicate which type of migration.
+    rake data:abort_if_pending_migrations          # Raises an error if there are pending data migrations
+    rake data:dump                                 # Create a db/data_schema.rb file that stores the current data version
+    rake data:forward                              # Pushes the schema to the next version (specify steps w/ STEP=n)
+    rake data:migrate                              # Migrate data migrations (options: VERSION=x, VERBOSE=false)
+    rake data:migrate:down                         # Runs the "down" for a given migration VERSION
+    rake data:migrate:redo                         # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x)
+    rake data:migrate:status                       # Display status of data migrations
+    rake data:migrate:up                           # Runs the "up" for a given migration VERSION
+    rake data:rollback                             # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+    rake data:schema:load                          # Load data_schema.rb file into the database without running the data migrations
+    rake data:version                              # Retrieves the current schema version number for data migrations
+    rake db:abort_if_pending_migrations:with_data  # Raises an error if there are pending migrations or data migrations
+    rake db:forward:with_data                      # Pushes the schema to the next version (specify steps w/ STEP=n)
+    rake db:migrate:down:with_data                 # Runs the "down" for a given migration VERSION
+    rake db:migrate:redo:with_data                 # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x)
+    rake db:migrate:status:with_data               # Display status of data and schema migrations
+    rake db:migrate:up:with_data                   # Runs the "up" for a given migration VERSION
+    rake db:migrate:with_data                      # Migrate the database data and schema (options: VERSION=x, VERBOSE=false)
+    rake db:prepare:with_data                      # Runs setup if database does not exist, or runs data and schema migrations if it does
+    rake db:rollback:with_data                     # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+    rake db:schema:load:with_data                  # Load both schema.rb and data_schema.rb file into the database
+    rake db:structure:load:with_data               # Load both structure.sql and data_schema.rb file into the database
+    rake db:version:with_data                      # Retrieves the current schema version numbers for data and schema migrations
+
+
+Tasks work as they would with the 'vanilla' db version. The 'with_data' addition to the 'db' tasks will run the task in the context of both the data and schema migrations. That is, rake db:rollback:with_data will check to see if it was a schema or data migration invoked last, and do that. Tasks invoked in that space also have an additional line of output, indicating if the action is performed on data or schema.
+
+With 'up' and 'down', you can specify the option 'BOTH', which defaults to false. Using true, will migrate both the data and schema (in the desired direction) if they both match the version provided. Again, going up, schema is given precedence. Down its data.
+
+When using `rake db:migrate:with_data` migrations will be run in ascending order by their version. For example, if you have a data migration with version 20230410000000 and a schema migration with version 20230415000000, expect the data migration to run first.
+
+`rake db:migrate:status:with_data` provides an additional column to indicate which type of migration.
+
+### Configuration
+
+`data_migrate` respects `ActiveRecord::Base.dump_schema_after_migration`. If it is set to `false`, data schema file will not be generated
+
+By default, data migrations are added to the `db/data/` path.
+You can override this setting in `config/initializers/data_migrate.rb`
+
+```ruby
+DataMigrate.configure do |config|
+  config.data_migrations_table_name = 'my_migrations_database_name'
+  config.data_migrations_path = 'db/awesomepath/'
+  config.data_template_path = Rails.root.join("lib", "awesomepath", "custom_data_migration.rb")
+  config.db_configuration = {
+    'host' => '127.0.0.1',
+    'database' => 'awesome_database',
+    'adapter' => 'mysql2',
+    'username' => 'root',
+    'password' => nil,
+  }
+  config.spec_name = 'primary'
+end
+
+```
 
 ## Capistrano Support
 
@@ -152,6 +142,20 @@ require 'capistrano/data_migrate'
 
 From now on capistrano will run `rake db:migrate:with_data` in every deploy.
 
+## Rails Engines support
+
+This gem also has a initial support for adding data migrations inside Rails engines.
+Just add your engines directory pattern to data_migrations initializer, for example
+in the case your engines are located in `engines` folder you can set it up like this:
+
+```ruby
+DataMigrate.configure do |config|
+  config.data_migrations_path = ['db/data'] + Dir['engines/**/db/data']
+end
+```
+
+Then, in the Engine's `db/data` folder, you can add data migrations and run them as usual.
+
 ### Contributing
 
 ## Testing
@@ -159,14 +163,26 @@ From now on capistrano will run `rake db:migrate:with_data` in every deploy.
 Run tests for a specific version of Rails
 
 ```
-appraisal install
-appraisal rails-4.2 rspec
-appraisal rails-5.0 rspec
+bundle exec appraisal rails-6.1 rspec
+bundle exec appraisal rails-7.0 rspec
+bundle exec appraisal rails-7.1 rspec
+bundle exec appraisal rails-7.2 rspec
+bundle exec appraisal rails-8.0 rspec
 ```
 
+## Releasing new version
+
+1. Update version.rb file, run `bundle exec appraisal` to update the version in corresponding gemfile.lock
+2. Create a new tag, eg `git tag 9.4.1`
+3. Go to https://github.com/ilyakatz/data-migrate/tags
+4. Click "Create release" under 9.4.1
+5. CLick "Generate release notes"
+6. Click "Publish release"
+
 ## Thanks
+
 [Andrew J Vargo](http://github.com/ajvargo) Andrew was the original creator and maintainer of this project!
 
-[Jeremy Durham](http://jeremydurham.com/) for fleshing out the idea with me, and providing guidance.
+[Jeremy Durham](http://jeremydurham.com/) for fleshing out the idea and providing guidance.
 
-You!  Yes, you. Thanks for checking it out.
+You! Yes, you. Thanks for checking it out.

data/lib/capistrano/data_migrate/migrate.rb

@@ -7,10 +7,9 @@ namespace :deploy do
       conditionally_migrate = fetch(:conditionally_migrate)
       info '[deploy:migrate] Checking changes in db/migrate or db/data' if conditionally_migrate
 
-      if conditionally_migrate && (
-          test("diff -q #{release_path}/db/migrate #{current_path}/db/migrate") ||
-          test("diff -q #{release_path}/db/data #{current_path}/db/data")
-        )
+      if conditionally_migrate &&
+         test("diff -q #{release_path}/db/migrate #{current_path}/db/migrate") &&
+         test("diff -q #{release_path}/db/data #{current_path}/db/data")
         info '[deploy:migrate] Skip `deploy:migrate` (nothing changed in db/migrate or db/data)'
       else
         info '[deploy:migrate] Run `rake db:migrate:with_data`'

data/lib/data_migrate/config.rb

@@ -0,0 +1,33 @@
+module DataMigrate
+  include ActiveSupport::Configurable
+  class << self
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :data_migrations_table_name, :data_migrations_path, :data_template_path, :db_configuration, :spec_name
+
+    DEFAULT_DATA_TEMPLATE_PATH = "data_migration.rb"
+
+    def initialize
+      @data_migrations_table_name = "data_migrations"
+      @data_migrations_path = "db/data/"
+      @data_template_path = DEFAULT_DATA_TEMPLATE_PATH
+      @db_configuration = nil
+      @spec_name = nil
+    end
+
+    def data_template_path=(value)
+      @data_template_path = value.tap do |path|
+        raise ArgumentError, "File not found: '#{path}'" unless path == DEFAULT_DATA_TEMPLATE_PATH || File.exist?(path)
+      end
+    end
+  end
+end