automatic_foreign_key 1.0.5 → 1.1.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+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

data/README.rdoc

@@ -77,6 +77,33 @@ configuration properties:
 * <code>config.active_record.table_name_prefix</code>
 * <code>config.active_record.table_name_suffix</code>
 
+=== 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.
+
+  create_table :orders, :id => false do |t|
+    ...
+    t.integer :order_id, :index => true
+  end
+
+If you want to pass some options for index use hash params.
+
+  create_table :bills, :id => false do |t|
+    ...
+    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
+keys by default. However PostgreSQL users may have fun with that feature.
+
+=== Configuration ===
+
+For customization purposes create config/initializers/automatic_foreign_key.rb file:
+AutomaticForeignKey.auto_index = true # create indices on FKs by default
+AutomaticForeignKey.on_update = :cascade # cascade as default on_update action
+AutomaticForeignKey.on_delete = :restrtic # restrict as default on_delete action
+
 === Rails 3 compatibility
 
     Automatic foreign key is fully compatibly with Rails 3.

data/Rakefile

@@ -7,8 +7,8 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "automatic_foreign_key"
     gem.summary = %Q{Automatically generate foreign-key constraints when creating tables}
-    gem.description = %Q{Automatic Key Migrations is a gem that automatically generates foreign-key
-constraints when creating tables. It uses SQL-92 syntax and as such should be compatible with most databases that support foreign-key constraints.}
+    gem.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.}
     gem.email = "michal.lomnicki@gmail.com"
     gem.homepage = "http://github.com/mlomnicki/automatic_foreign_key"
     gem.authors = ["Michał Łomnicki"]

data/VERSION

@@ -1 +1 @@
-1.0.5
+1.1.0

data/automatic_foreign_key.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{automatic_foreign_key}
-  s.version = "1.0.5"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michał Łomnicki"]
-  s.date = %q{2010-04-06}
-  s.description = %q{Automatic Key Migrations is a gem that automatically generates foreign-key
-constraints when creating tables. It uses SQL-92 syntax and as such should be compatible with most databases that support foreign-key constraints.}
+  s.authors = ["Micha\305\202 \305\201omnicki"]
+  s.date = %q{2010-06-12}
+  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}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -43,7 +43,9 @@ constraints when creating tables. It uses SQL-92 syntax and as such should be co
      "spec/references_spec.rb",
      "spec/schema/schema.rb",
      "spec/spec_helper.rb",
-     "spec/support/matchers/automatic_foreign_key_matchers.rb"
+     "spec/support/matchers/automatic_foreign_key_matchers.rb",
+     "spec/support/matchers/have_index.rb",
+     "spec/support/matchers/reference.rb"
   ]
   s.homepage = %q{http://github.com/mlomnicki/automatic_foreign_key}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -55,7 +57,9 @@ constraints when creating tables. It uses SQL-92 syntax and as such should be co
      "spec/connections/postgresql/connection.rb",
      "spec/connections/mysql/connection.rb",
      "spec/aaa_create_tables_spec.rb",
+     "spec/support/matchers/have_index.rb",
      "spec/support/matchers/automatic_foreign_key_matchers.rb",
+     "spec/support/matchers/reference.rb",
      "spec/spec_helper.rb",
      "spec/references_spec.rb",
      "spec/migration_spec.rb",

data/lib/automatic_foreign_key.rb

@@ -16,6 +16,18 @@ module AutomaticForeignKey
     end
 
   end
+
+  # Default FK update action 
+  mattr_accessor :on_update
+  
+  # Default FK delete action 
+  mattr_accessor :on_delete
+
+  # Create an index after creating FK (default false)
+  mattr_accessor :auto_index
+  @@auto_index = nil
+
+
 end
 
 ActiveRecord::Base.send(:include, AutomaticForeignKey::ActiveRecord::Base)

data/lib/automatic_foreign_key/active_record/migration.rb

@@ -11,19 +11,44 @@ module AutomaticForeignKey::ActiveRecord
       # add_column('comments', 'post_id', :integer)
       #   # creates a column and adds foreign key on posts(id)
       #
+      # add_column('comments', 'post_id', :integer, :on_update => :cascade, :on_delete => :cascade)
+      #   # creates a column and adds foreign key on posts(id) with cascade actions on update and on delete
+      #
+      # add_column('comments', 'post_id', :integer, :index => true)
+      #   # creates a column and adds foreign key on posts(id)
+      #   # additionally adds index on posts(id)
+      #
+      # add_column('comments', 'post_id', :integer, :index => { :unique => true, :name => 'comments_post_id_unique_index' }))
+      #   # creates a column and adds foreign key on posts(id)
+      #   # additionally adds unique index on posts(id) named comments_post_id_unique_index
+      #
       # add_column('addresses', 'citizen_id', :integer, :references => :users
       #   # creates a column and adds foreign key on users(id)
       #
       # add_column('addresses', 'citizen_id', :integer, :references => [:users, :uuid]
       #   # creates a column and adds foreign key on users(uuid)
       #
-      # add_column('users', 'verified')
-      #   # just creates a column as usually
       def add_column(table_name, column_name, type, options = {})
         super
+        index = options.fetch(:index, AutomaticForeignKey.auto_index)
         references = ActiveRecord::Base.references(table_name, column_name, options)
-        add_foreign_key(table_name, column_name, references.first, references.last, options) if references
+        if references
+          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)
+      end
+
     end
   end
 end

data/spec/migration_spec.rb

@@ -68,6 +68,71 @@ describe ActiveRecord::Migration do
       end
     end
 
+    it "should create an index if specified" do
+      add_column(:post_id, :integer, :index => true) do
+        @model.should have_index.on(:post_id)
+      end
+    end
+
+    it "should create a unique index if specified" do
+      add_column(:post_id, :integer, :index => { :unique => true }) do
+        @model.should have_unique_index.on(:post_id)
+      end
+    end
+
+    it "should allow custom name for index" do
+      index_name = 'comments_post_id_unique_index'
+      add_column(:post_id, :integer, :index => { :unique => true, :name => index_name }) do
+        @model.should have_unique_index(:name => index_name).on(:post_id)
+      end
+    end
+
+    it "should auto-create index if specified in global options" do
+      AutomaticForeignKey.auto_index = true
+      add_column(:post_id, :integer) do
+        @model.should have_index.on(:post_id)
+      end
+      AutomaticForeignKey.auto_index = false
+    end
+
+    it "should allow to overwrite auto_index options in column definition" do
+      AutomaticForeignKey.auto_index = true
+      add_column(:post_id, :integer, :index => false) do
+        # MySQL creates an index on foreign by default
+        # and we can do nothing with that
+        unless mysql?
+          @model.should_not have_index.on(:post_id)
+        end
+      end
+      AutomaticForeignKey.auto_index = false
+    end
+
+    it "should use default on_update action" do
+      AutomaticForeignKey.on_update = :cascade
+      add_column(:post_id, :integer) do
+        @model.should reference.on(:post_id).on_update(:cascade) 
+      end
+      AutomaticForeignKey.on_update = nil
+    end
+
+    it "should use default on_delete action" do
+      AutomaticForeignKey.on_delete = :cascade
+      add_column(:post_id, :integer) do
+        @model.should reference.on(:post_id).on_delete(:cascade) 
+      end
+      AutomaticForeignKey.on_delete = nil
+    end
+
+    it "should allow to overwrite default actions" do
+      AutomaticForeignKey.on_delete = :cascade
+      AutomaticForeignKey.on_update = :restrict
+      add_column(:post_id, :integer, :on_update => :set_null, :on_delete => :set_null) do
+        @model.should reference.on(:post_id).on_delete(:set_null).on_update(:set_null)
+      end
+      AutomaticForeignKey.on_delete = nil
+    end
+
+    protected
     def add_column(column_name, *args)
       table = @model.table_name
       ActiveRecord::Migration.suppress_messages do
@@ -81,10 +146,14 @@ describe ActiveRecord::Migration do
   end
     
   def foreign_key(model, column)
-    columns = Array(column)
+    columns = Array(column).collect(&:to_s)
     model.foreign_keys.detect { |fk| fk.table_name == model.table_name && fk.column_names == columns } 
   end
-  
+
+  def mysql?
+    ActiveRecord::Base.connection.adapter_name == 'MySQL'
+  end
+
   def create_table(model, columns_with_options)
     ActiveRecord::Migration.suppress_messages do
       ActiveRecord::Migration.create_table model.table_name, :force => true do |t|

data/spec/support/matchers/automatic_foreign_key_matchers.rb

@@ -1,52 +1,2 @@
-module AutomaticForeignKeyMatchers
-
-  class Reference
-    def initialize(expected)
-      @column_names = nil
-      unless expected.empty?
-        @references_column_names = Array(expected).collect(&:to_s)
-        @references_table_name = @references_column_names.shift 
-      end
-    end
-
-    def matches?(model)
-      @model = model
-      if @references_table_name
-        @result = @model.foreign_keys.select do |fk|
-          fk.references_table_name == @references_table_name && 
-            fk.references_column_names == @references_column_names
-        end
-      else
-        @result = @model.foreign_keys
-      end
-      if @column_names 
-        @result.any? { |fk| fk.column_names == @column_names }
-      else
-        !!@result
-      end
-    end
-
-    def failure_message_for_should(should_not = false)
-      target_column_names = @column_names.present? ? "(#{@column_names.join(', ')})" : "" 
-      destinantion_column_names = @references_table_name ? "#{@references_table_name}(#{@references_column_names.join(', ')})" : "anything"
-      invert = should_not ? 'not' : ''
-      "Expected #{@model.table_name}#{target_column_names} #{invert} to reference #{destinantion_column_names}"
-    end
-
-    def failure_message_for_should_not
-      failure_message_for_should(true)
-    end
-  
-    def on(*column_names)
-      @column_names = column_names.collect(&:to_s)
-      self
-    end
-
-  end
-
-  def reference(*expect)
-    Reference.new(expect)
-  end
-
-end
-
+require 'support/matchers/reference'
+require 'support/matchers/have_index'

data/spec/support/matchers/have_index.rb

@@ -0,0 +1,52 @@
+module AutomaticForeignKeyMatchers
+
+  class HaveIndex
+
+    def initialize(expectation, options = {})
+      set_required_columns(expectation, options)
+    end
+
+    def matches?(model)
+      @model = model
+      @model.indexes.any? do |index|
+        index.columns.to_set == @required_columns &&
+          (@unique  ? index.unique : true) &&
+          (@name    ? index.name == @name.to_s : true)
+      end
+    end
+
+    def failure_message_for_should(should_not = false)
+      invert = should_not ? "not to" : ""
+      "Expected #{@model.table_name} to #{invert} contain index on #{@required_columns.entries.inspect}"
+    end
+
+    def failure_message_for_should_not
+      failure_message_for_should(true)
+    end
+
+    def on(expectation)
+      set_required_columns(expectation)
+      self
+    end
+
+    private
+    def set_required_columns(expectation, options = {})
+      @required_columns = Array(expectation).collect(&:to_s).to_set
+      @unique = options.delete(:unique)
+      @name   = options.delete(:name)
+    end
+
+  end
+
+  def have_index(*expectation)
+    options = expectation.extract_options!
+    HaveIndex.new(expectation, options)
+  end
+
+  def have_unique_index(*expectation)
+    options = expectation.extract_options!
+    options[:unique] = true
+    HaveIndex.new(expectation, options)
+  end
+
+end

data/spec/support/matchers/reference.rb

@@ -0,0 +1,66 @@
+module AutomaticForeignKeyMatchers
+
+  class Reference
+    def initialize(expected)
+      @column_names = nil
+      unless expected.empty?
+        @references_column_names = Array(expected).collect(&:to_s)
+        @references_table_name = @references_column_names.shift 
+      end
+    end
+
+    def matches?(model)
+      @model = model
+      if @references_table_name
+        @result = @model.foreign_keys.select do |fk|
+          fk.references_table_name == @references_table_name && 
+            fk.references_column_names == @references_column_names
+        end
+      else
+        @result = @model.foreign_keys
+      end
+      if @column_names 
+        @result.any? do |fk| 
+          fk.column_names == @column_names &&
+            (@on_update ? fk.on_update == @on_update : true) &&
+            (@on_delete ? fk.on_delete == @on_delete : true)
+        end
+      else
+        !!@result
+      end
+    end
+
+    def failure_message_for_should(should_not = false)
+      target_column_names = @column_names.present? ? "(#{@column_names.join(', ')})" : "" 
+      destinantion_column_names = @references_table_name ? "#{@references_table_name}(#{@references_column_names.join(', ')})" : "anything"
+      invert = should_not ? 'not' : ''
+      "Expected #{@model.table_name}#{target_column_names} #{invert} to reference #{destinantion_column_names}"
+    end
+
+    def failure_message_for_should_not
+      failure_message_for_should(true)
+    end
+  
+    def on(*column_names)
+      @column_names = column_names.collect(&:to_s)
+      self
+    end
+
+    def on_update(action)
+      @on_update = action
+      self
+    end
+
+    def on_delete(action)
+      @on_delete = action
+      self
+    end
+
+  end
+
+  def reference(*expect)
+    Reference.new(expect)
+  end
+
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 5
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 +02:00
+date: 2010-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,8 +46,8 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 description: |-
-  Automatic Key Migrations is a gem that automatically generates foreign-key
-  constraints when creating tables. It uses SQL-92 syntax and as such should be compatible with most databases that support foreign-key constraints.
+  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: []
 
@@ -83,6 +83,8 @@ files:
 - spec/schema/schema.rb
 - spec/spec_helper.rb
 - spec/support/matchers/automatic_foreign_key_matchers.rb
+- spec/support/matchers/have_index.rb
+- spec/support/matchers/reference.rb
 has_rdoc: true
 homepage: http://github.com/mlomnicki/automatic_foreign_key
 licenses: []
@@ -118,7 +120,9 @@ test_files:
 - spec/connections/postgresql/connection.rb
 - spec/connections/mysql/connection.rb
 - spec/aaa_create_tables_spec.rb
+- spec/support/matchers/have_index.rb
 - spec/support/matchers/automatic_foreign_key_matchers.rb
+- spec/support/matchers/reference.rb
 - spec/spec_helper.rb
 - spec/references_spec.rb
 - spec/migration_spec.rb