data_migrate 6.2.0 → 6.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406033afc1679b99c3126cbbe9d033db56db817bf98a14a2f7926517e5f54587
-  data.tar.gz: d33213b5b15ab486fce6e0d1e276d77be5a5dc69768bebb8d26400b7fe3523a8
+  metadata.gz: d7ade2dd2b613ca6bff60e0afbba1d88cbe9fa4aba6a133b158f2dea3c3dcc3a
+  data.tar.gz: ba747d96bdbd3f31598cb56bd125995d850e1fc1d5c3ca6e90554198fa816014
 SHA512:
-  metadata.gz: eddd59586a06045a5120af7c1bb44b7f9da3099fbbdcda532f7975fb4356ba2c82a4b08bc460104df880c0030c8037cdbac0300a29ca8c789f457a3d8a7127d1
-  data.tar.gz: 062cf7e95ae5dd4ebc7ce321fe040726badba05aa049b83cc5a2b46ac0e52d654cda011582052d928af3bcd90c95b4c1883da32522e49793b3196ffff0960e2c
+  metadata.gz: 60a953d37627c879c8355765f98448c7fd90bbeaa270c3449c9eb1e6d2f7c08df79eae14bf487a3950d58f20722b27190ec1e562a83b89e78d76dcf9823d6e86
+  data.tar.gz: 564372cfea442ca66c7a2a918bcc671662cc40f9beace2493fefcf5b7901df22abdd19f5c28aba57586a1a208c8446123a7490f473b3a1c6ebeb4aa74fd68c4d

data/.gitignore

@@ -3,6 +3,8 @@
 *.lock
 gemfiles/.bundle
 spec/db/test.db
+spec/db/other_test.db
+spec/db/data_schema.rb
 .vscode/
 .DS_Store
 .idea/

data/Changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)

data/README.md

@@ -82,26 +82,29 @@ You can generate a data migration as you would a schema migration:
 ### Rake Tasks
 
     $> rake -T data
-    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: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: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 files into the database
-    rake db:structure:load:with_data  # Load both structure.sql and data_schema.rb files into the database
-    rake db:version:with_data         # Retrieves the current schema version numbers for data and schema migrations
+    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: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.
 
@@ -119,6 +122,13 @@ You can override this setting in `config/initializers/data_migrate.rb`
 ```ruby
 DataMigrate.configure do |config|
   config.data_migrations_path = "db/awesomepath/"
+  config.db_configuration = {
+    'host' => '127.0.0.1',
+    'database' => 'awesome_database',
+    'adapter' => 'mysql2',
+    'username' => 'root',
+    'password' => nil,
+  }
 end
 
 ```

data/lib/data_migrate/config.rb

@@ -12,10 +12,11 @@ module DataMigrate
   end
 
   class Config
-    attr_accessor :data_migrations_path
+    attr_accessor :data_migrations_path, :db_configuration
 
     def initialize
       @data_migrations_path = "db/data/"
+      @db_configuration = nil
     end
   end
 end

data/lib/data_migrate/data_migrator.rb

@@ -76,17 +76,8 @@ module DataMigrate
 
       def create_table(sm_table)
         ActiveRecord::Base.connection.create_table(sm_table, id: false) do |schema_migrations_table|
-          schema_migrations_table.column :version, :string, null: false
+          schema_migrations_table.string :version, primary_key: true
         end
-
-        suffix = ActiveRecord::Base.table_name_suffix
-        prefix = ActiveRecord::Base.table_name_prefix
-        index_name = "#{prefix}unique_data_migrations#{suffix}"
-
-        options = {unique: true, name: index_name}
-        options[:length] = 191 if ActiveRecord::Base.connection_config[:adapter] == "mysql2"
-
-        ActiveRecord::Base.connection.add_index sm_table, :version, options
       end
 
       def table_exists?(connection, table_name)

data/lib/data_migrate/data_migrator_five.rb

@@ -75,8 +75,13 @@ module DataMigrate
       end
 
       def db_config
-        ActiveRecord::Base.configurations[Rails.env || "development"] ||
-          ENV["DATABASE_URL"]
+        env = Rails.env || "development"
+        ar_config = if (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 6
+                      ActiveRecord::Base.configurations.configs_for(env_name: env).first
+                    else
+                      ActiveRecord::Base.configurations[env]
+                    end
+        ar_config || ENV["DATABASE_URL"]
       end
     end
 

data/lib/data_migrate/data_schema_migration.rb

@@ -6,8 +6,8 @@ module DataMigrate
         ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix
       end
 
-      def index_name
-        "#{table_name_prefix}unique_data_migrations#{table_name_suffix}"
+      def primary_key
+        "version"
       end
     end
   end

data/lib/data_migrate/database_tasks.rb

@@ -69,7 +69,7 @@ module DataMigrate
     def self.pending_data_migrations
       data_migrations = DataMigrate::DataMigrator.migrations(data_migrations_path)
       sort_migrations(DataMigrate::DataMigrator.new(:up, data_migrations ).
-        pending_migrations.map {|m| { version: m.version, kind: :data }})
+        pending_migrations.map {|m| { version: m.version, name: m.name, kind: :data }})
     end
 
     def self.pending_schema_migrations

data/lib/data_migrate/migration.rb

@@ -14,8 +14,8 @@ module DataMigrate
         ActiveRecord::Base.table_name_prefix + "data_migrations" + ActiveRecord::Base.table_name_suffix
       end
 
-      def index_name
-        "#{table_name_prefix}unique_data_migrations#{table_name_suffix}"
+      def primary_key
+        "version"
       end
     end
 

data/lib/data_migrate/migration_five.rb

@@ -14,8 +14,8 @@ module DataMigrate
         ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix
       end
 
-      def index_name
-        "#{table_name_prefix}unique_data_migrations#{table_name_suffix}"
+      def primary_key
+        "version"
       end
     end
 

data/lib/data_migrate/schema_migration.rb

@@ -7,7 +7,7 @@ module DataMigrate
       sort_migrations(
         ActiveRecord::Migrator.new(:up, all_migrations).
         pending_migrations.
-        map {|m| { version: m.version, kind: :schema }}
+        map {|m| { version: m.version, name: m.name, kind: :schema }}
       )
     end
 

data/lib/data_migrate/schema_migration_five.rb

@@ -7,7 +7,7 @@ module DataMigrate
       sort_migrations(
         ActiveRecord::Migrator.new(:up, all_migrations).
         pending_migrations.
-        map {|m| { version: m.version, kind: :schema }}
+        map {|m| { version: m.version, name: m.name, kind: :schema }}
       )
     end
 

data/lib/data_migrate/tasks/data_migrate_tasks.rb

@@ -6,6 +6,16 @@ module DataMigrate
         @migrations_paths ||= DataMigrate.config.data_migrations_path
       end
 
+      def dump
+        if ActiveRecord::Base.dump_schema_after_migration
+          filename = DataMigrate::DatabaseTasks.schema_file
+          ActiveRecord::Base.establish_connection(DataMigrate.config.db_configuration) if DataMigrate.config.db_configuration
+          File.open(filename, "w:utf-8") do |file|
+            DataMigrate::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+          end
+        end
+      end
+
       def migrate
         DataMigrate::DataMigrator.assure_data_schema_table
         target_version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
@@ -16,6 +26,16 @@ module DataMigrate
           DataMigrate::DataMigrator.migrate(migrations_paths, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
         end
       end
+
+      def abort_if_pending_migrations(migrations, message)
+        if migrations.any?
+          puts "You have #{migrations.size} pending #{migrations.size > 1 ? 'migrations:' : 'migration:'}"
+          migrations.each do |pending_migration|
+            puts "  %4d %s" % [pending_migration[:version], pending_migration[:name]]
+          end
+          abort message
+        end
+      end
     end
   end
 end

data/lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-  VERSION = "6.2.0".freeze
+  VERSION = "6.6.2".freeze
 end

data/spec/data_migrate/data_schema_migration_spec.rb

@@ -9,8 +9,8 @@ describe DataMigrate::DataSchemaMigration do
   end
 
   describe :index_name do
-    it "returns correct index name" do
-      expect(subject.index_name).to eq("unique_data_migrations")
+    it "returns correct primary key name" do
+      expect(subject.primary_key).to eq("version")
     end
   end
 end

data/spec/data_migrate/migration.rb

@@ -14,6 +14,6 @@ describe subject do
   it "uses correct index name" do
     expect(subject).to receive(:table_name_prefix) { "" }
     expect(subject).to receive(:table_name_suffix) { "" }
-    expect(subject.index_name).to eq("unique_data_migrations")
+    expect(subject.primary_key).to eq("version")
   end
 end

data/spec/data_migrate/tasks/data_migrate_tasks_spec.rb

@@ -3,23 +3,74 @@
 require "spec_helper"
 
 describe DataMigrate::Tasks::DataMigrateTasks do
-  let(:db_config) do
-    {
-      adapter: "sqlite3",
-      database: "spec/db/test.db"
-    }
-  end
+  describe :dump do
+    let(:db_config) do
+      {
+        adapter: "sqlite3",
+        database: "spec/db/other_test.db"
+      }
+    end
 
-  before do
-    allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
-    ActiveRecord::Base.establish_connection(db_config)
-  end
+    before do
+      allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
+      allow(DataMigrate::DatabaseTasks).to receive(:db_dir).and_return("spec/db")
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
+    context 'when not given a separate db config' do
+      it 'does not override the default connection' do
+        DataMigrate::Tasks::DataMigrateTasks.migrate
+        expect(ActiveRecord::Base).not_to receive(:establish_connection)
+        expect(DataMigrate::SchemaDumper).to receive(:dump)
+        DataMigrate::Tasks::DataMigrateTasks.dump
+      end
+    end
+
+    context 'when given ' do
+      let(:override_config) do
+        {
+          'host' => '127.0.0.1',
+          'database' => 'other_test',
+          'adapter' => 'sqlite3',
+          'username' => 'root',
+          'password' => nil,
+        }
+      end
+
+      before do
+        DataMigrate.configure do |config|
+          config.db_configuration = override_config
+        end
+      end
 
-  after do
-    ActiveRecord::Migration.drop_table("data_migrations")
+      it 'overrides the default connection' do
+        DataMigrate::Tasks::DataMigrateTasks.migrate
+        expect(ActiveRecord::Base).to receive(:establish_connection).with(override_config)
+        DataMigrate::Tasks::DataMigrateTasks.dump
+      end
+    end
   end
 
   describe :migrate do
+    let(:db_config) do
+      {
+        adapter: "sqlite3",
+        database: "spec/db/test.db"
+      }
+    end
+
+    before do
+      allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
+      ActiveRecord::Base.establish_connection(db_config)
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
     it do
        expect {
         DataMigrate::Tasks::DataMigrateTasks.migrate
@@ -32,4 +83,36 @@ describe DataMigrate::Tasks::DataMigrateTasks do
       }.to output(/20171231235959 SuperUpdate: migrating/).to_stdout
     end
   end
+
+  describe :abort_if_pending_migrations do
+    subject { DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(migrations, message) }
+
+    let(:message) { "ABORT_MESSAGE" }
+
+    context "when there are no pending migrations" do
+      let(:migrations) { [] }
+
+      it "shouldn't do anything" do
+        expect { subject }.to_not raise_error
+      end
+    end
+
+    context "when there are pending migrations" do
+      let(:migrations) do
+        [{
+          name: "A",
+          version: 1
+        }, {
+          name: 'B',
+          version: 2
+        }]
+      end
+
+      it "should abort with given message and print names and versions of pending migrations" do
+        expect { subject }
+          .to raise_error(SystemExit, message)
+          .and output("You have 2 pending migrations:\n     1 A\n     2 B\n").to_stdout
+      end
+    end
+  end
 end

data/tasks/databases.rake

@@ -223,6 +223,14 @@ namespace :db do
     end
   end
 
+  namespace :abort_if_pending_migrations do
+    desc "Raises an error if there are pending migrations or data migrations"
+    task with_data: :environment do
+      message = %{Run `rake db:migrate:with_data` to update your database then try again.}
+      DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(pending_migrations, message)
+    end
+  end
+
   namespace :schema do
     namespace :load do
       desc "Load both schema.rb and data_schema.rb file into the database"
@@ -327,21 +335,22 @@ namespace :data do
     puts "Current data version: #{DataMigrate::DataMigrator.current_version}"
   end
 
+  desc "Raises an error if there are pending data migrations"
+  task abort_if_pending_migrations: :environment do
+    message = %{Run `rake data:migrate` to update your database then try again.}
+    DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(pending_data_migrations, message)
+  end
+
   desc "Create a db/data_schema.rb file that stores the current data version"
   task dump: :environment do
-    if ActiveRecord::Base.dump_schema_after_migration
-      filename = DataMigrate::DatabaseTasks.schema_file
-      File.open(filename, "w:utf-8") do |file|
-        DataMigrate::SchemaDumper.dump(ActiveRecord::Base.connection, file)
-      end
-    end
+    DataMigrate::Tasks::DataMigrateTasks.dump
 
     # Allow this task to be called as many times as required. An example
     # is the migrate:redo task, which calls other two internally
     # that depend on this one.
     Rake::Task["data:dump"].reenable
   end
-  
+
   namespace :schema do
     desc "Load data_schema.rb file into the database"
     task load: :environment do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_migrate
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.6.2
 platform: ruby
 authors:
 - Andrew J Vargo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Rake tasks to migrate data alongside schema changes.