declare_schema 1.5.0.pre.1 → 2.1.0.pre.1

data/spec/fixtures/migrations/postgresql/will_generate_unique_constraint_names_rails_7.txt

@@ -0,0 +1,15 @@
+create_table :affiliates, id: :bigserial do |t|
+  t.string  :name, limit: 250, null: true
+  t.integer :category_id, limit: 8, null: false
+end
+create_table :advertisers, id: :bigserial do |t|
+  t.string  :name, limit: 250, null: true
+  t.integer :category_id, limit: 8, null: false
+end
+create_table :categories, id: :bigserial do |t|
+  t.string :name, limit: 250, null: true
+end
+add_index :affiliates, [:category_id], name: :index_affiliates_on_category_id
+add_index :advertisers, [:category_id], name: :index_advertisers_on_category_id
+add_foreign_key :affiliates, :categories, column: :category_id, name: :index_affiliates_on_category_id
+add_foreign_key :advertisers, :categories, column: :category_id, name: :index_advertisers_on_category_id

data/spec/fixtures/migrations/sqlite3/will_generate_unique_constraint_names_rails_6.txt

@@ -0,0 +1,15 @@
+create_table :categories, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+end
+create_table :advertisers, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string  :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+  t.integer :category_id, limit: 8, null: false
+end
+create_table :affiliates, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string  :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+  t.integer :category_id, limit: 8, null: false
+end
+add_index :advertisers, [:category_id], name: :index_advertisers_on_category_id
+add_index :affiliates, [:category_id], name: :index_affiliates_on_category_id
+add_foreign_key :advertisers, :categories, column: :category_id, name: :index_advertisers_on_category_id
+add_foreign_key :affiliates, :categories, column: :category_id, name: :index_affiliates_on_category_id

data/spec/fixtures/migrations/sqlite3/will_generate_unique_constraint_names_rails_7.txt

@@ -0,0 +1,15 @@
+create_table :affiliates, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string  :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+  t.integer :category_id, limit: 8, null: false
+end
+create_table :advertisers, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string  :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+  t.integer :category_id, limit: 8, null: false
+end
+create_table :categories, id: :bigint, options: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin" do |t|
+  t.string :name, limit: 250, null: true, charset: "utf8mb4", collation: "utf8mb4_bin"
+end
+add_index :affiliates, [:category_id], name: :index_affiliates_on_category_id
+add_index :advertisers, [:category_id], name: :index_advertisers_on_category_id
+add_foreign_key :affiliates, :categories, column: :category_id, name: :index_affiliates_on_category_id
+add_foreign_key :advertisers, :categories, column: :category_id, name: :index_advertisers_on_category_id

data/spec/lib/declare_schema/api_spec.rb

@@ -4,9 +4,7 @@ require 'rails'
 require 'rails/generators'
 
 RSpec.describe 'DeclareSchema API' do
-  before do
-    load File.expand_path('prepare_testapp.rb', __dir__)
-  end
+  include_context 'prepare test app'
 
   describe 'example models' do
     it 'generates a model' do
@@ -39,10 +37,6 @@ RSpec.describe 'DeclareSchema API' do
 
       load_models
 
-      if ActiveSupport::VERSION::MAJOR == 5
-        generate_migrations '-n', '-m'
-      end
-
       require 'advert'
       Advert.reset_primary_key
 

data/spec/lib/declare_schema/field_declaration_dsl_spec.rb

@@ -3,14 +3,14 @@
 require_relative '../../../lib/declare_schema/field_declaration_dsl'
 
 RSpec.describe DeclareSchema::FieldDeclarationDsl do
+  include_context 'prepare test app'
+
   let(:model) { TestModel.new }
   subject { declared_class.new(model) }
 
   context 'Using declare_schema' do
     before do
-      load File.expand_path('prepare_testapp.rb', __dir__)
-
-      class TestModel < ActiveRecord::Base
+      class TestModel < ActiveRecord::Base # rubocop:disable Lint/ConstantDefinitionInBlock
         declare_schema do
           string :name, limit: 127
 

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -1,26 +1,20 @@
 # frozen_string_literal: true
 
-begin
-  require 'mysql2'
-rescue LoadError
-end
-
-begin
-  require 'sqlite3'
-rescue LoadError
-end
-
 RSpec.describe DeclareSchema::Model::FieldSpec do
-  let(:model) { double('model', _table_options: {}, _declared_primary_key: 'id') }
-  let(:col_spec) { double('col_spec', type: :string) }
-
-  before do
-    load File.expand_path('prepare_testapp.rb', __dir__)
+  include_context 'prepare test app'
+
+  let(:model)    { double('model', _table_options: {}, _declared_primary_key: 'id') }
+  let(:col_spec) do
+    if current_adapter == 'postgresql'
+      instance_double(ActiveRecord::ConnectionAdapters::PostgreSQL::Column, type: :string, sql_type: 'character varying(100)', oid: 1043, fmod: 2052)
+    else
+      instance_double(ActiveRecord::ConnectionAdapters::Column, type: :string, sql_type: :string)
+    end
   end
 
   describe '#initialize' do
+    subject { described_class.new(model, :price, :integer, anonymize_using: 'x', null: false, position: 0, limit: 4) }
     it 'normalizes option order' do
-      subject = described_class.new(model, :price, :integer, anonymize_using: 'x', null: false, position: 0, limit: 4)
       expect(subject.options.keys).to eq([:limit, :null, :anonymize_using])
     end
 
@@ -33,48 +27,54 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
 
   describe '#schema_attributes' do
     describe 'integer 4' do
+      subject { described_class.new(model, :price, :integer, limit: 4, null: false, position: 0) }
       it 'returns schema attributes' do
-        subject = described_class.new(model, :price, :integer, limit: 4, null: false, position: 0)
         expect(subject.schema_attributes(col_spec)).to eq(type: :integer, limit: 4, null: false)
       end
     end
 
     describe 'integer 8' do
+      subject { described_class.new(model, :price, :integer, limit: 8, null: true, position: 2) }
       it 'returns schema attributes' do
-        subject = described_class.new(model, :price, :integer, limit: 8, null: true, position: 2)
         expect(subject.schema_attributes(col_spec)).to eq(type: :integer, limit: 8, null: true)
       end
     end
 
     describe 'bigint' do
+      subject { described_class.new(model, :price, :bigint, null: false, position: 2) }
       it 'returns schema attributes' do
-        subject = described_class.new(model, :price, :bigint, null: false, position: 2)
         expect(subject.schema_attributes(col_spec)).to eq(type: :integer, limit: 8, null: false)
       end
     end
 
     describe 'string' do
+      subject { described_class.new(model, :title, :string, limit: 100, null: true, charset: 'utf8mb4', position: 0) }
+
       it 'returns schema attributes (including charset/collation iff mysql)' do
-        subject = described_class.new(model, :title, :string, limit: 100, null: true, charset: 'utf8mb4', position: 0)
-        if defined?(Mysql2)
+        case current_adapter
+        when 'mysql2'
           expect(subject.schema_attributes(col_spec)).to eq(type: :string, limit: 100, null: true, charset: 'utf8mb4', collation: 'utf8mb4_bin')
         else
           expect(subject.schema_attributes(col_spec)).to eq(type: :string, limit: 100, null: true)
         end
       end
 
-      if defined?(Mysql2)
+      context 'MySQL only' do
+        include_context 'skip unless' do
+          let(:adapter) { 'mysql2' }
+        end
+
         context 'when running on MySQL 8.0' do
           around do |spec|
             DeclareSchema.mysql_version = Gem::Version.new('8.0.21')
             spec.run
           ensure
-            DeclareSchema.remove_instance_variable('@mysql_version') rescue nil
+            DeclareSchema.remove_instance_variable('@mysql_version') rescue nil # rubocop:disable Style/RescueModifier
           end
 
-          it 'normalizes charset and collation' do
-            subject = described_class.new(model, :title, :string, limit: 100, null: true, charset: 'utf8', collation: 'utf8_general', position: 0)
+          subject { described_class.new(model, :title, :string, limit: 100, null: true, charset: 'utf8', collation: 'utf8_general', position: 0) }
 
+          it 'normalizes charset and collation' do
             expect(subject.schema_attributes(col_spec)).to eq(type: :string, limit: 100, null: true, charset: 'utf8mb3', collation: 'utf8mb3_general')
           end
         end
@@ -89,9 +89,9 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
     end
 
     describe 'text' do
+      subject { described_class.new(model, :title, :text, limit: 200, null: true, charset: 'utf8mb4', position: 2) }
       it 'returns schema attributes (including charset/collation iff mysql)' do
-        subject = described_class.new(model, :title, :text, limit: 200, null: true, charset: 'utf8mb4', position: 2)
-        if defined?(Mysql2)
+        if current_adapter == 'mysql2'
           expect(subject.schema_attributes(col_spec)).to eq(type: :text, limit: 255, null: true, charset: 'utf8mb4', collation: 'utf8mb4_bin')
         else
           expect(subject.schema_attributes(col_spec)).to eq(type: :text, null: true)
@@ -99,7 +99,7 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       end
 
       it 'allows a default to be set unless mysql' do
-        if defined?(Mysql2)
+        if current_adapter == 'mysql2'
           expect do
             described_class.new(model, :title, :text, limit: 200, null: true, default: 'none', charset: 'utf8mb4', position: 2)
           end.to raise_exception(DeclareSchema::MysqlTextMayNotHaveDefault)
@@ -110,10 +110,10 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       end
 
       describe 'limit' do
+        subject { described_class.new(model, :title, :text, null: true, charset: 'utf8mb4', position: 2) }
         it 'uses default_text_limit option when not explicitly set in field spec' do
           allow(::DeclareSchema).to receive(:default_text_limit) { 100 }
-          subject = described_class.new(model, :title, :text, null: true, charset: 'utf8mb4', position: 2)
-          if defined?(Mysql2)
+          if current_adapter == 'mysql2'
             expect(subject.schema_attributes(col_spec)).to eq(type: :text, limit: 255, null: true, charset: 'utf8mb4', collation: 'utf8mb4_bin')
           else
             expect(subject.schema_attributes(col_spec)).to eq(type: :text, null: true)
@@ -121,11 +121,9 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
         end
 
         it 'raises error when default_text_limit option is nil when not explicitly set in field spec' do
-          if defined?(Mysql2)
+          if current_adapter == 'mysql2'
             expect(::DeclareSchema).to receive(:default_text_limit) { nil }
-            expect do
-              described_class.new(model, :title, :text, null: true, charset: 'utf8mb4', position: 2)
-            end.to raise_error(/limit: must be provided for :text field/)
+            expect { subject }.to raise_error(/limit: must be provided for :text field/)
           end
         end
       end
@@ -173,18 +171,22 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       end
     end
 
-    if defined?(Mysql2)
+    context 'MySQL only' do
+      include_context 'skip unless' do
+        let(:adapter) { 'mysql2' }
+      end
+
       describe 'varbinary' do # TODO: :varbinary is an Invoca addition to Rails; make it a configurable option
+        subject { described_class.new(model, :binary_dump, :varbinary, limit: 200, null: false, position: 2) }
         it 'is supported' do
-          subject = described_class.new(model, :binary_dump, :varbinary, limit: 200, null: false, position: 2)
           expect(subject.schema_attributes(col_spec)).to eq(type: :varbinary, limit: 200, null: false)
         end
       end
     end
 
     describe 'decimal' do
+      subject { described_class.new(model, :quantity, :decimal, precision: 8, scale: 10, null: true, position: 3) }
       it 'allows precision: and scale:' do
-        subject = described_class.new(model, :quantity, :decimal, precision: 8, scale: 10, null: true, position: 3)
         expect(subject.schema_attributes(col_spec)).to eq(type: :decimal, precision: 8, scale: 10, null: true)
       end
 
@@ -199,10 +201,18 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       end
     end
 
-    [:integer, :bigint, :string, :text, :binary, :datetime, :date, :time, (:varbinary if defined?(Mysql2))].compact.each do |t|
+    [:integer, :bigint, :string, :text, :binary, :datetime, :date, :time, :varbinary].compact.each do |t|
       describe t.to_s do
         let(:extra) { t == :string ? { limit: 100 } : {} }
 
+        around do |spec|
+          if t == :varbinary && current_adapter != 'mysql2'
+            spec.skip
+          else
+            spec.run
+          end
+        end
+
         it 'does not allow precision:' do
           expect_any_instance_of(described_class).to receive(:warn).with(/precision: only allowed for :decimal type/)
           described_class.new(model, :quantity, t, **{ precision: 8, null: true, position: 3 }.merge(extra))
@@ -216,25 +226,31 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
     end
 
     describe 'datetime' do
+      subject { described_class.new(model, :created_at, :datetime, null: false, position: 1) }
       it 'keeps type as "datetime"' do
-        subject = described_class.new(model, :created_at, :datetime, null: false, position: 1)
         expect(subject.schema_attributes(col_spec)).to eq(type: :datetime, null: false)
       end
     end
 
     describe 'timestamp' do
+      subject { described_class.new(model, :created_at, :timestamp, null: true, position: 2) }
       it 'normalizes type to "datetime"' do
-        subject = described_class.new(model, :created_at, :timestamp, null: true, position: 2)
         expect(subject.schema_attributes(col_spec)).to eq(type: :datetime, null: true)
       end
     end
 
     describe 'default:' do
-      let(:col_spec) { double('col_spec', type: :integer) }
+      subject { described_class.new(model, :price, :integer, limit: 4, default: '42', null: true, position: 2) }
+
+      let(:col_spec) do
+        if current_adapter == 'postgresql'
+          instance_double(ActiveRecord::ConnectionAdapters::PostgreSQL::Column, type: :integer, sql_type: "integer", limit: 4, oid: 23, fmod: -1)
+        else
+          instance_double(ActiveRecord::ConnectionAdapters::Column, type: :integer, sql_type: "integer", limit: 4)
+        end
+      end
 
       it 'typecasts default value' do
-        allow(col_spec).to receive(:type_cast_from_database) { |default| Integer(default) }
-        subject = described_class.new(model, :price, :integer, limit: 4, default: '42', null: true, position: 2)
         expect(subject.schema_attributes(col_spec)).to eq(type: :integer, limit: 4, default: 42, null: true)
       end
     end
@@ -242,8 +258,15 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
 
   describe '#schema_attributes' do
     let(:col_spec) do
-      sql_type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: "integer(8)", type: :integer, limit: 8)
-      ActiveRecord::ConnectionAdapters::Column.new("price", nil, sql_type_metadata, false, "adverts")
+      if current_adapter == 'postgresql'
+        instance_double(ActiveRecord::ConnectionAdapters::PostgreSQL::Column,
+                        name: "price", type: :integer, sql_type: "integer", limit: 4,
+                        null: false, default: nil, default_function: "adverts", oid: 23, fmod: -1)
+      else
+        instance_double(ActiveRecord::ConnectionAdapters::Column,
+                        name: "price", type: :integer, sql_type: "integer(8)", limit: 8,
+                        null: false, default: nil, default_function: "adverts")
+      end
     end
 
     it 'returns the attributes except name, position, and non-SQL options' do

data/spec/lib/declare_schema/generator_spec.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe 'DeclareSchema Migration Generator' do
-  before do
-    load File.expand_path('prepare_testapp.rb', __dir__)
-  end
+  include_context 'prepare test app'
 
   it "generates nested models" do
     generate_model 'alpha/beta', 'one:string', 'two:integer'
@@ -19,77 +17,37 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     EOS
 
-    if ActiveSupport::VERSION::MAJOR >= 7
-      expect_model_definition_to_eq('alpha', <<~EOS)
-        module Alpha
-          def self.table_name_prefix
-            "alpha_"
-          end
-        end
-      EOS
-    else
-      expect_model_definition_to_eq('alpha', <<~EOS)
-        module Alpha
-          def self.table_name_prefix
-            'alpha_'
-          end
+    expect_model_definition_to_eq('alpha', <<~EOS)
+      module Alpha
+        def self.table_name_prefix
+          #{ActiveSupport::VERSION::MAJOR >= 7 ? '"alpha_"' : "'alpha_'"}
         end
-      EOS
-    end
+      end
+    EOS
 
-    case ActiveSupport::VERSION::MAJOR
-    when 5
-      expect_test_definition_to_eq('alpha/beta', <<~EOS)
-        require "test_helper"
+    expect_test_definition_to_eq('alpha/beta', <<~EOS)
+      require "test_helper"
 
-        class Alpha::BetaTest < ActiveSupport::TestCase
-          # test "the truth" do
-          #   assert true
-          # end
-        end
-      EOS
-    else
-      expect_test_definition_to_eq('alpha/beta', <<~EOS)
-        require "test_helper"
-
-        class Alpha::BetaTest < ActiveSupport::TestCase
-          # test "the truth" do
-          #   assert true
-          # end
-        end
-      EOS
-    end
+      class Alpha::BetaTest < ActiveSupport::TestCase
+        # test "the truth" do
+        #   assert true
+        # end
+      end
+    EOS
 
-    case ActiveSupport::VERSION::MAJOR
-    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
+    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 #{ActiveSupport::VERSION::MAJOR >= 7 ? '"{}"' : "'{}'"} 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
 
     $LOAD_PATH << "#{TESTAPP_PATH}/app/models"
 
@@ -97,7 +55,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(File.exist?('db/schema.rb')).to be_truthy
 
-    if defined?(SQLite3)
+    if current_adapter == 'sqlite3'
       if ActiveSupport.version >= Gem::Version.new('7.1.0')
         expect(File.exist?("storage/development.sqlite3") || File.exist?("storage/test.sqlite3")).to be_truthy
       else

data/spec/lib/declare_schema/interactive_primary_key_spec.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
-begin
-  require 'mysql2'
-rescue LoadError
-end
-
 RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
-  before do
-    load File.expand_path('prepare_testapp.rb', __dir__)
-  end
+  include_context 'prepare test app'
 
   context 'Using declare_schema' do
     it "allows alternate primary keys" do
@@ -56,12 +49,12 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
       # (0.1ms)  DROP TABLE "afoos"
       #  (pry):17
       # (0.9ms)  commit transaction
-      if defined?(SQLite3)
+      if current_adapter == 'sqlite3'
         ActiveRecord::Base.connection.execute("drop table foos")
         ActiveRecord::Base.connection.execute("CREATE TABLE foos (id integer PRIMARY KEY AUTOINCREMENT NOT NULL)")
       end
 
-      if !defined?(Mysql2) # TODO TECH-4814 Put this test back for Mysql2
+      unless current_adapter == 'mysql2' # TODO TECH-4814 Put this test back for Mysql2
         # replace custom primary_key
         class Foo < ActiveRecord::Base
           declare_schema do