data_migrater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0a68cf4d21de0ee3a7406e759ee2e845fa34c15
+  data.tar.gz: 5dc9b57fe7f9ef317d4fc0deee61130d390aa939
+SHA512:
+  metadata.gz: 3d5760d59787acb7288fb4521d4942d97be558c75801a7f1fae58b8e92de9f1fab7e23a01d30587ee12056641dafc4bac3c291c90b56ef94efb05057b2a2425c
+  data.tar.gz: d43f33644a45da85afc3a2d320dc158384da82014a4b193634285d700032ce391d1fa45a5c63801deeacb7d68e4866bea77ff2ebad9fa90922b240b796ef9622

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+- Rails 4 support.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 GetNinjas
+
+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,47 @@
+# Data Migrater
+
+Data Migration is like Migrate, but it will changes the data of your tables,
+not your schema. This gems creates a file where you can write code to make
+change along you schema changes.
+
+## Install
+
+Extracts the necessary files including a migrate that create a table used
+to keep you data migration version.
+
+```bash
+rails g data_migrater:install
+```
+
+Then execute the migrations to create the table.
+
+```bash
+rake db:migrate
+```
+
+## Usage
+
+Now we can create a data migration with `name` we want.
+
+```bash
+rails g data_migrater:create name
+```
+
+Check your `db/data_migrate` folder, the data migration will be there.
+Next time your application run, all pending data migration will be execute.
+
+## Test
+
+Before send pull request, check if specs is passing.
+
+```bash
+rspec spec
+```
+
+## Code Style
+
+And check if the code style is good.
+
+```bash
+rubocop --debug --display-cop-names
+```

data/lib/data_migrater.rb

@@ -0,0 +1,8 @@
+module DataMigrater
+end
+
+require 'data_migration'
+require 'data_migrater/collection'
+require 'data_migrater/migration'
+require 'data_migrater/migrator'
+require 'data_migrater/version'

data/lib/data_migrater/collection.rb

@@ -0,0 +1,25 @@
+module DataMigrater
+  class Collection
+    def initialize(path = "#{Rails.root}/db/data_migrate")
+      @path = path
+    end
+
+    def migrations
+      Dir.entries(@path).sort.map do |migration_file|
+        migration_for migration_file
+      end.compact
+    end
+
+    private
+
+    def migration_for(file)
+      if file =~ migration_pattern
+        DataMigrater::Migration.new $1.to_i, $2, "#{$1}_#{$2}"
+      end
+    end
+
+    def migration_pattern
+      /^([0-9]+)_([_a-z0-9]+)\.rb$/
+    end
+  end
+end

data/lib/data_migrater/migration.rb

@@ -0,0 +1,35 @@
+module DataMigrater
+  class Migration
+    attr_reader :version, :name, :filename
+
+    def initialize(version, name, filename, path = "#{Rails.root}/db/data_migrate")
+      @filename = filename
+      @name     = name
+      @path     = path
+      @version  = version
+    end
+
+    def execute
+      data_migration = DataMigration.new version: @version
+
+      return false unless data_migration.valid?
+
+      begin
+        data_migration.save!
+        migration.execute
+      rescue StandardError => e
+        data_migration.destroy
+
+        raise e
+      end
+    end
+
+    private
+
+    def migration
+      require_dependency "#{@path}/#{filename}.rb"
+
+      name.camelize.constantize.new
+    end
+  end
+end

data/lib/data_migrater/migrator.rb

@@ -0,0 +1,38 @@
+module DataMigrater
+  class Migrator
+    def initialize(collection = DataMigrater::Collection.new)
+      @collection = collection
+    end
+
+    def migrate
+      ActiveRecord::Base.transaction do
+        if execute?
+          data_migrations.each(&:execute)
+        else
+          pending_migrations.each do |migration|
+            puts "  #{migration.version} #{migration.name}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def execute?
+      return false if pending_migrations.any?
+
+      DataMigration.table_exists? && data_migrations.any?
+    end
+
+    def data_migrations
+      @data_migrations ||= @collection.migrations
+    end
+
+    def pending_migrations
+      migrations_paths = ActiveRecord::Migrator.migrations_paths
+      migrator         = ActiveRecord::Migrator.open migrations_paths
+
+      @pending_migrations ||= migrator.pending_migrations
+    end
+  end
+end

data/lib/data_migrater/version.rb

@@ -0,0 +1,3 @@
+module DataMigrater
+  VERSION = "0.1.0"
+end

data/lib/data_migration.rb

@@ -0,0 +1,3 @@
+class DataMigration < ActiveRecord::Base
+  validates :version, uniqueness: true
+end

data/lib/generators/data_migrater/create_generator.rb

@@ -0,0 +1,16 @@
+module DataMigrater
+  class CreateGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :name, type: :string
+
+    desc "create a skeleton data migration."
+
+    def create_migrate_file
+      tmpl    = 'db/data_migrate/data_migrate.rb.erb'
+      version = Time.zone.now.strftime '%Y%m%d%H%M%S'
+
+      template tmpl, "db/data_migrate/#{version}_#{name.underscore}.rb"
+    end
+  end
+end

data/lib/generators/data_migrater/install_generator.rb

@@ -0,0 +1,22 @@
+module DataMigrater
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "creates an initializer and copy necessary files."
+
+    def create_data_folder
+      FileUtils.mkdir_p 'db/data_migrate'
+      FileUtils.touch   'db/data_migrate/.keep'
+    end
+
+    def copy_migrate
+      version = Time.zone.now.strftime '%Y%m%d%H%M%S'
+
+      template 'db/migrate/create_data_migrations.rb', "db/migrate/#{version}_create_data_migrations.rb"
+    end
+
+    def copy_initializer
+      template 'config/initializers/data_migrater.rb', 'config/initializers/data_migrater.rb'
+    end
+  end
+end

data/lib/generators/data_migrater/templates/config/initializers/data_migrater.rb

@@ -0,0 +1,3 @@
+require 'data_migrater'
+
+DataMigrater::Migrator.new.migrate unless Rails.env.test?

data/lib/generators/data_migrater/templates/db/data_migrate/data_migrate.rb.erb

@@ -0,0 +1,4 @@
+class <%= name.camelize %>
+  def execute
+  end
+end

data/lib/generators/data_migrater/templates/db/migrate/create_data_migrations.rb

@@ -0,0 +1,7 @@
+class CreateDataMigrations < ActiveRecord::Migration
+  def change
+    create_table :data_migrations do |t|
+      t.string :version, null: false
+    end
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe DataMigrater::Collection do
+  let(:path) { 'db/data_migrate' }
+
+  before do
+    FileUtils.mkdir_p path
+
+    allow(Rails).to receive(:root) { '.' }
+  end
+
+  after do
+    FileUtils.rm_rf 'db'
+  end
+
+  describe '.migrations' do
+    let(:file_1) { '20151205090800_add_column' }
+    let(:file_2) { '20151205090801_rename_column' }
+    let(:file_3) { 'invalid_20151205090802_remove_column' }
+
+    subject { described_class.new path }
+
+    before do
+      FileUtils.touch "#{path}/#{file_1}.rb"
+      FileUtils.touch "#{path}/#{file_2}.rb"
+      FileUtils.touch "#{path}/#{file_3}.rb"
+    end
+
+    it 'returns valid migrations' do
+      expect(subject.migrations.size).to eq 2
+
+      expect(subject.migrations.first.name).to    eq 'add_column'
+      expect(subject.migrations.first.version).to eq 20151205090800
+
+      expect(subject.migrations.last.name).to    eq 'rename_column'
+      expect(subject.migrations.last.version).to eq 20151205090801
+    end
+  end
+end

data/spec/data_migration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe DataMigration do
+  let(:version) { '19841023113000' }
+
+  it { expect(DataMigration.new version: version).to be_valid }
+
+  it 'validates uniqueness' do
+    DataMigration.create! version: version
+
+    expect {
+      DataMigration.create! version: version
+    }.to raise_error ActiveRecord::RecordInvalid
+  end
+end

data/spec/migrater_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe DataMigrater::Migrator do
+  before do
+    FileUtils.mkdir_p 'db/migrate'
+
+    allow(Rails).to receive(:root) { '.' }
+  end
+
+  after do
+    FileUtils.rm_rf 'db'
+  end
+
+  let(:connection) { ActiveRecord::Base.connection }
+
+  it 'has a version number' do
+    expect(DataMigrater::VERSION).not_to be_nil
+  end
+
+  describe '.migrate' do
+    let(:data_migration)  { double }
+    let(:data_migrations) { [data_migration] }
+    let(:insert)          { "insert into data_migrations(version) values('21161023010203')" }
+    let(:select)          { 'select version from data_migrations' }
+    let(:version)         { lambda { connection.select_one(select)['version'] } }
+
+    before do
+      connection.insert_sql insert
+    end
+
+    context 'when has no pending migration' do
+      context 'when data migration table does not exists' do
+        let(:data_migration) { double }
+        let(:collection)     { double migrations: [data_migration] }
+
+        before do
+          allow(DataMigration).to receive(:table_exists?) { false }
+        end
+
+        subject { described_class.new collection }
+
+        it 'does not executes data migration' do
+          expect(data_migration).to_not receive :execute
+
+          subject.migrate
+        end
+      end
+
+      context 'when data migration table exists' do
+        context 'but there is no data migration on collection' do
+          let(:collection) { double migrations: [] }
+
+          subject { described_class.new collection }
+
+          it { expect { subject.migrate }.to_not change { version.call } }
+        end
+
+        context 'and has data migration on collection' do
+          let(:data_migration_2) { double }
+          let(:collection)       { double migrations: [data_migration, data_migration_2] }
+
+          it 'executes migration' do
+            expect(data_migration).to   receive :execute
+            expect(data_migration_2).to receive :execute
+
+            described_class.new(collection).migrate
+          end
+        end
+      end
+    end
+
+    context 'when migration throws exception' do
+      before do
+        allow(data_migration).to receive(:execute).and_raise
+      end
+
+      it 'keeps the actual version' do
+        begin
+          subject.migrate
+        rescue
+        end
+
+        expect(version.call).to eq '21161023010203'
+      end
+    end
+
+    context 'when there are migration on db/migrate' do
+      let(:collection) { double migrations: [data_migration] }
+
+      context 'pending' do
+        let(:next_version)   { version.call.to_i + 1 }
+        let(:next_migration) { "#{Rails.root}/db/migrate/#{next_version}_migration.rb" }
+
+        before { FileUtils.touch next_migration }
+        after  { FileUtils.rm next_migration }
+
+        it 'does not run the data migrations' do
+          expect(data_migration).to_not receive :execute
+
+          described_class.new(collection).migrate
+        end
+      end
+
+      context 'executed' do
+        before do
+          allow_any_instance_of(ActiveRecord::Migrator).to receive(:pending_migrations) { [] }
+        end
+
+        it 'runs the data migrations' do
+          expect(data_migration).to receive :execute
+
+          described_class.new(collection).migrate
+        end
+      end
+    end
+  end
+end

data/spec/migration_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe DataMigrater::Migration do
+  let(:name)     { 'add_column_to_users_table' }
+  let(:path)     { 'db/data_migrate' }
+  let(:version)  { '20151205090800' }
+  let(:filename) { "#{version}_#{name}" }
+
+  class AddColumnToUsersTable
+  end
+
+  before do
+    FileUtils.mkdir_p path
+    FileUtils.touch "#{path}/#{filename}.rb"
+  end
+
+  after do
+    FileUtils.rm_rf 'db'
+  end
+
+  describe "#execute" do
+    let(:migration) { double.as_null_object }
+
+    subject { described_class.new version, name, filename, path }
+
+    before do
+      allow(AddColumnToUsersTable).to receive(:new) { migration }
+    end
+
+    context 'when migration was already run' do
+      before do
+        DataMigration.create version: version
+      end
+
+      specify { expect(subject.execute).to be_falsy }
+
+      it 'does not executes' do
+        expect(migration).to_not receive :execute
+
+        subject.execute
+      end
+    end
+
+    context 'when migration was not run before' do
+      it 'executes the migration' do
+        expect(migration).to receive :execute
+
+        subject.execute
+      end
+
+      it 'creates a new data_migrations' do
+        subject.execute
+
+        expect(DataMigration.exists? version: version).to be_truthy
+      end
+
+      context 'and some error is raised' do
+        before do
+          allow(migration).to receive(:execute).and_raise RuntimeError
+        end
+
+        specify { expect { subject.execute }.to raise_error RuntimeError }
+
+        it 'removes data migration object' do
+          begin
+            subject.execute
+          rescue
+            expect(DataMigration.exists? version: version).to be_falsy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'active_record/railtie'
+require 'data_migrater'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Schema.define do
+  create_table :data_migrations do |t|
+    t.string :version, null: false
+  end
+end
+
+RSpec.configure do |config|
+  config.before do
+    DataMigration.destroy_all
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: data_migrater
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GetNinjas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates Data Migrations on Migrate style.
+email: tech@getninjas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/data_migrater.rb
+- lib/data_migrater/collection.rb
+- lib/data_migrater/migration.rb
+- lib/data_migrater/migrator.rb
+- lib/data_migrater/version.rb
+- lib/data_migration.rb
+- lib/generators/data_migrater/create_generator.rb
+- lib/generators/data_migrater/install_generator.rb
+- lib/generators/data_migrater/templates/config/initializers/data_migrater.rb
+- lib/generators/data_migrater/templates/db/data_migrate/data_migrate.rb.erb
+- lib/generators/data_migrater/templates/db/migrate/create_data_migrations.rb
+- spec/collection_spec.rb
+- spec/data_migration_spec.rb
+- spec/migrater_spec.rb
+- spec/migration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/getninjas/data_migrater
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Data Migrator gem
+test_files:
+- spec/collection_spec.rb
+- spec/data_migration_spec.rb
+- spec/migrater_spec.rb
+- spec/migration_spec.rb
+- spec/spec_helper.rb