systematize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39619b8bfa011bf992c002bf266e3cc87e074d0c
+  data.tar.gz: 5a1f88232472a5ec70e5d795448b59a93f5beb7d
+SHA512:
+  metadata.gz: 51c3ab97157d5853c4c1d55e9d92396212094d7669b115d30ba0ae1438cfbc3c1ad216af673711cba9745ac8c40bfc229039416b14dc42608d2ea7a4ad65dbf5
+  data.tar.gz: 2ab08ea9995723e086409e78fe4741a0386b7a16cacb332e4f1b9c33bd0a409bf4180eb686e10460daddfdc8f42aef81d150ef65805e4360fdff3532d944c354

data/README.md

@@ -0,0 +1,69 @@
+# systematize
+
+![shuffler.gif](https://s15.postimg.org/jupy0v0or/shuffler.gif)
+
+One of the most important things that a ruby application can have are the migrations, but they can be one of 2 kinds:
+- Structural migrations
+- Data migrations
+
+If you want to organize said migrations in their purpose you'll probably have a folder for the struture ones and another for the data ones. But with that separation comes a problem, when should you run one type and when to run the other?
+Probably the sanner way of doing it is we firstly run the structure migrations and after that we run the data migrations, but with this approach one problem will rise:
+
+What if I have a new field that is initially populated taking into account another field, and after that we can delete that other field?
+Imagine the following scenario:
+- You have a `Post` model that initially has a boolean field called `:deleted`.
+- After some time, and some deleted `Posts`, you need to know when that post has been deleted. So you create a `:deleted_at` field that will contain the time os the deletion.
+- You can now delete the old `:deleted` field because it turned obsolete, so you create the migration to do it.
+
+On this scenario we will have 2 structure migrations (create the `:deleted_at` field and removing the `:deleted` field) and a data migration (go through all the Posts and add the time to `:deleted_at` if they are `:deleted`). With previous migration approach, running all the migrations would fail because when the data migration run we would have the `:deleted` field because it was deleted by the structure migration.
+
+This is when `systematize` comes in for the rescue 🚀
+
+## Installation
+
+If your using a Gemfile, just add it to your project
+<pre><code>#Gemfile
+gem 'systematize'
+</code></pre>
+
+Or just add it via `bundler`
+<pre><code>bundle install 'systematize'</code></pre>
+
+## Structure
+So as the structural migrations live in the `db/migrate` folder, the data migrations shall live in the `db/data` folder:
+
+<pre><code>- app
+  |
+  |-db
+    |-data
+    |-migrate
+</pre></code>
+
+## Usage
+After installing you'll se the following tasks pop-up:
+
+<pre><code>$> bundle exec rake -T
+rake systematize:migrate       # Migrate the database
+rake systematize:rollback      # Rollback the database (options: STEP=x, VERBOSE=false)
+rake systematize:rollback_all  # Rollback all the database
+</pre></code>
+
+Now if you need to migrate the database you just need to run:
+<pre><code>bundle exec rake systematize:migrate</pre></code>
+
+Needing to rollback the previous migration? No problem.
+<pre><code>bundle exec rake systematize:rollback</pre></code>
+
+Need to rollback 2/3/4 migrations? I got you.
+<pre><code>bundle exec rake systematize:rollback STEP=2 </pre></code>
+
+Made a mess so big you need to start fresh? Do it. (the migrations need to be reversible :smile:)
+<pre><code>bundle exec rake systematize:rollback_all </pre></code>
+
+## Caveats
+- The migrations need to follow the Rails convention to them `YYYYMMDDHHMMSS_create_products.rb`
+- The migrations are wrapped around a `ActiveRecord::Base.transaction`, so if any of the migration fails the batch of migrations will rollback, until the previous successful batch.
+
+## TODO
+- [ ] Customizable folder configuration
+- [ ] Customizable transaction type configuration

data/lib/systematize/railtie.rb

@@ -0,0 +1,11 @@
+require 'systematize'
+
+module Systematize
+  class Railtie < Rails::Railtie
+    railtie_name :systematize
+
+    rake_tasks do
+      load 'tasks/migrations.rake'
+    end
+  end
+end

data/lib/systematize/runner.rb

@@ -0,0 +1,30 @@
+module Systematize
+  class Runner
+
+    DB_FOLDER_PATH              = "#{Rack::Directory.new('').root}/db"
+    DATA_MIGRATIONS_PATH        = "#{DB_FOLDER_PATH}/data"
+    STRUCTURE_MIGRATIONS_PATH   = "#{DB_FOLDER_PATH}/migrate"
+    TEMP_MIGRATIONS_FOLDER_PATH = "#{DB_FOLDER_PATH}/tmp"
+
+    def self.run(&block)
+
+      # Create temporary folder where all the migrations will be
+      FileUtils.mkdir(TEMP_MIGRATIONS_FOLDER_PATH)
+
+      #copy all the files to a temporary folder
+      FileUtils.cp_r(Dir.glob("#{STRUCTURE_MIGRATIONS_PATH}/*.rb"), TEMP_MIGRATIONS_FOLDER_PATH)
+      FileUtils.cp_r(Dir.glob("#{DATA_MIGRATIONS_PATH}/*.rb"), TEMP_MIGRATIONS_FOLDER_PATH)
+
+      ActiveRecord::Base.transaction do
+        yield(TEMP_MIGRATIONS_FOLDER_PATH)
+      end
+
+    rescue Exception => e
+      raise e
+
+    ensure
+      # Remove the temporary folder
+      FileUtils.rm_rf(TEMP_MIGRATIONS_FOLDER_PATH)
+    end
+  end
+end

data/lib/systematize/version.rb

@@ -0,0 +1,3 @@
+module Systematize
+  VERSION = "0.0.1"
+end

data/lib/systematize.rb

@@ -0,0 +1,4 @@
+module Systematize
+  require 'systematize/railtie'
+  require 'systematize/runner'
+end

data/lib/tasks/migrations.rake

@@ -0,0 +1,27 @@
+namespace :systematize do
+  desc "Migrate the database"
+  task :migrate => :environment do
+    Systematize::Runner.run do |temp_folder|
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] || "true"
+      ActiveRecord::Migrator.migrate(temp_folder)
+    end
+  end
+
+  desc "Rollback the database (options: STEP=x, VERBOSE=false)"
+  task :rollback => :environment do
+    Systematize::Runner.run do |temp_folder|
+      steps = ENV["STEP"] ? ENV["STEP"].to_i : 1
+
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] || "true"
+      ActiveRecord::Migrator.rollback(temp_folder, steps)
+    end
+  end
+
+  desc "Rollback all the database"
+  task :rollback_all => :environment do
+    Systematize::Runner.run do |temp_folder|
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] || "true"
+      ActiveRecord::Migrator.migrate(temp_folder, 0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rails'
+require 'systematize'
+require 'pry'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+end

data/spec/support/db/data/20161117152453_mark_deleted_posts_with_timestamp.rb

@@ -0,0 +1,15 @@
+class MarkDeletedPostsWithTimestamp < ActiveRecord::Migration
+  def up
+    Post.where(deleted: true).each do |post|
+      post.deleted_at = Time.now
+      post.save
+    end
+  end
+
+  def down
+    Post.where("deleted_at != ?", nil).each do |post|
+      post.deleted = true
+      post.save
+    end
+  end
+end

data/spec/support/db/migrate/20161117151622_create_posts_table.rb

@@ -0,0 +1,12 @@
+class CreatePostsTable < ActiveRecord::Migration
+  def change
+    create_table :posts do |p|
+      p.string :title
+      p.string :description
+      p.integer :owner_id
+      p.boolean :deleted
+
+      p.timestamps
+    end
+  end
+end

data/spec/support/db/migrate/20161117152138_add_deleted_at_timestamp.rb

@@ -0,0 +1,9 @@
+class AddDeletedAtTimestamp < ActiveRecord::Migration
+  def up
+    add_column :posts, :deleted_at, :time
+  end
+
+  def down
+    remove_column :posts, :deleted_at
+  end
+end

data/spec/support/db/migrate/20161117152655_remove_deleted_column.rb

@@ -0,0 +1,9 @@
+class RemoveDeletedColumn < ActiveRecord::Migration
+  def up
+    remove_column :posts, :deleted
+  end
+
+  def down
+    add_column :posts, :deleted, :boolean
+  end
+end

data/spec/systematize/runner_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Systematize::Runner do
+
+  describe '#run' do
+
+    subject{
+      described_class.run do |temp_folder|
+        "The temp folder is at #{temp_folder}"
+      end
+    }
+
+    before do
+
+      stub_const('Systematize::Runner::DB_FOLDER_PATH', './spec/support/db')
+      stub_const('Systematize::Runner::DATA_MIGRATIONS_PATH', "#{Systematize::Runner::DB_FOLDER_PATH}/data")
+      stub_const('Systematize::Runner::STRUCTURE_MIGRATIONS_PATH', "#{Systematize::Runner::DB_FOLDER_PATH}/migrate")
+      stub_const('Systematize::Runner::TEMP_MIGRATIONS_FOLDER_PATH', "#{Systematize::Runner::DB_FOLDER_PATH}/tmp")
+
+      allow(FileUtils).to receive(:mkdir).and_call_original
+      allow(FileUtils).to receive(:rm_rf).and_call_original
+      allow(FileUtils).to receive(:cp_r).and_call_original
+
+      subject
+    end
+
+
+    it 'creates a temp folder where all the migrations will be' do
+      expect(FileUtils).to have_received(:mkdir).once
+    end
+
+    it 'deletes the temp folder where all the migrations were' do
+      expect(FileUtils).to have_received(:rm_rf).once
+    end
+
+    it 'copies the content of /db/migrate to /db/temp' do
+      expect(FileUtils)
+        .to have_received(:cp_r)
+        .with(Dir.glob("#{Systematize::Runner::STRUCTURE_MIGRATIONS_PATH}/*.rb"), Systematize::Runner::TEMP_MIGRATIONS_FOLDER_PATH)
+        .once
+    end
+
+    it 'copies the content of /db/data to /db/temp' do
+      expect(FileUtils)
+        .to have_received(:cp_r)
+        .with(Dir.glob("#{Systematize::Runner::DATA_MIGRATIONS_PATH}/*.rb"), Systematize::Runner::TEMP_MIGRATIONS_FOLDER_PATH)
+        .once
+    end
+
+    # Test if #run yields the block that it receives
+    specify{
+      expect{ |b|
+        described_class.run(&b)
+      }
+      .to yield_with_args(Systematize::Runner::TEMP_MIGRATIONS_FOLDER_PATH)
+    }
+
+  end
+
+end

data/spec/testapp/Gemfile

@@ -0,0 +1,41 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.0'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'systematize', path: '../../../systematize'
+
+gem 'pry'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'

data/spec/testapp/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: ../../../systematize
+  specs:
+    systematize (0.0.1)
+      activerecord
+      railties
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.0)
+      actionpack (= 3.2.0)
+      mail (~> 2.4.0)
+    actionpack (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.0)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+    activerecord (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+    activesupport (3.2.0)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coderay (1.1.1)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.10.0)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    journey (1.0.4)
+    jquery-rails (3.1.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    multi_json (1.12.1)
+    polyglot (0.3.5)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.4.7)
+    rack-cache (1.6.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (3.2.0)
+      actionmailer (= 3.2.0)
+      actionpack (= 3.2.0)
+      activerecord (= 3.2.0)
+      activeresource (= 3.2.0)
+      activesupport (= 3.2.0)
+      bundler (~> 1.0)
+      railties (= 3.2.0)
+    railties (3.2.0)
+      actionpack (= 3.2.0)
+      activesupport (= 3.2.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (11.3.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sass (3.4.22)
+    sass-rails (3.2.6)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    slop (3.6.0)
+    sprockets (2.1.4)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.12)
+    thor (0.14.6)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.52)
+    uglifier (3.0.3)
+      execjs (>= 0.3.0, < 3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 3.2.1)
+  jquery-rails
+  pry
+  rails (= 3.2.0)
+  sass-rails (~> 3.2.3)
+  sqlite3
+  systematize!
+  uglifier (>= 1.0.3)
+
+BUNDLED WITH
+   1.13.6