nonschema_migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da4a766ada05593da5379df6b6dc1fde7b18aae17138f07f458dab54784f019f
+  data.tar.gz: c7d572cd3a1b3a37b2d6aa795efeb7939731ccbd9e2d14bee4d89ef1f447d74a
+SHA512:
+  metadata.gz: 17fb2d645b46f83ddb25c069e8e2beeae6eb80d7821a0abe4f65386897644a075e54c88088d09f91cbd31f157eba63b547225891f93a9097d3bd63a42cfa8249
+  data.tar.gz: 83daa3c35a73bc96fbb26953e554a173f1079ea040b8737c6764b107efb7d2d8501dce9f337adf9cff4cc3a48bfcc7e7f787e37b9d0cc1da224234b8a76cdae1

data/lib/active_record/data_migration.rb

@@ -0,0 +1,52 @@
+require 'active_record/scoping/default'
+require 'active_record/scoping/named'
+require 'active_record/base'
+
+module ActiveRecord
+  class DataMigration < ActiveRecord::Base
+    class << self
+      def primary_key
+        nil
+      end
+
+      def table_name
+        "#{table_name_prefix}data_migrations#{table_name_suffix}"
+      end
+
+      def index_name
+        "#{table_name_prefix}unique_data_migrations#{table_name_suffix}"
+      end
+
+      def table_exists?
+        connection.table_exists?(table_name)
+      end
+
+      def create_table(limit=nil)
+        unless table_exists?
+          version_options = {null: false}
+          version_options[:limit] = limit if limit
+
+          connection.create_table(table_name, id: false) do |t|
+            t.column :version, :string, version_options
+          end
+          connection.add_index table_name, :version, unique: true, name: index_name
+        end
+      end
+
+      def drop_table
+        if table_exists?
+          connection.remove_index table_name, name: index_name
+          connection.drop_table(table_name)
+        end
+      end
+
+      def normalize_migration_number(number)
+        "%.3d" % number.to_i
+      end
+    end
+
+    def version
+      super.to_i
+    end
+  end
+end

data/lib/generators/data_migration_generator.rb

@@ -0,0 +1,28 @@
+
+# this is the generator used to create a data migration
+
+class DataMigrationGenerator < ActiveRecord::Generators::Base
+  self.source_root(File.join(self.superclass.base_root,'active_record/migration/templates'))
+
+  desc <<-DESC
+Description:
+    Creates new nondestructive migration
+  DESC
+
+  def create_data_migration_file
+    migration_template "migration.rb", "db/data_migrate/#{file_name}.rb"
+  end
+
+  # 'migration.rb' now requires this var/method
+  def migration_action
+    'create'
+  end
+
+  private
+
+  # this used in migration template which is inherited, we want this values to be an empty array.
+  def attributes
+    []
+  end
+end
+

data/lib/generators/data_migrations/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module DataMigrations
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Creates an initializer and copy files to your application."
+    class_option :orm, type: 'boolean'
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def copy_initializer
+      migration_template "create_data_migrations.rb",
+                         "db/migrate/create_data_migrations.rb"
+    end
+  end
+end

data/lib/generators/data_migrations/templates/create_data_migrations.rb

@@ -0,0 +1,11 @@
+class CreateDataMigrations < ActiveRecord::Migration
+  def self.up
+    create_table :data_migrations do |t|
+      t.string :version
+    end
+  end
+
+  def self.down
+    drop_table :data_migrations
+  end
+end

data/lib/nonschema_migrations/railtie.rb

@@ -0,0 +1,9 @@
+require 'nonschema_migrations'
+
+module DataMigrations
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'tasks/data.rb'
+    end
+  end
+end

data/lib/nonschema_migrations.rb

@@ -0,0 +1,11 @@
+
+MIGRATIONS_PATH = 'db/data_migrate'
+
+require 'generators/data_migrations/install_generator.rb'
+require 'generators/data_migration_generator.rb'
+require 'active_record/data_migration.rb'
+require 'nonschema_migrator.rb'
+
+module NondestructiveMigrations
+  require "nonschema_migrations/railtie.rb" if defined?(Rails)
+end

data/lib/nonschema_migrator.rb

@@ -0,0 +1,161 @@
+
+
+
+class NondestructiveMigrator < ActiveRecord::Migrator
+  # This class related to data migration.
+  # Used in rake tasks (rake data:[migrate|rollback|up|down])
+
+  if defined?(ActiveRecord::MigrationContext)
+    class SchemaMigration < ActiveRecord::SchemaMigration
+      def self.table_name
+        NondestructiveMigrator.schema_migrations_table_name
+      end
+    end
+
+    class MigrationContext < ActiveRecord::MigrationContext
+      def initialize(migrations_paths)
+        super(migrations_paths)
+        @schema_migration = NondestructiveMigrator::SchemaMigration
+      end
+
+      def new_migrator(*args)
+        result = NondestructiveMigrator.new(*args)
+        result.migration_context = self
+        result
+      end
+
+      # these methods are copied from ActiveRecord::Migrator
+      # replaced:
+      #  1.) ActiveRecord::SchemaMigration with @schema_migration
+      #  2.) ActiveRecord::Migrator.new with new_migrator
+
+      def get_all_versions
+        if @schema_migration.table_exists?
+          @schema_migration.all_versions.map(&:to_i)
+        else
+          []
+        end
+      end
+
+      def migrations_status
+        db_list = @schema_migration.normalized_versions
+
+        file_list = migration_files.map do |file|
+          version, name, scope = parse_migration_filename(file)
+          raise IllegalMigrationNameError.new(file) unless version
+          version = @schema_migration.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
+
+      def move(direction, steps)
+        migrator = new_migrator(direction, migrations)
+
+        if current_version != 0 && !migrator.current_migration
+          raise UnknownMigrationVersionError.new(current_version)
+        end
+
+        start_index =
+          if current_version == 0
+            0
+          else
+            migrator.migrations.index(migrator.current_migration)
+          end
+
+        finish = migrator.migrations[start_index + steps]
+        version = finish ? finish.version : 0
+        send(direction, version)
+      end
+
+      def up(target_version = nil)
+        selected_migrations = if block_given?
+          migrations.select { |m| yield m }
+        else
+          migrations
+        end
+
+        new_migrator(: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
+
+        new_migrator(:down, selected_migrations, target_version).migrate
+      end
+    end
+
+    class << self
+      def context(path)
+        NondestructiveMigrator::MigrationContext.new(path)
+      end
+
+      def new_migrator(path, *args)
+        result = self.new(*args)
+        result.migration_context=context(path)
+        result
+      end
+
+      def migrate(path)
+        context(path).migrate()
+      end
+
+      def run(direction, path, target_version)
+        new_migrator(path, direction, context(path).migrations, target_version).run
+      end
+    end
+
+    def migration_context=(context)
+      @migration_context = context
+    end
+
+    def load_migrated
+      @migrated_versions = Set.new(@migration_context.get_all_versions)
+    end
+  end
+
+  def record_version_state_after_migrating(version)
+    if down?
+      migrated.delete(version)
+      ActiveRecord::DataMigration.where(:version => version.to_s).delete_all
+    else
+      migrated << version
+      ActiveRecord::DataMigration.create!(:version => version.to_s)
+    end
+  end
+
+
+  class <<self
+    def migrations_path
+      MIGRATIONS_PATH
+    end
+    
+    def schema_migrations_table_name
+      'data_migrations'
+    end
+
+    def schema_migrations_table_name
+      ActiveRecord::DataMigration.table_name
+    end
+
+    def get_all_versions(connection = ActiveRecord::Base.connection)
+      if connection.table_exists?(schema_migrations_table_name)
+        ActiveRecord::DataMigration.all.map { |x| x.version.to_i }.sort
+      else
+        []
+      end
+    end
+  end
+end
+
+

data/lib/tasks/data.rb

@@ -0,0 +1,34 @@
+
+
+namespace :data do
+  task :data_migration_dependencies => :environment do
+    require 'nonschema_migrations'
+  end
+
+  desc "run data migration (#{MIGRATIONS_PATH})"
+  task :migrate => :data_migration_dependencies do
+    NondestructiveMigrator.migrate(MIGRATIONS_PATH)
+  end
+
+  desc "rollback data migration (#{MIGRATIONS_PATH})"
+  task :rollback => :data_migration_dependencies do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    NondestructiveMigrator.rollback(MIGRATIONS_PATH,step)
+  end
+
+  namespace :migrate do
+    desc %Q{runs the "up" for a given _data_ migration VERSION}
+    task :up => :data_migration_dependencies do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      NondestructiveMigrator.run(:up, MIGRATIONS_PATH, version)
+    end
+
+    desc %Q{runs the "down" for a given _data_ migration VERSION}
+    task :down => :data_migration_dependencies do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      NondestructiveMigrator.run(:down, MIGRATIONS_PATH, version)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: nonschema_migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Fleetwood-Boldt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Separate schema-only migrations from nonschema (data) migrations in your
+  Rails app
+email: jason.fb@datatravels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record/data_migration.rb
+- lib/generators/data_migration_generator.rb
+- lib/generators/data_migrations/install_generator.rb
+- lib/generators/data_migrations/templates/create_data_migrations.rb
+- lib/nonschema_migrations.rb
+- lib/nonschema_migrations/railtie.rb
+- lib/nonschema_migrator.rb
+- lib/tasks/data.rb
+homepage: https://github.com/jasonfb/nonschema_migrations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Nonschema(data-only) migrations for your Rails app
+test_files: []