polymorpheus 3.1.0 → 3.1.1

data/spec/mysql2_adapter_spec.rb

@@ -1,167 +1,317 @@
-require 'active_record'
 require 'spec_helper'
-require 'sql_logger'
-require 'polymorpheus'
-require 'polymorpheus/trigger'
-require 'shared_examples'
-
-Polymorpheus::Adapter.load!
 
 describe Polymorpheus::ConnectionAdapters::MysqlAdapter do
+  # The foreign key name is not truncated, so the maximum column name
+  # length ends up being:  64 - "pets_" - "_fk" == 56
+  #
+  # Using `t.references` also adds an index on this column, with a slightly
+  # longer name: 64 - "index_pets_on_" - "_id" == 46
+  #
+  # Go with the shorter of the two here, since it's still long enough to test
+  # the generation of Polymorpheus' trigger names.
+  let(:long_column1) { ('x' * 46).to_sym }
+  let(:long_column2) { ('y' * 46).to_sym }
 
-  #######################################################
-  # Setup
-  #######################################################
-
-  before(:all) do
-    class << ActiveRecord::Base.connection
-      include Polymorpheus::SqlLogger
-      alias_method :original_execute, :execute
-      alias_method :execute, :log_sql_statements
+  before do
+    create_table(:pets) do |t|
+      t.references :cat
+      t.references :dog
+      t.string :name
+      t.string :color
     end
-  end
 
-  after(:all) do
-    class << ActiveRecord::Base.connection
-      alias_method :execute, :original_execute
-    end
-  end
+    create_table(:cats)
+    create_table(:dogs)
 
-  let(:connection) { ActiveRecord::Base.connection }
-  let(:sql) { connection.sql_statements }
-
-  def clean_sql(sql_string)
-    sql_string.gsub(/^\n\s*/,'').gsub(/\s*\n\s*$/,'')
-      .gsub(/\n\s*/,"\n").gsub(/\s*$/,"")
-      .gsub('`', '')
-      .gsub(/\ FOREIGN KEY/, "\nFOREIGN KEY")
-      .gsub(/\ REFERENCES/, "\nREFERENCES")
-      .gsub(/\ ON DELETE/, "\nON DELETE")
-      .gsub(/\ ON UPDATE/, "\nON UPDATE")
-      .gsub(/([[:alpha:]])\(/, '\1 (')
+    clear_sql_history
   end
 
-  before do
-    connection.clear_sql_history
-    subject
+  after do
+    drop_table :pets
+    drop_table :cats
+    drop_table :dogs
   end
 
   #######################################################
   # Specs
   #######################################################
 
-  describe "migration statements" do
-    context "basic case with no uniqueness constraints" do
-      include_context "columns with short names"
-      let(:options) { {} }
+  describe '#add_polymorphic_constraints' do
+    it 'adds foreign keys with no uniqueness constraints' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' }
+      )
+
+      should_execute_sql <<-EOS
+        DROP TRIGGER IF EXISTS pfki_pets_catid_dogid
+        DROP TRIGGER IF EXISTS pfku_pets_catid_dogid
+        CREATE TRIGGER pfki_pets_catid_dogid BEFORE INSERT ON pets
+          FOR EACH ROW
+            BEGIN
+              IF(IF(NEW.cat_id IS NULL, 0, 1) + IF(NEW.dog_id IS NULL, 0, 1)) <> 1 THEN
+                SET NEW = 'Error';
+              END IF;
+            END
+        CREATE TRIGGER pfku_pets_catid_dogid BEFORE UPDATE ON pets
+          FOR EACH ROW
+            BEGIN
+              IF(IF(NEW.cat_id IS NULL, 0, 1) + IF(NEW.dog_id IS NULL, 0, 1)) <> 1 THEN
+                SET NEW = 'Error';
+              END IF;
+            END
+
+        ALTER TABLE `pets` ADD CONSTRAINT `pets_cat_id_fk`
+        FOREIGN KEY (`cat_id`)
+        REFERENCES `cats`(id)
 
-      it_behaves_like "mysql2 migration statements"
+        ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk`
+        FOREIGN KEY (`dog_id`)
+        REFERENCES `dogs`(id)
+      EOS
     end
 
-    context "when uniqueness constraint is specified as true" do
-      include_context "columns with short names"
-      let(:options) { { :unique => true } }
-      let(:unique_key_sql) do
-        %{ CREATE UNIQUE INDEX pfk_pets_dogid ON pets (dog_id)
-           CREATE UNIQUE INDEX pfk_pets_kittyid ON pets (kitty_id) }
-      end
-      let(:remove_indices_sql) do
-        %{ DROP INDEX pfk_pets_kittyid ON pets
-           DROP INDEX pfk_pets_dogid ON pets }
-      end
+    it 'adds uniqueness specified with true' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: true
+      )
 
-      it_behaves_like "mysql2 migration statements"
+      should_execute_sql <<-EOS
+        CREATE UNIQUE INDEX pfk_pets_catid ON pets (cat_id)
+        CREATE UNIQUE INDEX pfk_pets_dogid ON pets (dog_id)
+      EOS
     end
 
-    context "specifying uniqueness constraint as a string" do
-      include_context "columns with short names"
-      let(:options) { { :unique => 'field1' } }
-      let(:unique_key_sql) do
-        %{ CREATE UNIQUE INDEX pfk_pets_dogid_field1 ON pets (dog_id, field1)
-           CREATE UNIQUE INDEX pfk_pets_kittyid_field1 ON pets (kitty_id, field1) }
-      end
-      let(:remove_indices_sql) do
-        %{ DROP INDEX pfk_pets_kittyid_field1 ON pets
-           DROP INDEX pfk_pets_dogid_field1 ON pets }
-      end
+    it 'adds uniqueness specified with a string' do
+      add_polymorphic_constraints('pets', { cat_id: 'cats.id' }, unique: 'name')
+      should_execute_sql <<-EOS
+        CREATE UNIQUE INDEX pfk_pets_catid_name ON pets (cat_id, name)
+      EOS
+    end
 
-      it_behaves_like "mysql2 migration statements"
+    it 'adds uniqueness specified as an array' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id' },
+        unique: [:name, :color]
+      )
+      should_execute_sql <<-EOS
+        CREATE UNIQUE INDEX pfk_pets_catid_name_color ON pets (cat_id, name, color)
+      EOS
     end
 
-    context "specifying uniqueness constraint as an array" do
-      include_context "columns with short names"
-      let(:options) { { :unique => [:foo, :bar] } }
-      let(:unique_key_sql) do
-        %{ CREATE UNIQUE INDEX pfk_pets_dogid_foo_bar ON pets (dog_id, foo, bar)
-           CREATE UNIQUE INDEX pfk_pets_kittyid_foo_bar ON pets (kitty_id, foo, bar) }
-      end
-      let(:remove_indices_sql) do
-        %{ DROP INDEX pfk_pets_kittyid_foo_bar ON pets
-           DROP INDEX pfk_pets_dogid_foo_bar ON pets }
-      end
+    it 'adds an on update constraint' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id' },
+        on_update: :cascade
+      )
+      should_execute_sql <<-EOS
+        ALTER TABLE `pets` ADD CONSTRAINT `pets_cat_id_fk`
+        FOREIGN KEY (`cat_id`)
+        REFERENCES `cats`(id)
+        ON UPDATE CASCADE
+      EOS
+    end
 
-      it_behaves_like "mysql2 migration statements"
+    it 'raises an error when on_update has invalid arguments' do
+      expect do
+        add_polymorphic_constraints(
+          'pets',
+          { cat_id: 'cats.id' },
+          on_update: :invalid
+        )
+      end.to raise_error ArgumentError
     end
 
-    context "specifying an on update constraint" do
-      include_context "columns with short names"
-      let(:options) { { :on_update => :cascade } }
-      let(:fkey_sql) do
-        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id) ON UPDATE CASCADE
-           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) ON UPDATE CASCADE }
-      end
+    it 'adds an on delete constraint' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id' },
+        on_delete: :cascade
+      )
+      should_execute_sql <<-EOS
+        ALTER TABLE `pets` ADD CONSTRAINT `pets_cat_id_fk`
+        FOREIGN KEY (`cat_id`)
+        REFERENCES `cats`(id)
+        ON DELETE CASCADE
+      EOS
+    end
 
-      it_behaves_like "mysql2 migration statements"
+    it 'raises an error when on_delete has invalid arguments' do
+      expect do
+        add_polymorphic_constraints(
+          'pets',
+          { cat_id: 'cats.id' },
+          on_update: :invalid
+        )
+      end.to raise_error ArgumentError
     end
 
-    context "specifying on delete and on update constraints" do
-      include_context "columns with short names"
-      let(:options) { { :on_update => :cascade, :on_delete => :restrict } }
-      let(:fkey_sql) do
-        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id) ON DELETE RESTRICT ON UPDATE CASCADE
-           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) ON DELETE RESTRICT ON UPDATE CASCADE }
+    it 'truncates long trigger names to 64 characters' do
+      create_table(:pets) do |t|
+        t.references long_column1
+        t.references long_column2
       end
 
-      it_behaves_like "mysql2 migration statements"
+      add_polymorphic_constraints(
+        'pets',
+        { "#{long_column1}_id" => 'cats.id', "#{long_column2}_id" => 'dogs.id' }
+      )
+
+      should_execute_sql <<-EOS
+        DROP TRIGGER IF EXISTS pfki_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy
+        DROP TRIGGER IF EXISTS pfku_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy
+        CREATE TRIGGER pfki_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy BEFORE INSERT ON pets
+          FOR EACH ROW
+            BEGIN
+              IF(IF(NEW.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_id IS NULL, 0, 1) + IF(NEW.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy_id IS NULL, 0, 1)) <> 1 THEN
+                SET NEW = 'Error';
+              END IF;
+            END
+        CREATE TRIGGER pfku_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy BEFORE UPDATE ON pets
+          FOR EACH ROW
+            BEGIN
+              IF(IF(NEW.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_id IS NULL, 0, 1) + IF(NEW.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy_id IS NULL, 0, 1)) <> 1 THEN
+                SET NEW = 'Error';
+              END IF;
+            END
+      EOS
     end
+  end
 
-    context "when on_delete and on_update have invalid arguments" do
-      include_context "columns with short names"
-      let(:options) { { :on_update => :invalid, :on_delete => nil } }
-      let(:fkey_sql) do
-        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id)
-           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) }
-      end
+  describe '#remove_polymorphic_constraints' do
+    it 'removes triggers and foreign keys with no uniqueness constraints' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: true
+      )
+      clear_sql_history
 
-      it "#add_polymorphic_constraints raises an argument error" do
-        expect do
-          connection.add_polymorphic_constraints(table, columns, options)
-        end.to raise_error ArgumentError
-      end
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' }
+      )
+      should_execute_sql <<-EOS
+        DROP TRIGGER IF EXISTS pfki_pets_catid_dogid
+        DROP TRIGGER IF EXISTS pfku_pets_catid_dogid
+      EOS
+    end
+
+    it 'removes uniqueness index specified with true' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: true
+      )
+      clear_sql_history
 
-      it_behaves_like 'mysql2 add sql for polymorphic triggers'
-      it_behaves_like 'mysql2 remove sql for polymorphic constraints'
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: true
+      )
+      should_execute_sql <<-EOS
+        DROP INDEX pfk_pets_catid ON pets
+        DROP INDEX pfk_pets_dogid ON pets
+      EOS
     end
 
-    context "when table and column names combined are very long" do
-      include_context "columns with long names"
+    it 'removes uniqueness index specified with a string' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: 'name'
+      )
+      clear_sql_history
+
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: 'name'
+      )
 
-      it_behaves_like "mysql2 migration statements"
     end
-  end
 
-  describe "#triggers" do
-    let(:trigger1) { double(Trigger, :name => '1') }
-    let(:trigger2) { double(Trigger, :name => '2') }
+    it 'removes uniqueness index specified with an array' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: [:name, :color]
+      )
+      clear_sql_history
+
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        unique: [:name, :color]
+      )
+
+    end
+
+    it 'removes an on update constraint' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        on_update: :cascade
+      )
+      clear_sql_history
+
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        on_update: :cascade
+      )
+
+    end
+
+    it 'removes an on delete constraint' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        on_delete: :cascade
+      )
+      clear_sql_history
+
+      remove_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' },
+        on_update: :cascade
+      )
 
-    before do
-      connection.stub_sql('show triggers', [:trigger1, :trigger2])
-      Trigger.stub(:new).with(:trigger1).and_return(trigger1)
-      Trigger.stub(:new).with(:trigger2).and_return(trigger2)
     end
 
-    specify do
-      connection.triggers.should == [trigger1, trigger2]
+    it 'truncates long trigger names to 64 characters' do
+      create_table(:pets) do |t|
+        t.references long_column1
+        t.references long_column2
+      end
+      args = [
+        'pets',
+        { "#{long_column1}_id" => 'cats.id', "#{long_column2}_id" => 'dogs.id' }
+      ]
+      add_polymorphic_constraints(*args)
+      clear_sql_history
+      remove_polymorphic_constraints(*args)
+      should_execute_sql <<-EOS
+        DROP TRIGGER IF EXISTS pfki_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy
+        DROP TRIGGER IF EXISTS pfku_pets_xxxxxxxxxxxxxxxxxxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyy
+      EOS
+    end
+  end
+
+  describe "#triggers" do
+    it 'returns the triggers for the current schema' do
+      add_polymorphic_constraints(
+        'pets',
+        { cat_id: 'cats.id', dog_id: 'dogs.id' }
+      )
+      expect(triggers.map(&:name)).to eq(
+        ['pfki_pets_catid_dogid', 'pfku_pets_catid_dogid']
+      )
     end
   end
 end

data/spec/schema_dumper_spec.rb

@@ -1,38 +1,32 @@
-require 'active_record'
 require 'spec_helper'
-require 'sql_logger'
-require 'polymorpheus'
-require 'polymorpheus/trigger'
-require 'stringio'
-
-# this is normally done via a Railtie in non-testing situations
-ActiveRecord::SchemaDumper.class_eval { include Polymorpheus::SchemaDumper }
 
 describe Polymorpheus::SchemaDumper do
-
   let(:connection) { ActiveRecord::Base.connection }
   let(:stream) { StringIO.new }
 
   before do
-    # pretend like we have a trigger defined
-    connection.stub(:triggers).and_return(
-      [Trigger.new(["trigger_name", "INSERT", "pets",
-        %{BEGIN
-            IF(IF(NEW.dog_id IS NULL, 0, 1) + IF(NEW.kitty_id IS NULL, 0, 1)) <> 1 THEN
-              SET NEW = 'Error';
-            END IF;
-          END},
-        "BEFORE", nil, "", "production@%", "utf8", "utf8_general_ci",
-        "utf8_unicode_ci"])]
+    create_table :story_arcs do |t|
+      t.references :hero
+      t.references :villain
+    end
+    create_table :heros
+    create_table :villains
+    ActiveRecord::Base.connection.add_polymorphic_constraints(
+      'story_arcs',
+      { hero_id: 'heros.id', villain_id: 'villains.id' }
     )
 
     ActiveRecord::SchemaDumper.dump(connection, stream)
   end
 
+  after do
+    drop_table :story_arcs # drop first, due to the foreign key
+  end
+
   subject { stream.string }
 
   let(:schema_statement) do
-    %{  add_polymorphic_triggers(:pets, ["dog_id", "kitty_id"])}
+    %{  add_polymorphic_triggers(:story_arcs, ["hero_id", "villain_id"])}
   end
 
   specify "the schema statement is part of the dump" do
@@ -42,5 +36,4 @@ describe Polymorpheus::SchemaDumper do
   specify "there is exactly one instance of the schema statement" do
     subject.index(schema_statement).should == subject.rindex(schema_statement)
   end
-
 end