immigrant 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdd0fcce996e63a9bbd79d5846a03508a5eb6f37
-  data.tar.gz: 8223a67a2b04354b3d76a3914954e63f6497f69a
+  metadata.gz: 7ed3d771b38d02c5ff03b07c83d14e820703fe43
+  data.tar.gz: 8408b58635d65127dfcb28125bc23ff701abb442
 SHA512:
-  metadata.gz: bde334922bc6b593d7746e2f1a722cb936ad46b5f6de00e5a8c616163a96e12664a79527ba18163f11b102910385ba96ad0bd4f2d697cb4bf71837d58477a566
-  data.tar.gz: 76e6525a673b96efaa26506b4408f5db93010fac02d520ea03b0ce9606afd3f585f28bccbaa736b5494df5a531ac4d6013e4817bc25fa04bc9e150e0c193253e
+  metadata.gz: d81e14ec77a85039b8cd6fb9ca64b3bb25730ee4b232a220c37c1285340993b808d3ec82a2d721172fc2a5647ee934bf007774d76d32105761cd3279b8d98098
+  data.tar.gz: 29faf9f62a44d17984fd685600e38220a1e3cc355127c98fb810c4e76b1609ec8068eda4380e05a8738b38505c54fd2ab5435e855eba193bd019b0a9a602d42e

data/lib/immigrant.rb

@@ -33,15 +33,23 @@ module Immigrant
           if current_key.to_table != foreign_key.to_table || current_key.options[:primary_key] != foreign_key.options[:primary_key]
             warnings[hash_key] = "Skipping #{foreign_key.from_table}.#{foreign_key.options[:column]}: its association references a different key/table than its current foreign key"
           end
-        elsif !ignore_keys[hash_key]
-          new_keys << foreign_key
+          next
         end
+
+        next if ignore_keys[hash_key]
+        next unless key_validator.valid?(foreign_key)
+
+        new_keys << foreign_key
       end
       [new_keys.sort_by{ |key| key.options[:name] }, warnings]
     end
 
     private
 
+      def key_validator
+        @key_validator ||= KeyValidator.new
+      end
+
       def tables
         @tables ||= ActiveRecord::Base.connection.tables
       end
@@ -129,8 +137,6 @@ module Immigrant
         column = reflection.send(FOREIGN_KEY).to_s
         primary_key = (reflection.options[:primary_key] || reflection.klass.primary_key).to_s
 
-        return unless column_exists?(from_table, column)
-
         [
           ForeignKeyDefinition.new(
             from_table,
@@ -154,8 +160,6 @@ module Immigrant
           actions = {:on_delete => :cascade, :on_update => :cascade}
         end
 
-        return unless column_exists?(from_table, column)
-
         [
           ForeignKeyDefinition.new(
             from_table,
@@ -169,45 +173,32 @@ module Immigrant
       end
 
       def infer_habtm_keys(klass, reflection)
-        keys = []
-
         join_table = (reflection.respond_to?(:join_table) ? reflection.join_table : reflection.options[:join_table]).to_s
 
         left_to_table = klass.table_name
         left_column = reflection.send(FOREIGN_KEY).to_s
         left_primary_key = klass.primary_key.to_s
-        if column_exists?(join_table, left_column)
-          keys << ForeignKeyDefinition.new(
-            join_table,
-            left_to_table,
-            :column => left_column,
-            :primary_key => left_primary_key
-          )
-        end
 
         right_to_table = reflection.klass.table_name
         right_column = reflection.association_foreign_key.to_s
         right_primary_key = reflection.klass.primary_key.to_s
-        if column_exists?(join_table, left_column)
-          keys << ForeignKeyDefinition.new(
+
+        [
+          ForeignKeyDefinition.new(
+            join_table,
+            left_to_table,
+            :column => left_column,
+            :primary_key => left_primary_key
+          ),
+          ForeignKeyDefinition.new(
             join_table,
             right_to_table,
             :column => right_column,
             :primary_key => right_primary_key
           )
-        end
-
-        keys
-      end
-
-      def column_exists?(table_name, column_name)
-        columns_for(table_name).any? { |column| column.name == column_name }
+        ]
       end
 
-      def columns_for(table_name)
-        @columns ||= {}
-        @columns[table_name] ||= ActiveRecord::Base.connection.columns(table_name)
-      end
 
       def qualified_reflection?(reflection, klass)
         scope = reflection.scope
@@ -225,5 +216,6 @@ module Immigrant
 end
 
 require 'immigrant/loader'
+require 'immigrant/key_validator'
 require 'immigrant/foreign_key_extensions'
 require 'immigrant/railtie' if defined?(Rails)

data/lib/immigrant/key_validator.rb

@@ -0,0 +1,32 @@
+module Immigrant
+  class KeyValidator
+    def valid?(key)
+      tables = connection.tables
+      return false unless tables.include?(key.from_table)
+      return false unless tables.include?(key.to_table)
+      return false unless column_exists?(key.from_table, key.options[:column])
+      return false unless column_exists?(key.to_table, key.options[:primary_key])
+      return false unless key.options[:primary_key] == "id" || has_unique_index?(key.to_table, key.options[:primary_key])
+      true
+    end
+
+   private
+
+    def has_unique_index?(table_name, column_name)
+      connection.indexes(table_name).any? { |index| index.columns == [column_name] && index.unique && index.where.nil? }
+    end
+
+    def column_exists?(table_name, column_name)
+      columns_for(table_name).any? { |column| column.name == column_name }
+    end
+
+    def columns_for(table_name)
+      @columns ||= {}
+      @columns[table_name] ||= connection.columns(table_name)
+    end
+
+    def connection
+      @connection ||= ActiveRecord::Base.connection
+    end
+  end
+end

data/test/immigrant_test.rb

@@ -41,16 +41,21 @@ class ImmigrantTest < ActiveSupport::TestCase
       ActiveSupport::DescendantsTracker.direct_descendants(ActiveRecord::Base).map(&:table_name)
     end
     def columns(table_name)
-      AnyColumn.new
+      AnyCollection.new
+    end
+    def indexes(table_name)
+      AnyCollection.new
     end
   end
 
-  class AnyColumn
+  class AnyCollection
     def any?
       true
     end
   end
 
+  Index = ActiveRecord::ConnectionAdapters::IndexDefinition
+
   def teardown
     subclasses = ActiveSupport::DescendantsTracker.direct_descendants(ActiveRecord::Base)
     subclasses.each do |subclass|
@@ -455,6 +460,26 @@ class ImmigrantTest < ActiveSupport::TestCase
     end
   end
 
+  test 'insufficiently unique "primary" keys should not generate a foreign key' do
+    given <<-CODE
+      class Setting < ActiveRecord::Base; end
+
+      class SettingValue < ActiveRecord::Base
+        belongs_to :setting,
+                   :conditions => { :deleted_at => nil },
+                   foreign_key: :name, primary_key: :name
+      end
+    CODE
+
+    # emulate `"index_settings_on_name" UNIQUE, btree (name) WHERE deleted_at IS NULL`
+    # it's unique, but not enough for a foreign key just on name
+    indexes = [Index.new("settings", ["name"], true, "deleted_at IS NULL")]
+
+    MockConnection.stub_any_instance(:indexes, indexes) do
+      assert_equal([], infer_keys)
+    end
+  end
+
   test 'ignore_keys should be respected' do
     given <<-CODE
       class User <  ActiveRecord::Base; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immigrant
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Jon Jensen
@@ -48,6 +48,7 @@ files:
 - lib/immigrant/compat/active_record.rb
 - lib/immigrant/compat/foreigner.rb
 - lib/immigrant/foreign_key_extensions.rb
+- lib/immigrant/key_validator.rb
 - lib/immigrant/loader.rb
 - lib/immigrant/railtie.rb
 - lib/immigrant/task.rb