reversibility_checker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d36081ec7bc7c4abb8a6ea04a967fa1e6dadf9a00f65f36b9d88edb41bb38cf
-  data.tar.gz: 3afc569c9ef0064593a0acd3183a5e087be5d59f3cb298df8a1c64416c93d6f3
+  metadata.gz: c8716ded2cae0032c7edbbed7c8984b81d713d87fc6db20e65e78b127b96d492
+  data.tar.gz: ed5c4a55d4d0a22e56455b5ef97f1081f4825f84de998ddcc8a61f307d82bbb5
 SHA512:
-  metadata.gz: 8113b44ad3f4f22265781c3f3e97c89100858bdd66d3868a27f2338157a34426cb7288fa1801f584c71f846cf4c12895c9762e89e304f1c0095b7b0d68cfdea6
-  data.tar.gz: 2a1c04ada6b3349d18f55cc3a1849bfbeb1d1dac9a6a0431115fbcc0fb45bb9988ebd821d3170ae975a63711800c33c491a9a10aeb0c32cdaca94f9b9f7af30e
+  metadata.gz: 864547946fd5688164ba9f629d85518b8a48f93d9b3a56e5c711e58ec763306ca255fee03ec86ea65323e6c29845bfca70552de1ab71354be7516d6d50eb7e78
+  data.tar.gz: fa59da40b51345a7a53342e3a55e1fb1c0138ec71fe3e9a5f3fa8b316183a32d33870ad9cd5cb8d9af303bf4fbbab21751b948b4320b025024cee196e0f92142

data/README.md

@@ -14,4 +14,49 @@ end
 $ rails db:migrate:check_reversibility
 ```
 
-This task check diffs between a current schema and a schema which migrated and rollbacked. If there are diffs, it will print the diffs and exit with exit status `1`.
+This task checks diffs between a current schema and a schema which migrated and rollbacked. If there are diffs, it will print the diffs and exit with exit status `1`.
+
+## Example
+
+if you create a following migration file,
+
+```rb
+class ChangeEmailLimitAtUsers < ActiveRecord::Migration[5.2]
+  def up
+    change_column :users, :email, :string, limit: 50
+  end
+
+  def down
+    change_column :users, :email, :string
+  end
+end
+```
+
+when you run `db:migrate:check_reversibility` task, this task will run `db:migrate` and `db:rollback` and print diffs between a current schema and a rollbacked schema.
+
+```bash
+$ rails db:migrate:check_reversibility
+ # This file is auto-generated from the current state of the database. Instead
+ # of editing this file, please use the migrations feature of Active Record to
+ # incrementally modify your database, and then regenerate this schema definition.
+ #
+ # Note that this schema.rb definition is the authoritative source for your
+ # database schema. If you need to create the application database on another
+ # system, you should be using db:schema:load, not running all the migrations
+ # from scratch. The latter is a flawed and unsustainable approach (the more migrations
+ # you'll amass, the slower it'll run and the greater likelihood for issues).
+ #
+ # It's strongly recommended that you check this file into your version control system.
+
+ ActiveRecord::Schema.define(version: 2018_10_17_064352) do
+
+   create_table "users", force: :cascade do |t|
+     t.string "name"
+-    t.string "email"
++    t.string "email", limit: 50
+     t.datetime "created_at", null: false
+     t.datetime "updated_at", null: false
+   end
+
+ end
+```

data/lib/reversibility_checker/railties/reversible.rake

@@ -1,6 +1,5 @@
 require "active_record"
 require "diffy"
-require "stringio"
 
 namespace :db do
   namespace :migrate do
@@ -28,19 +27,17 @@ namespace :db do
       ActiveRecord::Base.connection.migration_context.up(current_version)
 
       # Take a snapshot of the temporary schema
-      current_buffer = StringIO.new
-      ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, current_buffer)
+      current_schema = ReversibilityChecker.dump(config)
 
       # Migrate a temporary schema upto latest and rollback to current version
       ActiveRecord::Base.connection.migration_context.up
       ActiveRecord::Base.connection.migration_context.down(current_version)
 
       # Take a snapshot again
-      rollbacked_buffer = StringIO.new
-      ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, rollbacked_buffer)
+      rollbacked_schema = ReversibilityChecker.dump(config)
 
       # Compare two snapshots
-      diff = Diffy::Diff.new(current_buffer.string, rollbacked_buffer.string)
+      diff = Diffy::Diff.new(current_schema, rollbacked_schema)
 
       if diff.count > 0
         Object::STDOUT.puts diff.to_s(:color)

data/lib/reversibility_checker/version.rb

@@ -1,3 +1,3 @@
 module ReversibilityChecker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/reversibility_checker.rb

@@ -1,2 +1,20 @@
 require "reversibility_checker/railtie"
 require "reversibility_checker/version"
+
+require "active_record"
+require "stringio"
+
+module ReversibilityChecker
+  def self.dump(config)
+    case ActiveRecord::Base.schema_format
+    when :ruby
+      buffer = StringIO.new
+      ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, buffer)
+      buffer.string
+    when :sql
+      file = Tempfile.new
+      ActiveRecord::Tasks::DatabaseTasks.structure_dump(config, file.path)
+      file.read
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reversibility_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Naoto Kaneko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails