sleistner-migration_fu 0.0.1

data/README.rdoc

@@ -0,0 +1,61 @@
+= MigrationFu
+
+Rails gem / plugin for generating foreign key constraints.
+
+== Install
+  
+=== as gem
+  
+  sudo gem install sleistner-migration_fu --source http://gems.github.com
+  
+=== or plugin
+  
+  script/plugin install git://github.com/sleistner/migration_fu.git
+
+== Usage
+
+  -----------------       -----------------
+  |    users      |       |   addresses   |
+  -----------------       -----------------
+  | id            |       | id            |
+  | username      | <---- | user_id       |
+  | password      |       | street        |
+  -----------------       -----------------
+
+  [ON DELETE {RESTRICT | CASCADE | SET NULL | NO ACTION}]
+  [ON UPDATE {RESTRICT | CASCADE | SET NULL | NO ACTION}]
+
+  see http://dev.mysql.com/doc/refman/5.0/en/innodb-foreign-key-constraints.html
+    
+  arguments:  from_table,  to_table,  options => { :name, on_delete, on_update }
+
+  add_foreign_key(:addresses, :users, :name => 'fk_add_user')
+               
+  add_foreign_key(:addresses, :users, :on_delete => :cascade)
+  add_foreign_key(:addresses, :users, :on_delete => :set_null)
+  add_foreign_key(:addresses, :users, :on_delete => :restrict)
+  add_foreign_key(:addresses, :users, :on_delete => :no_action)
+               
+  add_foreign_key(:addresses, :users, :on_update => :cascade)
+  add_foreign_key(:addresses, :users, :on_update => :set_null)
+  add_foreign_key(:addresses, :users, :on_update => :restrict)
+  add_foreign_key(:addresses, :users, :on_update => :no_action)
+    
+  add_foreign_key(:addresses, :users,  :on_delete => :cascade, :on_update => :cascade)
+    
+  class CreateUsers < ActiveRecord::Migration
+  
+    def self.up
+      create_table :users, :force => true do |t|
+        t.string :username, :null => false
+        t.string :password, :null => false
+      end
+  
+      create_table :addresses, :force => true do |t|
+        t.references :user
+        t.string :street, :null => false
+      end
+  
+      add_foreign_key(:addresses, :users, :on_delete => :cascade)
+    end
+  end

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the migration_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the migration_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MigrationFu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :test do
+  desc 'Measure test coverage'
+  task :coverage do
+    system("rcov --rails --text-summary -Ilib --xrefs --html test/unit/*_test.rb") 
+    #test/functional/*_test.rb test/views/*_test.rb test/integration/*_test.rb")
+    system("open coverage/index.html") if PLATFORM['darwin']
+    system("firefox coverage/index.html") if PLATFORM['linux']
+  end
+end
+
+Echoe.new('migration_fu', '0.0.1') do |p|
+  p.description     = 'Add or remove foreign keys'
+  p.url             = 'http://github.com/sleistner/migration_fu'
+  p.author          = 'Steffen Leistner'
+  p.email           = 'sleistner@gmail.com'
+  p.ignore_pattern  = ['tmp/*', 'script/*.rake']
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1 @@
+require 'migration_fu'

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/migration_fu.rb

@@ -0,0 +1,53 @@
+module ActiveRecord
+
+  class Migration
+
+    MAX_KEY_LENGTH = 64
+    OPTION_KEYS = [:restrict, :set_null, :cascade, :no_action]
+    OPTION_VALUES = [:on_update, :on_delete]
+
+    class << self
+
+      def add_foreign_key(from_table, to_table, options = {})
+        process(from_table, to_table, options) do |ft, tt, id|
+          execute "ALTER TABLE #{ft} ADD CONSTRAINT #{id} FOREIGN KEY(#{tt.singularize}_id) REFERENCES #{tt}(id)" << conditions(options)
+        end 
+      end
+      
+      def remove_foreign_key(from_table, to_table, options = {})
+        process(from_table, to_table, options) do |ft, tt, id|
+          execute "ALTER TABLE #{ft} DROP FOREIGN KEY #{id}"
+        end
+      end
+
+      def entirely_reset_column_information
+        ActiveRecord::Base.send(:subclasses).each(&:reset_column_information)
+      end
+
+      private
+
+      def conditions(options)
+        conditions = ''
+        options.each_pair do |key, value|
+          conditions << " #{key.to_s.gsub(/_/, ' ')} #{value.to_s.gsub(/_/, ' ')}".upcase if condition_valid?(key, value)
+        end
+        conditions
+      end
+
+      def condition_valid?(key, value)
+        OPTION_VALUES.include?(key.to_sym) && OPTION_KEYS.include?(value.to_sym)
+      end
+
+      def process(from_table, to_table, options)
+        id = options[:name] || "fk_#{from_table}_#{to_table}"
+
+        if id.size > MAX_KEY_LENGTH
+          id = id.slice(0...MAX_KEY_LENGTH)
+          puts "Warning: foreign key id has more then #{MAX_KEY_LENGTH} characters - sliced to '#{id}'"
+        end
+        yield(from_table.to_s, to_table.to_s, id)
+      end
+      
+    end
+  end
+end

data/migration_fu.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{migration_fu}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steffen Leistner"]
+  s.date = %q{2008-11-12}
+  s.description = %q{Add or remove foreign keys}
+  s.email = %q{sleistner@gmail.com}
+  s.extra_rdoc_files = ["lib/migration_fu.rb", "README.rdoc"]
+  s.files = ["init.rb", "install.rb", "lib/migration_fu.rb", "Rakefile", "README.rdoc", "test/migration_fu_test.rb", "Manifest", "migration_fu.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/sleistner/migration_fu}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Migration_fu", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{migration_fu}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Add or remove foreign keys}
+  s.test_files = ["test/migration_fu_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/test/migration_fu_test.rb

@@ -0,0 +1,69 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/migration_fu'
+
+class String
+  def singularize; self[0...-1] end
+end
+
+class ActiveRecord::Migration
+  def self.execute command; command end
+end
+
+class MigrationFuTest < Test::Unit::TestCase
+  
+  ID        = 'fk_users_files'
+  CUSTOM_ID = 'fk_my_name'
+  
+  def setup
+    @foo = ActiveRecord::Migration
+  end
+  
+  def test_should_add_foreign_key_without_options
+    assert_equal add_command, add
+  end
+
+  def test_should_add_foreign_key_with_invalid_options_but_ignore_them
+    assert_equal add_command, add(:on_del => :ca)
+  end
+
+  def test_should_add_foreign_key_with_valid_options
+    assert_equal "#{add_command} ON DELETE CASCADE", add(:on_delete => :cascade)
+    assert_equal "#{add_command} ON UPDATE SET NULL ON DELETE CASCADE", add(:on_update => :set_null, :on_delete => :cascade)
+  end
+  
+  def test_should_add_foreign_key_with_optional_name
+    assert_equal add_command(CUSTOM_ID), add(:name => CUSTOM_ID)
+  end
+  
+  def test_should_add_foreign_key_and_truncate_id
+    to = 'x' * 70
+    assert_equal add_command('fk_users_' << 'x' * 55, to), @foo.add_foreign_key(:users, to.to_sym)
+  end
+  
+  def test_should_remove_foreign_key
+    assert_equal remove_command, remove
+  end
+  
+  def test_should_remove_foreign_key_with_optional_name
+    assert_equal remove_command(CUSTOM_ID), remove(:name => CUSTOM_ID)
+  end
+  
+  private
+  
+  def add(options = {})
+    @foo.add_foreign_key :users, :files, options
+  end
+
+  def remove(options = {})
+    @foo.remove_foreign_key :users, :files, options
+  end
+  
+  def add_command(id = ID, to = 'files')
+    "ALTER TABLE users ADD CONSTRAINT #{id} FOREIGN KEY(#{to.singularize}_id) REFERENCES #{to}(id)"
+  end
+  
+  def remove_command(id = ID)
+    "ALTER TABLE users DROP FOREIGN KEY #{id}"
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: sleistner-migration_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Steffen Leistner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Add or remove foreign keys
+email: sleistner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/migration_fu.rb
+- README.rdoc
+files: 
+- init.rb
+- install.rb
+- lib/migration_fu.rb
+- Rakefile
+- README.rdoc
+- test/migration_fu_test.rb
+- Manifest
+- migration_fu.gemspec
+has_rdoc: true
+homepage: http://github.com/sleistner/migration_fu
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Migration_fu
+- --main
+- README.rdoc
+require_paths: 
+- lib
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: migration_fu
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Add or remove foreign keys
+test_files: 
+- test/migration_fu_test.rb