data_migrate 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26625c3d1527400f57850a3ca1932d96f6416cbc
-  data.tar.gz: 95a2a2d587eed28a7f228bb61b4d928f7a9205bb
+  metadata.gz: 513041c34e205e9f58b811e7b91a667d2383faaf
+  data.tar.gz: e33fbb5f528b37e747639225e7e05d9205ea4019
 SHA512:
-  metadata.gz: a2ba6be64d1fe490b91cc2cf6511270747aba5ab363694b77503c272528ca81a60700d7c012c16eae748da5b9ba5153bd20b715e686032bde75e9ad8c415f8fb
-  data.tar.gz: e58fc200e080c68b8dcc60e2430abccdf3065555df7edfedfbf66cef25e3406292a084648f9012242de16eb9cb266feee810d8d6327bbf2a6605a8aad63c0a8d
+  metadata.gz: 3352d4c800ad8cac090b0b4bb92e3fc646b16a54e871b88138f132b4f825581a42c1f3ff430563d6ed98c559129371e0dd0736466a328518405ddfd920204c3f
+  data.tar.gz: a93f9ed99ab3e6c346dacd1e3d5ce4ecfaf9c80cfa2d66ece9eb9177d72e2dccfdfacc60e0373f138582975bb3170a940e4974d2b5573e751a463d555e650e7d

data/.gitignore

@@ -5,3 +5,4 @@ gemfiles/.bundle
 spec/db/test.db
 .vscode/
 tasks/databases.rake
+.DS_Store

data/.ruby-style.yml

@@ -1057,3 +1057,5 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 Layout/SpaceBeforeFirstArg:
   Enabled: false
+Style/FormatStringToken:
+  Enabled: false

data/.travis.yml

@@ -4,10 +4,10 @@ rvm:
   - 2.3.4
 script: bundle exec rspec
 gemfile:
-  - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
 matrix:
   exclude:
     - rvm: 2.0.0-p648

data/Appraisals

@@ -1,7 +1,3 @@
-appraise 'rails-4.1' do
-  gem 'rails', '4.1.16'
-end
-
 appraise 'rails-4.2' do
   gem 'rails', '4.2.8'
   # Nokogiri 1.7+ requires Ruby 2.1+
@@ -14,4 +10,8 @@ end
 
 appraise 'rails-5.1' do
   gem 'rails', '5.1'
-end
+end
+
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
+end

data/Changelog.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## 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

data/Gemfile.rails5.2

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in data_migrate.gemspec
+gemspec
+gem 'rails', '~> 5.2'

data/README.md

@@ -69,13 +69,7 @@ table to track all the goodness.
 
 ## 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 4.2 through 5.2
 
 ### Important notes for older versions
 
@@ -164,9 +158,9 @@ 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 install
+bundle exec appraisal rails-4.2 rspec
+bundle exec appraisal rails-5.0 rspec
 ```
 
 ## Thanks

data/data_migrate.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "data_migrate"
 
-  s.add_dependency('rails', '>= 4.1')
+  s.add_dependency('rails', '>= 4.2')
   s.add_development_dependency "appraisal"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/lib/data_migrate.rb

@@ -1,15 +1,30 @@
 # frozen_string_literal: true
 
-require File.join(File.dirname(__FILE__), "data_migrate", "data_migrator")
+if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 2
+  require File.join(File.dirname(__FILE__), "data_migrate", "data_migrator_five")
+else
+  require File.join(File.dirname(__FILE__), "data_migrate", "data_migrator")
+end
 require File.join(File.dirname(__FILE__), "data_migrate",
                   "data_schema_migration")
 require File.join(File.dirname(__FILE__), "data_migrate", "data_schema")
 require File.join(File.dirname(__FILE__), "data_migrate", "database_tasks")
 require File.join(File.dirname(__FILE__), "data_migrate", "schema_dumper")
-require File.join(File.dirname(__FILE__), "data_migrate", "status_service")
-if Rails::VERSION::MAJOR >= 5
-  require File.join(File.dirname(__FILE__), "data_migrate", "migration_five")
+if Rails::VERSION::MAJOR == 5 &&  Rails::VERSION::MINOR == 2
+  require File.join(File.dirname(__FILE__), "data_migrate", "status_service_five")
+  require File.join(File.dirname(__FILE__), "data_migrate", "schema_migration_five")
+else
+  require File.join(File.dirname(__FILE__), "data_migrate", "status_service")
+  require File.join(File.dirname(__FILE__), "data_migrate", "schema_migration")
+end
+if Rails::VERSION::MAJOR == 5
+  if  Rails::VERSION::MINOR == 2
+    require File.join(File.dirname(__FILE__), "data_migrate", "migration_context")
+  else
+    require File.join(File.dirname(__FILE__), "data_migrate", "migration_five")
+  end
 else
   require File.join(File.dirname(__FILE__), "data_migrate", "migration")
 end
 require File.join(File.dirname(__FILE__), "data_migrate", "railtie")
+require File.join(File.dirname(__FILE__), "data_migrate", "tasks/data_migrate_tasks")

data/lib/data_migrate/data_migrator.rb

@@ -16,7 +16,12 @@ module DataMigrate
       end
     end
 
+
     class << self
+      def current_version(connection = ActiveRecord::Base.connection)
+        get_all_versions(connection).max || 0
+      end
+
       def get_all_versions(connection = ActiveRecord::Base.connection)
         if table_exists?(connection, schema_migrations_table_name)
           # Certain versions of the gem wrote data migration versions into

data/lib/data_migrate/data_migrator_five.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module DataMigrate
+  class DataMigrator < ActiveRecord::Migrator
+    self.migrations_paths = ["db/data"]
+
+    def self.assure_data_schema_table
+      DataMigrate::DataSchemaMigration.create_table
+    end
+
+    def initialize(direction, migrations, target_version = nil)
+      @direction         = direction
+      @target_version    = target_version
+      @migrated_versions = nil
+      @migrations        = migrations
+
+      validate(@migrations)
+
+      DataMigrate::DataSchemaMigration.create_table
+      ActiveRecord::InternalMetadata.create_table
+    end
+
+    def load_migrated
+      # Certain versions of the gem wrote data migration versions into
+      # schema_migrations table. After the fix, it was corrected to write into
+      # data_migrations. However, not to break anything we are going to
+      # get versions from both tables.
+      #
+      # This may cause some problems:
+      # Eg. rake data:versions will show version from the schema_migrations table
+      # which may be a version of actual schema migration and not data migration
+      @migrated_versions =
+        DataMigrate::DataSchemaMigration.normalized_versions.map(&:to_i).sort +
+        ActiveRecord::SchemaMigration.normalized_versions.map(&:to_i).sort
+    end
+
+    class << self
+      def current_version
+        DataMigrate::MigrationContext.new(migrations_paths).current_version
+      end
+
+      ##
+      # Compares the given filename with what we expect data migration
+      # filenames to be, eg the "20091231235959_some_name.rb" pattern
+      # @param (String) filename
+      # @return (MatchData)
+      def match(filename)
+        /(\d{14})_(.+)\.rb/.match(filename)
+      end
+
+      def migrations_status
+        DataMigrate::MigrationContext.new(migrations_paths).migrations_status
+      end
+
+      #TODO: this was added to be backward compatible, need to re-evaluate
+      def migrations(_migrations_paths)
+        DataMigrate::MigrationContext.new(migrations_paths).migrations
+      end
+
+      #TODO: this was added to be backward compatible, need to re-evaluate
+      def run(direction, migration_paths, version)
+        DataMigrate::MigrationContext.new(migration_paths).run(direction, version)
+      end
+
+      def rollback(migrations_path, steps)
+        DataMigrate::MigrationContext.new(migrations_path).rollback(steps)
+      end
+    end
+
+    private
+
+    def record_version_state_after_migrating(version)
+      if down?
+        migrated.delete(version)
+        DataMigrate::DataSchemaMigration.where(version: version.to_s).delete_all
+      else
+        migrated << version
+        DataMigrate::DataSchemaMigration.create!(version: version.to_s)
+      end
+    end
+  end
+end

data/lib/data_migrate/data_schema.rb

@@ -14,20 +14,32 @@ module DataMigrate
       return if info[:version].blank?
 
       version = info[:version].to_i
-      table_name = DataMigrate::DataMigrator.schema_migrations_table_name
-      sm_table = quote_table_name(table_name)
-      migrated = select_values("SELECT version FROM #{sm_table}").map(&:to_i)
-
-      versions = []
-      Dir.foreach(DataMigrate::DataMigrator.full_migrations_path) do |file|
-        match_data = DataMigrate::DataMigrator.match(file)
-        versions << match_data[1].to_i if match_data
-      end
 
       unless migrated.include?(version)
         execute "INSERT INTO #{sm_table} (version) VALUES ('#{version}')"
       end
 
+      insert(version)
+    end
+
+    private
+
+    def migrated
+      @migrated ||= select_values("SELECT version FROM #{sm_table}").map(&:to_i)
+    end
+
+    def versions
+      @versions ||= begin
+        versions = []
+        Dir.foreach(DataMigrate::DataMigrator.full_migrations_path) do |file|
+          match_data = DataMigrate::DataMigrator.match(file)
+          versions << match_data[1].to_i if match_data
+        end
+        versions
+      end
+    end
+
+    def insert(version)
       inserted = Set.new
       (versions - migrated).each do |v|
         if inserted.include?(v)
@@ -39,5 +51,13 @@ module DataMigrate
         end
       end
     end
+
+    def sm_table
+      quote_table_name(table_name)
+    end
+
+    def table_name
+      DataMigrate::DataSchemaMigration.table_name
+    end
   end
 end

data/lib/data_migrate/data_schema_migration.rb

@@ -1,5 +1,6 @@
 module DataMigrate
   class DataSchemaMigration < ::ActiveRecord::SchemaMigration
+
     class << self
       def table_name
         ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix

data/lib/data_migrate/database_tasks.rb

@@ -9,5 +9,74 @@ module DataMigrate
     def self.data_schema_file
       File.join(db_dir, "data_schema.rb")
     end
+
+    def self.forward(step = 1)
+      DataMigrate::DataMigrator.assure_data_schema_table
+      migrations = pending_migrations.reverse.pop(step).reverse
+      migrations.each do | pending_migration |
+        if pending_migration[:kind] == :data
+          ActiveRecord::Migration.write("== %s %s" % ["Data", "=" * 71])
+          DataMigrate::DataMigrator.run(:up, data_migrations_path, pending_migration[:version])
+        elsif pending_migration[:kind] == :schema
+          ActiveRecord::Migration.write("== %s %s" % ["Schema", "=" * 69])
+          DataMigrate::SchemaMigration.run(:up, schema_migrations_path, pending_migration[:version])
+        end
+      end
+    end
+
+    def self.data_migrations_path
+      "db/data/"
+    end
+
+    def self.schema_migrations_path
+      "db/migrate/"
+    end
+
+    def self.pending_migrations
+      sort_migrations(pending_schema_migrations, pending_data_migrations)
+    end
+
+    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 }})
+    end
+
+    def self.pending_schema_migrations
+      ::DataMigrate::SchemaMigration.pending_schema_migrations
+    end
+
+    def self.sort_migrations(set1, set2 = nil)
+      migrations = set1 + (set2 || [])
+      migrations.sort {|a, b|  sort_string(a) <=> sort_string(b)}
+    end
+
+    def self.sort_string(migration)
+      "#{migration[:version]}_#{migration[:kind] == :data ? 1 : 0}"
+    end
+
+    def self.past_migrations(sort = nil)
+      sort = sort.downcase if sort
+      db_list_data =
+        if DataMigrate::DataSchemaMigration.table_exists?
+          DataMigrate::DataSchemaMigration.normalized_versions.sort
+        else
+          []
+        end
+      db_list_schema = ActiveRecord::SchemaMigration.normalized_versions.sort.sort
+      migrations = db_list_data.map do |d|
+        {
+          version: d.to_i, kind: :data
+        }
+      end +
+                   db_list_schema.map do |d|
+                     {
+                       version: d.to_i, kind: :schema
+                     }
+                   end
+
+      sort == "asc" ? sort_migrations(migrations) : sort_migrations(migrations).reverse
+    end
+
   end
 end

data/lib/data_migrate/migration.rb

@@ -11,7 +11,7 @@ module DataMigrate
       end
 
       def table_name
-        ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix
+        ActiveRecord::Base.table_name_prefix + "data_migrations" + ActiveRecord::Base.table_name_suffix
       end
 
       def index_name

data/lib/data_migrate/migration_context.rb

@@ -0,0 +1,90 @@
+module DataMigrate
+  class MigrationContext < ActiveRecord::MigrationContext
+    def initialize(migrations_paths = "db/data")
+      @migrations_paths = migrations_paths || "db/data"
+    end
+
+    def up(target_version = nil)
+      selected_migrations = if block_given?
+                              migrations.select { |m| yield m }
+                            else
+                              migrations
+                            end
+
+      DataMigrator.new(:up, selected_migrations, target_version).migrate
+    end
+
+    def down(target_version = nil)
+      selected_migrations =
+        if block_given?
+          migrations.select { |m| yield m }
+        else
+          migrations
+        end
+
+      DataMigrator.new(:down, selected_migrations, target_version).migrate
+    end
+
+    def run(direction, target_version)
+      DataMigrator.new(direction, migrations, target_version).run
+    end
+
+    def current_version
+      get_all_versions.max || 0
+    rescue ActiveRecord::NoDatabaseError
+    end
+
+    def migration_files
+      paths = Array(migrations_paths)
+      Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+    end
+
+    def migrations_status
+      db_list = DataSchemaMigration.normalized_versions
+
+      file_list = migration_files.map do |file|
+        version, name, scope = parse_migration_filename(file)
+        raise ActiveRecord::IllegalMigrationNameError.new(file) unless version
+        version = ActiveRecord::SchemaMigration.normalize_migration_number(version)
+        status = db_list.delete(version) ? "up" : "down"
+        [status, version, (name + scope).humanize]
+      end.compact
+
+      db_list.map! do |version|
+        ["up", version, "********** NO FILE **********"]
+      end
+
+      (db_list + file_list).sort_by { |_, version, _| version }
+    end
+
+    private
+
+    def get_all_versions
+      if DataMigrate::DataSchemaMigration.table_exists?
+        DataSchemaMigration.normalized_versions.map(&:to_i)
+      else
+        []
+      end
+    end
+
+    def move(direction, steps)
+      migrator = DataMigrator.new(direction, migrations)
+
+      if current_version != 0 && !migrator.current_migration
+        raise ActiveRecord::UnknownMigrationVersionError.new(current_version)
+      end
+
+      start_index =
+        if current_version.zero?
+          0
+        else
+          migrator.migrations.index(migrator.current_migration)
+        end
+
+      finish = migrator.migrations[start_index + steps]
+      version = finish ? finish.version : 0
+      send(direction, version)
+    end
+
+  end
+end