declare_schema 0.3.0 → 0.5.0.pre.1

data/spec/lib/declare_schema/api_spec.rb

@@ -10,14 +10,14 @@ RSpec.describe 'DeclareSchema API' do
 
   describe 'example models' do
     it 'generates a model' do
-      expect(system("bundle exec rails generate declare_schema:model advert title:string body:text")).to be_truthy
+      generate_model 'advert', 'title:string', 'body:text'
 
       # The above will generate the test, fixture and a model file like this:
       # model_declaration = Rails::Generators.invoke('declare_schema:model', ['advert2', 'title:string', 'body:text'])
       # expect(model_declaration.first).to eq([["Advert"], nil, "app/models/advert.rb", nil,
       #                                       [["AdvertTest"], "test/models/advert_test.rb", nil, "test/fixtures/adverts.yml"]])
 
-      expect(File.read("#{TESTAPP_PATH}/app/models/advert.rb")).to eq(<<~EOS)
+      expect_model_definition_to_eq('advert', <<~EOS)
         class Advert < #{active_record_base_class}
 
           fields do
@@ -27,7 +27,8 @@ RSpec.describe 'DeclareSchema API' do
 
         end
       EOS
-      system("rm -rf #{TESTAPP_PATH}/app/models/advert2.rb #{TESTAPP_PATH}/test/models/advert2.rb #{TESTAPP_PATH}/test/fixtures/advert2.rb")
+
+      clean_up_model('advert2')
 
       # The migration generator uses this information to create a migration.
       # The following creates and runs the migration:
@@ -36,13 +37,11 @@ RSpec.describe 'DeclareSchema API' do
 
       # We're now ready to start demonstrating the API
 
-      Rails.application.config.autoload_paths += ["#{TESTAPP_PATH}/app/models"]
-
-      $LOAD_PATH << "#{TESTAPP_PATH}/app/models"
+      load_models
 
-      unless Rails::VERSION::MAJOR >= 6
+      if Rails::VERSION::MAJOR == 5
         # TODO: get this to work on Travis for Rails 6
-        Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+        generate_migrations '-n', '-m'
       end
 
       require 'advert'

data/spec/lib/declare_schema/generator_spec.rb

@@ -6,22 +6,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
   end
 
   it "generates nested models" do
-    Rails::Generators.invoke('declare_schema:model', %w[alpha/beta one:string two:integer])
+    generate_model 'alpha/beta', 'one:string', 'two:integer'
 
-    expect(File.exist?('app/models/alpha/beta.rb')).to be_truthy
-
-    expect(File.read('app/models/alpha/beta.rb')).to eq(<<~EOS)
+    expect_model_definition_to_eq('alpha/beta', <<~EOS)
       class Alpha::Beta < #{active_record_base_class}
-  
+
         fields do
           one :string, limit: 255
           two :integer
         end
-  
+
       end
     EOS
 
-    expect(File.read('app/models/alpha.rb')).to eq(<<~EOS)
+    expect_model_definition_to_eq('alpha', <<~EOS)
       module Alpha
         def self.table_name_prefix
           'alpha_'
@@ -29,9 +27,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     EOS
 
-    expect(File.read('test/models/alpha/beta_test.rb')).to eq(<<~EOS)
+    expect_test_definition_to_eq('alpha/beta', <<~EOS)
       require 'test_helper'
-      
+
       class Alpha::BetaTest < ActiveSupport::TestCase
         # test "the truth" do
         #   assert true
@@ -39,7 +37,50 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     EOS
 
-    expect(File.exist?('test/fixtures/alpha/beta.yml')).to be_truthy
+    case Rails::VERSION::MAJOR
+    when 4
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined.  If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        #  column: value
+      EOS
+    when 5
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined. If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        # column: value
+      EOS
+    when 6
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined. If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        # column: value
+      EOS
+    end
 
     $LOAD_PATH << "#{TESTAPP_PATH}/app/models"
 

data/spec/lib/declare_schema/interactive_primary_key_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
       self.primary_key = "foo_id"
     end
 
-    Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+    generate_migrations '-n', '-m'
     expect(Foo.primary_key).to eq('foo_id')
 
     ### migrate from
@@ -24,28 +24,30 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
     end
 
     puts "\n\e[45m Please enter 'id' (no quotes) at the next prompt \e[0m"
-    Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+    generate_migrations '-n', '-m'
     expect(Foo.primary_key).to eq('id')
 
     nuke_model_class(Foo)
 
     ### migrate to
 
-    # rename to custom primary_key
-    class Foo < ActiveRecord::Base
-      fields do
+    if Rails::VERSION::MAJOR >= 5
+      # rename to custom primary_key
+      class Foo < ActiveRecord::Base
+        fields do
+        end
+        self.primary_key = "foo_id"
       end
-      self.primary_key = "foo_id"
-    end
 
-    puts "\n\e[45m Please enter 'drop id' (no quotes) at the next prompt \e[0m"
-    Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
-    expect(Foo.primary_key).to eq('foo_id')
+      puts "\n\e[45m Please enter 'drop id' (no quotes) at the next prompt \e[0m"
+      generate_migrations '-n', '-m'
+      expect(Foo.primary_key).to eq('foo_id')
 
-    ### ensure it doesn't cause further migrations
+      ### ensure it doesn't cause further migrations
 
-    # check no further migrations
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq("")
+      # check no further migrations
+      up = Generators::DeclareSchema::Migration::Migrator.run.first
+      expect(up).to eq("")
+    end
   end
 end

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -11,14 +11,12 @@ RSpec.describe 'DeclareSchema Migration Generator' do
   it 'generates migrations' do
     ## The migration generator -- introduction
 
-    up_down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up_down).to eq(["", ""])
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to migrate_up("").and migrate_down("")
 
     class Advert < ActiveRecord::Base
     end
 
-    up_down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up_down).to eq(["", ""])
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to migrate_up("").and migrate_down("")
 
     Generators::DeclareSchema::Migration::Migrator.ignore_tables = ["green_fishes"]
 
@@ -30,17 +28,27 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         name :string, limit: 255, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq(<<~EOS.strip)
-      create_table :adverts, id: :bigint do |t|
-        t.string :name, limit: 255
-      end
-    EOS
-    expect(down).to eq("drop_table :adverts")
+
+    up, _ = Generators::DeclareSchema::Migration::Migrator.run.tap do |migrations|
+      expect(migrations).to(
+        migrate_up(<<~EOS.strip)
+          create_table :adverts, id: :bigint do |t|
+            t.string :name, limit: 255
+          end
+        EOS
+        .and migrate_down("drop_table :adverts")
+      )
+    end
 
     ActiveRecord::Migration.class_eval(up)
     expect(Advert.columns.map(&:name)).to eq(["id", "name"])
 
+    if Rails::VERSION::MAJOR < 5
+      # Rails 4 sqlite driver doesn't create PK properly. Fix that by dropping and recreating.
+      ActiveRecord::Base.connection.execute("drop table adverts")
+      ActiveRecord::Base.connection.execute('CREATE TABLE "adverts" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255))')
+    end
+
     class Advert < ActiveRecord::Base
       fields do
         name :string, limit: 255, null: true
@@ -48,19 +56,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         published_at :datetime, null: true
       end
     end
-    up, down = migrate
-    expect(up).to eq(<<~EOS.strip)
-      add_column :adverts, :body, :text
-      add_column :adverts, :published_at, :datetime
 
-      add_index :adverts, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
-    # TODO: ^ TECH-4975 add_index should not be there
+    Advert.connection.schema_cache.clear!
+    Advert.reset_column_information
 
-    expect(down).to eq(<<~EOS.strip)
-      remove_column :adverts, :body
-      remove_column :adverts, :published_at
-    EOS
+    expect(migrate).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :body, :text
+        add_column :adverts, :published_at, :datetime
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :adverts, :body
+        remove_column :adverts, :published_at
+      EOS
+    )
 
     Advert.field_specs.clear # not normally needed
     class Advert < ActiveRecord::Base
@@ -70,9 +79,11 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = migrate
-    expect(up).to eq("remove_column :adverts, :published_at")
-    expect(down).to eq("add_column :adverts, :published_at, :datetime")
+    expect(migrate).to(
+      migrate_up("remove_column :adverts, :published_at").and(
+        migrate_down("add_column :adverts, :published_at, :datetime")
+      )
+    )
 
     nuke_model_class(Advert)
     class Advert < ActiveRecord::Base
@@ -82,20 +93,22 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      remove_column :adverts, :name
-    EOS
-
-    expect(down).to eq(<<~EOS.strip)
-      remove_column :adverts, :title
-      add_column :adverts, :name, :string, limit: 255
-    EOS
-
-    up, down = Generators::DeclareSchema::Migration::Migrator.run(adverts: { name: :title })
-    expect(up).to eq("rename_column :adverts, :name, :title")
-    expect(down).to eq("rename_column :adverts, :title, :name")
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+        remove_column :adverts, :name
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :adverts, :title
+        add_column :adverts, :name, :string, limit: 255
+      EOS
+    )
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run(adverts: { name: :title })).to(
+      migrate_up("rename_column :adverts, :name, :title").and(
+        migrate_down("rename_column :adverts, :title, :name")
+      )
+    )
 
     migrate
 
@@ -106,9 +119,11 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up_down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up_down).to eq(["change_column :adverts, :title, :text",
-                           "change_column :adverts, :title, :string, limit: 255"])
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up("change_column :adverts, :title, :text").and(
+        migrate_down("change_column :adverts, :title, :string, limit: 255")
+      )
+    )
 
     class Advert < ActiveRecord::Base
       fields do
@@ -117,11 +132,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = migrate
-    expect(up.split(',').slice(0,3).join(',')).to eq('change_column :adverts, :title, :string')
-    expect(up.split(',').slice(3,2).sort.join(',')).to eq(" default: \"Untitled\", limit: 255")
-    expect(down).to eq("change_column :adverts, :title, :string, limit: 255")
-
+    expect(migrate).to(
+      migrate_up(<<~EOS.strip)
+        change_column :adverts, :title, :string, limit: 255, default: "Untitled"
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        change_column :adverts, :title, :string, limit: 255
+      EOS
+    )
 
     ### Limits
 
@@ -131,8 +149,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up).to eq("add_column :adverts, :price, :integer, limit: 2")
+    up, _ = Generators::DeclareSchema::Migration::Migrator.run.tap do |migrations|
+      expect(migrations).to migrate_up("add_column :adverts, :price, :integer, limit: 2")
+    end
 
     # Now run the migration, then change the limit:
 
@@ -143,9 +162,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq("change_column :adverts, :price, :integer, limit: 3")
-    expect(down).to eq("change_column :adverts, :price, :integer, limit: 2")
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        change_column :adverts, :price, :integer, limit: 3
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        change_column :adverts, :price, :integer, limit: 2
+      EOS
+    )
 
     # Note that limit on a decimal column is ignored (use :scale and :precision)
 
@@ -156,8 +180,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up).to eq("add_column :adverts, :price, :decimal")
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to migrate_up("add_column :adverts, :price, :decimal")
 
     # Limits are generally not needed for `text` fields, because by default, `text` fields will use the maximum size
     # allowed for that database type (0xffffffff for LONGTEXT in MySQL unlimited in Postgres, 1 billion in Sqlite).
@@ -172,12 +195,13 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up).to eq(<<~EOS.strip)
-      add_column :adverts, :price, :decimal
-      add_column :adverts, :notes, :text, null: false
-      add_column :adverts, :description, :text, null: false
-    EOS
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :price, :decimal
+        add_column :adverts, :notes, :text, null: false
+        add_column :adverts, :description, :text, null: false
+      EOS
+    )
 
     # (There is no limit on `add_column ... :description` above since these tests are run against SQLite.)
 
@@ -196,11 +220,12 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up).to eq(<<~EOS.strip)
-      add_column :adverts, :notes, :text, null: false, limit: 4294967295
-      add_column :adverts, :description, :text, null: false, limit: 255
-    EOS
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :notes, :text, null: false, limit: 4294967295
+        add_column :adverts, :description, :text, null: false, limit: 255
+      EOS
+    )
 
     Advert.field_specs.delete :notes
 
@@ -239,9 +264,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq("change_column :adverts, :description, :text, limit: 4294967295, null: false")
-    expect(down).to eq("change_column :adverts, :description, :text")
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        change_column :adverts, :description, :text, limit: 4294967295, null: false
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        change_column :adverts, :description, :text
+      EOS
+    )
 
     # TODO TECH-4814: The above test should have this output:
     # TODO => "change_column :adverts, :description, :text, limit: 255
@@ -254,9 +284,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq("change_column :adverts, :description, :text, limit: 4294967295, null: false")
-    expect(down).to eq("change_column :adverts, :description, :text")
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        change_column :adverts, :description, :text, limit: 4294967295, null: false
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        change_column :adverts, :description, :text
+      EOS
+    )
     ::DeclareSchema::Model::FieldSpec::instance_variable_set(:@mysql_text_limits, false)
 
     Advert.field_specs.clear
@@ -286,18 +321,21 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       belongs_to :category
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :category_id, :integer, limit: 8, null: false
-      add_index :adverts, [:category_id], name: 'on_category_id'
-    EOS
-    expect(down.sub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      remove_column :adverts, :category_id
-      remove_index :adverts, name: :on_category_id rescue ActiveRecord::StatementInvalid
-    EOS
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :category_id, :integer, limit: 8, null: false
+
+        add_index :adverts, [:category_id], name: 'on_category_id'
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :adverts, :category_id
+
+        remove_index :adverts, name: :on_category_id rescue ActiveRecord::StatementInvalid
+      EOS
+    )
 
     Advert.field_specs.delete(:category_id)
-    Advert.index_specs.delete_if {|spec| spec.fields==["category_id"]}
+    Advert.index_definitions.delete_if { |spec| spec.fields==["category_id"] }
 
     # If you specify a custom foreign key, the migration generator observes that:
 
@@ -306,14 +344,17 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       fields { }
       belongs_to :category, foreign_key: "c_id", class_name: 'Category'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :c_id, :integer, limit: 8, null: false
-      add_index :adverts, [:c_id], name: 'on_c_id'
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :c_id, :integer, limit: 8, null: false
+
+        add_index :adverts, [:c_id], name: 'on_c_id'
+      EOS
+    )
 
     Advert.field_specs.delete(:c_id)
-    Advert.index_specs.delete_if { |spec| spec.fields == ["c_id"] }
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["c_id"] }
 
     # You can avoid generating the index by specifying `index: false`
 
@@ -322,11 +363,15 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       fields { }
       belongs_to :category, index: false
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq("add_column :adverts, :category_id, :integer, limit: 8, null: false")
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :category_id, :integer, limit: 8, null: false
+      EOS
+    )
 
     Advert.field_specs.delete(:category_id)
-    Advert.index_specs.delete_if { |spec| spec.fields == ["category_id"] }
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["category_id"] }
 
     # You can specify the index name with :index
 
@@ -335,14 +380,17 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       fields { }
       belongs_to :category, index: 'my_index'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :category_id, :integer, limit: 8, null: false
-      add_index :adverts, [:category_id], name: 'my_index'
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :category_id, :integer, limit: 8, null: false
+
+        add_index :adverts, [:category_id], name: 'my_index'
+      EOS
+    )
 
     Advert.field_specs.delete(:category_id)
-    Advert.index_specs.delete_if { |spec| spec.fields == ["category_id"] }
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["category_id"] }
 
     ### Timestamps and Optimimistic Locking
 
@@ -355,17 +403,19 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         optimistic_lock
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :created_at, :datetime
-      add_column :adverts, :updated_at, :datetime
-      add_column :adverts, :lock_version, :integer, null: false, default: 1
-    EOS
-    expect(down.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      remove_column :adverts, :created_at
-      remove_column :adverts, :updated_at
-      remove_column :adverts, :lock_version
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :created_at, :datetime
+        add_column :adverts, :updated_at, :datetime
+        add_column :adverts, :lock_version, :integer, null: false, default: 1
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :adverts, :created_at
+        remove_column :adverts, :updated_at
+        remove_column :adverts, :lock_version
+      EOS
+    )
 
     Advert.field_specs.delete(:updated_at)
     Advert.field_specs.delete(:created_at)
@@ -380,13 +430,16 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, limit: 255, null: true
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title], name: 'on_title'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields==["title"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title], name: 'on_title'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields==["title"] }
 
     # You can ask for a unique index
 
@@ -395,13 +448,16 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, unique: true, null: true, limit: 255
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title], unique: true, name: 'on_title'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields == ["title"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title], unique: true, name: 'on_title'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["title"] }
 
     # You can specify the name for the index
 
@@ -410,52 +466,64 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: 'my_index', limit: 255, null: true
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title], name: 'my_index'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields==["title"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title], name: 'my_index'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields==["title"] }
 
     # You can ask for an index outside of the fields block
 
     class Advert < ActiveRecord::Base
       index :title
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title], name: 'on_title'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields == ["title"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title], name: 'on_title'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["title"] }
 
     # The available options for the index function are `:unique` and `:name`
 
     class Advert < ActiveRecord::Base
       index :title, unique: true, name: 'my_index'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title], unique: true, name: 'my_index'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields == ["title"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title], unique: true, name: 'my_index'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields == ["title"] }
 
     # You can create an index on more than one field
 
     class Advert < ActiveRecord::Base
       index [:title, :category_id]
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :title, :string, limit: 255
-      add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
-    EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields==["title", "category_id"] }
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        add_column :adverts, :title, :string, limit: 255
+
+        add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
+      EOS
+    )
+
+    Advert.index_definitions.delete_if { |spec| spec.fields==["title", "category_id"] }
 
     # Finally, you can specify that the migration generator should completely ignore an
     # index by passing its name to ignore_index in the model.
@@ -476,19 +544,24 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     Advert.connection.schema_cache.clear!
     Advert.reset_column_information
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run("adverts" => "ads")
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      rename_table :adverts, :ads
-      add_column :ads, :title, :string, limit: 255
-      add_column :ads, :body, :text
-      add_index :ads, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
-    expect(down.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      remove_column :ads, :title
-      remove_column :ads, :body
-      rename_table :ads, :adverts
-      add_index :adverts, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
+    expect(Generators::DeclareSchema::Migration::Migrator.run("adverts" => "ads")).to(
+      migrate_up(<<~EOS.strip)
+        rename_table :adverts, :ads
+
+        add_column :ads, :title, :string, limit: 255
+        add_column :ads, :body, :text
+
+        add_index :ads, [:id], unique: true, name: 'PRIMARY'
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :ads, :title
+        remove_column :ads, :body
+
+        rename_table :ads, :adverts
+
+        add_index :adverts, [:id], unique: true, name: 'PRIMARY'
+      EOS
+    )
 
     # Set the table name back to what it should be and confirm we're in sync:
 
@@ -512,21 +585,27 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         body :text, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run("adverts" => "advertisements")
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      rename_table :adverts, :advertisements
-      add_column :advertisements, :title, :string, limit: 255
-      add_column :advertisements, :body, :text
-      remove_column :advertisements, :name
-      add_index :advertisements, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
-    expect(down.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      remove_column :advertisements, :title
-      remove_column :advertisements, :body
-      add_column :adverts, :name, :string, limit: 255
-      rename_table :advertisements, :adverts
-      add_index :adverts, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run("adverts" => "advertisements")).to(
+      migrate_up(<<~EOS.strip)
+        rename_table :adverts, :advertisements
+
+        add_column :advertisements, :title, :string, limit: 255
+        add_column :advertisements, :body, :text
+        remove_column :advertisements, :name
+
+        add_index :advertisements, [:id], unique: true, name: 'PRIMARY'
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        remove_column :advertisements, :title
+        remove_column :advertisements, :body
+        add_column :adverts, :name, :string, limit: 255
+
+        rename_table :advertisements, :adverts
+
+        add_index :adverts, [:id], unique: true, name: 'PRIMARY'
+      EOS
+    )
 
     ### Drop a table
 
@@ -536,9 +615,24 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     # Dropping tables is where the automatic down-migration really comes in handy:
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up).to eq("drop_table :adverts")
-    expect(down.gsub(/,.*/m, '')).to eq("create_table \"adverts\"")
+    rails4_table_create = <<~EOS.strip
+      create_table "adverts", force: :cascade do |t|
+        t.string "name", limit: 255
+      end
+    EOS
+
+    rails5_table_create = <<~EOS.strip
+      create_table "adverts", id: :integer, force: :cascade do |t|
+        t.string "name", limit: 255
+      end
+    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run).to(
+      migrate_up(<<~EOS.strip)
+        drop_table :adverts
+      EOS
+      .and migrate_down(Rails::VERSION::MAJOR >= 5 ? rails5_table_create : rails4_table_create)
+    )
 
     ## STI
 
@@ -559,20 +653,26 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     end
     class SuperFancyAdvert < FancyAdvert
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      add_column :adverts, :type, :string, limit: 255
-      add_index :adverts, [:type], name: 'on_type'
-    EOS
-    expect(down.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      remove_column :adverts, :type
-      remove_index :adverts, name: :on_type rescue ActiveRecord::StatementInvalid
-    EOS
+
+    up, _ = Generators::DeclareSchema::Migration::Migrator.run do |migrations|
+      expect(migrations).to(
+        migrate_up(<<~EOS.strip)
+          add_column :adverts, :type, :string, limit: 255
+
+          add_index :adverts, [:type], name: 'on_type'
+        EOS
+        .and migrate_down(<<~EOS.strip)
+          remove_column :adverts, :type
+
+          remove_index :adverts, name: :on_type rescue ActiveRecord::StatementInvalid
+        EOS
+      )
+    end
 
     Advert.field_specs.delete(:type)
     nuke_model_class(SuperFancyAdvert)
     nuke_model_class(FancyAdvert)
-    Advert.index_specs.delete_if { |spec| spec.fields==["type"] }
+    Advert.index_definitions.delete_if { |spec| spec.fields==["type"] }
 
     ## Coping with multiple changes
 
@@ -600,16 +700,17 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         body :text, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run(adverts: { title: :name })
-    expect(up).to eq(<<~EOS.strip)
-      rename_column :adverts, :title, :name
-      change_column :adverts, :name, :string, limit: 255, default: \"No Name\"
-    EOS
 
-    expect(down).to eq(<<~EOS.strip)
-      rename_column :adverts, :name, :title
-      change_column :adverts, :title, :string, limit: 255, default: \"Untitled\"
-    EOS
+    expect(Generators::DeclareSchema::Migration::Migrator.run(adverts: { title: :name })).to(
+      migrate_up(<<~EOS.strip)
+        rename_column :adverts, :title, :name
+        change_column :adverts, :name, :string, limit: 255, default: "No Name"
+      EOS
+      .and migrate_down(<<~EOS.strip)
+        rename_column :adverts, :name, :title
+        change_column :adverts, :title, :string, limit: 255, default: "Untitled"
+      EOS
+    )
 
     ### Rename a table and add a column
 
@@ -621,13 +722,17 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         created_at :datetime
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads).first
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      rename_table :adverts, :ads
-      add_column :ads, :created_at, :datetime, null: false
-      change_column :ads, :title, :string, limit: 255, null: false, default: \"Untitled\"
-      add_index :ads, [:id], unique: true, name: 'PRIMARY_KEY'
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads)).to(
+      migrate_up(<<~EOS.strip)
+        rename_table :adverts, :ads
+
+        add_column :ads, :created_at, :datetime, null: false
+        change_column :ads, :title, :string, limit: 255, null: false, default: \"Untitled\"
+
+        add_index :ads, [:id], unique: true, name: 'PRIMARY'
+      EOS
+    )
 
     class Advert < ActiveRecord::Base
       fields do
@@ -648,11 +753,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
       self.primary_key = "advert_id"
     end
-    up, _down = Generators::DeclareSchema::Migration::Migrator.run(adverts: { id: :advert_id })
-    expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
-      rename_column :adverts, :id, :advert_id
-      add_index :adverts, [:advert_id], unique: true, name: 'PRIMARY_KEY'
-    EOS
+
+    expect(Generators::DeclareSchema::Migration::Migrator.run(adverts: { id: :advert_id })).to(
+      migrate_up(<<~EOS.strip)
+        rename_column :adverts, :id, :advert_id
+
+        add_index :adverts, [:advert_id], unique: true, name: 'PRIMARY'
+      EOS
+    )
 
     nuke_model_class(Advert)
     ActiveRecord::Base.connection.execute("drop table `adverts`;")
@@ -691,7 +799,200 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     expect(Ad.field_specs['company'].options[:validates].inspect).to eq("{:presence=>true, :uniqueness=>{:case_sensitive=>false}}")
   end
 
-  if Rails::VERSION::MAJOR >= 5
+  describe 'serialize' do
+    before do
+      class Ad < ActiveRecord::Base
+        @serialize_args = []
+
+        class << self
+          attr_reader :serialize_args
+
+          def serialize(*args)
+            @serialize_args << args
+          end
+        end
+      end
+    end
+
+    describe 'untyped' do
+      it 'allows serialize: true' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :text, limit: 0xFFFF, serialize: true
+          end
+        end
+
+        expect(Ad.serialize_args).to eq([[:allow_list]])
+      end
+
+      it 'converts defaults with .to_yaml' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: true, null: true, default: []
+            allow_hash :string, limit: 255, serialize: true, null: true, default: {}
+            allow_string :string, limit: 255, serialize: true, null: true, default: ['abc']
+            allow_null :string, limit: 255, serialize: true, null: true, default: nil
+          end
+        end
+
+        expect(Ad.field_specs['allow_list'].default).to eq("--- []\n")
+        expect(Ad.field_specs['allow_hash'].default).to eq("--- {}\n")
+        expect(Ad.field_specs['allow_string'].default).to eq("---\n- abc\n")
+        expect(Ad.field_specs['allow_null'].default).to eq(nil)
+      end
+    end
+
+    describe 'Array' do
+      it 'allows serialize: Array' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: Array, null: true
+          end
+        end
+
+        expect(Ad.serialize_args).to eq([[:allow_list, Array]])
+      end
+
+      it 'allows Array defaults' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: Array, null: true, default: [2]
+            allow_string :string, limit: 255, serialize: Array, null: true, default: ['abc']
+            allow_empty :string, limit: 255, serialize: Array, null: true, default: []
+            allow_null :string, limit: 255, serialize: Array, null: true, default: nil
+          end
+        end
+
+        expect(Ad.field_specs['allow_list'].default).to eq("---\n- 2\n")
+        expect(Ad.field_specs['allow_string'].default).to eq("---\n- abc\n")
+        expect(Ad.field_specs['allow_empty'].default).to eq(nil)
+        expect(Ad.field_specs['allow_null'].default).to eq(nil)
+      end
+    end
+
+    describe 'Hash' do
+      it 'allows serialize: Hash' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: Hash, null: true
+          end
+        end
+
+        expect(Ad.serialize_args).to eq([[:allow_list, Hash]])
+      end
+
+      it 'allows Hash defaults' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_loc :string, limit: 255, serialize: Hash, null: true, default: { 'state' => 'CA' }
+            allow_hash :string, limit: 255, serialize: Hash, null: true, default: {}
+            allow_null :string, limit: 255, serialize: Hash, null: true, default: nil
+          end
+        end
+
+        expect(Ad.field_specs['allow_loc'].default).to eq("---\nstate: CA\n")
+        expect(Ad.field_specs['allow_hash'].default).to eq(nil)
+        expect(Ad.field_specs['allow_null'].default).to eq(nil)
+      end
+    end
+
+    describe 'JSON' do
+      it 'allows serialize: JSON' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: JSON
+          end
+        end
+
+        expect(Ad.serialize_args).to eq([[:allow_list, JSON]])
+      end
+
+      it 'allows JSON defaults' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_hash :string, limit: 255, serialize: JSON, null: true, default: { 'state' => 'CA' }
+            allow_empty_array :string, limit: 255, serialize: JSON, null: true, default: []
+            allow_empty_hash :string, limit: 255, serialize: JSON, null: true, default: {}
+            allow_null :string, limit: 255, serialize: JSON, null: true, default: nil
+          end
+        end
+
+        expect(Ad.field_specs['allow_hash'].default).to eq("{\"state\":\"CA\"}")
+        expect(Ad.field_specs['allow_empty_array'].default).to eq("[]")
+        expect(Ad.field_specs['allow_empty_hash'].default).to eq("{}")
+        expect(Ad.field_specs['allow_null'].default).to eq(nil)
+      end
+    end
+
+    class ValueClass
+      delegate :present?, :inspect, to: :@value
+
+      def initialize(value)
+        @value = value
+      end
+
+      class << self
+        def dump(object)
+          if object&.present?
+            object.inspect
+          end
+        end
+
+        def load(serialized)
+          if serialized
+            raise 'not used ???'
+          end
+        end
+      end
+    end
+
+    describe 'custom coder' do
+      it 'allows serialize: ValueClass' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :string, limit: 255, serialize: ValueClass
+          end
+        end
+
+        expect(Ad.serialize_args).to eq([[:allow_list, ValueClass]])
+      end
+
+      it 'allows ValueClass defaults' do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_hash :string, limit: 255, serialize: ValueClass, null: true, default: ValueClass.new([2])
+            allow_empty_array :string, limit: 255, serialize: ValueClass, null: true, default: ValueClass.new([])
+            allow_null :string, limit: 255, serialize: ValueClass, null: true, default: nil
+          end
+        end
+
+        expect(Ad.field_specs['allow_hash'].default).to eq("[2]")
+        expect(Ad.field_specs['allow_empty_array'].default).to eq(nil)
+        expect(Ad.field_specs['allow_null'].default).to eq(nil)
+      end
+    end
+
+    it 'disallows serialize: with a non-string column type' do
+      expect do
+        class Ad < ActiveRecord::Base
+          fields do
+            allow_list :integer, limit: 8, serialize: true
+          end
+        end
+      end.to raise_exception(ArgumentError, /must be :string or :text/)
+    end
+  end
+
+  context "for Rails #{Rails::VERSION::MAJOR}" do
+    if Rails::VERSION::MAJOR >= 5
+      let(:optional_true) { { optional: true } }
+      let(:optional_false) { { optional: false } }
+    else
+      let(:optional_true) { {} }
+      let(:optional_false) { {} }
+    end
+    let(:optional_flag) { { false => optional_false, true => optional_true } }
+
     describe 'belongs_to' do
       before do
         unless defined?(AdCategory)
@@ -718,10 +1019,10 @@ RSpec.describe 'DeclareSchema Migration Generator' do
           reset_column_information
           belongs_to :ad_category, optional: true
         end
-        expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: true)
+        expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional_true)
       end
 
-      describe 'contradictory settings' do # contradictory settings are ok during migration
+      describe 'contradictory settings' do # contradictory settings are ok--for example, during migration
         it 'passes through optional: true, null: false' do
           class AdvertBelongsTo < ActiveRecord::Base
             self.table_name = 'adverts'
@@ -729,7 +1030,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             reset_column_information
             belongs_to :ad_category, optional: true, null: false
           end
-          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: true)
+          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional_true)
           expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(false)
         end
 
@@ -740,7 +1041,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             reset_column_information
             belongs_to :ad_category, optional: false, null: true
           end
-          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: false)
+          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional_false)
           expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(true)
         end
       end
@@ -754,7 +1055,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
                 belongs_to :ad_category, null: #{nullable}
               end
             EOS
-            expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: nullable)
+            expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional_flag[nullable])
             expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(nullable)
           end
 
@@ -765,7 +1066,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
                 belongs_to :ad_category, optional: #{nullable}
               end
             EOS
-            expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: nullable)
+            expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional_flag[nullable])
             expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(nullable)
           end
         end
@@ -781,7 +1082,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         end
       end
 
-      Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+      generate_migrations '-n', '-m'
 
       migrations = Dir.glob('db/migrate/*declare_schema_migration*.rb')
       expect(migrations.size).to eq(1), migrations.inspect