automatic_foreign_key 1.0.2 → 1.0.5

data/Rakefile

@@ -12,7 +12,7 @@ constraints when creating tables. It uses SQL-92 syntax and as such should be co
     gem.email = "michal.lomnicki@gmail.com"
     gem.homepage = "http://github.com/mlomnicki/automatic_foreign_key"
     gem.authors = ["Michał Łomnicki"]
-    gem.add_dependency "redhillonrails_core", ">= 1.0.2"
+    gem.add_dependency "redhillonrails_core", ">= 1.0.4.1"
     gem.add_dependency "activerecord", ">= 2.2"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -41,9 +41,32 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+require 'spec/rake/spectask'
+%w[postgresql mysql].each do |adapter|
+  namespace adapter do
+    Spec::Rake::SpecTask.new(:spec) do |spec|
+      spec.libs << 'lib' << 'spec' << "spec/connections/#{adapter}"
+      spec.spec_files = FileList['spec/**/*_spec.rb']
+    end
+  end
+end
+
+desc 'Run postgresql and mysql tests'
+task :spec do 
+  %w[postgresql mysql].each do |adapter|
+    Rake::Task["#{adapter}:spec"].invoke
+  end
+end
+
+task :spec => :check_dependencies
 
-task :default => :test
+task :default => :spec
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
@@ -54,3 +77,44 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+namespace :postgresql do
+  desc 'Build the PostgreSQL test databases'
+  task :build_databases do
+    %x( createdb -E UTF8 afk_unittest )
+    %x( createdb -E UTF8 afk_unittest2 )
+  end
+
+  desc 'Drop the PostgreSQL test databases'
+  task :drop_databases do
+    %x( dropdb afk_unittest )
+    %x( dropdb afk_unittest2 )
+  end
+
+  desc 'Rebuild the PostgreSQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
+end
+
+task :build_postgresql_databases => 'postgresql:build_databases'
+task :drop_postgresql_databases => 'postgresql:drop_databases'
+task :rebuild_postgresql_databases => 'postgresql:rebuild_databases'
+
+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})
+  end
+
+  desc 'Drop the MySQL test databases' 
+  task :drop_databases do
+    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop afk_unittest )
+  end
+
+  desc 'Rebuild the MySQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
+end
+
+task :build_mysql_databases => 'mysql:build_databases'
+task :drop_mysql_databases => 'mysql:drop_databases'
+task :rebuild_mysql_databases => 'mysql:rebuild_databases'

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.5

data/automatic_foreign_key.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{automatic_foreign_key}
-  s.version = "1.0.2"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michał Łomnicki"]
-  s.date = %q{2010-03-30}
+  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.email = %q{michal.lomnicki@gmail.com}
@@ -32,27 +32,51 @@ constraints when creating tables. It uses SQL-92 syntax and as such should be co
      "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",
-     "lib/generators/automatic_foreign_key/templates/migration.rb"
+     "lib/generators/automatic_foreign_key/templates/migration.rb",
+     "spec/aaa_create_tables_spec.rb",
+     "spec/connections/mysql/connection.rb",
+     "spec/connections/postgresql/connection.rb",
+     "spec/migration_spec.rb",
+     "spec/models/comment.rb",
+     "spec/models/post.rb",
+     "spec/models/user.rb",
+     "spec/references_spec.rb",
+     "spec/schema/schema.rb",
+     "spec/spec_helper.rb",
+     "spec/support/matchers/automatic_foreign_key_matchers.rb"
   ]
   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.summary = %q{Automatically generate foreign-key constraints when creating tables}
+  s.test_files = [
+    "spec/schema/schema.rb",
+     "spec/connections/postgresql/connection.rb",
+     "spec/connections/mysql/connection.rb",
+     "spec/aaa_create_tables_spec.rb",
+     "spec/support/matchers/automatic_foreign_key_matchers.rb",
+     "spec/spec_helper.rb",
+     "spec/references_spec.rb",
+     "spec/migration_spec.rb",
+     "spec/models/user.rb",
+     "spec/models/post.rb",
+     "spec/models/comment.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redhillonrails_core>, [">= 1.0.2"])
+      s.add_runtime_dependency(%q<redhillonrails_core>, [">= 1.0.4.1"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.2"])
     else
-      s.add_dependency(%q<redhillonrails_core>, [">= 1.0.2"])
+      s.add_dependency(%q<redhillonrails_core>, [">= 1.0.4.1"])
       s.add_dependency(%q<activerecord>, [">= 2.2"])
     end
   else
-    s.add_dependency(%q<redhillonrails_core>, [">= 1.0.2"])
+    s.add_dependency(%q<redhillonrails_core>, [">= 1.0.4.1"])
     s.add_dependency(%q<activerecord>, [">= 2.2"])
   end
 end

data/lib/automatic_foreign_key/active_record/base.rb

@@ -1,10 +1,24 @@
 module AutomaticForeignKey::ActiveRecord
   module Base
-    def self.included(base)
+    def self.included(base) # :nodoc
       base.extend(ClassMethods)
     end
 
     module ClassMethods
+      # Determines referenced table and column.
+      # Used in migrations.
+      #   references('comments', 'post_id') # => ['posts', 'id']
+      #
+      # If <tt>column_name</tt> is parent_id it references to the same table
+      #   references('pages', 'parent_id')  # => ['pages', 'id']
+      #
+      # If referenced table cannot be determined properly it may be overriden
+      #   references('widgets', 'main_page_id', :references => 'pages')) 
+      #   # => ['pages', 'id']
+      #
+      # Also whole result may be given by hand
+      #   references('addresses', 'member_id', :references => ['users', 'uuid'])
+      #   # => ['users', 'uuid']
       def references(table_name, column_name, options = {})
         column_name = column_name.to_s
         if options.has_key?(:references)

data/lib/automatic_foreign_key/active_record/migration.rb

@@ -5,6 +5,20 @@ module AutomaticForeignKey::ActiveRecord
     end
 
     module ClassMethods
+      # Overrides standard ActiveRecord add column and adds 
+      # foreign key if column references other column
+      #
+      # add_column('comments', 'post_id', :integer)
+      #   # creates a column and adds foreign key on posts(id)
+      #
+      # 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
         references = ActiveRecord::Base.references(table_name, column_name, options)

data/lib/automatic_foreign_key.rb

@@ -1,4 +1,5 @@
 begin
+  require 'active_support'
   require 'redhillonrails_core'
 rescue
   gem 'redhillonrails_core'

data/spec/aaa_create_tables_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# This is not a test really. It just here to create schema
+# The filename begins with "aaa" to ensure this is executed initially
+
+ActiveRecord::Migration.suppress_messages do
+  load_schema
+end

data/spec/connections/mysql/connection.rb

@@ -0,0 +1,18 @@
+print "Using MySQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+ActiveRecord::Base.configurations = {
+  'afk' => {
+    :adapter => 'mysql',
+    :database => 'afk_unittest',
+    :username => 'afk',
+    :encoding => 'utf8',
+    :socket => '/var/run/mysqld/mysqld.sock',
+    :min_messages => 'warning'
+  }
+
+}
+
+ActiveRecord::Base.establish_connection 'afk'

data/spec/connections/postgresql/connection.rb

@@ -0,0 +1,15 @@
+print "Using PostgreSQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+ActiveRecord::Base.configurations = {
+  'afk' => {
+    :adapter => 'postgresql',
+    :database => 'afk_unittest',
+    :min_messages => 'warning'
+  }
+
+}
+
+ActiveRecord::Base.establish_connection 'afk'

data/spec/migration_spec.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'models/post'
+require 'models/comment'
+
+describe ActiveRecord::Base do
+
+  it "should respond to references" do
+    ActiveRecord::Base.should respond_to :references
+  end
+
+end
+
+describe ActiveRecord::Migration do
+
+  context "when table is created" do
+    it "should create foreign keys" do
+      create_table(Post,  :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)
+    end
+
+  end
+
+  context "when column is added" do
+
+    before(:all) do
+      @model = Comment
+    end
+
+    it "should create foreign key" do
+      add_column(:post_id, :integer) do
+        @model.should reference(:posts, :id).on(:post_id)
+      end
+    end
+
+    it "should create foreign key to explicity given table" do
+      add_column(:author_id, :integer, :references => :users) do
+        @model.should reference(:users, :id).on(:author_id)
+      end
+    end
+
+    it "should create foreign key to explicity given table and column name" do
+      add_column(:author_login, :string, :references => [:users, :login]) do 
+        @model.should reference(:users, :login).on(:author_login) 
+      end
+    end
+
+    it "should create foreign key to the same table on parent_id" do
+      add_column(:parent_id, :integer) do
+        @model.should reference(@model.table_name, :id).on(:parent_id)
+      end
+    end
+
+    it "shouldn't create foreign key if column doesn't look like foreign key" do
+      add_column(:views_count, :integer) do
+        @model.should_not reference.on(:views_count)
+      end
+    end
+
+    it "shouldnt't create foreign key if specified explicity" do
+      add_column(:post_id, :integer, :references => nil) do
+        @model.should_not reference.on(:post_id)
+      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
+
+  end
+    
+  def foreign_key(model, column)
+    columns = Array(column)
+    model.foreign_keys.detect { |fk| fk.table_name == model.table_name && fk.column_names == columns } 
+  end
+  
+  def create_table(model, columns_with_options)
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.create_table model.table_name, :force => true do |t|
+        columns_with_options.each_pair do |column, options|
+          t.integer column, options
+        end
+      end
+      model.reset_column_information
+    end
+  end
+
+end
+

data/spec/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end

data/spec/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_many :comments
+end

data/spec/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/references_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'references method' do
+
+  before(:all) do
+    @target = ActiveRecord::Base
+    @table_name = 'comments'
+    @column_name = 'post_id'
+    @destination_table = 'posts'
+    @destinantion_column = :id
+  end
+
+  it "should accept table name and column name to references" do
+    lambda { @target.references(@table_name, @column_name) }.should_not raise_error
+  end
+
+  it "should return an array" do
+    @target.references(@table_name, @column_name).should be_an(Array)
+  end
+
+  it "should split column name to table name and primary key" do
+    result = @target.references(@table_name, @column_name)
+    result[0].should eql @destination_table
+    result[1].should eql @destinantion_column
+  end
+
+  it "should handle parent_id as belonging to the same table" do
+    column_name = 'parent_id'
+    result = @target.references(@table_name, column_name)
+    result[0].should eql @table_name
+    result[1].should eql :id
+  end
+
+  it "should accept :references option which overrides default table name" do
+    result = @target.references(@table_name, @column_name, :references => 'users')
+    result[0].should eql 'users'
+    result[1].should eql :id
+  end
+
+  it "should accept :references option which overrides default table name and default column name" do
+    result = @target.references(@table_name, @column_name, :references => ['users', 'uuid'])
+    result[0].should eql 'users'
+    result[1].should eql 'uuid'
+  end
+
+end
+

data/spec/schema/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+
+  create_table :users, :force => true do |t|
+    t.string :login
+  end
+  add_index :users, :login, :unique => true
+  
+  create_table :comments, :force => true do |t|
+    t.string :content
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string :content
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'automatic_foreign_key'
+require 'spec'
+require 'spec/autorun'
+require 'connection'
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  config.include(AutomaticForeignKeyMatchers)
+end
+
+def load_schema
+  eval(File.read(File.join(File.dirname(__FILE__), 'schema', 'schema.rb')))
+end

data/spec/support/matchers/automatic_foreign_key_matchers.rb

@@ -0,0 +1,52 @@
+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
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 +02:00
+date: 2010-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,8 +27,9 @@ dependencies:
         segments: 
         - 1
         - 0
-        - 2
-        version: 1.0.2
+        - 4
+        - 1
+        version: 1.0.4.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -71,6 +72,17 @@ files:
 - lib/automatic_foreign_key/active_record/migration.rb
 - lib/generators/automatic_foreign_key/migration_generator.rb
 - lib/generators/automatic_foreign_key/templates/migration.rb
+- spec/aaa_create_tables_spec.rb
+- spec/connections/mysql/connection.rb
+- spec/connections/postgresql/connection.rb
+- spec/migration_spec.rb
+- spec/models/comment.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/references_spec.rb
+- spec/schema/schema.rb
+- spec/spec_helper.rb
+- spec/support/matchers/automatic_foreign_key_matchers.rb
 has_rdoc: true
 homepage: http://github.com/mlomnicki/automatic_foreign_key
 licenses: []
@@ -101,5 +113,15 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Automatically generate foreign-key constraints when creating tables
-test_files: []
-
+test_files: 
+- spec/schema/schema.rb
+- spec/connections/postgresql/connection.rb
+- spec/connections/mysql/connection.rb
+- spec/aaa_create_tables_spec.rb
+- spec/support/matchers/automatic_foreign_key_matchers.rb
+- spec/spec_helper.rb
+- spec/references_spec.rb
+- spec/migration_spec.rb
+- spec/models/user.rb
+- spec/models/post.rb
+- spec/models/comment.rb