polymorpheus 1.0 → 1.1.0

data/README.md

@@ -69,8 +69,8 @@ Now let's review what we've done.
 * Instead of `imageable_type` and `imageable_id` columns in the pictures table, we've created explicit columns for the `employee_id` and `product_id`
 * The `add_polymorphic_constraints` call takes care of all of the database constraints you need, without you needing to worry about sql! Specifically it:
   * Creates foreign key relationships in the database as specified. So in this example, we have specified that the `employee_id` column in the `pictures` table should have a foreign key constraint with the `id` column of the `employees` table.
-  * Creates appropriate triggers in our database that make sure that exactly on or the other of `employee_id` or `poduct_id` are specified for a given record. An exception will be raised if you try to save a database record that contains both or none of them.
-* **Options for migrations**: There are options to add uniqueness constraints, customize the foreign keys generated by Polymorpheus, and specify the name of generated database indexes. For more info on this, [read the wiki entry](https://github.com/wegowise/polymorpheus/wiki/Migration-options).
+  * Creates appropriate triggers in our database that make sure that exactly on or the other of `employee_id` or `product_id` are specified for a given record. An exception will be raised if you try to save a database record that contains both or none of them.
+* **Options for migrations**: There are options to customize the foreign keys generated by Polymorpheus and add uniqueness constraints. For more info on this, [read the wiki entry](https://github.com/wegowise/polymorpheus/wiki/Migration-options).
 
 ## Model definitions
 

data/lib/polymorpheus/mysql_adapter.rb

@@ -55,8 +55,7 @@ module Polymorpheus
       def remove_polymorphic_constraints(table, columns, options = {})
         poly_drop_triggers(table, columns.keys.sort)
         columns.each do |(col, reference)|
-          ref_table, ref_col = reference.to_s.split('.')
-          remove_foreign_key table, ref_table
+          remove_foreign_key table, :column => col
         end
         if options[:unique].present?
           poly_remove_indexes(table, columns.keys, Array(options[:unique]))

data/lib/polymorpheus/version.rb

@@ -1,3 +1,3 @@
 module Polymorpheus
-  VERSION = '1.0'
+  VERSION = '1.1.0'
 end

data/polymorpheus.gemspec

@@ -5,14 +5,20 @@ require File.dirname(__FILE__) + "/lib/polymorpheus/version"
 Gem::Specification.new do |s|
   s.name        = "polymorpheus"
   s.version     = Polymorpheus::VERSION
+
   s.authors     = ["Barun Singh"]
   s.email       = "bsingh@wegowise.com"
   s.homepage    = "http://github.com/wegowise/polymorpheus"
   s.summary     = "Provides a database-friendly method for polymorphic relationships"
   s.description = "Provides a database-friendly method for polymorphic relationships"
+
   s.required_rubygems_version = ">= 1.3.6"
   s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]*.{txt,rdoc,md} *.gemspec]) + %w{Rakefile}
   s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
   s.license = 'MIT'
+
   s.add_dependency('foreigner')
+  s.add_dependency('activerecord', '>=3.0')
+  s.add_development_dependency('rspec-rails')
+  s.add_development_dependency('mysql2')
 end

data/spec/mysql2_adapter_spec.rb

@@ -5,11 +5,16 @@ require 'foreigner'
 require 'foreigner/connection_adapters/mysql2_adapter'
 require 'polymorpheus'
 require 'polymorpheus/trigger'
+require 'shared_examples'
 
 Polymorpheus::Adapter.load!
 
 describe Polymorpheus::ConnectionAdapters::MysqlAdapter do
 
+  #######################################################
+  # Setup
+  #######################################################
+
   before(:all) do
     class << ActiveRecord::Base.connection
       include Polymorpheus::SqlLogger
@@ -27,174 +32,80 @@ describe Polymorpheus::ConnectionAdapters::MysqlAdapter do
   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*$/,"")
+  end
+
   before do
     connection.clear_sql_history
     subject
   end
 
-  shared_examples_for "migration statements" do
-    describe "#add_polymorphic_constraints" do
-      before { connection.add_polymorphic_constraints(table, columns, options) }
-
-      specify do
-        clean_sql(sql.join("\n")).should == clean_sql(full_constraints_sql)
-      end
-    end
-
-    describe "#add_polymorphic_triggers" do
-      before { connection.add_polymorphic_triggers(table, columns.keys) }
-
-      specify do
-        clean_sql(sql.join("\n")).should == clean_sql(trigger_sql)
-      end
-    end
-  end
+  #######################################################
+  # Specs
+  #######################################################
 
-  context "when the table and column names are not too long" do
-    let(:table) { 'pets' }
-    let(:columns) { { 'kitty_id' => 'cats.name', 'dog_id' => 'dogs.id' } }
-    let(:options) { {} }
-
-    let(:trigger_sql) do
-      %{
-        DROP TRIGGER IF EXISTS pfki_pets_dogid_kittyid
-        DROP TRIGGER IF EXISTS pfku_pets_dogid_kittyid
-        CREATE TRIGGER pfki_pets_dogid_kittyid BEFORE INSERT ON pets
-          FOR EACH ROW
-            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
-        CREATE TRIGGER pfku_pets_dogid_kittyid BEFORE UPDATE ON pets
-          FOR EACH ROW
-            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
-      }
-    end
+  describe "migration statements" do
+    context "basic case with no uniqueness constraints" do
+      include_context "columns with short names"
+      let(:options) { {} }
 
-    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)
-      }
+      it_behaves_like "mysql2 migration statements"
     end
 
-    let(:full_constraints_sql) { trigger_sql + fkey_sql }
-
-    it_behaves_like "migration statements"
-
-    context "and we specify a uniqueness constraint as true" do
+    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)
-        }
+        %{ 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
 
-      let(:full_constraints_sql) { trigger_sql + unique_key_sql + fkey_sql }
-
-      it_behaves_like "migration statements"
+      it_behaves_like "mysql2 migration statements"
     end
 
-    context "and we specify a uniqueness constraint as a string" do
+    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)
-        }
+        %{ 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
 
-      let(:full_constraints_sql) { trigger_sql + unique_key_sql + fkey_sql }
-
-      it_behaves_like "migration statements"
+      it_behaves_like "mysql2 migration statements"
     end
 
-    context "and we specify a uniqueness constraint as an array" do
+    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(:full_constraints_sql) { trigger_sql + unique_key_sql + fkey_sql }
-
-      it_behaves_like "migration statements"
-    end
-
-    context "and we specify a uniqueness constraint on fields with really long names" do
-      let(:options) do
-        { :unique => [:fee_was_a_buddhist_prodigy, :ground_control_to_major_tom] }
+        %{ 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(:unique_key_sql) do
-        %{
-          CREATE UNIQUE INDEX pfk_pets_dogid_feewasabuddhistpr_groundcontroltoma ON pets (dog_id, fee_was_a_buddhist_prodigy, ground_control_to_major_tom)
-          CREATE UNIQUE INDEX pfk_pets_kittyid_feewasabuddhistpr_groundcontroltoma ON pets (kitty_id, fee_was_a_buddhist_prodigy, ground_control_to_major_tom)
-        }
+      let(:remove_indices_sql) do
+        %{ DROP INDEX pfk_pets_kittyid_foo_bar ON pets
+           DROP INDEX pfk_pets_dogid_foo_bar ON pets }
       end
 
-      let(:full_constraints_sql) { trigger_sql + unique_key_sql + fkey_sql }
-
-      it_behaves_like "migration statements"
-    end
-  end
-
-  context "when the table and column names combined are very long" do
-    let(:table) { 'bicycles' }
-    let(:columns) do
-       { 'im_too_cool_to_vote_and_ill_only_ride_a_fixie' => 'hipster.id',
-         'really_im_not_doping_i_just_practice_a_lot' => 'professional.id' }
-    end
-    let(:options) { {} }
-
-    let(:trigger_sql) do
-      %{
-        DROP TRIGGER IF EXISTS pfki_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
-        DROP TRIGGER IF EXISTS pfku_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
-        CREATE TRIGGER pfki_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr BEFORE INSERT ON bicycles
-          FOR EACH ROW
-            BEGIN
-              IF(IF(NEW.im_too_cool_to_vote_and_ill_only_ride_a_fixie IS NULL, 0, 1) + IF(NEW.really_im_not_doping_i_just_practice_a_lot IS NULL, 0, 1)) <> 1 THEN
-                SET NEW = 'Error';
-              END IF;
-            END
-        CREATE TRIGGER pfku_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr BEFORE UPDATE ON bicycles
-          FOR EACH ROW
-            BEGIN
-              IF(IF(NEW.im_too_cool_to_vote_and_ill_only_ride_a_fixie IS NULL, 0, 1) + IF(NEW.really_im_not_doping_i_just_practice_a_lot IS NULL, 0, 1)) <> 1 THEN
-                SET NEW = 'Error';
-              END IF;
-            END
-      }
+      it_behaves_like "mysql2 migration statements"
     end
 
-    let(:fkey_sql) do
-      %{
-        ALTER TABLE `bicycles` ADD CONSTRAINT `bicycles_im_too_cool_to_vote_and_ill_only_ride_a_fixie_fk` FOREIGN KEY (`im_too_cool_to_vote_and_ill_only_ride_a_fixie`) REFERENCES `hipster`(id)
-        ALTER TABLE `bicycles` ADD CONSTRAINT `bicycles_really_im_not_doping_i_just_practice_a_lot_fk` FOREIGN KEY (`really_im_not_doping_i_just_practice_a_lot`) REFERENCES `professional`(id)
-      }
-    end
+    context "when table and column names combined are very long" do
+      include_context "columns with long names"
 
-    let(:unique_key_sql) do
-      %{
-        CREATE UNIQUE INDEX pfk_blah
-      }
+      it_behaves_like "mysql2 migration statements"
     end
-
-    let(:full_constraints_sql) { trigger_sql + fkey_sql }
-
-    it_behaves_like "migration statements"
   end
 
-
-
   describe "#triggers" do
     let(:trigger1) { stub(Trigger, :name => '1') }
     let(:trigger2) { stub(Trigger, :name => '2') }
@@ -209,10 +120,4 @@ describe Polymorpheus::ConnectionAdapters::MysqlAdapter do
       connection.triggers.should == [trigger1, trigger2]
     end
   end
-
-
-  def clean_sql(sql_string)
-    sql_string.gsub(/^\n\s*/,'').gsub(/\s*\n\s*$/,'').gsub(/\n\s*/,"\n")
-  end
-
 end

data/spec/shared_examples.rb

@@ -0,0 +1,115 @@
+shared_examples_for "mysql2 migration statements" do
+  describe "#add_polymorphic_constraints" do
+    before { connection.add_polymorphic_constraints(table, columns, options) }
+
+    specify do
+      clean_sql(sql.join("\n")).should == clean_sql(full_constraints_sql)
+    end
+  end
+
+  describe "#add_polymorphic_triggers" do
+    before { connection.add_polymorphic_triggers(table, columns.keys) }
+
+    specify do
+      clean_sql(sql.join("\n")).should == clean_sql(trigger_sql)
+    end
+  end
+
+  describe "#remove_polymorphic_constraints" do
+    before { connection.remove_polymorphic_constraints(table, columns, options) }
+
+    specify do
+      clean_sql(sql.join("\n")).should == clean_sql(remove_constraints_sql)
+    end
+  end
+end
+
+shared_context "columns with short names" do
+  let(:table) { 'pets' }
+  let(:columns) { { 'kitty_id' => 'cats.name', 'dog_id' => 'dogs.id' } }
+  let(:trigger_sql) do
+    %{
+      DROP TRIGGER IF EXISTS pfki_pets_dogid_kittyid
+      DROP TRIGGER IF EXISTS pfku_pets_dogid_kittyid
+      CREATE TRIGGER pfki_pets_dogid_kittyid BEFORE INSERT ON pets
+        FOR EACH ROW
+          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
+      CREATE TRIGGER pfku_pets_dogid_kittyid BEFORE UPDATE ON pets
+        FOR EACH ROW
+          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
+    }
+  end
+  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
+  let(:unique_key_sql) { '' }
+  let(:full_constraints_sql) { trigger_sql + unique_key_sql + fkey_sql }
+  let(:remove_indices_sql) { '' }
+  let(:remove_constraints_sql) do
+    %{
+      DROP TRIGGER IF EXISTS pfki_pets_dogid_kittyid
+      DROP TRIGGER IF EXISTS pfku_pets_dogid_kittyid
+      ALTER TABLE `pets` DROP FOREIGN KEY `pets_kitty_id_fk`
+      ALTER TABLE `pets` DROP FOREIGN KEY `pets_dog_id_fk`
+    } +
+    remove_indices_sql
+  end
+end
+
+shared_context "columns with long names" do
+  let(:table) { 'bicycles' }
+  let(:columns) do
+     { 'im_too_cool_to_vote_and_ill_only_ride_a_fixie' => 'hipster.id',
+       'really_im_not_doping_i_just_practice_a_lot' => 'professional.id' }
+  end
+  let(:options) { {} }
+
+  let(:trigger_sql) do
+    %{
+      DROP TRIGGER IF EXISTS pfki_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
+      DROP TRIGGER IF EXISTS pfku_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
+      CREATE TRIGGER pfki_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr BEFORE INSERT ON bicycles
+        FOR EACH ROW
+          BEGIN
+            IF(IF(NEW.im_too_cool_to_vote_and_ill_only_ride_a_fixie IS NULL, 0, 1) + IF(NEW.really_im_not_doping_i_just_practice_a_lot IS NULL, 0, 1)) <> 1 THEN
+              SET NEW = 'Error';
+            END IF;
+          END
+      CREATE TRIGGER pfku_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr BEFORE UPDATE ON bicycles
+        FOR EACH ROW
+          BEGIN
+            IF(IF(NEW.im_too_cool_to_vote_and_ill_only_ride_a_fixie IS NULL, 0, 1) + IF(NEW.really_im_not_doping_i_just_practice_a_lot IS NULL, 0, 1)) <> 1 THEN
+              SET NEW = 'Error';
+            END IF;
+          END
+    }
+  end
+
+  let(:fkey_sql) do
+    %{
+      ALTER TABLE `bicycles` ADD CONSTRAINT `bicycles_im_too_cool_to_vote_and_ill_only_ride_a_fixie_fk` FOREIGN KEY (`im_too_cool_to_vote_and_ill_only_ride_a_fixie`) REFERENCES `hipster`(id)
+      ALTER TABLE `bicycles` ADD CONSTRAINT `bicycles_really_im_not_doping_i_just_practice_a_lot_fk` FOREIGN KEY (`really_im_not_doping_i_just_practice_a_lot`) REFERENCES `professional`(id)
+    }
+  end
+
+  let(:full_constraints_sql) { trigger_sql + fkey_sql }
+  let(:remove_constraints_sql) do
+    %{
+      DROP TRIGGER IF EXISTS pfki_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
+      DROP TRIGGER IF EXISTS pfku_bicycles_imtoocooltovoteandillonl_reallyimnotdopingijustpr
+      ALTER TABLE `bicycles` DROP FOREIGN KEY `bicycles_im_too_cool_to_vote_and_ill_only_ride_a_fixie_fk`
+      ALTER TABLE `bicycles` DROP FOREIGN KEY `bicycles_really_im_not_doping_i_just_practice_a_lot_fk`
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polymorpheus
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000Z
+date: 2012-10-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreigner
-  requirement: &2151832820 !ruby/object:Gem::Requirement
+  requirement: &70167733248880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,40 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151832820
+  version_requirements: *70167733248880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70167733248340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167733248340
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70167733247920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70167733247920
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &70167733247460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70167733247460
 description: Provides a database-friendly method for polymorphic relationships
 email: bsingh@wegowise.com
 executables: []
@@ -42,6 +75,7 @@ files:
 - spec/interface_spec.rb
 - spec/mysql2_adapter_spec.rb
 - spec/schema_dumper_spec.rb
+- spec/shared_examples.rb
 - spec/spec_helper.rb
 - spec/sql_logger.rb
 - spec/trigger_spec.rb
@@ -62,9 +96,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2769054126994398138
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: