immigrant 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dc2d24a68bb12d527576e6b877f143f2c42bf63
-  data.tar.gz: 02333cc92bc40d48c3f7e043b842432ee5998e00
+  metadata.gz: bdd0fcce996e63a9bbd79d5846a03508a5eb6f37
+  data.tar.gz: 8223a67a2b04354b3d76a3914954e63f6497f69a
 SHA512:
-  metadata.gz: 165a88a133f812b38899ea19b2d0fc079956d5fae1c4c2814c53569d8da37502c3c37d6052d7069c171c43a671426eecfaac49710cec5854c561d9c45e3abd03
-  data.tar.gz: be53c1539e0c349c76afd32136fdec1df908f15ca25357e5321f77d76d1b7768d414516dae27814339c0fc040fa387a4196944927d298364d66e18868e976819
+  metadata.gz: bde334922bc6b593d7746e2f1a722cb936ad46b5f6de00e5a8c616163a96e12664a79527ba18163f11b102910385ba96ad0bd4f2d697cb4bf71837d58477a566
+  data.tar.gz: 76e6525a673b96efaa26506b4408f5db93010fac02d520ea03b0ce9606afd3f585f28bccbaa736b5494df5a531ac4d6013e4817bc25fa04bc9e150e0c193253e

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jon Jensen
+Copyright (c) 2012-2015 Jon Jensen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -35,6 +35,22 @@ task you can add to your CI setup.  Just run `rake immigrant:check_keys`,
 and if anything is missing it will tell you about it and exit with a
 non-zero status.
 
+### Skipping associations
+
+`Immigrant.ignore_keys` allows you to specify a list of keys that should
+be ignored (both in the migration generator and the rake task). This is
+useful if you have associations spanning databases.
+
+Just create an config/initializers/immigrant.rb file with something like
+the following:
+
+```ruby
+Immigrant.ignore_keys = [
+  { from_table: "users", column: "account_id" },
+  # etc
+]
+```
+
 ## Considerations
 
 If the data in your tables is bad, then the migration will fail to run
@@ -46,10 +62,10 @@ add foreign keys.
 Immigrant currently only looks for foreign keys in `ActiveRecord::Base`'s
 database. So if a model is using a different database connection and it has
 foreign keys, Immigrant will incorrectly include them again in the generated
-migration.
+migration. `Immigrant.ignore_keys` can be used to work around this.
 
 ## [Changelog](CHANGELOG.md)
 
 ## License
 
-Copyright (c) 2012-2014 Jon Jensen, released under the MIT license
+Copyright (c) 2012-2015 Jon Jensen, released under the MIT license

data/lib/immigrant.rb

@@ -1,13 +1,28 @@
 require 'active_support/all'
 
 module Immigrant
+  class << self
+    # expected format:
+    # [{from_table: "the_table", column: "the_column"}, ...]"
+    attr_writer :ignore_keys
+
+    def ignore_keys
+      @ignore_keys ||= []
+    end
+  end
+
   class KeyFinder
     def infer_keys(db_keys = current_foreign_keys, classes = model_classes)
-      database_keys = db_keys.inject({}) { |hash, foreign_key|
-        hash[foreign_key.hash_key] = foreign_key
-        hash
-      }
+      database_keys = Hash[db_keys.map { |foreign_key|
+        [foreign_key.hash_key, foreign_key]
+      }]
+
+      ignore_keys = Hash[Immigrant.ignore_keys.map { |key|
+        [[key[:from_table], key[:column]], true]
+      }]
+
       model_keys, warnings = model_keys(classes)
+
       new_keys = []
       model_keys.keys.each do |hash_key|
         foreign_key = model_keys[hash_key]
@@ -18,7 +33,7 @@ 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
-        else
+        elsif !ignore_keys[hash_key]
           new_keys << foreign_key
         end
       end

data/test/immigrant_test.rb

@@ -455,6 +455,30 @@ class ImmigrantTest < ActiveSupport::TestCase
     end
   end
 
+  test 'ignore_keys should be respected' do
+    given <<-CODE
+      class User <  ActiveRecord::Base; end
+      class Category < ActiveRecord::Base; end
+      class Widget < ActiveRecord::Base
+        belongs_to :user
+        belongs_to :category
+      end
+    CODE
+
+    Immigrant.ignore_keys = [{:from_table => "widgets", :column => "category_id"}]
+    begin
+      assert_equal(
+        [foreign_key_definition(
+           'widgets', 'users',
+           :column => 'user_id', :primary_key => 'id'
+         )],
+        infer_keys
+      )
+    ensure
+      Immigrant.ignore_keys = []
+    end
+  end
+
   test 'ForeignKeyDefinition#to_ruby should correctly dump the key' do
     if ActiveRecord::VERSION::STRING < '4.2.'
       definition = foreign_key_definition('foos', 'bars', dependent: 'delete')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immigrant
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Jon Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord