declare_schema 0.10.0 → 0.12.0.pre.2

data/spec/lib/declare_schema/schema_change/index_add_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/index_add'
+
+RSpec.describe DeclareSchema::SchemaChange::IndexAdd do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'users' }
+  let(:column_names) { [:last_name, 'first_name'] }
+  let(:name) { 'on_last_name_and_first_name' }
+  let(:unique) { false }
+  subject { described_class.new(table_name, column_names, name: name, unique: unique) }
+
+  describe '#up/down' do
+    describe '#up' do
+      context 'without where:' do
+        it 'responds with command' do
+          expect(subject.up).to eq("add_index :#{table_name}, #{column_names.map(&:to_sym).inspect}, name: #{name.to_sym.inspect}\n")
+        end
+      end
+
+      context 'with empty where:' do
+        subject { described_class.new(table_name, column_names, name: name, unique: unique, where: nil) }
+
+        it 'responds with command' do
+          expect(subject.up).to eq("add_index :#{table_name}, #{column_names.map(&:to_sym).inspect}, name: #{name.to_sym.inspect}\n")
+        end
+      end
+
+      context 'with where:' do
+        let(:where) { "'last_name like 'A%'"}
+        subject { described_class.new(table_name, column_names, name: name, unique: unique, where: where) }
+
+        it 'responds with command' do
+          expect(subject.up).to eq("add_index :#{table_name}, #{column_names.map(&:to_sym).inspect}, name: #{name.to_sym.inspect}, where: #{where.inspect}\n")
+        end
+      end
+
+      context 'with unique: true' do
+        let(:unique) { true }
+
+        it 'responds with command' do
+          expect(subject.up).to eq("add_index :#{table_name}, #{column_names.map(&:to_sym).inspect}, name: #{name.to_sym.inspect}, unique: true\n")
+        end
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        expect(subject.down).to eq("remove_index :#{table_name}, name: #{name.to_sym.inspect}\n")
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/index_remove_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/index_remove'
+
+RSpec.describe DeclareSchema::SchemaChange::IndexRemove do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'users' }
+  let(:column_names) { [:last_name, 'first_name'] }
+  let(:name) { 'on_last_name_and_first_name' }
+  let(:unique) { true }
+  subject { described_class.new(table_name, column_names, name: name, unique: unique) }
+
+  describe '#up/down' do
+    describe '#up' do
+      it 'responds with command' do
+        expect(subject.up).to eq("remove_index :#{table_name}, name: #{name.to_sym.inspect}\n")
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        expect(subject.down).to eq("add_index :#{table_name}, #{column_names.map(&:to_sym).inspect}, name: #{name.to_sym.inspect}, unique: #{unique}\n")
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/primary_key_change_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/primary_key_change'
+
+RSpec.describe DeclareSchema::SchemaChange::PrimaryKeyChange do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'users' }
+  let(:old_column_names) { ['id'] }
+  let(:new_column_names) { [:last_name, 'first_name'] }
+  let(:name) { 'PRIMARY' }
+  subject { described_class.new(table_name, old_column_names, new_column_names) }
+
+  describe '#up/down' do
+    context 'when PRIMARY KEY set -> set' do
+      describe '#up' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} DROP PRIMARY KEY, ADD PRIMARY KEY (#{new_column_names.join(', ')})"
+          expect(subject.up).to eq("execute #{command.inspect}\n")
+        end
+      end
+
+      describe '#down' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} DROP PRIMARY KEY, ADD PRIMARY KEY (#{old_column_names.join(', ')})"
+          expect(subject.down).to eq("execute #{command.inspect}\n")
+        end
+      end
+    end
+
+    context 'when PRIMARY KEY unset -> set' do
+      let(:old_column_names) { nil }
+
+      describe '#up' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} ADD PRIMARY KEY (#{new_column_names.join(', ')})"
+          expect(subject.up).to eq("execute #{command.inspect}\n")
+        end
+      end
+
+      describe '#down' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} DROP PRIMARY KEY"
+          expect(subject.down).to eq("execute #{command.inspect}\n")
+        end
+      end
+    end
+
+    context 'when PRIMARY KEY set -> unset' do
+      let(:new_column_names) { nil }
+
+      describe '#up' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} DROP PRIMARY KEY"
+          expect(subject.up).to eq("execute #{command.inspect}\n")
+        end
+      end
+
+      describe '#down' do
+        it 'responds with command' do
+          command = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} ADD PRIMARY KEY (#{old_column_names.join(', ')})"
+          expect(subject.down).to eq("execute #{command.inspect}\n")
+        end
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/table_add_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/table_add'
+
+RSpec.describe DeclareSchema::SchemaChange::TableAdd do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'networks' }
+  let(:fields) { [[:string, :title, limit: 255, null: false ], [:boolean, :admin, null: false]] }
+  let(:create_table_options) { { id: :primary_key } }
+  let(:sql_options) { '' }
+
+  subject { described_class.new(table_name, fields, create_table_options, sql_options: sql_options) }
+
+  describe '#up/down' do
+    describe '#up' do
+      it 'responds with command' do
+        expect(subject.up).to eq(<<~EOS)
+          create_table :networks, id: :primary_key do |t|
+            t.string  :title, limit: 255, null: false
+            t.boolean :admin, null: false
+          end
+
+        EOS
+      end
+
+      context 'with sql_options' do
+        let(:sql_options) { 'CHARACTER SET utf8mb4' }
+
+        it 'responds with command' do
+          expect(subject.up).to eq(<<~EOS)
+          create_table :networks, id: :primary_key, options: "CHARACTER SET utf8mb4" do |t|
+            t.string  :title, limit: 255, null: false
+            t.boolean :admin, null: false
+          end
+
+          EOS
+        end
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        expect(subject.down).to eq("drop_table :#{table_name}\n")
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/table_change_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/table_change'
+
+RSpec.describe DeclareSchema::SchemaChange::TableChange do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'networks' }
+  let(:old_options) { { charset: 'utf8', collation: 'utf8_ci' } }
+  let(:new_options) { { charset: 'utf8mb4', collation: 'utf8mb4_bin' } }
+  subject { described_class.new(table_name, old_options, new_options) }
+
+  describe '#up/down' do
+    describe '#up' do
+      it 'responds with command' do
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8mb4 COLLATE utf8mb4_bin"
+        expect(subject.up).to eq("execute #{statement.inspect}\n")
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8 COLLATE utf8_ci"
+        expect(subject.down).to eq("execute #{statement.inspect}\n")
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/table_remove_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/table_remove'
+
+RSpec.describe DeclareSchema::SchemaChange::TableRemove do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:table_name) { 'networks' }
+  let(:add_table_back) { "create table networks(\n)" }
+  subject { described_class.new(table_name, add_table_back) }
+
+  describe '#up/down' do
+    describe '#up' do
+      it 'responds with command' do
+        expect(subject.up).to eq("drop_table :#{table_name}\n")
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        expect(subject.down).to eq("#{add_table_back}\n\n")
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/schema_change/table_rename_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/schema_change/table_rename'
+
+RSpec.describe DeclareSchema::SchemaChange::TableRename do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  let(:old_name) { 'networks' }
+  let(:new_name) { 'customers' }
+  subject { described_class.new(old_name, new_name) }
+
+  describe '#up/down' do
+    describe '#up' do
+      it 'responds with command' do
+        expect(subject.up).to eq("rename_table :#{old_name}, :#{new_name}\n")
+      end
+    end
+
+    describe '#down' do
+      it 'responds with command' do
+        expect(subject.down).to eq("rename_table :#{new_name}, :#{old_name}\n")
+      end
+    end
+  end
+end

data/spec/lib/generators/declare_schema/migration/migrator_spec.rb

@@ -11,18 +11,8 @@ module Generators
   module DeclareSchema
     module Migration
       RSpec.describe Migrator do
-        before do
-          ActiveRecord::Base.connection.tables
-        end
-
         subject { described_class.new }
 
-        describe 'format_options' do
-          it 'returns an array of option .inspect strings, with symbols using the modern : hash notation' do
-            expect(subject.format_options({ limit: 4, 'key' => 'value "quoted"' })).to eq(["limit: 4", '"key" => "value \"quoted\""'])
-          end
-        end
-
         describe '#before_generating_migration' do
           it 'requires a block be passed' do
             expect { described_class.before_generating_migration }.to raise_error(ArgumentError, 'A block is required when setting the before_generating_migration callback')
@@ -67,7 +57,7 @@ module Generators
           end
         end
 
-        describe 'load_rails_models' do
+        describe '#load_rails_models' do
           before do
             expect(Rails.application).to receive(:eager_load!)
             expect(Rails::Engine).to receive(:subclasses).and_return([])
@@ -90,6 +80,64 @@ module Generators
             it { should be_nil }
           end
         end
+
+        describe '#order_migrations' do
+          let(:class_name_order) do
+            %w[ TableRename
+                TableAdd
+                TableChange
+                ColumnAdd
+                ColumnRename
+                ColumnChange
+                PrimaryKeyChange
+                IndexAdd
+                ForeignKeyAdd
+                ForeignKeyRemove
+                IndexRemove
+                ColumnRemove
+                TableRemove ]
+            end
+          let(:one_of_each) do
+            class_name_order.map do |class_name|
+              klass = klass_from_class_name(class_name)
+              instance_double(klass).tap do |double|
+                allow(double).to receive(:class).and_return(klass)
+              end
+            end
+          end
+          let(:one_of_each_shuffled) { one_of_each.shuffle }
+
+          it 'orders properly' do
+            ordered = subject.order_migrations(one_of_each_shuffled)
+            expect(ordered.map { |c| c.class.name.sub(/.*::/, '') }).to eq(class_name_order)
+          end
+
+          context 'when there are dups' do
+            let(:one_of_each_with_dups) do
+              (class_name_order * 2).map do |class_name|
+                klass = klass_from_class_name(class_name)
+                instance_double(klass).tap do |double|
+                  allow(double).to receive(:class).and_return(klass)
+                end
+              end
+            end
+            let(:one_of_each_with_dups_shuffled) { one_of_each_with_dups.shuffle }
+            let(:one_of_each_with_dups_shuffled_grouped) { one_of_each_with_dups_shuffled.group_by { |c| c.class.name } }
+
+            it 'sorts stably' do
+              ordered = subject.order_migrations(one_of_each_with_dups_shuffled)
+              ordered_grouped = ordered.group_by { |c| c.class.name }
+              ordered_grouped.each do |class_name, schema_changes|
+                shuffled_for_class = one_of_each_with_dups_shuffled_grouped[class_name]
+                expect(schema_changes.map(&:object_id)).to eq(shuffled_for_class.map(&:object_id))
+              end
+            end
+          end
+        end
+
+        def klass_from_class_name(class_name)
+          "::DeclareSchema::SchemaChange::#{class_name}".constantize
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -27,7 +27,7 @@ RSpec.configure do |config|
   RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
 
   def active_record_base_class
-    if Rails::VERSION::MAJOR == 4
+    if ActiveSupport::VERSION::MAJOR == 4
       'ActiveRecord::Base'
     else
       'ApplicationRecord'

data/spec/support/acceptance_spec_helpers.rb

@@ -45,13 +45,13 @@ module AcceptanceSpecHelpers
 
   class MigrationUpEquals < RSpec::Matchers::BuiltIn::Eq
     def matches?(subject)
-      super(subject[0].gsub(/, +([a-z_]+:)/i, ', \1')) # normalize multiple spaces to one
+      super(subject[0].strip.gsub(/, +([a-z_]+:)/i, ', \1').gsub(/\n+/, "\n")) # normalize multiple spaces and newlines to one
     end
   end
 
   class MigrationDownEquals < RSpec::Matchers::BuiltIn::Eq
     def matches?(subject)
-      super(subject[1].gsub(/, +([a-z_]+:)/i, ', \1')) # normalize multiple spaces to one
+      super(subject[1].strip.gsub(/, +([a-z_]+:)/i, ', \1').gsub(/\n+/, "\n")) # normalize multiple spaces and newlines to one
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0.pre.2
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,21 @@ files:
 - lib/declare_schema/model/index_definition.rb
 - lib/declare_schema/model/table_options_definition.rb
 - lib/declare_schema/railtie.rb
+- lib/declare_schema/schema_change/all.rb
+- lib/declare_schema/schema_change/base.rb
+- lib/declare_schema/schema_change/column_add.rb
+- lib/declare_schema/schema_change/column_change.rb
+- lib/declare_schema/schema_change/column_remove.rb
+- lib/declare_schema/schema_change/column_rename.rb
+- lib/declare_schema/schema_change/foreign_key_add.rb
+- lib/declare_schema/schema_change/foreign_key_remove.rb
+- lib/declare_schema/schema_change/index_add.rb
+- lib/declare_schema/schema_change/index_remove.rb
+- lib/declare_schema/schema_change/primary_key_change.rb
+- lib/declare_schema/schema_change/table_add.rb
+- lib/declare_schema/schema_change/table_change.rb
+- lib/declare_schema/schema_change/table_remove.rb
+- lib/declare_schema/schema_change/table_rename.rb
 - lib/declare_schema/version.rb
 - lib/generators/declare_schema/migration/USAGE
 - lib/generators/declare_schema/migration/migration_generator.rb
@@ -91,6 +106,20 @@ files:
 - spec/lib/declare_schema/model/index_definition_spec.rb
 - spec/lib/declare_schema/model/table_options_definition_spec.rb
 - spec/lib/declare_schema/prepare_testapp.rb
+- spec/lib/declare_schema/schema_change/base_spec.rb
+- spec/lib/declare_schema/schema_change/column_add_spec.rb
+- spec/lib/declare_schema/schema_change/column_change_spec.rb
+- spec/lib/declare_schema/schema_change/column_remove_spec.rb
+- spec/lib/declare_schema/schema_change/column_rename_spec.rb
+- spec/lib/declare_schema/schema_change/foreign_key_add_spec.rb
+- spec/lib/declare_schema/schema_change/foreign_key_remove_spec.rb
+- spec/lib/declare_schema/schema_change/index_add_spec.rb
+- spec/lib/declare_schema/schema_change/index_remove_spec.rb
+- spec/lib/declare_schema/schema_change/primary_key_change_spec.rb
+- spec/lib/declare_schema/schema_change/table_add_spec.rb
+- spec/lib/declare_schema/schema_change/table_change_spec.rb
+- spec/lib/declare_schema/schema_change/table_remove_spec.rb
+- spec/lib/declare_schema/schema_change/table_rename_spec.rb
 - spec/lib/declare_schema_spec.rb
 - spec/lib/generators/declare_schema/migration/migrator_spec.rb
 - spec/spec_helper.rb
@@ -99,7 +128,7 @@ homepage: https://github.com/Invoca/declare_schema
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -115,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Database schema declaration and migration generator for Rails
 test_files: []