declare_schema 0.8.0.pre.3 → 0.9.0

data/spec/lib/declare_schema/interactive_primary_key_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
     end
 
     generate_migrations '-n', '-m'
-    expect(Foo.primary_key).to eq('foo_id')
+    expect(Foo._defined_primary_key).to eq('foo_id')
 
     ### migrate from
     # rename from custom primary_key
@@ -31,7 +31,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
 
     puts "\n\e[45m Please enter 'id' (no quotes) at the next prompt \e[0m"
     generate_migrations '-n', '-m'
-    expect(Foo.primary_key).to eq('id')
+    expect(Foo._defined_primary_key).to eq('id')
 
     nuke_model_class(Foo)
 
@@ -47,7 +47,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
 
       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')
+      expect(Foo._defined_primary_key).to eq('foo_id')
 
       ### ensure it doesn't cause further migrations
 

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -372,14 +372,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'on_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :category_id
 
         remove_index :adverts, name: :on_category_id rescue ActiveRecord::StatementInvalid
 
-        #{"remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
+        #{"remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" if defined?(Mysql2)}
       EOS
     )
 
@@ -400,8 +400,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:c_id], name: 'on_c_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -420,8 +420,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       migrate_up(<<~EOS.strip)
         add_column :adverts, :category_id, :integer, limit: 8, null: false
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -442,8 +442,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -468,16 +468,16 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         add_column :adverts, :updated_at, :datetime, null: true
         add_column :adverts, :lock_version, :integer#{lock_version_limit}, null: false, default: 1
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :created_at
         remove_column :adverts, :updated_at
         remove_column :adverts, :lock_version
 
-        #{"remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" +
-          "remove_foreign_key(\"adverts\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" +
+          "remove_foreign_key(\"adverts\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -501,8 +501,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -522,8 +522,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -543,8 +543,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -562,8 +562,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -581,8 +581,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -600,8 +600,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -637,8 +637,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             "add_index :ads, [:id], unique: true, name: 'PRIMARY'\n"
           elsif defined?(Mysql2)
             "execute \"ALTER TABLE ads DROP PRIMARY KEY, ADD PRIMARY KEY (id)\"\n\n" +
-            "add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-            "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")"
+            "add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+            "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")"
           end}
       EOS
       .and migrate_down(<<~EOS.strip)
@@ -651,8 +651,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             "add_index :adverts, [:id], unique: true, name: 'PRIMARY'\n"
           elsif defined?(Mysql2)
             "execute \"ALTER TABLE adverts DROP PRIMARY KEY, ADD PRIMARY KEY (id)\"\n\n" +
-            "remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" +
-            "remove_foreign_key(\"adverts\", name: \"index_adverts_on_c_id\")"
+            "remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" +
+            "remove_foreign_key(\"adverts\", name: \"on_c_id\")"
           end}
       EOS
     )

data/spec/lib/declare_schema/model/habtm_model_shim_spec.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+begin
+  require 'mysql2'
+rescue LoadError
+end
+
+require_relative '../../../../lib/declare_schema/model/habtm_model_shim'
+
+RSpec.describe DeclareSchema::Model::HabtmModelShim do
+  let(:join_table) { "parent_1_parent_2" }
+  let(:foreign_keys) { ["parent_1_id", "parent_2_id"] }
+  let(:foreign_key_classes) { [Parent1, Parent2] }
+
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+
+    class Parent1 < ActiveRecord::Base
+      self.table_name = "parent_1s"
+    end
+
+    class Parent2 < ActiveRecord::Base
+      self.table_name = "parent_2s"
+    end
+  end
+
+  describe 'class methods' do
+    describe '.from_reflection' do
+      let(:reflection) { double("reflection", join_table: join_table,
+                                              foreign_key: foreign_keys.first,
+                                              association_foreign_key: foreign_keys.last,
+                                              active_record: foreign_key_classes.first,
+                                              class_name: 'Parent1') }
+      it 'returns a new object' do
+        result = described_class.from_reflection(reflection)
+
+        expect(result).to be_a(described_class)
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    let(:connection) { instance_double(ActiveRecord::Base.connection.class, "connection") }
+
+    subject { described_class.new(join_table, foreign_keys, foreign_key_classes, connection) }
+
+    describe '#initialize' do
+      it 'stores initialization attributes' do
+        expect(subject.join_table).to eq(join_table)
+        expect(subject.foreign_keys).to eq(foreign_keys)
+        expect(subject.foreign_key_classes).to be(foreign_key_classes)
+        expect(subject.connection).to be(connection)
+      end
+    end
+
+    describe '#table_options' do
+      it 'returns empty hash' do
+        expect(subject.table_options).to eq({})
+      end
+    end
+
+    describe '#table_name' do
+      it 'returns join_table' do
+        expect(subject.table_name).to eq(join_table)
+      end
+    end
+
+    describe '#field_specs' do
+      it 'returns 2 field specs' do
+        result = subject.field_specs
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result[foreign_keys.first]).to be_a(::DeclareSchema::Model::FieldSpec)
+        expect(result[foreign_keys.first].model).to eq(subject)
+        expect(result[foreign_keys.first].name.to_s).to eq(foreign_keys.first)
+        expect(result[foreign_keys.first].type).to eq(:integer)
+        expect(result[foreign_keys.first].position).to eq(0)
+
+        expect(result[foreign_keys.last]).to be_a(::DeclareSchema::Model::FieldSpec)
+        expect(result[foreign_keys.last].model).to eq(subject)
+        expect(result[foreign_keys.last].name.to_s).to eq(foreign_keys.last)
+        expect(result[foreign_keys.last].type).to eq(:integer)
+        expect(result[foreign_keys.last].position).to eq(1)
+      end
+    end
+
+    describe '#primary_key' do
+      it 'returns false' do
+        expect(subject._defined_primary_key).to eq(false)
+      end
+    end
+
+    describe '#_defined_primary_key' do
+      it 'returns false' do
+        expect(subject._defined_primary_key).to eq(false)
+      end
+    end
+
+    describe '#index_definitions_with_primary_key' do
+      it 'returns 2 index definitions' do
+        result = subject.index_definitions_with_primary_key
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result.first).to be_a(::DeclareSchema::Model::IndexDefinition)
+        expect(result.first.name).to eq('PRIMARY')
+        expect(result.first.fields).to eq(['parent_1_id', 'parent_2_id'])
+        expect(result.first.unique).to be_truthy
+
+        expect(result.last).to be_a(::DeclareSchema::Model::IndexDefinition)
+        expect(result.last.name).to eq('on_parent_2_id')
+        expect(result.last.unique).to be_falsey
+        expect(result.last.fields).to eq(['parent_2_id'])
+      end
+    end
+
+    describe '#index_definitions' do
+      it 'returns index_definitions_with_primary_key' do
+        result = subject.index_definitions
+        expect(result.size).to eq(2), result.inspect
+      end
+    end
+
+    describe 'ignore_indexes' do
+      it 'returns empty array' do
+        expect(subject.ignore_indexes).to eq([])
+      end
+    end
+
+    describe '#constraint_specs' do
+      it 'returns 2 foreign keys' do
+        result = subject.constraint_specs
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result.first).to be_a(::DeclareSchema::Model::ForeignKeyDefinition)
+        expect(result.first.foreign_key).to eq(foreign_keys.first)
+        expect(result.first.parent_table_name).to be(Parent1.table_name)
+        expect(result.first.on_delete_cascade).to be_truthy
+
+        expect(result.last).to be_a(::DeclareSchema::Model::ForeignKeyDefinition)
+        expect(result.last.foreign_key).to eq(foreign_keys.last)
+        expect(result.last.parent_table_name).to be(Parent2.table_name)
+        expect(result.last.on_delete_cascade).to be_truthy
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/model/index_definition_spec.rb

@@ -58,7 +58,17 @@ RSpec.describe DeclareSchema::Model::IndexDefinition do
     end
   end
 
-  describe 'class << self' do
+  describe 'class methods' do
+    describe 'index_name' do
+      it 'works with a single column' do
+        expect(described_class.index_name('parent_id')).to eq('on_parent_id')
+      end
+
+      it 'works with many columns' do
+        expect(described_class.index_name(['a', 'b', 'c'])).to eq('on_a_and_b_and_c')
+      end
+    end
+
     context 'with a migrated database' do
       before do
         ActiveRecord::Base.connection.execute <<~EOS

data/spec/lib/declare_schema_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+RSpec.describe DeclareSchema do
+  describe '#default_charset' do
+    subject { described_class.default_charset }
+
+    context 'when not explicitly set' do
+      it { should eq("utf8mb4") }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_charset = "utf8" }
+      after  { described_class.default_charset = "utf8mb4" }
+      it     { should eq("utf8") }
+    end
+  end
+
+  describe '#default_collation' do
+    subject { described_class.default_collation }
+
+    context 'when not explicitly set' do
+      it { should eq("utf8mb4_bin") }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_collation = "utf8mb4_general_ci" }
+      after  { described_class.default_collation = "utf8mb4_bin" }
+      it     { should eq("utf8mb4_general_ci") }
+    end
+  end
+
+  describe '#default_text_limit' do
+    subject { described_class.default_text_limit }
+
+    context 'when not explicitly set' do
+      it { should eq(0xffff_ffff) }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_text_limit = 0xffff }
+      after  { described_class.default_text_limit = 0xffff_ffff }
+      it     { should eq(0xffff) }
+    end
+  end
+
+  describe '#default_string_limit' do
+    subject { described_class.default_string_limit }
+
+    context 'when not explicitly set' do
+      it { should eq(nil) }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_string_limit = 225 }
+      after  { described_class.default_string_limit = nil }
+      it     { should eq(225) }
+    end
+  end
+
+  describe '#default_null' do
+    subject { described_class.default_null }
+
+    context 'when not explicitly set' do
+      it { should eq(false) }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_null = true }
+      after  { described_class.default_null = false }
+      it     { should eq(true) }
+    end
+  end
+
+  describe '#default_generate_foreign_keys' do
+    subject { described_class.default_generate_foreign_keys }
+
+    context 'when not explicitly set' do
+      it { should eq(true) }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_generate_foreign_keys = false }
+      after  { described_class.default_generate_foreign_keys = true }
+      it     { should eq(false) }
+    end
+  end
+
+  describe '#default_generate_indexing' do
+    subject { described_class.default_generate_indexing }
+
+    context 'when not explicitly set' do
+      it { should eq(true) }
+    end
+
+    context 'when explicitly set' do
+      before { described_class.default_generate_indexing = false }
+      after  { described_class.default_generate_indexing = true }
+      it     { should eq(false) }
+    end
+  end
+end