createk_data_migrator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99b4fed781f0d902d6405fae0316299baf15c356
+  data.tar.gz: e54954cf3272cff56b956a694709cc23c02e89d9
+SHA512:
+  metadata.gz: 077aa2d2b7a6c5d83bfa3629c18012a55f5f4192dd54e83bcaa829b56051beb9be472fdbbc10133b6657c5bddc9a4d5ec97e275803953e5a1b6d34da1e53d1f7
+  data.tar.gz: 58f5a649f4bf550c083697b7e21fb4a2f7d021f89c3b0459b0fb92bfad1f0638eb84ed72ff849b6271cf12a13c5e0f96f957532e53fc2d17986283bccaeefb20

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_migrator.gemspec
+gem 'byebug'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,58 @@
+# DataMigrator Useage
+
+## Installing DataMigrator
+
+Add the following to your Gemfile
+
+Add `data_migrator`
+
+Then run `bundle install`
+
+Once DataMigrator is installed you will need to generate the `data_migrations`
+table that stores the versioning of data migrations.
+
+Run the following from the command line. `rails generate data_migrator`
+
+Then run `rake db:migrate`
+
+DataMigrator should now be installed & ready to be used
+
+## Data Migration
+
+Data migrations are used within an application to make ammendments & changes to data. 
+For example if a set collection of `SomeModel`'s need their `status` changing to
+`active`.
+
+## Creating the migration itself 
+
+We can create data migrations using a pre-defined Rails generator that is ran
+from the command line. `rails generate data_migration change_some_models_state_to_active`.
+This will then create a data migration file within the `db/migrate_data` folder.
+
+By default this file will contain an `up` and a `down` method, although a
+`rollback` task not yet been implemented for data migrations.
+
+Enter some code that you would like to be run within the `up` method.
+
+```
+class ChangeSomeModelsStateToActive < ActiveRecord::Migration
+  def up
+    some_models = SomeModel.find(some_model_ids)
+    some_models.update_all(state: 'active')
+  end
+
+  def down
+  end
+end
+```
+
+## Running the migration
+
+Outstanding data migrations can be manually ran with the command `rake db:data:migrate`.
+
+## Ensuring the same data migration is not run more than once
+
+The implementation is inherited from the Rails way of creating the usual database
+migrations. This means when a data migration is ran, a record of which migration 
+is inserted into the `data_migrations` table. This table is then checked prior
+to running any future data migration, thus stopping duplicate entries.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "createk_data_migrator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/createk_data_migrator.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'createk_data_migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "createk_data_migrator"
+  spec.version       = CreatekDataMigrator::VERSION
+  spec.authors       = ["Reiss Johnson"]
+  spec.email         = ["reissjohnson@me.com"]
+
+  spec.summary       = %q{A Gem used for creating data migration tasks}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/createk_data_migrator/railtie.rb

@@ -0,0 +1,7 @@
+class CreatekDataMigrator
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/data_migrate.rake'
+    end
+  end
+end

data/lib/createk_data_migrator/version.rb

@@ -0,0 +1,3 @@
+class CreatekDataMigrator
+  VERSION = "0.1.1"
+end

data/lib/createk_data_migrator.rb

@@ -0,0 +1,19 @@
+require "createk_data_migrator/version"
+require "createk_data_migrator/railtie" if defined?(Rails)
+
+class CreatekDataMigrator
+  class << self
+    attr_writer :data_migrations_path
+
+    def migrate
+      begin
+        old_paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+        ActiveRecord::Tasks::DatabaseTasks.migrations_paths = [Rails.root.join('db/migrate_data')]
+
+        ActiveRecord::Tasks::DatabaseTasks.migrate
+      ensure
+        ActiveRecord::Tasks::DatabaseTasks.migrations_paths = old_paths
+      end
+    end
+  end
+end

data/lib/generators/createk_data_migrator_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CreatekDataMigrator
+  class InstallGenerator < ::Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc "add the migrations"
+    namespace 'createk_data_migrator'
+
+    def self.next_migration_number(path)
+      unless @prev_migration_nr
+        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      else
+        @prev_migration_nr += 1
+      end
+      @prev_migration_nr.to_s
+    end
+
+    def copy_migrations
+      migration_template "create_data_migrations_table.rb", "db/migrate/create_data_migrations_table.rb"
+    end
+  end
+end

data/lib/generators/data_migration_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'rails/generators/actions/create_migration'
+
+class DataMigrationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../../templates', __FILE__)
+  include Rails::Generators::Migration
+
+  def create_data_migration
+    migration_template('data_migration_template.rb', "db/migrate_data/#{file_name}.rb")
+  end
+
+  private
+
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+
+  def migration_class_name
+    @name.camelize
+  end
+
+  def migration_version
+    return unless Rails.version >= '5'
+    ['4.2']
+  end
+end

data/lib/generators/templates/create_data_migrations_table.rb.tt

@@ -0,0 +1,12 @@
+class CreateDataMigrationsTable < ActiveRecord::Migration['4.2']
+  def self.up
+    create_table :data_migrations, id: false do |t|
+      t.string  :version
+      t.index :version, unique: true
+    end
+  end
+
+  def self.down
+    drop_table :data_migrations
+  end
+end

data/lib/tasks/data_migrate.rake

@@ -0,0 +1,17 @@
+require 'createk_data_migrator'
+
+namespace :db do
+  desc 'Run Data Migrations'
+  namespace :data do
+    task migrate: :environment do
+      begin
+        old_table_name = ActiveRecord::Base.schema_migrations_table_name
+        ActiveRecord::Base.schema_migrations_table_name = 'data_migrations'
+
+        CreatekDataMigrator.migrate
+      ensure
+        ActiveRecord::Base.schema_migrations_table_name = old_table_name
+      end
+    end
+  end
+end

data/lib/templates/data_migration_template.rb.tt

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+  end
+
+  def down
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: createk_data_migrator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Reiss Johnson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- reissjohnson@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- createk_data_migrator.gemspec
+- lib/createk_data_migrator.rb
+- lib/createk_data_migrator/railtie.rb
+- lib/createk_data_migrator/version.rb
+- lib/generators/createk_data_migrator_generator.rb
+- lib/generators/data_migration_generator.rb
+- lib/generators/templates/create_data_migrations_table.rb.tt
+- lib/tasks/data_migrate.rake
+- lib/templates/data_migration_template.rb.tt
+homepage: 
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Gem used for creating data migration tasks
+test_files: []