rafaelp-postgresql_migrations 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Rafael Lima (http://rafael.adm.br)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkdn

@@ -0,0 +1,65 @@
+# Postgresql Migrations
+
+## DESCRIPTION
+
+This gem implements "add\_foreign\_key" and "remove\_foreign\_key" for PostgreSQLAdapter.
+
+## REQUIREMENTS
+
+* activerecord
+* postgres
+
+## INSTALLATION
+
+    $ sudo gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install rafaelp-postgresql_migrations
+
+## USAGE
+
+### Example 1
+
+    require 'postgresql_migrations'
+    class UserBelongsToAccount < ActiveRecord::Migration
+      def self.up
+        add_foreign_key :users, :account_id, :accounts, :id
+      end
+
+      def self.down
+        remove_foreign_key :users, :account_id, :accounts, :id
+      end
+    end
+
+### Example 2
+
+    require 'postgresql_migrations'
+    class UserBelongsToAccount < ActiveRecord::Migration
+      def self.up
+        add_foreign_key :users, :account_id, :accounts, :id, :match => 'simple', :on_delete => 'restrict', :on_update => 'cascade'
+      end
+
+      def self.down
+        remove_foreign_key :users, :account_id
+      end
+    end
+
+## LICENSE
+
+Postgresql Migrations is released under the MIT License.
+
+## AUTHOR
+
+### **Rafael Lima**
+
+Working at [Myfreecomm](http://myfreecomm.com.br)
+
+Blog: [http://rafael.adm.br](http://rafael.adm.br)
+
+Podcast: [http://rafael.adm.br/voltandopracasa](http://rafael.adm.br/voltandopracasa)
+
+Github: [http://github.com/rafaelp](http://github.com/rafaelp)
+
+Twitter: [http://twitter.com/rafaelp](http://twitter.com/rafaelp)
+
+### Did you like?
+
+[Recommend me at Working With Rails](http://workingwithrails.com/recommendation/new/person/14248-rafael-lima)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the dbdesigner_migration_generator plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the dbdesigner_migration_generator plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DbdesignerMigrationGenerator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config/requirements.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+%w[activerecord pg].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: sudo gem install #{req_gem} -y"
+    exit
+  end
+end
+
+require 'active_record/connection_adapters/postgresql_adapter'
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/postgresql_migrations.gemspec

@@ -0,0 +1,27 @@
+spec = Gem::Specification.new do |s| 
+  s.name = "postgresql_migrations"
+  s.version = "0.1.0"
+  s.date     = "2009-09-18"
+  s.author = "Rafael Lima"
+  s.email = "contato@rafael.adm.br"
+  s.homepage = "http://rafael.adm.br"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "This gem implements add_foreign_key and remove_foreign_key for PostgreSQLAdapter."
+  s.files    = [
+    "MIT-LICENSE",
+    "Rakefile",
+		"README.mkdn", 
+		"postgresql_migrations.gemspec", 
+		"config/requirements.rb",
+		"postgresql_migrations.rb"]
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/postgresql_migrations_add_foreign_key_test.rb",
+    "test/postgresql_migrations_remove_foreign_key_test.rb",
+     ]
+  s.require_path = "."
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.mkdn"]
+  s.add_dependency("activerecord", ["> 0.0.0"])
+  s.add_dependency("pg", ["> 0.0.0"])
+end

data/postgresql_migrations.rb

@@ -0,0 +1,49 @@
+# PostgresqlMigrations
+
+module PostgresqlMigrations
+  def add_foreign_key(from_table, from_columns, to_table, to_columns, options = {})
+    from_columns = [from_columns] unless from_columns.is_a? Array
+    to_columns = [to_columns] unless to_columns.is_a? Array
+
+    constraint_name = "fk_#{from_table}_#{from_columns.join('_')}"
+
+    sql = "ALTER TABLE #{from_table} ADD CONSTRAINT #{constraint_name} FOREIGN KEY (#{from_columns.join(',')}) REFERENCES #{to_table}(#{to_columns.join(',')})"
+
+    # MATCH
+
+    # FULL
+    #  will not allow one column of a multicolumn foreign key to be null unless all foreign key columns are null
+    # PARTIAL
+    #  is not yet implemented
+    # SIMPLE
+    #  allows some foreign key columns to be null while other parts of the foreign key are not null
+    sql << " MATCH #{options[:match]}" unless options[:match].nil?
+
+    # ACTIONS
+    
+    # NO ACTION
+    #  Produce an error indicating that the deletion or update would create a foreign key constraint violation. If the constraint is deferred, this error will be produced at constraint check time if there still exist any referencing rows. This is the default action. 
+    # RESTRICT
+    #  Produce an error indicating that     constraint_name = "fk_#{from_table}_#{from_columns.join('_')}"the deletion or update would create a foreign key constraint violation. This is the same as NO ACTION except that the check is not deferrable. 
+    # CASCADE
+    #  Delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively. 
+    # SET NULL
+    #  Set the referencing column(s) to null. 
+    # SET DEFAULT
+    #  Set the referencing column(s) to their default values. 
+    sql << " ON DELETE #{options[:on_delete]}" unless options[:on_delete].nil?
+    sql << " ON UPDATE #{options[:on_update]}" unless options[:on_update].nil?
+    
+    execute sql
+  end
+
+  def remove_foreign_key(from_table, from_columns)
+    from_columns = [from_columns] unless from_columns.is_a? Array
+    constraint_name = "fk_#{from_table}_#{from_columns.join('_')}"
+
+    sql = "ALTER TABLE #{from_table} DROP CONSTRAINT #{constraint_name}"
+    execute sql
+  end
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :include, PostgresqlMigrations

data/test/postgresql_migrations_add_foreign_key_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPostgresqlMigrationsAddForeignKey < Test::Unit::TestCase
+  include PostgresqlMigrations
+  
+  def test_simple_call_with_strings
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id)"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', 'account_id', 'account', 'id')
+  end
+
+  def test_simple_call_with_symbols
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id)"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key(:users, :account_id, :account, :id)
+  end
+
+  def test_multiple_columns_with_strings
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id_account_version FOREIGN KEY (account_id,account_version) REFERENCES account(id,version)"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', ['account_id','account_version'], 'account', ['id','version'])
+  end
+
+  def test_multiple_columns_with_symbols
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id_account_version FOREIGN KEY (account_id,account_version) REFERENCES account(id,version)"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key(:users, [:account_id,:account_version], :account, [:id,:version])
+  end
+
+  def test_call_with_match
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id) MATCH simple"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', 'account_id', 'account', 'id', :match => 'simple')
+  end
+
+  def test_call_with_on_delete
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id) ON DELETE cascade"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', 'account_id', 'account', 'id', :on_delete => 'cascade')
+  end
+
+  def test_call_with_on_update
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id) ON UPDATE cascade"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', 'account_id', 'account', 'id', :on_update => 'cascade')
+  end
+
+  def test_call_with_match_on_delete_and_on_update
+    sql = "ALTER TABLE users ADD CONSTRAINT fk_users_account_id FOREIGN KEY (account_id) REFERENCES account(id) MATCH full ON DELETE restrict ON UPDATE restrict"
+    expects(:execute).with(sql).returns(true)
+    add_foreign_key('users', 'account_id', 'account', 'id', :match => 'full', :on_delete => 'restrict', :on_update => 'restrict')
+  end
+
+end

data/test/postgresql_migrations_remove_foreign_key_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPostgresqlMigrationsRemoveForeignKey < Test::Unit::TestCase
+  include PostgresqlMigrations
+
+  def test_simple_call_with_strings
+    sql = "ALTER TABLE users DROP CONSTRAINT fk_users_account_id"
+    expects(:execute).with(sql).returns(true)
+    remove_foreign_key('users', 'account_id')
+  end
+
+  def test_simple_call_with_symbols
+    sql = "ALTER TABLE users DROP CONSTRAINT fk_users_account_id"
+    expects(:execute).with(sql).returns(true)
+    remove_foreign_key(:users, :account_id)
+  end
+
+  def test_multiple_columns_with_strings
+    sql = "ALTER TABLE users DROP CONSTRAINT fk_users_account_id_parent_id"
+    expects(:execute).with(sql).returns(true)
+    remove_foreign_key('users', ['account_id','parent_id'])
+  end
+
+  def test_multiple_columns_with_symbols
+    sql = "ALTER TABLE users DROP CONSTRAINT fk_users_account_id_parent_id"
+    expects(:execute).with(sql).returns(true)
+    remove_foreign_key(:users, [:account_id,:parent_id])
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'config/requirements'
+require File.dirname(__FILE__) + '/../postgresql_migrations'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: rafaelp-postgresql_migrations
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rafael Lima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: 
+email: contato@rafael.adm.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mkdn
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.mkdn
+- postgresql_migrations.gemspec
+- config/requirements.rb
+- postgresql_migrations.rb
+has_rdoc: true
+homepage: http://rafael.adm.br
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- .
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This gem implements add_foreign_key and remove_foreign_key for PostgreSQLAdapter.
+test_files: 
+- test/test_helper.rb
+- test/postgresql_migrations_add_foreign_key_test.rb
+- test/postgresql_migrations_remove_foreign_key_test.rb