automatic_foreign_key 1.1.0 → 1.1.5

data/README.rdoc

@@ -77,7 +77,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.
@@ -94,10 +94,12 @@ If you want to pass some options for index use hash params.
     t.integer :order_id, :index => { :unique => true, :name => 'foo_index' }
   end
 
-That option is useless for MySQL users as their RDBMS adds indices on foreign
+==== NOTE
+
+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.
 
-=== Configuration ===
+=== Configuration
 
 For customization purposes create config/initializers/automatic_foreign_key.rb file:
 AutomaticForeignKey.auto_index = true # create indices on FKs by default

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.5

data/automatic_foreign_key.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{automatic_foreign_key}
-  s.version = "1.1.0"
+  s.version = "1.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Micha\305\202 \305\201omnicki"]
-  s.date = %q{2010-06-12}
+  s.authors = ["Michał Łomnicki"]
+  s.date = %q{2010-09-07}
   s.description = %q{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.}
   s.email = %q{michal.lomnicki@gmail.com}
@@ -29,6 +29,7 @@ constraints when creating tables or adding columns. It uses SQL-92 syntax and as
      "install.rb",
      "lib/automatic_foreign_key.rb",
      "lib/automatic_foreign_key/active_record/base.rb",
+     "lib/automatic_foreign_key/active_record/connection_adapters/schema_statements.rb",
      "lib/automatic_foreign_key/active_record/connection_adapters/table_definition.rb",
      "lib/automatic_foreign_key/active_record/migration.rb",
      "lib/generators/automatic_foreign_key/migration_generator.rb",
@@ -50,7 +51,7 @@ constraints when creating tables or adding columns. It uses SQL-92 syntax and as
   s.homepage = %q{http://github.com/mlomnicki/automatic_foreign_key}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Automatically generate foreign-key constraints when creating tables}
   s.test_files = [
     "spec/schema/schema.rb",
@@ -72,7 +73,7 @@ constraints when creating tables or adding columns. It uses SQL-92 syntax and as
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<redhillonrails_core>, [">= 1.0.4.1"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.2"])
     else

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

@@ -0,0 +1,22 @@
+module AutomaticForeignKey::ActiveRecord::ConnectionAdapters
+  module SchemaStatements
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :create_table, :automatic_foreign_key
+      end
+    end
+
+    def create_table_with_automatic_foreign_key(table, options = {})
+      indices = nil
+      create_table_without_automatic_foreign_key(table, options) do |table_definition|
+        yield table_definition if block_given?
+        indices = table_definition.indices
+      end
+      indices.each do |column_name, index_options|
+        add_index(table, column_name, index_options)
+      end 
+    end
+
+  end
+end

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

@@ -1,7 +1,11 @@
+require 'active_support'
+require 'active_support/core_ext/module/attr_accessor_with_default'
+
 module AutomaticForeignKey::ActiveRecord::ConnectionAdapters
   module TableDefinition
     def self.included(base)
       base.class_eval do
+        attr_accessor_with_default :indices, Array.new
         alias_method_chain :column, :automatic_foreign_key
         alias_method_chain :primary_key, :automatic_foreign_key
       end
@@ -14,7 +18,15 @@ 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)
-      foreign_key(name, references.first, references.last, options) if references
+      if references
+        AutomaticForeignKey.set_default_update_and_delete_actions!(options)
+        foreign_key(name, references.first, references.last, options) 
+      end
+      index = options.fetch(:index, AutomaticForeignKey.auto_index)
+      if index
+        # append [column_name, index_options] pair
+        self.indices << [name, AutomaticForeignKey.options_for_index(index)]
+      end
       self
     end
 

data/lib/automatic_foreign_key/active_record/migration.rb

@@ -33,20 +33,10 @@ module AutomaticForeignKey::ActiveRecord
         index = options.fetch(:index, AutomaticForeignKey.auto_index)
         references = ActiveRecord::Base.references(table_name, column_name, options)
         if references
-          set_default_update_and_delete_actions!(options)
+          AutomaticForeignKey.set_default_update_and_delete_actions!(options)
           add_foreign_key(table_name, column_name, references.first, references.last, options) 
         end
-        add_index(table_name, column_name, options_for_index(index)) if index
-      end
-
-      private
-      def options_for_index(index)
-        index.is_a?(Hash) ? index : {}
-      end
-
-      def set_default_update_and_delete_actions!(options)
-        options[:on_update] = options.fetch(:on_update, AutomaticForeignKey.on_update)
-        options[:on_delete] = options.fetch(:on_delete, AutomaticForeignKey.on_delete)
+        add_index(table_name, column_name, AutomaticForeignKey.options_for_index(index)) if index
       end
 
     end

data/lib/automatic_foreign_key.rb

@@ -13,6 +13,7 @@ module AutomaticForeignKey
 
     module ConnectionAdapters
       autoload :TableDefinition, 'automatic_foreign_key/active_record/connection_adapters/table_definition'
+      autoload :SchemaStatements, 'automatic_foreign_key/active_record/connection_adapters/schema_statements'
     end
 
   end
@@ -27,9 +28,18 @@ module AutomaticForeignKey
   mattr_accessor :auto_index
   @@auto_index = nil
 
+  def self.options_for_index(index)
+    index.is_a?(Hash) ? index : {}
+  end
+
+  def self.set_default_update_and_delete_actions!(options)
+    options[:on_update] = options.fetch(:on_update, AutomaticForeignKey.on_update)
+    options[:on_delete] = options.fetch(:on_delete, AutomaticForeignKey.on_delete)
+  end
 
 end
 
 ActiveRecord::Base.send(:include, AutomaticForeignKey::ActiveRecord::Base)
 ActiveRecord::Migration.send(:include, AutomaticForeignKey::ActiveRecord::Migration)
 ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, AutomaticForeignKey::ActiveRecord::ConnectionAdapters::TableDefinition)
+ActiveRecord::ConnectionAdapters::SchemaStatements.send(:include, AutomaticForeignKey::ActiveRecord::ConnectionAdapters::SchemaStatements)

data/spec/connections/mysql/connection.rb

@@ -1,8 +1,6 @@
 print "Using MySQL\n"
 require 'logger'
 
-ActiveRecord::Base.logger = Logger.new("debug.log")
-
 ActiveRecord::Base.configurations = {
   'afk' => {
     :adapter => 'mysql',

data/spec/connections/postgresql/connection.rb

@@ -1,8 +1,6 @@
 print "Using PostgreSQL\n"
 require 'logger'
 
-ActiveRecord::Base.logger = Logger.new("debug.log")
-
 ActiveRecord::Base.configurations = {
   'afk' => {
     :adapter => 'postgresql',

data/spec/migration_spec.rb

@@ -15,13 +15,44 @@ end
 describe ActiveRecord::Migration do
 
   context "when table is created" do
+    before(:all) do
+      @model = Post
+    end
+    
+
     it "should create foreign keys" do
-      create_table(Post,  :user_id => {}, 
+      create_table(@model,  :user_id => {}, 
                           :author_id => { :references => :users },
                           :member_id => { :references => nil } )
-      Post.should reference(:users, :id).on(:user_id)
-      Post.should reference(:users, :id).on(:author_id)
-      Post.should_not reference.on(:member_id)
+      @model.should reference(:users, :id).on(:user_id)
+      @model.should reference(:users, :id).on(:author_id)
+      @model.should_not reference.on(:member_id)
+    end
+
+    it "should use default on_cascade action" do
+      AutomaticForeignKey.on_update = :cascade
+      create_table(@model, :user_id => {})
+      AutomaticForeignKey.on_update = nil
+      @model.should reference.on(:user_id).on_update(:cascade) 
+    end
+
+    it "should use default on_cascade action" do
+      AutomaticForeignKey.on_delete = :cascade
+      create_table(@model, :user_id => {})
+      AutomaticForeignKey.on_delete = nil
+      @model.should reference.on(:user_id).on_delete(:cascade) 
+    end
+
+    it "should create an index if specified" do
+      create_table(@model, :state => { :index => true }) 
+      @model.should have_index.on(:state)
+    end
+    
+    it "should auto-create index if specified in global options" do
+      AutomaticForeignKey.auto_index = nil
+      create_table(@model, :state => {}) 
+      @model.should have_index.on(:state)
+      AutomaticForeignKey.auto_index = false
     end
 
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 5
+  version: 1.1.5
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-12 00:00:00 +02:00
+date: 2010-09-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redhillonrails_core
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -36,6 +37,7 @@ dependencies:
   name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -68,6 +70,7 @@ files:
 - install.rb
 - lib/automatic_foreign_key.rb
 - lib/automatic_foreign_key/active_record/base.rb
+- lib/automatic_foreign_key/active_record/connection_adapters/schema_statements.rb
 - lib/automatic_foreign_key/active_record/connection_adapters/table_definition.rb
 - lib/automatic_foreign_key/active_record/migration.rb
 - lib/generators/automatic_foreign_key/migration_generator.rb
@@ -95,6 +98,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -102,6 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -111,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Automatically generate foreign-key constraints when creating tables