immigrant 0.1.6 → 0.1.7

data/README.md

@@ -0,0 +1,47 @@
+# Immigrant
+[<img src="https://secure.travis-ci.org/jenseng/immigrant.png?rvm=1.9.3" />](http://travis-ci.org/jenseng/immigrant)
+
+Immigrant gives [Foreigner](https://github.com/matthuhiggins/foreigner) a
+migration generator so you can effortlessly add missing foreign keys. This is
+particularly helpful when you decide to add keys to an established Rails app.
+
+Like Foreigner, Immigrant requires Rails 3.0 or greater.
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'immigrant'
+```
+
+## Usage
+
+```bash
+rails generate immigration AddKeys
+```
+
+This will create a migration named AddKeys which will have `add_foreign_key`
+statements for any missing foreign keys. Immigrant infers missing ones by
+evaluating the associations in your models (e.g. `belongs_to`, `has_many`, etc.).
+Only missing keys will be added; existing ones will never be altered or
+removed.
+
+## Considerations
+
+If the data in your tables is bad, then the migration will fail to run
+(obviously). IOW, ensure you don't have orphaned records **before** you try to
+add foreign keys.
+
+## Known Issues
+
+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.
+
+## [Changelog](CHANGELOG.md)
+
+## License
+
+Copyright (c) 2012-2014 Jon Jensen, released under the MIT license

data/lib/generators/immigration_generator.rb

@@ -10,10 +10,10 @@ class ImmigrationGenerator < ActiveRecord::Generators::Base
       $stderr.puts "NOTICE: #{key.options[:name]} has ON DELETE CASCADE. You should remove the :dependent option from the association to take advantage of this."
     end
     if @keys.present?
-      template = ActiveRecord::VERSION::STRING < "3.1." ? "immigration-pre-3.1.rb" : "immigration.rb"
+      template = ActiveRecord::VERSION::STRING < "3.1." ? 'immigration-pre-3.1.rb.erb' : 'immigration.rb.erb'
       migration_template template, "db/migrate/#{file_name}.rb"
     else
-      puts "Nothing to do"
+      puts 'Nothing to do'
     end
   end
 

data/lib/immigrant.rb

@@ -39,11 +39,7 @@ module Immigrant
       end
 
       def model_classes
-        classes = []
-        ActiveRecord::Base.descendants.each do |model|
-          classes << model.name.constantize
-        end
-        classes
+        ActiveRecord::Base.descendants
       end
 
       def model_keys(classes)
@@ -113,6 +109,7 @@ module Immigrant
       end
 
       def infer_belongs_to_keys(klass, reflection)
+        return [] if reflection.name == :left_side # redundant and unusable reflection automagically created by HABTM
         [
           Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(
             klass.table_name,

data/test/helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 Bundler.require(:default)
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'active_record'
 
 require 'foreigner'

data/test/immigrant_test.rb

@@ -17,15 +17,16 @@ class ImmigrantTest < ActiveSupport::TestCase
     if ActiveRecord::VERSION::STRING >= '4.'
       # support old 3.x syntax for the sake of concise tests
       [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many].each do |method|
-        instance_eval <<-CODE
-          def self.#{method}(assoc, options = {})
-            args = [assoc]
-            scope = options.extract!(:conditions, :order)
-            if scope
-              args.push lambda{ where(scope[:conditions]).order(scope[:order]) }
+        instance_eval <<-CODE, __FILE__, __LINE__ + 1
+          def self.#{method}(assoc, scope = nil, options = {})
+            if scope.is_a?(Hash)
+              options = scope
+              scope_opts = options.extract!(:conditions, :order)
+              scope = if scope_opts && scope_opts.present?
+                lambda{ |_| where(scope_opts[:conditions]).order(scope_opts[:order]) }
+              end
             end
-            args.push options
-            super *args
+            super assoc, scope, options
           end
         CODE
       end
@@ -44,18 +45,30 @@ class ImmigrantTest < ActiveSupport::TestCase
   def teardown
     subclasses = ActiveSupport::DescendantsTracker.direct_descendants(MockModel)
     subclasses.each do |subclass|
-      ImmigrantTest.send(:remove_const, subclass.to_s.sub(/.*::/, ''))
+      Object.send(:remove_const, subclass.to_s)
     end
     subclasses.replace([])
+    # also need to clear out other things under AR::Base, because as of
+    # 4.1 there are automagical anonymous classes due to HABTM
+    subclasses = ActiveSupport::DescendantsTracker.direct_descendants(ActiveRecord::Base)
+    subclasses.replace([MockModel])
+  end
+
+  def given(code)
+    # ugly little hack to get these temp classes not namespaced, so
+    # that generated HM/BT from HABTM will find the right class
+    Object.class_eval code
   end
 
   # basic scenarios
 
   test 'belongs_to should generate a foreign key' do
-    class Author < MockModel; end
-    class Book < MockModel
-      belongs_to :guy, :class_name => 'Author', :foreign_key => 'author_id'
-    end
+    given <<-CODE
+      class Author < MockModel; end
+      class Book < MockModel
+        belongs_to :guy, :class_name => 'Author', :foreign_key => 'author_id'
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -69,10 +82,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_one should generate a foreign key' do
-    class Author < MockModel
-      has_one :piece_de_resistance, :class_name => 'Book', :order => "id DESC"
-    end
-    class Book < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_one :piece_de_resistance, :class_name => 'Book', :order => "id DESC"
+      end
+      class Book < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -86,10 +101,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_one :dependent => :delete should generate a foreign key with :dependent => :delete' do
-    class Author < MockModel
-      has_one :book, :order => "id DESC", :dependent => :delete
-    end
-    class Book < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_one :book, :order => "id DESC", :dependent => :delete
+      end
+      class Book < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -103,10 +120,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_many should generate a foreign key' do
-    class Author < MockModel
-      has_many :babies, :class_name => 'Book'
-    end
-    class Book < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_many :babies, :class_name => 'Book'
+      end
+      class Book < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -120,10 +139,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_many :dependent => :delete_all should generate a foreign key with :dependent => :delete' do
-    class Author < MockModel
-      has_many :books, :dependent => :delete_all
-    end
-    class Book < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_many :books, :dependent => :delete_all
+      end
+      class Book < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -137,10 +158,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_and_belongs_to_many should generate two foreign keys' do
-    class Author < MockModel
-      has_and_belongs_to_many :fans
-    end
-    class Fan < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_and_belongs_to_many :fans
+      end
+      class Fan < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -158,10 +181,12 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'has_and_belongs_to_many should respect the join_table' do
-    class Author < MockModel
-      has_and_belongs_to_many :fans, :join_table => :lols_wuts
-    end
-    class Fan < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_and_belongs_to_many :fans, :join_table => :lols_wuts
+      end
+      class Fan < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -179,13 +204,15 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'conditional has_one/has_many associations should ignore :dependent' do
-    class Author < MockModel
-      has_many :articles, :conditions => "published", :dependent => :delete_all
-      has_one :favorite_book, :class_name => 'Book',
-              :conditions => "most_awesome", :dependent => :delete
-    end
-    class Book < MockModel; end
-    class Article < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_many :articles, :conditions => "published", :dependent => :delete_all
+        has_one :favorite_book, :class_name => 'Book',
+                :conditions => "most_awesome", :dependent => :delete
+      end
+      class Book < MockModel; end
+      class Article < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -203,13 +230,15 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'primary_key should be respected' do
-    class User < MockModel
-      has_many :emails, :primary_key => :email, :foreign_key => :to,
-               :dependent => :destroy
-    end
-    class Email < MockModel
-      belongs_to :user, :primary_key => :email, :foreign_key => :to
-    end
+    given <<-CODE
+      class User < MockModel
+        has_many :emails, :primary_key => :email, :foreign_key => :to,
+                 :dependent => :destroy
+      end
+      class Email < MockModel
+        belongs_to :user, :primary_key => :email, :foreign_key => :to
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -225,11 +254,13 @@ class ImmigrantTest < ActiveSupport::TestCase
   # (no) duplication
 
   test 'STI should not generate duplicate foreign keys' do
-    class Company < MockModel; end
-    class Employee < MockModel
-      belongs_to :company
-    end
-    class Manager < Employee; end
+    given <<-CODE
+      class Company < MockModel; end
+      class Employee < MockModel
+        belongs_to :company
+      end
+      class Manager < Employee; end
+    CODE
 
     assert(Manager.reflections.present?)
     keys = Immigrant.infer_keys([]).first
@@ -244,12 +275,14 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'complementary associations should not generate duplicate foreign keys' do
-    class Author < MockModel
-      has_many :books
-    end
-    class Book < MockModel
-      belongs_to :author
-    end
+    given <<-CODE
+      class Author < MockModel
+        has_many :books
+      end
+      class Book < MockModel
+        belongs_to :author
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -263,12 +296,14 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'redundant associations should not generate duplicate foreign keys' do
-    class Author < MockModel
-      has_many :books
-      has_many :favorite_books, :class_name => 'Book', :conditions => "awesome"
-      has_many :bad_books, :class_name => 'Book', :conditions => "amateur_hour"
-    end
-    class Book < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_many :books
+        has_many :favorite_books, :class_name => 'Book', :conditions => "awesome"
+        has_many :bad_books, :class_name => 'Book', :conditions => "amateur_hour"
+      end
+      class Book < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -297,13 +332,15 @@ class ImmigrantTest < ActiveSupport::TestCase
       )
     ]
 
-    class Author < MockModel
-      has_many :articles
-      has_one :favorite_book, :class_name => 'Book',
-              :conditions => "most_awesome"
-    end
-    class Book < MockModel; end
-    class Article < MockModel; end
+    given <<-CODE
+      class Author < MockModel
+        has_many :articles
+        has_one :favorite_book, :class_name => 'Book',
+                :conditions => "most_awesome"
+      end
+      class Book < MockModel; end
+      class Article < MockModel; end
+    CODE
 
     keys = Immigrant.infer_keys(database_keys).first
     assert_equal([], keys)
@@ -311,15 +348,17 @@ class ImmigrantTest < ActiveSupport::TestCase
 
   if ActiveRecord::VERSION::STRING < '4.'
     test 'finder_sql associations should not generate foreign keys' do
-      class Author < MockModel
-        has_many :books, :finder_sql => <<-SQL
-          SELECT *
-          FROM books
-          WHERE author_id = \#{id}
-          ORDER BY RANDOM() LIMIT 5'
-        SQL
-      end
-      class Book < MockModel; end
+      given <<-CODE
+        class Author < MockModel
+          has_many :books, :finder_sql => <<-SQL
+            SELECT *
+            FROM books
+            WHERE author_id = \\\#{id}
+            ORDER BY RANDOM() LIMIT 5'
+          SQL
+        end
+        class Book < MockModel; end
+      CODE
 
       keys = Immigrant.infer_keys([]).first
       assert_equal([], keys)
@@ -327,33 +366,37 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'polymorphic associations should not generate foreign keys' do
-    class Property < MockModel
-      belongs_to :owner, :polymorphic => true 
-    end
-    class Person < MockModel
-      has_many :properties, :as => :owner
-    end
-    class Corporation < MockModel
-      has_many :properties, :as => :owner
-    end
+    given <<-CODE
+      class Property < MockModel
+        belongs_to :owner, :polymorphic => true
+      end
+      class Person < MockModel
+        has_many :properties, :as => :owner
+      end
+      class Corporation < MockModel
+        has_many :properties, :as => :owner
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_equal([], keys)
   end
 
   test 'has_many :through should not generate foreign keys' do
-    class Author < MockModel
-      has_many :authors_fans
-      has_many :fans, :through => :authors_fans
-    end
-    class AuthorsFan < MockModel
-      belongs_to :author
-      belongs_to :fan
-    end
-    class Fan < MockModel
-      has_many :authors_fans
-      has_many :authors, :through => :authors_fans
-    end
+    given <<-CODE
+      class Author < MockModel
+        has_many :authors_fans
+        has_many :fans, :through => :authors_fans
+      end
+      class AuthorsFan < MockModel
+        belongs_to :author
+        belongs_to :fan
+      end
+      class Fan < MockModel
+        has_many :authors_fans
+        has_many :authors, :through => :authors_fans
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }
@@ -371,11 +414,13 @@ class ImmigrantTest < ActiveSupport::TestCase
   end
 
   test 'broken associations should not cause errors' do
-    class Author < MockModel; end
-    class Book < MockModel
-      belongs_to :author
-      belongs_to :invalid
-    end
+    given <<-CODE
+      class Author < MockModel; end
+      class Book < MockModel
+        belongs_to :author
+        belongs_to :invalid
+      end
+    CODE
 
     keys = Immigrant.infer_keys([]).first
     assert_nothing_raised { keys.map { |key| key.to_ruby(:add) } }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immigrant
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -48,16 +48,13 @@ description: Adds a generator for creating a foreign key migration based on your
 email: jenseng@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
 - LICENSE.txt
 - Rakefile
-- README.rdoc
+- README.md
 - lib/generators/USAGE
 - lib/generators/immigration_generator.rb
-- lib/generators/templates/immigration-pre-3.1.rb
-- lib/generators/templates/immigration.rb
 - lib/immigrant/foreign_key_definition.rb
 - lib/immigrant/loader.rb
 - lib/immigrant/railtie.rb

data/README.rdoc

@@ -1,41 +0,0 @@
-= Immigrant
-{<img src="https://secure.travis-ci.org/jenseng/immigrant.png?rvm=1.9.3" />}[http://travis-ci.org/jenseng/immigrant]
-
-Immigrant gives {Foreigner}[https://github.com/matthuhiggins/foreigner] a
-migration generator so you can effortlessly add missing foreign keys. This is
-particularly helpful when you decide to add keys to an established Rails app.
-
-Like Foreigner, Immigrant requires Rails 3.0 or greater.
-
-== Installation
-
-Add the following to your Gemfile:
-
-  gem 'immigrant'
-
-== Usage
-
-  rails generate immigration AddKeys
-
-This will create a migration named AddKeys which will have add_foreign_key
-statements for any missing foreign keys. Immigrant infers missing ones by
-evaluating the associations in your models (e.g. belongs_to, has_many, etc.).
-Only missing keys will be added; existing ones will never be altered or
-removed.
-
-== Considerations
-
-If the data in your tables is bad, then the migration will fail to run
-(obviously). IOW, ensure you don't have orphaned records *before* you try to
-add foreign keys.
-
-== Known Issues
-
-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.
-
-== License
-
-Copyright (c) 2013 Jon Jensen, released under the MIT license

data/lib/generators/templates/immigration-pre-3.1.rb

@@ -1,13 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-  def self.up
-<% @keys.each do |key| -%>
-    <%= key.to_ruby(:add) %>
-<%- end -%>
-  end
-
-  def self.down
-<% @keys.each do |key| -%>
-    <%= key.to_ruby(:remove) %>
-<%- end -%>
-  end
-end

data/lib/generators/templates/immigration.rb

@@ -1,7 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-  def change
-<% @keys.each do |key| -%>
-    <%= key.to_ruby(:add) %>
-<%- end -%>
-  end
-end