automatic_foreign_key 1.2.0 → 1.3.0

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 .rvmrc
+.bundle

data/CHANGELOG

@@ -1,3 +1,5 @@
+1.3.0
+    * allow to disable automatic FK creation
 1.2.0
     * added install generator
     * fixed doubled auto-index inside Schema.define

data/Gemfile.lock

@@ -1,41 +1,42 @@
 PATH
   remote: .
   specs:
-    automatic_foreign_key (1.2.0)
+    automatic_foreign_key (1.3.0)
       activerecord (>= 2)
-      redhillonrails_core (~> 1.1.2)
+      redhillonrails_core (>= 1.2.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
       builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      arel (~> 2.0.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.3)
-    arel (2.0.7)
+    activesupport (3.0.9)
+    arel (2.0.10)
     builder (2.1.2)
     diff-lcs (1.1.2)
     i18n (0.5.0)
     mysql (2.8.1)
-    mysql2 (0.2.6)
+    mysql2 (0.2.11)
     pg (0.10.0)
-    redhillonrails_core (1.1.2)
-      activerecord
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rake (0.9.2)
+    redhillonrails_core (1.2.0)
+      activerecord (>= 2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
-    tzinfo (0.3.24)
+    rspec-mocks (2.6.0)
+    tzinfo (0.3.29)
 
 PLATFORMS
   ruby
@@ -43,6 +44,7 @@ PLATFORMS
 DEPENDENCIES
   automatic_foreign_key!
   mysql
-  mysql2
+  mysql2 (~> 0.2.11)
   pg
-  rspec (~> 2.4.0)
+  rake
+  rspec (~> 2.6.0)

data/README.rdoc

@@ -9,13 +9,24 @@ options to the schema column definition statements.
 
 === Installation
 
-As a gem
-    
-  gem install automatic_foreign_key
+    gem install automatic_foreign_key
+    rails generate automatic_foreign_key:install
 
-...or as a plugin
+=== Rails 3.1 compatibility
 
-  script/plugin install http://github.com/mlomnicki/automatic_foreign_key.git
+You need at least 1.3.0 version.
+Also explicit reference to redhillonrails_core 2.0.0.pre must be set.
+
+    gem "automatic_foreign_key", "~> 1.3.0"
+    gem "redhillonrails_core", "~> 2.0.0.pre"
+
+=== Rails 3.0 compatibility
+
+Fully compatible with Rails 3.
+
+=== Rails 2.x compatibility
+
+Only generator is not compatible
 
 === Usage
 
@@ -83,7 +94,7 @@ would be misinterpreted as a foreign-key (say for example if you named the prima
 
 There is also a generator for creating foreign keys on a database that currently has none:
 
-  ruby script/generate foreign_key_migration
+  ruby rails generate automatic_foreign_key:migration
 
 The plugin fully supports and understands the following active-record
 configuration properties:
@@ -92,7 +103,7 @@ configuration properties:
 * <code>config.active_record.table_name_prefix</code>
 * <code>config.active_record.table_name_suffix</code>
 
-=== Auto Indices 
+=== Auto Indices
 
 It's very common to create an index on foreign key. You can instruct
 AutomaticForeignKey to add an index after adding foreign key.
@@ -114,7 +125,7 @@ If you want to pass some options for index use hash params.
 Auto indexing option is useless for MySQL users as their RDBMS adds indices on foreign
 keys by default. However PostgreSQL users may have fun with that feature.
 
-=== Column Indices 
+=== Column Indices
 
 You can create an index on any column by specifying the +:index+ option.
 
@@ -149,20 +160,19 @@ For customization purposes create config/initializers/automatic_foreign_key.rb f
     config.auto_index = true # create indices on FKs by default
     config.on_update = :cascade # cascade as default on_update action
     config.on_delete = :restrict # restrict as default on_delete action
-  end
 
-=== Rails 3 compatibility
-
-    Automatic foreign key is fully compatible with Rails 3.
-
-=== Rails 2.x compatibility
-    
-    Everything but generator is compatible
+    config.disable = false # set to true if you want to disable auto foreign keys
+  end
 
 === Dependencies
 
 * RedHill on Rails Core (redhillonrails_core).
 
+=== Support
+
+Don't hesitate to ask questions on our mailing list.
+http://groups.google.com/group/rails-db
+
 === NOTE
 
 * Code was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
@@ -170,5 +180,5 @@ For customization purposes create config/initializers/automatic_foreign_key.rb f
 
 === License
 
-This plugin is copyright 2010 by Michał Łomnicki and is released
+This plugin is copyright 2011 by Michał Łomnicki and is released
 under the MIT license.

data/Rakefile

@@ -29,15 +29,16 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+DBNAME = "afk_unittest"
 namespace :postgresql do
   desc 'Build the PostgreSQL test databases'
   task :build_databases do
-    %x( createdb -E UTF8 afk_unittest )
+    %x( createdb -E UTF8 #{DBNAME} )
   end
 
   desc 'Drop the PostgreSQL test databases'
   task :drop_databases do
-    %x( dropdb afk_unittest )
+    %x( dropdb #{DBNAME} )
   end
 
   desc 'Rebuild the PostgreSQL test databases'
@@ -52,12 +53,12 @@ MYSQL_DB_USER = 'afk'
 namespace :mysql do
   desc 'Build the MySQL test databases'
   task :build_databases do
-    %x( echo "create DATABASE afk_unittest DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{MYSQL_DB_USER})
+    %x( echo "create DATABASE #{DBNAME} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{MYSQL_DB_USER})
   end
 
-  desc 'Drop the MySQL test databases' 
+  desc 'Drop the MySQL test databases'
   task :drop_databases do
-    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop afk_unittest )
+    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop #{DBNAME} )
   end
 
   desc 'Rebuild the MySQL test databases'

data/automatic_foreign_key.gemspec

@@ -21,11 +21,12 @@ constraints when creating tables or adding columns. It uses SQL-92 syntax and as
   s.require_paths = ["lib"]
 
   s.add_dependency("activerecord", ">= 2")
-  s.add_dependency("redhillonrails_core", "~> 1.1.2")
+  s.add_dependency("redhillonrails_core", ">= 1.2.0")
       
-  s.add_development_dependency("rspec", "~> 2.4.0")
+  s.add_development_dependency("rspec", "~> 2.6.0")
   s.add_development_dependency("pg")
   s.add_development_dependency("mysql")
-  s.add_development_dependency("mysql2")
+  s.add_development_dependency("mysql2", "~> 0.2.11")
+  s.add_development_dependency("rake")
 end
 

data/lib/automatic_foreign_key.rb

@@ -19,16 +19,21 @@ module AutomaticForeignKey
 
   end
 
-  # Default FK update action 
+  # Default FK update action
   mattr_accessor :on_update
-  
-  # Default FK delete action 
+
+  # Default FK delete action
   mattr_accessor :on_delete
 
   # Create an index after creating FK (default false)
   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
+
   def self.setup(&block)
     yield self
   end

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

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

data/lib/automatic_foreign_key/active_record/migration.rb

@@ -29,13 +29,17 @@ module AutomaticForeignKey::ActiveRecord
       #
       def add_column(table_name, column_name, type, options = {})
         super
-        handle_column_options(table_name, column_name, options)
+        unless AutomaticForeignKey.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 AutomaticForeignKey.disable
+          remove_foreign_key_if_exists(table_name, column_name)
+          handle_column_options(table_name, column_name, options)
+        end
       end
 
       protected

data/lib/automatic_foreign_key/version.rb

@@ -1,3 +1,3 @@
 module AutomaticForeignKey
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/generators/automatic_foreign_key/templates/automatic_foreign_key.rb

@@ -12,5 +12,8 @@ AutomaticForeignKey.setup do |config|
   # It's relevant for PostgreSQL only.
   # MySQL engines auto-index foreign keys by default
   # config.auto_index = true
+  #
+  # Disable automatic foreign key creation.
+  # config.disable = true
 
 end

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
       AutomaticForeignKey.auto_index = true
       create_table(@model,  :user_id => {},
@@ -182,17 +182,6 @@ describe ActiveRecord::Migration do
       AutomaticForeignKey.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 = AutomaticForeignKey.disable
+    AutomaticForeignKey.disable = true
+    begin
+      yield
+    ensure
+      AutomaticForeignKey.disable = old_value
+    end
+  end
+
 end
 

metadata

@@ -1,114 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: automatic_foreign_key
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+  prerelease: 
 platform: ruby
-authors: 
-- "Micha\xC5\x82 \xC5\x81omnicki"
+authors:
+- Michał Łomnicki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-23 00:00:00 +01:00
+date: 2011-07-22 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &79958930 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        version: "2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redhillonrails_core
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *79958930
+- !ruby/object:Gem::Dependency
+  name: redhillonrails_core
+  requirement: &79958130 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 2
-        version: 1.1.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *79958130
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &79957220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
-        version: 2.4.0
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: pg
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *79957220
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: &79956760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mysql
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *79956760
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: &79956040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *79956040
+- !ruby/object:Gem::Dependency
   name: mysql2
+  requirement: &79955350 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :development
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *79955350
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &79954720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-description: Automatic Foreign Key automatically generates foreign-key constraints when creating tables or adding columns. It uses SQL-92 syntax and as such should be compatible with most databases that support foreign-key constraints.
-email: 
+  prerelease: false
+  version_requirements: *79954720
+description: Automatic Foreign Key automatically generates foreign-key constraints
+  when creating tables or adding columns. It uses SQL-92 syntax and as such should
+  be compatible with most databases that support foreign-key constraints.
+email:
 - michal.lomnicki@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - CHANGELOG
@@ -150,34 +139,32 @@ files:
 has_rdoc: true
 homepage: https://github.com/mlomnicki/automatic_foreign_key
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 126095695
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 126095695
 requirements: []
-
 rubyforge_project: automatic_foreign_key
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Automatically generate foreign-key constraints when creating tables
 test_files: []
-