artemk-migration_fu 0.0.1

data/README.rdoc

@@ -0,0 +1,51 @@
+= MigrationFu
+
+Rails gem / plugin for generating mysql foreign key constraints.
+
+== Install
+  
+=== as gem
+  
+  sudo gem install artemk-migration_fu
+  
+=== 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 => :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/init.rb

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

data/lib/migration_fu.rb

@@ -0,0 +1,58 @@
+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, fk|
+          execute "ALTER TABLE #{ft} ADD CONSTRAINT #{id} FOREIGN KEY(#{fk}) 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}, DROP 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 options[:fk_field]
+          fk = options[:fk_field]
+          id = "#{id}_#{options[:fk_field]}"
+        else
+          fk = "#{to_table.to_s.singularize}_id"
+        end
+
+        if id.size > MAX_KEY_LENGTH
+          puts "*** foreign key id has more than #{MAX_KEY_LENGTH} characters - sliced to '#{id}'"
+        end
+        yield(from_table.to_s, to_table, id[0...MAX_KEY_LENGTH], fk)
+      end
+
+    end
+  end
+end

data/test/migration_fu_test.rb

@@ -0,0 +1,85 @@
+require 'test/unit'
+require 'rubygems'
+begin require 'redgreen'; rescue LoadError; end
+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'
+  CUSTOM_FK = 'person_id'
+
+  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_match(/ON DELETE CASCADE/, add(:on_update => :set_null, :on_delete => :cascade))
+    assert_match(/ON UPDATE SET NULL/, 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_with_optional_fk_field
+    assert_equal add_command(CUSTOM_ID, :fk_field => CUSTOM_FK), add(:name => CUSTOM_ID, :fk_field => CUSTOM_FK)
+  end
+
+  def test_should_add_foreign_key_and_truncate_id
+    to = 'x' * 70
+    assert_equal add_command('fk_users_' << 'x' * 55, :to => 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, opts = {})
+    opts = {:to => 'files'}.merge!(opts)
+    if opts[:fk_field]
+      fk = opts[:fk_field]
+      id = "#{id}_#{opts[:fk_field]}"
+    else
+      fk = "#{opts[:to].singularize}_id"
+    end
+    "ALTER TABLE users ADD CONSTRAINT #{id} FOREIGN KEY(#{fk}) REFERENCES #{opts[:to]}(id)"
+  end
+
+  def remove_command(id = ID)
+    "ALTER TABLE users DROP FOREIGN KEY #{id}, DROP KEY #{id}"
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: artemk-migration_fu
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-21 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Add and remove FK in MYSQL
+email: artemk@svitla.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- init.rb
+- lib/migration_fu.rb
+- README.rdoc
+- test/migration_fu_test.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add and remove FK in MYSQL
+test_files: 
+- test/migration_fu_test.rb