aspgems-foreign_key_migrations 2.0.0.beta1

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,24 @@
+ActiveRecord::Schema.define do
+
+  create_table :users, :force => true do |t|
+    t.string :login
+  end
+  add_index :users, :login, :unique => true
+
+  create_table :members, :force => true do |t|
+    t.string :login
+  end
+
+  create_table :comments, :force => true do |t|
+    t.string :content
+    t.integer :user
+    t.integer :user_id
+  end
+
+  add_foreign_key :comments, :user_id, :users, :id
+
+  create_table :posts, :force => true do |t|
+    t.string :content
+  end
+
+end

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'stringio'
+
+require 'models/post'
+
+describe "Schema dump" do
+
+  let(:dump) do
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.ignore_tables = []
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  end
+
+  it "shouldn't include :index option for index" do
+    add_column(:author_id, :integer, :references => :users, :index => true) do
+      dump.should_not match(/index => true/)
+    end
+  end
+    
+  protected
+  def add_column(column_name, *args)
+    table = Post.table_name
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.add_column(table, column_name, *args)
+      Post.reset_column_information
+      yield if block_given?
+      ActiveRecord::Migration.remove_column(table, column_name)
+    end
+  end
+
+end

data/spec/schema_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActiveRecord::Schema do
+
+  let(:schema) { ActiveRecord::Schema }
+
+  let(:connection) { ActiveRecord::Base.connection }
+
+  after(:all) do
+    # revert to general schema
+    ActiveRecord::Migration.suppress_messages do
+      load 'schema/schema.rb'
+    end
+  end
+
+  context "defining with auto_index" do
+
+    it "should pass" do
+      with_auto_index do
+        expect { define_schema }.should_not raise_error
+      end
+    end
+
+    it "should create only explicity added indexes" do
+      with_auto_index do
+        define_schema
+        connection.tables.collect { |table| connection.indexes(table) }.flatten.should have_at_most(1).item
+      end
+    end
+
+  end
+
+  protected
+  def define_schema
+    ActiveRecord::Migration.suppress_messages do
+      schema.define do
+        create_table :users, :force => true do
+        end
+
+        create_table :posts, :force => true do |t|
+          t.integer :user_id
+        end
+
+        create_table :comments, :force => true do |t|
+          t.integer :user_id
+        end
+
+        # mysql will create index on FK automatically
+        unless ForeignKeyMigrationsHelpers.mysql?
+          add_index :posts, :user_id
+          add_index :comments, :user_id
+        end
+      end
+    end
+  end
+
+  def with_auto_index(value = true)
+    old_value = ForeignKeyMigrations.auto_index
+    ForeignKeyMigrations.auto_index = value
+    yield
+  ensure
+    ForeignKeyMigrations.auto_index = old_value
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'rspec'
+require 'foreign_key_migrations'
+require 'connection'
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include(ForeignKeyMigrationsMatchers)
+end
+
+def load_schema
+  eval(File.read(File.join(File.dirname(__FILE__), 'schema', 'schema.rb')))
+end

data/spec/support/helpers.rb

@@ -0,0 +1,8 @@
+module ForeignKeyMigrationsHelpers
+  extend self
+
+  def mysql?
+    ActiveRecord::Base.connection.adapter_name =~ /^mysql/i
+  end
+
+end

data/spec/support/matchers/foreign_key_migrations_matchers.rb

@@ -0,0 +1,2 @@
+require 'support/matchers/reference'
+require 'support/matchers/have_index'

data/spec/support/matchers/have_index.rb

@@ -0,0 +1,52 @@
+module ForeignKeyMigrationsMatchers
+
+  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 ForeignKeyMigrationsMatchers
+
+  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 && 
+            @references_column_names.empty? ? true : 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.empty?
+      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} to #{invert} 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

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: aspgems-foreign_key_migrations
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 2.0.0.beta1
+platform: ruby
+authors: 
+- "Micha\xC5\x82 \xC5\x81omnicki"
+- "Paco Guzm\xC3\xA1n"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aspgems-redhillonrails_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.beta2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+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
+- fjguzman@aspgems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- foreign_key_migrations.gemspec
+- init.rb
+- install.rb
+- lib/foreign_key_migrations.rb
+- lib/foreign_key_migrations/active_record/base.rb
+- lib/foreign_key_migrations/active_record/connection_adapters/schema_statements.rb
+- lib/foreign_key_migrations/active_record/connection_adapters/table_definition.rb
+- lib/foreign_key_migrations/active_record/migration.rb
+- lib/foreign_key_migrations/version.rb
+- lib/generators/foreign_key_migrations/migration_generator.rb
+- lib/generators/foreign_key_migrations/templates/migration.rb
+- spec/aaa_create_tables_spec.rb
+- spec/connections/mysql/connection.rb
+- spec/connections/mysql2/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/schema_dumper_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/matchers/foreign_key_migrations_matchers.rb
+- spec/support/matchers/have_index.rb
+- spec/support/matchers/reference.rb
+homepage: https://github.com/aspgems/foreign_key_migrations
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Automatically generate foreign-key constraints when creating tables
+test_files: []
+