aspgems-foreign_key_migrations 2.0.0.beta1 → 2.0.0.beta2

data/.gitignore

@@ -1,3 +1,4 @@
 spec/db/*db
 spec/debug.log
+pkg
 

data/.travis.yml

@@ -0,0 +1,6 @@
+script: "bundle exec rake create_databases spec"
+bundler_args: "--without development"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree

data/CHANGELOG

@@ -1,3 +1,27 @@
+2.0.0.beta2
+    * allow to disable automatic FK creation
+1.2.0
+    * added install generator
+    * fixed doubled auto-index inside Schema.define
+    * upgraded to RSpec 2
+    * got rid of jeweler in favor of bundler
+1.1.8
+    * depend on redhillonrails_core 1.1.2
+1.1.7
+    * handle references for change_column
+1.1
+    * create index within foreign key (auto index)
+    * global configuration for: auto_index and on_update/on_delete actions
+1.0.2
+    * rails 3 generator
+1.0.1
+    * used autoload
+    * rails 3 compatibility
+1.0.0
+    * renamed from foreign_key_migration to automatic_foreign_key
+    * added gemspec
+
+
 [REVISION 20080131]
 
 [FIXED] Stack-level too deep.

data/README.md

@@ -1,4 +1,7 @@
-# Foreign Key Migrations 
+[![Build Status](https://secure.travis-ci.org/aspgems/foreign_key_migrations.png)](http://travis-ci.org/aspgems/foreign_key_migrations)
+
+Foreign Key Migrations
+======================
 
 Foreign Key Migrations is a plugin that automatically generates foreign-key
 constraints when creating tables. It uses SQL-92 syntax and as such should be
@@ -8,51 +11,63 @@ In the simplest case, the plugin assumes that if you have a column named
 <tt>customer_id</tt> that you want a foreign-key constraint generated that references
 the <tt>id</tt> column in the <tt>customers</tt> table:
 
+```ruby
     create_table :orders do |t|
       t.column :customer_id, :integer, :null => false
       ...
     end
+```
 
 If you have multiple columns referencing a table or for whatever reason, your
 column name isn't the same as the referenced table name, you can use the
 `:references` option:
 
+```ruby
     create_table :orders do |t|
       t.column :ordered_by_id, :integer, :null => false, :references => :customers
       ...
     end
+```
 
 If you have a column with a name ending in <tt>_id</tt> for which you do not wish a
 foreign-key to be generated, you can use `:references => nil`:
 
+```ruby
     create_table :orders do |t|
       t.column :external_id, :integer, :null => false, :references => nil
       ...
     end
+```
 
 Sometimes you may (for legacy reasons) need to reference a primary key column that is
 named something other than <tt>id</tt>. In this case you can specify the name of the column:
 
+```ruby
     create_table :orders do |t|
       t.column :ordered_by_pk, :integer, :null => false, :references => [:customers, :pk]
       ...
     end
+```
 
 You also have the option of specifying what to do on delete/update using
 `:on_delete`/`:on_update`, respectively to one of:
 `:cascade`; `:restrict`; and `:set_null`:
 
+```ruby
     create_table :orders do |t|
       t.column :customer_id, :integer, :on_delete => :set_null, :on_update => :cascade
       ...
     end
+```
 
 If your database supports it (for example PostgreSQL) you can also mark the constraint as deferrable:
 
+```ruby
     create_table :orders do |t|
       t.column :customer_id, :integer, :deferrable => true
       ...
     end
+```
 
 By convention, if a column is named <tt>parent_id</tt> it will be treated as a circular reference to
 the table in which it is defined.
@@ -61,10 +76,12 @@ Sometimes you may (for legacy reasons) need to name your primary key column such
 would be misinterpreted as a foreign-key (say for example if you named the primary key
 <tt>order_id</tt>). In this case you can manually create the primary key as follows:
 
+```ruby
     create_table :orders, :id => false do |t|
       ...
       t.primary_key :order_id, :references => nil
     end
+```
 
 There is also a generator for creating foreign keys on a database that currently has none:
 
@@ -77,15 +94,29 @@ configuration properties:
 * `config.active_record.table_name_prefix`
 * `config.active_record.table_name_suffix`
 
-## Dependencies
+Install
+-------
+
+Put this line in your Gemfile:
+
+    gem 'aspgems-foreign_key_migrations', '~> 2.0.0.beta1', :require => 'foreign_key_migrations'
+
+Then bundle:
+
+    % bundle
+
+Dependencies
+------------
 
 * RedHill on Rails Core (redhillonrails_core) aspgems version.
 
-## NOTE
+NOTE
+----
 
 * Code was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
 
-## License
+License
+-------
 
 This plugin is copyright 2006 by RedHill Consulting, Pty. Ltd. and is released
 under the MIT license.

data/Rakefile

@@ -10,34 +10,33 @@ require 'rspec/core/rake_task'
   end
 end
 
+task :default => [:create_databases, :spec]
+
 desc 'Run postgresql and mysql tests'
-task :spec do 
-  %w[postgresql mysql mysql2].each do |adapter|
+task :spec do
+  %w[postgresql mysql mysql2 sqlite3].each do |adapter|
+    puts "\n\e[1;33m[#{ENV["BUNDLE_GEMFILE"]}] #{adapter}\e[m\n"
     Rake::Task["#{adapter}:spec"].invoke
   end
 end
 
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "foreign key migrations #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc 'Create databases'
+task :create_databases do
+  %w[postgresql mysql].each do |adapter|
+    Rake::Task["#{adapter}:build_databases"].invoke
+  end
 end
 
 namespace :postgresql do
   desc 'Build the PostgreSQL test databases'
   task :build_databases do
-    %x( createdb -E UTF8 fkm_unittest )
+    system "psql -c 'create database foreign_key_migrations;' -U postgres >/dev/null"
+    abort "failed to create postgres database" unless $?.success?
   end
 
   desc 'Drop the PostgreSQL test databases'
   task :drop_databases do
-    %x( dropdb fkm_unittest )
+    %x( dropdb foreign_key_migrations )
   end
 
   desc 'Rebuild the PostgreSQL test databases'
@@ -48,16 +47,16 @@ task :build_postgresql_databases => 'postgresql:build_databases'
 task :drop_postgresql_databases => 'postgresql:drop_databases'
 task :rebuild_postgresql_databases => 'postgresql:rebuild_databases'
 
-MYSQL_DB_USER = 'fkm'
 namespace :mysql do
   desc 'Build the MySQL test databases'
   task :build_databases do
-    %x( echo "create DATABASE fkm_unittest DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{MYSQL_DB_USER})
+    system "mysql -e 'create database foreign_key_migrations default character set utf8 default collate utf8_unicode_ci;' >/dev/null"
+    abort "failed to create mysql database" unless $?.success?
   end
 
   desc 'Drop the MySQL test databases' 
   task :drop_databases do
-    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop fkm_unittest )
+    %x( mysqladmin -f drop foreign_key_migrations )
   end
 
   desc 'Rebuild the MySQL test databases'
@@ -66,4 +65,11 @@ end
 
 task :build_mysql_databases => 'mysql:build_databases'
 task :drop_mysql_databases => 'mysql:drop_databases'
-task :rebuild_mysql_databases => 'mysql:rebuild_databases'
+task :rebuild_mysql_databases => 'mysql:rebuild_databases'
+
+desc 'clobber generated files'
+task :clobber do
+  rm_rf "pkg"
+  rm_rf "tmp"
+  rm    "Gemfile.lock" if File.exist?("Gemfile.lock")
+end

data/foreign_key_migrations.gemspec

@@ -18,7 +18,7 @@ constraints when creating tables or adding columns. It uses SQL-92 syntax and as
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("aspgems-redhillonrails_core", "~> 2.0.0.beta2")
+  s.add_dependency("aspgems-redhillonrails_core", "~> 2.0.0.beta4")
       
   s.add_development_dependency("rspec", "~> 2.5.0")
   s.add_development_dependency("pg")

data/lib/foreign_key_migrations.rb

@@ -27,6 +27,11 @@ module ForeignKeyMigrations
   mattr_accessor :auto_index
   @@auto_index = nil
 
+  # Disable automatic foreign key creation.
+  # Useful for disabling automatic foreign keys in development env
+  # but enabling in test and production.
+  mattr_accessor :disable
+
   # FIXME Not used by now
   def self.setup(&block)
     yield self

data/lib/foreign_key_migrations/active_record/connection_adapters/table_definition.rb

@@ -17,16 +17,18 @@ module ForeignKeyMigrations::ActiveRecord::ConnectionAdapters
 
     def column_with_foreign_key_migrations(name, type, options = {})
       column_without_foreign_key_migrations(name, type, options)
-      references = ActiveRecord::Base.references(self.name, name, options)
-      if references
-        ForeignKeyMigrations.set_default_update_and_delete_actions!(options)
-        foreign_key(name, references.first, references.last, options)
-        if index = fkm_index_options(options)
-          # append [column_name, index_options] pair
-          self.indices << [name, ForeignKeyMigrations.options_for_index(index)]
+      unless ForeignKeyMigrations.disable
+        references = ActiveRecord::Base.references(self.name, name, options)
+        if references
+          ForeignKeyMigrations.set_default_update_and_delete_actions!(options)
+          foreign_key(name, references.first, references.last, options)
+          if index = fkm_index_options(options)
+            # append [column_name, index_options] pair
+            self.indices << [name, ForeignKeyMigrations.options_for_index(index)]
+          end
+        elsif options[:index]
+          self.indices << [name, ForeignKeyMigrations.options_for_index(options[:index])]
         end
-      elsif options[:index]
-        self.indices << [name, ForeignKeyMigrations.options_for_index(options[:index])]
       end
       self
     end

data/lib/foreign_key_migrations/active_record/migration.rb

@@ -29,13 +29,17 @@ module ForeignKeyMigrations::ActiveRecord
       #
       def add_column(table_name, column_name, type, options = {})
         super
-        handle_column_options(table_name, column_name, options)
+        unless ForeignKeyMigrations.disable
+          handle_column_options(table_name, column_name, options)
+        end
       end
 
       def change_column(table_name, column_name, type, options = {})
         super
-        remove_foreign_key_if_exists(table_name, column_name)
-        handle_column_options(table_name, column_name, options)
+        unless ForeignKeyMigrations.disable
+          remove_foreign_key_if_exists(table_name, column_name)
+          handle_column_options(table_name, column_name, options)
+        end
       end
 
       protected

data/lib/foreign_key_migrations/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyMigrations
-  VERSION = "2.0.0.beta1"
+  VERSION = "2.0.0.beta2"
 end

data/spec/connections/mysql/connection.rb

@@ -1,16 +1,16 @@
 print "Using MySQL\n"
 require 'logger'
 
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
 ActiveRecord::Base.configurations = {
-  'fkm' => {
+  'mysql' => {
     :adapter => 'mysql',
-    :database => 'fkm_unittest',
-    :username => 'fkm',
+    :database => 'foreign_key_migrations',
+    :username => (ENV["TRAVIS"] ? '' : 'redhillonrails'),
     :encoding => 'utf8',
-    :socket => '/var/run/mysqld/mysqld.sock',
-    :min_messages => 'warning'
   }
 
 }
 
-ActiveRecord::Base.establish_connection 'fkm'
+ActiveRecord::Base.establish_connection 'mysql'

data/spec/connections/mysql2/connection.rb

@@ -1,16 +1,16 @@
 print "Using MySQL2\n"
 require 'logger'
 
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
 ActiveRecord::Base.configurations = {
-  'fkm' => {
+  'mysql2' => {
     :adapter => 'mysql2',
-    :database => 'fkm_unittest',
-    :username => 'fkm',
+    :database => 'foreign_key_migrations',
+    :username => (ENV["TRAVIS"] ? '' : 'redhillonrails'),
     :encoding => 'utf8',
-    :socket => '/var/run/mysqld/mysqld.sock',
-    :min_messages => 'warning'
   }
 
 }
 
-ActiveRecord::Base.establish_connection 'fkm'
+ActiveRecord::Base.establish_connection 'mysql2'

data/spec/connections/postgresql/connection.rb

@@ -1,13 +1,16 @@
 print "Using PostgreSQL\n"
 require 'logger'
 
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
 ActiveRecord::Base.configurations = {
-  'fkm' => {
+  'postgres' => {
     :adapter => 'postgresql',
-    :database => 'fkm_unittest',
+    :database => 'foreign_key_migrations',
+    :username => 'postgres',
     :min_messages => 'warning'
   }
 
 }
 
-ActiveRecord::Base.establish_connection 'fkm'
+ActiveRecord::Base.establish_connection 'postgres'

data/spec/migration_spec.rb

@@ -54,7 +54,7 @@ describe ActiveRecord::Migration do
                    :state => { :index => {:with => :city} } ) 
       @model.should have_index.on([:state, :city])
     end
-    
+
     it "should auto-index foreign keys only" do
       ForeignKeyMigrations.auto_index = true
       create_table(@model,  :user_id => {},
@@ -182,17 +182,6 @@ describe ActiveRecord::Migration do
       ForeignKeyMigrations.on_delete = nil
     end
 
-    protected
-    def add_column(column_name, *args)
-      table = @model.table_name
-      ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.add_column(table, column_name, *args)
-        @model.reset_column_information
-        yield if block_given?
-        ActiveRecord::Migration.remove_column(table, column_name)
-      end
-    end
-
   end
 
   context "when column is changed" do
@@ -225,18 +214,40 @@ describe ActiveRecord::Migration do
       end
 
     end
-    
-    protected
-    def change_column(column_name, *args)
-      table = @model.table_name
-      ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.change_column(table, column_name, *args)
-        @model.reset_column_information
+
+    context "when disabled" do
+
+      before do
+        @model = Post
+      end
+
+      around do |example|
+        disable(&example)
+      end
+
+      it "should not create foreign key for created table" do
+        create_table(@model, :user_id => {})
+        @model.should_not reference.on(:user_id)
+      end
+
+      it "should not create foreign for added column" do
+        create_table(@model, {})
+        add_column(:user_id, :integer) do
+          @model.should_not reference.on(:user_id)
+        end
+      end
+
+      it "should not create foreign key for changed column" do
+        create_table(@model, :user_id => { :references => nil })
+        change_column(:user_id, :integer)
+        @model.should_not reference.on(:user_id)
       end
+
     end
 
   end
-    
+
+  protected
   def foreign_key(model, column)
     columns = Array(column).collect(&:to_s)
     model.foreign_keys.detect { |fk| fk.table_name == model.table_name && fk.column_names == columns } 
@@ -253,5 +264,33 @@ describe ActiveRecord::Migration do
     end
   end
 
+  def add_column(column_name, *args)
+    table = @model.table_name
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.add_column(table, column_name, *args)
+      @model.reset_column_information
+      yield if block_given?
+      ActiveRecord::Migration.remove_column(table, column_name)
+    end
+  end
+
+  def change_column(column_name, *args)
+    table = @model.table_name
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.change_column(table, column_name, *args)
+      @model.reset_column_information
+    end
+  end
+
+  def disable(&block)
+    old_value = ForeignKeyMigrations.disable
+    ForeignKeyMigrations.disable = true
+    begin
+      yield
+    ensure
+      ForeignKeyMigrations.disable = old_value
+    end
+  end
+
 end
 

metadata

@@ -2,7 +2,7 @@
 name: aspgems-foreign_key_migrations
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-14 00:00:00 Z
+date: 2011-08-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aspgems-redhillonrails_core
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.0.0.beta2
+        version: 2.0.0.beta4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -80,6 +80,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Automatically generate foreign-key constraints when creating tables