aspgems-foreign_key_migrations 2.0.0.beta1

data/.gitignore

@@ -0,0 +1,3 @@
+spec/db/*db
+spec/debug.log
+

data/CHANGELOG

@@ -0,0 +1,109 @@
+[REVISION 20080131]
+
+[FIXED] Stack-level too deep.
+
+[NEW] Generate foreign keys for databases that currently have none. Doesn't check to see if the foreign key already exists, nor does it drop the foreign keys yet.
+
+[REVISION 20071128]
+
+[FIXED] Workaround to ensure plugin is only ever loaded once.
+
+[REVISION 20070905]
+
+[FIXED] "some_column_name" referenced in foreign key constraint does not exist.
+
+[REVISION 20070904]
+
+[NEW] Support :references keyword when calling primary_key().
+
+[NEW] [#11995] the parameter :references needs the second argument referencing the field name.
+
+[REVISION 20070707]
+
+[NEW] Support acts_as_tree convention: if a column is named parent_id it will be treated as a circular reference to the table in which it is defined.
+
+[REVISION 20070703]
+
+[FIXED] Foreign-keys not created when using add_column.
+
+[REVISION 20070628]
+
+[FIXED] Stack level too deep in 'add_column_without_foreign_key_migrations' (Ronen Barzel).
+
+[REVISION 20070503]
+
+[NEW] Support for SQL92 [NOT] DEFERRABLE on foreign keys.
+
+[REVISION 20061202]
+
+[CHANGED] Use Rails 1.2 alias_method_chain.
+
+[CHANGED] Separate modules into individual files.
+
+[REVISION 20061013]
+
+[NEW] install.rb informs user of missing dependencies.
+
+[REVISION 20060909]
+
+[CHANGED] Replaced dependence on defunct Foreign Key Support and Schema Defining plugins with a single dependece on RedHill on Rails Core.
+
+[REVISION 20060831]
+
+[CHANGED] Separated out generic foreign-key functionality into new foreign key support plugin.
+
+[REVISION 20060629]
+
+[NEW] Added foreign_key method to table to allow t.foreign_key(columns, references_table_name, references_column_names, options).
+
+[NEW] Support foreign keys in add_column as we do for initial table columns.
+
+[NEW] Support :on_update and :on_delete as options--with values of :set_null, :cascade, or :restrict--for all foreign key creation mechanisms.
+
+[REVISION 20060627]
+
+[CHANGED] Reverted to overloaded column method with optional :references as the preferred mechanism with belongs_to a "nicety". This is really as a result of using it in a large-scale production application where belongs_to just didn't feel right in many cases and was semantically ambiguous.
+
+[REVISION 20060824]
+
+[CHANGED] Replaced method and column option :references with :belongs_to in keeping with the rails model keywords. The references variations are still available but have been deprecated and will be removed.
+
+[NEW] Added options :dependent => :nullify to SET NULL or :dependent => :delete_all | :destroy to CASCADE DELETE.
+
+[REVISION 20060812]
+
+[NEW] Added new table method references(table, options) which is essentially an alias for column(:table_id, :integer, options).
+
+[REVISION 20060803]
+
+[FIXED] The method proper_pluralized_table_name tries to call pluralize_table_name where it should call pluralized_table_name.
+
+[REVISION 20060623]
+
+[FIXED] Another try at a hack-around for a "feature" of pluralize that when called to pluralize a word that is already in the plural, acts as singularize.
+
+[REVISION 20060616]
+
+[FIXED] Hack-around for a "feature" of pluralize that when called to pluralize a word that is already in the plural, acts as singularize. Ie. "countries".pluralize becomes "country"!
+
+[REVISION 200606004]
+
+[CHANGED] This plugin now depends on Schema Defining!
+
+[REVISION 20060602]
+
+[CHANGED] Simplified static method overriding thanks to Ryan Tomayko.
+
+[REVISION 20060525]
+
+[CHANGED] Disabled foreign-key generation when executing a schema dump. This is a temporary measure until I get around to batching up the foreign keys at the end of the script.
+
+[REVISION 20060523]
+
+[NEW] Support :references => nil to prevent unwanted foreign-keys.
+
+[FIXED] Pluralization.
+
+[REVISION 20060522]
+
+[FIXED] Infinite recursion caused by bug in 1.8.4 method_alias on windows.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 RedHill Consulting, Pty. Ltd.
+
+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.md

@@ -0,0 +1,91 @@
+# Foreign Key Migrations 
+
+Foreign Key Migrations is a plugin that automatically generates foreign-key
+constraints when creating tables. It uses SQL-92 syntax and as such should be
+compatible with most databases that support foreign-key constraints.
+
+In the simplest case, the plugin assumes that if you have a column named
+<tt>customer_id</tt> that you want a foreign-key constraint generated that references
+the <tt>id</tt> column in the <tt>customers</tt> table:
+
+    create_table :orders do |t|
+      t.column :customer_id, :integer, :null => false
+      ...
+    end
+
+If you have multiple columns referencing a table or for whatever reason, your
+column name isn't the same as the referenced table name, you can use the
+`:references` option:
+
+    create_table :orders do |t|
+      t.column :ordered_by_id, :integer, :null => false, :references => :customers
+      ...
+    end
+
+If you have a column with a name ending in <tt>_id</tt> for which you do not wish a
+foreign-key to be generated, you can use `:references => nil`:
+
+    create_table :orders do |t|
+      t.column :external_id, :integer, :null => false, :references => nil
+      ...
+    end
+
+Sometimes you may (for legacy reasons) need to reference a primary key column that is
+named something other than <tt>id</tt>. In this case you can specify the name of the column:
+
+    create_table :orders do |t|
+      t.column :ordered_by_pk, :integer, :null => false, :references => [:customers, :pk]
+      ...
+    end
+
+You also have the option of specifying what to do on delete/update using
+`:on_delete`/`:on_update`, respectively to one of:
+`:cascade`; `:restrict`; and `:set_null`:
+
+    create_table :orders do |t|
+      t.column :customer_id, :integer, :on_delete => :set_null, :on_update => :cascade
+      ...
+    end
+
+If your database supports it (for example PostgreSQL) you can also mark the constraint as deferrable:
+
+    create_table :orders do |t|
+      t.column :customer_id, :integer, :deferrable => true
+      ...
+    end
+
+By convention, if a column is named <tt>parent_id</tt> it will be treated as a circular reference to
+the table in which it is defined.
+
+Sometimes you may (for legacy reasons) need to name your primary key column such that it
+would be misinterpreted as a foreign-key (say for example if you named the primary key
+<tt>order_id</tt>). In this case you can manually create the primary key as follows:
+
+    create_table :orders, :id => false do |t|
+      ...
+      t.primary_key :order_id, :references => nil
+    end
+
+There is also a generator for creating foreign keys on a database that currently has none:
+
+    ruby script/generate foreign_key_migration
+
+The plugin fully supports and understands the following active-record
+configuration properties:
+
+* `config.active_record.pluralize_table_names`
+* `config.active_record.table_name_prefix`
+* `config.active_record.table_name_suffix`
+
+## Dependencies
+
+* RedHill on Rails Core (redhillonrails_core) aspgems version.
+
+## NOTE
+
+* Code was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
+
+## License
+
+This plugin is copyright 2006 by RedHill Consulting, Pty. Ltd. and is released
+under the MIT license.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+%w[postgresql mysql mysql2].each do |adapter|
+  namespace adapter do
+    RSpec::Core::RakeTask.new(:spec) do |spec|
+      spec.rspec_opts = "-Ispec/connections/#{adapter}"
+    end
+  end
+end
+
+desc 'Run postgresql and mysql tests'
+task :spec do 
+  %w[postgresql mysql mysql2].each do |adapter|
+    Rake::Task["#{adapter}:spec"].invoke
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "foreign key migrations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :postgresql do
+  desc 'Build the PostgreSQL test databases'
+  task :build_databases do
+    %x( createdb -E UTF8 fkm_unittest )
+  end
+
+  desc 'Drop the PostgreSQL test databases'
+  task :drop_databases do
+    %x( dropdb fkm_unittest )
+  end
+
+  desc 'Rebuild the PostgreSQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
+end
+
+task :build_postgresql_databases => 'postgresql:build_databases'
+task :drop_postgresql_databases => 'postgresql:drop_databases'
+task :rebuild_postgresql_databases => 'postgresql:rebuild_databases'
+
+MYSQL_DB_USER = 'fkm'
+namespace :mysql do
+  desc 'Build the MySQL test databases'
+  task :build_databases do
+    %x( echo "create DATABASE fkm_unittest DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{MYSQL_DB_USER})
+  end
+
+  desc 'Drop the MySQL test databases' 
+  task :drop_databases do
+    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop fkm_unittest )
+  end
+
+  desc 'Rebuild the MySQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
+end
+
+task :build_mysql_databases => 'mysql:build_databases'
+task :drop_mysql_databases => 'mysql:drop_databases'
+task :rebuild_mysql_databases => 'mysql:rebuild_databases'

data/foreign_key_migrations.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "foreign_key_migrations/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aspgems-foreign_key_migrations"
+  s.version     = ForeignKeyMigrations::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michał Łomnicki", "Paco Guzmán"]
+  s.email       = ["michal.lomnicki@gmail.com", "fjguzman@aspgems.com"]
+  s.homepage    = "https://github.com/aspgems/foreign_key_migrations"
+  s.summary     = "Automatically generate foreign-key constraints when creating tables"
+  s.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."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("aspgems-redhillonrails_core", "~> 2.0.0.beta2")
+      
+  s.add_development_dependency("rspec", "~> 2.5.0")
+  s.add_development_dependency("pg")
+  s.add_development_dependency("mysql")
+  s.add_development_dependency("mysql2")
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'foreign_key_migrations' unless defined?(ForeignKeyMigrations)

data/install.rb

@@ -0,0 +1 @@
+puts "Note redhillonrails_core dependency is needed"

data/lib/foreign_key_migrations.rb

@@ -0,0 +1,48 @@
+require 'redhillonrails_core'
+
+module ForeignKeyMigrations
+  module ActiveRecord
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Migration
+
+    module ConnectionAdapters
+      extend ActiveSupport::Autoload
+
+      autoload :TableDefinition
+      autoload :SchemaStatements
+    end
+  end
+
+  # Default FK update action
+  mattr_accessor :on_update
+  @@on_update = :restrict
+
+  # Default FK delete action
+  mattr_accessor :on_delete
+  @@on_delete = :restrict
+
+  # Create an index after creating FK (default false)
+  mattr_accessor :auto_index
+  @@auto_index = nil
+
+  # FIXME Not used by now
+  def self.setup(&block)
+    yield self
+  end
+
+  def self.options_for_index(index)
+    index.is_a?(Hash) ? index : {}
+  end
+
+  def self.set_default_update_and_delete_actions!(options)
+    options[:on_update] = options.fetch(:on_update, ForeignKeyMigrations.on_update)
+    options[:on_delete] = options.fetch(:on_delete, ForeignKeyMigrations.on_delete)
+  end
+end
+
+ActiveRecord::Base.send(:include, ForeignKeyMigrations::ActiveRecord::Base)
+ActiveRecord::Migration.send(:include, ForeignKeyMigrations::ActiveRecord::Migration)
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, ForeignKeyMigrations::ActiveRecord::ConnectionAdapters::TableDefinition)
+ActiveRecord::ConnectionAdapters::SchemaStatements.send(:include, ForeignKeyMigrations::ActiveRecord::ConnectionAdapters::SchemaStatements)

data/lib/foreign_key_migrations/active_record/base.rb

@@ -0,0 +1,36 @@
+module ForeignKeyMigrations::ActiveRecord
+  module Base
+    def self.included(base) # :nodoc
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Determines referenced table and column.
+      # Used in migrations.
+      #   references('comments', 'post_id') # => ['posts', 'id']
+      #
+      # If <tt>column_name</tt> is parent_id it references to the same table
+      #   references('pages', 'parent_id')  # => ['pages', 'id']
+      #
+      # If referenced table cannot be determined properly it may be overriden
+      #   references('widgets', 'main_page_id', :references => 'pages'))
+      #   # => ['pages', 'id']
+      #
+      # Also whole result may be given by hand
+      #   references('addresses', 'member_id', :references => ['users', 'uuid'])
+      #   # => ['users', 'uuid']
+      def references(table_name, column_name, options = {})
+        column_name = column_name.to_s
+        if options.has_key?(:references)
+          references = options[:references]
+          references = [references, :id] unless references.nil? || references.is_a?(Array)
+          references
+        elsif column_name == 'parent_id'
+          [table_name, :id]
+        elsif column_name =~ /^(.*)_id$/
+          [pluralized_table_name($1), :id]
+        end
+      end
+    end
+  end
+end

data/lib/foreign_key_migrations/active_record/connection_adapters/schema_statements.rb

@@ -0,0 +1,23 @@
+module ForeignKeyMigrations::ActiveRecord::ConnectionAdapters
+  module SchemaStatements
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :create_table, :foreign_key_migrations
+      end
+    end
+
+    def create_table_with_foreign_key_migrations(table, options = {})
+      indices = nil
+      create_table_without_foreign_key_migrations(table, options) do |table_definition|
+        yield table_definition if block_given?
+        indices = table_definition.indices
+      end
+      indices.each do |column_name, index_options|
+        column_names = [column_name] + Array.wrap(index_options.delete(:with))
+        add_index(table, column_names, index_options)
+      end
+    end
+
+  end
+end