sparkfly-foreigner 0.5.4

data/spec/postgresql/semantics_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path('../spec_helper.rb', File.dirname(__FILE__))
+
+describe Foreigner::ConnectionAdapters::PostgreSQLAdapter do
+  include MigrationFactory
+
+  before(:each) do 
+    @adapter = AdapterHelper::PostgreSQLTestAdapter.new
+  end
+
+  describe 'when adding foreign keys' do
+    it 'should add foreign key without options' do
+      @adapter.add_foreign_key(:employees, :companies).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `fk_employees_company_id` FOREIGN KEY (`company_id`) REFERENCES `companies`(id)"
+      )
+    end
+
+    it 'should add foreign key with a name' do
+      @name = 'favorite_company_fk'
+      @adapter.add_foreign_key(:employees, :companies, :name => @name).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `#{@name}` FOREIGN KEY (`company_id`) REFERENCES `companies`(id)"
+      )
+    end
+
+    it 'should add foreign key with a column' do
+      @column = 'last_employer_id'
+      @adapter.add_foreign_key(:employees, :companies, :column => @column).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `fk_employees_last_employer_id` FOREIGN KEY (`#{@column}`) REFERENCES `companies`(id)"
+      )
+
+    end
+
+    it 'should add foreign key with column and a name' do
+      @name = 'favorite_company_fk'
+      @column = 'last_employer_id'
+      @adapter.add_foreign_key(:employees, :companies, :column => @column, :name => @name).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `#{@name}` FOREIGN KEY (`#{@column}`) REFERENCES `companies`(id)"
+      )
+    end
+
+    it 'should add foreign key with :dependent => :delete' do
+      @adapter.add_foreign_key(:employees, :companies, :dependent => :delete).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `fk_employees_company_id` FOREIGN KEY (`company_id`) REFERENCES `companies`(id) " +
+        "ON DELETE CASCADE")
+    end
+
+    it 'should add foreign key with :dependent => :nullify' do
+      @adapter.add_foreign_key(:employees, :companies, :dependent => :nullify).should eql(
+        "ALTER TABLE `employees` ADD CONSTRAINT `fk_employees_company_id` FOREIGN KEY (`company_id`) REFERENCES `companies`(id) " +
+        "ON DELETE SET NULL"
+      )
+    end
+  end
+
+  describe 'when dropping foreign keys' do
+    it 'should drop foreign key' do
+      @adapter.remove_foreign_key(:suppliers, :companies).should eql(
+        "ALTER TABLE `suppliers` DROP CONSTRAINT `fk_suppliers_company_id`"
+      )
+    end
+
+    it 'should drop foreign key by name' do
+      @adapter.remove_foreign_key(:suppliers, :name => "belongs_to_supplier").should eql(
+        "ALTER TABLE `suppliers` DROP CONSTRAINT `belongs_to_supplier`"
+      )
+    end
+
+    it 'should drop foreign key by column' do 
+      @adapter.remove_foreign_key(:suppliers, :column => "ship_to_id").should eql(
+        "ALTER TABLE `suppliers` DROP CONSTRAINT `fk_suppliers_ship_to_id`"
+      )
+    end
+  end
+
+end
+

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path('spec_helper.rb', File.dirname(__FILE__))
+
+class SchemaDumperTester
+
+  def tables(stream)
+    stream
+  end
+
+  include Foreigner::SchemaDumper
+  include ForeignKeyDefinitionFactory
+
+  def valid_foreign_key_definition(opt = {})
+    options = {
+      :from_table => 'items',
+      :to_table => 'collections'
+    }.merge(opt)
+  end
+
+  # Helper when we want to test a single generated statement
+  def generate_schema_statement(foreign_key_definition)
+    fkd = new_foreign_key(foreign_key_definition)
+    generate_foreign_keys_statements([fkd]).first
+  end
+end
+
+describe Foreigner::SchemaDumper do
+
+  before(:each) do 
+    @dumper = SchemaDumperTester.new
+    @fk_definition = {
+      :from_table => 'items',
+      :to_table => 'collections'
+    }
+
+    # Sanity Check
+    fkd = @dumper.new_foreign_key(@fk_definition)
+    fkd.from_table.should eql('items')
+    fkd.to_table.should eql('collections')
+  end
+
+  it 'should generate an add_foreign_key' do
+    @dumper.generate_schema_statement(@fk_definition).should match(/\s*add_foreign_key\s+:items,\s:collections/)
+  end
+
+  it 'should generate with a custom foreign key name' do
+    @foreign_key_name = 'fk_foreign_key_name'
+    @dumper.generate_schema_statement(:name => @foreign_key_name).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections,\s+:name\s+=>\s+\"#{@foreign_key_name}\"/
+    )
+  end
+
+  it 'should generate with a custom column id' do
+    @column = 'acctno'
+    @dumper.generate_schema_statement(:column => @column).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections,\s+:column\s+=>\s+\"#{@column}\"/
+    )
+  end
+
+  it 'should ignore custom column id conforming to Rails convention' do
+    @to_table = 'collections'
+    @column = @to_table.to_s.singularize + '_id'
+    @dumper.generate_schema_statement(:to_table => @to_table, :column => @column).should match(
+      /\s*add_foreign_key\s+:items,\s+#{@to_table.to_sym.inspect}/
+    )
+  end
+
+  it 'should generate with a custom primary key' do
+    @primary_key = 'upc'
+    @dumper.generate_schema_statement(:primary_key => @primary_key).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections,\s+:primary_key\s+=>\s+\"#{@primary_key}\"/
+    )
+  end
+
+  it 'should ignore custom primary key conforming to Rails convention' do
+    @primary_key = 'id'
+    @dumper.generate_schema_statement(:primary_key => @primary_key).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections/
+    )
+  end
+
+  it 'should generate with a :dependent => :nullify' do
+    @dependent = :nullify
+    @dumper.generate_schema_statement(:dependent => @dependent).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections,\s+:dependent\s+=>\s+#{@dependent.inspect}/
+    )
+  end
+
+  it 'should generate with a :dependent => :delete' do
+    @dependent = :delete
+    @dumper.generate_schema_statement(:dependent => @dependent).should match(
+      /\s*add_foreign_key\s+:items,\s+:collections,\s+:dependent\s+=>\s+#{@dependent.inspect}/
+    )
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+
+require 'rubygems'
+
+require 'active_support'
+require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'active_record/connection_adapters/sqlite3_adapter'
+require 'active_record/connection_adapters/mysql_adapter'
+require 'foreigner'
+require "foreigner/connection_adapters/postgresql_adapter"
+require "foreigner/connection_adapters/mysql_adapter"
+require "foreigner/connection_adapters/sqlite3_adapter"
+
+require File.expand_path('factory_helper.rb', File.dirname(__FILE__))
+require File.expand_path('adapter_helper.rb', File.dirname(__FILE__))
+
+CONFIGURATIONS = {
+  :postgresql => {
+    :adapter => "postgresql",
+    :username => "root",
+    :password => "",
+    :database => "test_foreigner_gem",
+    :min_messages => "ERROR"
+  },
+  :postgresql_admin => {
+    :adapter => "postgresql",
+    :username => "root",
+    :password => "",
+    :database => "test",
+    :min_messages => "ERROR"
+  }, # :postgresql_admin is used to connect in; :postgresql is used to actually test the migrations
+  :mysql => {
+    :adapter => 'mysql',
+    :host => 'localhost',
+    :username => 'root',
+    :database => 'foreigner_test'
+
+  }, 
+  :sqlite3 => {
+    :adapter => "sqlite3",
+    :database => ":memory:"
+  }
+}
+
+# Turn this on for debugging
+ActiveRecord::Migration.verbose = false
+
+

data/spec/sqlite3/schema_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path('../spec_helper.rb', File.dirname(__FILE__))
+
+describe Foreigner::ConnectionAdapters::SQLite3Adapter do
+  include MigrationFactory
+
+  before(:each) do 
+    @adapter = AdapterHelper::SQLite3TestAdapter.new
+    @adapter.recreate_test_environment
+    @adapter.schema(:items).should be_nil
+  end
+
+  describe 'when creating tables with t.foreign_key' do
+    it 'should understand t.foreign_key' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection, :null => false
+        t.foreign_key :collection
+      end
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\)/)
+    end
+
+    it 'should accept a :column parameter' do
+      @column = :item_collection_id
+
+      create_table :items do |t|
+        t.string :name
+        t.integer @column
+        t.foreign_key :collection, :column => @column
+      end
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"#{@column}\"\) REFERENCES \"collections\"\s*\(id\)/)
+    end
+
+    it 'should accept :dependent => :nullify' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection
+        t.foreign_key :collection, :dependent => :nullify
+      end     
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\) ON DELETE SET NULL/)
+    end
+
+    it 'should accept :dependent => :delete' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection
+        t.foreign_key :collection, :dependent => :delete
+      end     
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\) ON DELETE CASCADE/)
+    end
+  end
+
+  describe 'when creating tables with t.reference' do
+    it 'should accept a t.references constraint' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection, :foreign_key => true
+      end
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\)/)
+    end
+
+    it 'should accept :foreign_key => { :dependent => :nullify }' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection, :foreign_key => {:dependent => :nullify}
+      end
+
+      @adapter.schema(:items).match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\) ON DELETE SET NULL/)
+    end
+
+    it 'should accept :foreign_key => { :dependent => :delete }' do
+      create_table :items do |t|
+        t.string :name
+        t.references :collection, :foreign_key => {:dependent => :delete}
+      end
+
+      @adapter.schema(:items).should match(/FOREIGN KEY\s*\(\"collection_id\"\) REFERENCES \"collections\"\s*\(id\) ON DELETE CASCADE/)
+    end
+  end
+
+end
+

data/tasks/foreigner_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :foreigner do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: sparkfly-foreigner
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 4
+  version: 0.5.4
+platform: ruby
+authors: 
+- Ho-Sheng Hsiao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Allows you to add foreign keys to your migrations and enforce them
+email: hosh@sparkfly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/foreigner.rb
+- lib/foreigner/connection_adapters/abstract/schema_definitions.rb
+- lib/foreigner/connection_adapters/abstract/schema_statements.rb
+- lib/foreigner/connection_adapters/mysql_adapter.rb
+- lib/foreigner/connection_adapters/postgresql_adapter.rb
+- lib/foreigner/connection_adapters/sqlite3_adapter.rb
+- lib/foreigner/schema_dumper.rb
+- lib/foreigner/semantics/sql_2003.rb
+- spec/adapter_helper.rb
+- spec/factory_helper.rb
+- spec/mysql/schema_extractor_spec.rb
+- spec/mysql/schema_spec.rb
+- spec/mysql/semantics_spec.rb
+- spec/postgresql/schema_extractor_spec.rb
+- spec/postgresql/schema_spec.rb
+- spec/postgresql/semantics_spec.rb
+- spec/schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/sqlite3/schema_spec.rb
+- tasks/foreigner_tasks.rake
+has_rdoc: true
+homepage: http://github.com/hosh/foreigner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Foreign keys for Rails migrations for PostgreSQL, MySQL and Sqlite3. Based on dwilkie-foreigner
+test_files: 
+- spec/schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/sqlite3/schema_spec.rb
+- spec/postgresql/schema_extractor_spec.rb
+- spec/postgresql/schema_spec.rb
+- spec/postgresql/semantics_spec.rb
+- spec/adapter_helper.rb
+- spec/factory_helper.rb
+- spec/mysql/schema_extractor_spec.rb
+- spec/mysql/schema_spec.rb
+- spec/mysql/semantics_spec.rb