immigrant 0.1.8 → 0.2.0

data/README.md

@@ -1,11 +1,9 @@
 # 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.
+Immigrant gives Rails a foreign key migration generator so you can
+effortlessly find and add missing keys. This is particularly helpful
+when you decide to add keys to an established Rails app.
 
 ## Installation
 
@@ -15,6 +13,9 @@ Add the following to your Gemfile:
 gem 'immigrant'
 ```
 
+If you're using a version of Rails prior to 4.2, you'll also need the
+[Foreigner](https://github.com/matthuhiggins/foreigner) gem.
+
 ## Usage
 
 ```bash

data/lib/generators/immigration_generator.rb

@@ -10,8 +10,7 @@ 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.erb' : 'immigration.rb.erb'
-      migration_template template, "db/migrate/#{file_name}.rb"
+      migration_template Immigrant::TEMPLATE, "db/migrate/#{file_name}.rb"
     else
       puts 'Nothing to do'
     end

data/lib/immigrant.rb

@@ -1,11 +1,6 @@
 require 'active_support/all'
-require 'foreigner'
 
 module Immigrant
-  extend ActiveSupport::Autoload
-  autoload :Loader
-  autoload :ForeignKeyDefinition
-
   class << self
     def infer_keys(db_keys = current_foreign_keys, classes = model_classes)
       database_keys = db_keys.inject({}) { |hash, foreign_key|
@@ -17,7 +12,7 @@ module Immigrant
       model_keys.keys.each do |hash_key|
         foreign_key = model_keys[hash_key]
         # if the foreign key exists in the db, we call it good (even if
-        # the name is different or :dependent doesn't match), though 
+        # the name is different or :on_delete doesn't match, etc.), though
         # we do warn on clearly broken stuff
         if current_key = database_keys[hash_key]
           if current_key.to_table != foreign_key.to_table || current_key.options[:primary_key] != foreign_key.options[:primary_key]
@@ -111,26 +106,26 @@ module Immigrant
       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(
+          ForeignKeyDefinition.new(
             klass.table_name,
             reflection.klass.table_name,
-            :column => reflection.send(fk_method).to_s,
+            :column => reflection.send(FOREIGN_KEY).to_s,
             :primary_key => (reflection.options[:primary_key] || reflection.klass.primary_key).to_s,
             # although belongs_to can specify :dependent, it doesn't make
             # sense from a foreign key perspective
-            :dependent => nil
+            ON_DELETE => nil
           )
         ]
       end
 
       def infer_has_n_keys(klass, reflection)
         [
-          Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(
+          ForeignKeyDefinition.new(
             reflection.klass.table_name,
             klass.table_name,
-            :column => reflection.send(fk_method).to_s,
+            :column => reflection.send(FOREIGN_KEY).to_s,
             :primary_key => (reflection.options[:primary_key] || klass.primary_key).to_s,
-            :dependent => [:delete, :delete_all].include?(reflection.options[:dependent]) && !qualified_reflection?(reflection, klass) ? :delete : nil
+            ON_DELETE => [:delete, :delete_all].include?(reflection.options[:dependent]) && !qualified_reflection?(reflection, klass) ? :delete : nil
           )
         ]
       end
@@ -138,46 +133,22 @@ module Immigrant
       def infer_habtm_keys(klass, reflection)
         join_table = (reflection.respond_to?(:join_table) ? reflection.join_table : reflection.options[:join_table]).to_s
         [
-          Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(
+          ForeignKeyDefinition.new(
             join_table,
             klass.table_name,
-            :column => reflection.send(fk_method).to_s,
+            :column => reflection.send(FOREIGN_KEY).to_s,
             :primary_key => klass.primary_key.to_s,
-            :dependent => nil
+            ON_DELETE => nil
           ),
-          Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(
+          ForeignKeyDefinition.new(
             join_table,
             reflection.klass.table_name,
             :column => reflection.association_foreign_key.to_s,
             :primary_key => reflection.klass.primary_key.to_s,
-            :dependent => nil
+            ON_DELETE => nil
           )
         ]
       end
-
-      def fk_method
-        ActiveRecord::VERSION::STRING < '3.1.' ? :primary_key_name : :foreign_key
-      end
-
-      def qualified_reflection?(reflection, klass)
-        if ActiveRecord::VERSION::STRING < '4.'
-          reflection.options[:conditions].present?
-        else
-          scope = reflection.scope
-          if scope.nil?
-            false
-          elsif scope.respond_to?(:options)
-            scope.options[:where].present?
-          else
-            klass.instance_exec(*([nil]*scope.arity), &scope).where_values.present?
-          end
-        end
-      rescue
-        # if there's an error evaluating the scope block or whatever, just
-        # err on the side of caution and assume there are conditions
-        true
-      end
-
   end
 end
 

data/lib/immigrant/compat.rb

@@ -0,0 +1,57 @@
+version = ActiveRecord::VERSION::STRING
+
+if version >= '4.2.'
+  require_relative 'compat/4.2'
+else
+  begin
+    require 'foreigner'
+  rescue LoadError
+    $stderr.puts <<-ERR.strip_heredoc
+
+      ERROR: immigrant requires the foreigner gem (unless you are on rails 4.2+)
+
+      To fix this, add the following to your Gemfile:
+
+        gem "foreigner", "~> 1.2"
+
+      Or just upgrade rails ;) ... lol, "just"
+
+    ERR
+    exit 1
+  end
+  Foreigner.load
+
+  require_relative 'compat/foreigner_extensions'
+
+  if version >= '4.0'
+    require_relative 'compat/4.0'
+  elsif version >= '3.1'
+    require_relative 'compat/3.1'
+  else
+    require_relative 'compat/3.0'
+  end
+end
+
+# add some useful things for querying/comparing/dumping foreign keys
+module Immigrant
+  module ForeignKeyExtensions
+    def initialize(from_table, to_table, options, *args)
+      options ||= {}
+      options[:name] ||= "#{from_table}_#{options[:column]}_fk"
+      super(from_table, to_table, options, *args)
+    end
+
+    def hash_key
+      [from_table, options[:column]]
+    end
+
+    def to_ruby(action = :add)
+      if action == :add
+        dump_foreign_key(self)
+      else
+        "remove_foreign_key #{from_table.inspect}, " \
+        ":name => #{options[:name].inspect}"
+      end
+    end
+  end
+end

data/lib/immigrant/compat/3.0.rb

@@ -0,0 +1,11 @@
+module Immigrant
+  ForeignKeyDefinition = ::Foreigner::ConnectionAdapters::ForeignKeyDefinition
+
+  TEMPLATE = 'immigration-pre-3.1.rb.erb'
+  FOREIGN_KEY = :primary_key_name
+  ON_DELETE = :dependent
+
+  def self.qualified_reflection?(reflection, klass)
+    reflection.options[:conditions].present?
+  end
+end

data/lib/immigrant/compat/3.1.rb

@@ -0,0 +1,12 @@
+module Immigrant
+  ForeignKeyDefinition = ::Foreigner::ConnectionAdapters::ForeignKeyDefinition
+
+  TEMPLATE = 'immigration.rb.erb'
+  FOREIGN_KEY = :foreign_key
+  ON_DELETE = :dependent
+
+  def self.qualified_reflection?(reflection, klass)
+    reflection.options[:conditions].present?
+  end
+end
+

data/lib/immigrant/compat/4.0.rb

@@ -0,0 +1,22 @@
+module Immigrant
+  ForeignKeyDefinition = ::Foreigner::ConnectionAdapters::ForeignKeyDefinition
+
+  TEMPLATE = 'immigration.rb.erb'
+  FOREIGN_KEY = :foreign_key
+  ON_DELETE = :dependent
+
+  def self.qualified_reflection?(reflection, klass)
+    scope = reflection.scope
+    if scope.nil?
+      false
+    elsif scope.respond_to?(:options)
+      scope.options[:where].present?
+    else
+      klass.instance_exec(*([nil]*scope.arity), &scope).where_values.present?
+    end
+  rescue
+    # if there's an error evaluating the scope block or whatever, just
+    # err on the side of caution and assume there are conditions
+    true
+  end
+end

data/lib/immigrant/compat/4.2.rb

@@ -0,0 +1,60 @@
+require "active_record/connection_adapters/abstract/schema_definitions"
+
+module Immigrant
+  ForeignKeyDefinition = ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition
+
+  TEMPLATE = 'immigration.rb.erb'
+  FOREIGN_KEY = :foreign_key
+  ON_DELETE = :on_delete
+
+  def self.qualified_reflection?(reflection, klass)
+    scope = reflection.scope
+    if scope.nil?
+      false
+    elsif scope.respond_to?(:options)
+      scope.options[:where].present?
+    else
+      klass.instance_exec(*([nil]*scope.arity), &scope).where_values.present?
+    end
+  rescue
+    # if there's an error evaluating the scope block or whatever, just
+    # err on the side of caution and assume there are conditions
+    true
+  end
+
+  module ForeignKeyExtensions
+    # DRY alert: copied from ActiveRecord::SchemaDumper#foreign_keys
+    def dump_foreign_key(foreign_key)
+      parts = [
+        "add_foreign_key #{remove_prefix_and_suffix(foreign_key.from_table).inspect}",
+        remove_prefix_and_suffix(foreign_key.to_table).inspect,
+      ]
+
+      if foreign_key.column != foreign_key_column_for(foreign_key.to_table)
+        parts << "column: #{foreign_key.column.inspect}"
+      end
+
+      if foreign_key.custom_primary_key?
+        parts << "primary_key: #{foreign_key.primary_key.inspect}"
+      end
+
+      if foreign_key.name !~ /^fk_rails_[0-9a-f]{10}$/
+        parts << "name: #{foreign_key.name.inspect}"
+      end
+
+      parts << "on_update: #{foreign_key.on_update.inspect}" if foreign_key.on_update
+      parts << "on_delete: #{foreign_key.on_delete.inspect}" if foreign_key.on_delete
+
+      "  #{parts.join(', ')}"
+    end
+
+
+    def remove_prefix_and_suffix(table)
+      table.gsub(/^(#{ActiveRecord::Base.table_name_prefix})(.+)(#{ActiveRecord::Base.table_name_suffix})$/,  "\\2")
+    end
+
+    def foreign_key_column_for(table_name)
+      "#{table_name.to_s.singularize}_id"
+    end
+  end
+end

data/lib/immigrant/compat/foreigner_extensions.rb

@@ -0,0 +1,5 @@
+module Immigrant
+  module ForeignKeyExtensions
+    include Foreigner::SchemaDumper::ClassMethods
+  end
+end

data/lib/immigrant/loader.rb

@@ -1,7 +1,8 @@
 module Immigrant
   def self.load
-    Foreigner::ConnectionAdapters::ForeignKeyDefinition.instance_eval do
-      include Immigrant::ForeignKeyDefinition
-    end
+    require "active_record"
+    require_relative "compat"
+
+    ForeignKeyDefinition.send :include, ForeignKeyExtensions
   end
-end
+end

data/test/compat.rb

@@ -0,0 +1,8 @@
+if ActiveRecord::VERSION::STRING < '4.2.'
+  require "foreigner"
+
+  class Foreigner::Adapter
+    def self.configured_name; "dummy_adapter"; end
+    def self.load!; end
+  end
+end

data/test/helper.rb

@@ -3,20 +3,15 @@ require 'bundler/setup'
 Bundler.require(:default)
 
 require 'minitest/autorun'
-require 'active_record'
 
-require 'foreigner'
-class Foreigner::Adapter
-  def self.configured_name; "dummy_adapter"; end
-  def self.load!; end
-end
-Foreigner.load
+require 'active_record'
+require_relative "compat"
 
 require 'immigrant'
 Immigrant.load
 
 module TestMethods
   def foreign_key_definition(*args)
-    Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(*args)
+    Immigrant::ForeignKeyDefinition.new(*args)
   end
 end

data/test/immigrant_test.rb

@@ -75,7 +75,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -94,13 +94,13 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
   end
 
-  test 'has_one :dependent => :delete should generate a foreign key with :dependent => :delete' do
+  test 'has_one :dependent => :delete should generate a foreign key with :on_delete => :delete' do
     given <<-CODE
       class Author < MockModel
         has_one :book, :order => "id DESC", :dependent => :delete
@@ -113,7 +113,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => :delete
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => :delete
        )],
       keys
     )
@@ -132,13 +132,13 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
   end
 
-  test 'has_many :dependent => :delete_all should generate a foreign key with :dependent => :delete' do
+  test 'has_many :dependent => :delete_all should generate a foreign key with :on_delete => :delete' do
     given <<-CODE
       class Author < MockModel
         has_many :books, :dependent => :delete_all
@@ -151,7 +151,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => :delete
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => :delete
        )],
       keys
     )
@@ -170,11 +170,11 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'authors_fans', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        ),
        foreign_key_definition(
          'authors_fans', 'fans',
-         :column => 'fan_id', :primary_key => 'id', :dependent => nil
+         :column => 'fan_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -193,11 +193,11 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'lols_wuts', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        ),
        foreign_key_definition(
          'lols_wuts', 'fans',
-         :column => 'fan_id', :primary_key => 'id', :dependent => nil
+         :column => 'fan_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -219,11 +219,11 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'articles', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        ),
        foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -245,7 +245,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
         'emails', 'users',
-        :column => 'to', :primary_key => 'email', :dependent => nil
+        :column => 'to', :primary_key => 'email', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -268,7 +268,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'employees', 'companies',
-         :column => 'company_id', :primary_key => 'id', :dependent => nil
+         :column => 'company_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -289,7 +289,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -310,7 +310,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -319,16 +319,16 @@ class ImmigrantTest < ActiveSupport::TestCase
 
   # skipped associations
 
-  test 'associations should not generate foreign keys if they already exist, even if :dependent/name are different' do
+  test 'associations should not generate foreign keys if they already exist, even if :on_delete/name are different' do
     database_keys = [
       foreign_key_definition(
         'articles', 'authors',
-        :column => 'author_id', :primary_key => 'id', :dependent => nil,
+        :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil,
         :name => "doesn't_matter"
       ),
       foreign_key_definition(
         'books', 'authors', :column => 'author_id', :primary_key => 'id',
-        :dependent => :delete
+        Immigrant::ON_DELETE => :delete
       )
     ]
 
@@ -403,11 +403,11 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'authors_fans', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        ),
        foreign_key_definition(
          'authors_fans', 'fans',
-         :column => 'fan_id', :primary_key => 'id', :dependent => nil
+         :column => 'fan_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )
@@ -427,7 +427,7 @@ class ImmigrantTest < ActiveSupport::TestCase
     assert_equal(
       [foreign_key_definition(
          'books', 'authors',
-         :column => 'author_id', :primary_key => 'id', :dependent => nil
+         :column => 'author_id', :primary_key => 'id', Immigrant::ON_DELETE => nil
        )],
       keys
     )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immigrant
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: foreigner
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 description: Adds a generator for creating a foreign key migration based on your current
   model associations
 email: jenseng@gmail.com
@@ -57,10 +41,16 @@ files:
 - lib/generators/immigration_generator.rb
 - lib/generators/templates/immigration-pre-3.1.rb.erb
 - lib/generators/templates/immigration.rb.erb
-- lib/immigrant/foreign_key_definition.rb
+- lib/immigrant/compat/3.0.rb
+- lib/immigrant/compat/3.1.rb
+- lib/immigrant/compat/4.0.rb
+- lib/immigrant/compat/4.2.rb
+- lib/immigrant/compat/foreigner_extensions.rb
+- lib/immigrant/compat.rb
 - lib/immigrant/loader.rb
 - lib/immigrant/railtie.rb
 - lib/immigrant.rb
+- test/compat.rb
 - test/helper.rb
 - test/immigrant_test.rb
 homepage: http://github.com/jenseng/immigrant
@@ -83,9 +73,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
-summary: Migration generator for Foreigner
+summary: Foreign key migration generator for Rails
 test_files: []
 has_rdoc: 

data/lib/immigrant/foreign_key_definition.rb

@@ -1,26 +0,0 @@
-module Immigrant
-  # add some useful stuff to foreigner's ForeignKeyDefinition
-  # TODO: get more of this into foreigner so we don't need to monkey patch
-  module ForeignKeyDefinition
-    include Foreigner::SchemaDumper::ClassMethods
-
-    def initialize(from_table, to_table, options, *args)
-      options ||= {}
-      options[:name] ||= "#{from_table}_#{options[:column]}_fk"
-      super(from_table, to_table, options, *args)
-    end
-
-    def hash_key
-      [from_table, options[:column]]
-    end
-
-    def to_ruby(action = :add)
-      if action == :add
-        dump_foreign_key(self)
-      else
-        "remove_foreign_key #{from_table.inspect}, " \
-        ":name => #{options[:name].inspect}"
-      end
-    end
-  end
-end