automatic_foreign_key 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+MIT-LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGELOG

@@ -0,0 +1,3 @@
+1.0.0
+    * renamed from foreign_key_migration to automatic_foreign_key
+    * added 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.rdoc

@@ -0,0 +1,92 @@
+= Automatic Foreign Key
+
+Automatic Foreign Key is an ActiveRecord extension 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
++customer_id+ that you want a foreign-key constraint generated that references
+the +id+ column in the +customers+ 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
+<code>:references</code> 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 +_id+ for which you do not wish a
+foreign-key to be generated, you can use <code>:references => nil</code>:
+
+  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 +id+. 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
+<code>:on_delete</code>/<code>:on_update</code>, respectively to one of:
+<code>:cascade</code>; <code>:restrict</code>; and <code>:set_null</code>:
+
+  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 +parent_id+ 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
++order_id+). 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:
+
+* <code>config.active_record.pluralize_table_names</code>
+* <code>config.active_record.table_name_prefix</code>
+* <code>config.active_record.table_name_suffix</code>
+
+=== Dependencies
+
+* RedHill on Rails Core (redhillonrails_core).
+
+=== NOTE
+
+* Code was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
+* Former name was foreign_key_migrations
+
+=== License
+
+This plugin is copyright 2010 by Michał Łomnicki and is released
+under the MIT license.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "automatic_foreign_key"
+    gem.summary = %Q{Automatically generate foreign-key constraints when creating tables}
+    gem.description = %Q{Automatic Key Migrations is a gem 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.}
+    gem.email = "michal.lomnicki@gmail.com"
+    gem.homepage = "http://github.com/mlomnicki/automatic_foreign_key"
+    gem.authors = ["Michał Łomnicki"]
+    gem.add_dependency "redhillonrails_core", ">= 1.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "automatic_foreign_key #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/automatic_foreign_key.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{automatic_foreign_key}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Micha\305\202 \305\201omnicki"]
+  s.date = %q{2010-03-13}
+  s.description = %q{Automatic Key Migrations is a gem 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.}
+  s.email = %q{michal.lomnicki@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "automatic_foreign_key.gemspec",
+     "generators/foreign_key_migration/foreign_key_migration_generator.rb",
+     "generators/foreign_key_migration/templates/migration.rb",
+     "init.rb",
+     "install.rb",
+     "lib/automatic_foreign_key.rb",
+     "lib/red_hill_consulting/automatic_foreign_key/active_record/base.rb",
+     "lib/red_hill_consulting/automatic_foreign_key/active_record/connection_adapters/table_definition.rb",
+     "lib/red_hill_consulting/automatic_foreign_key/active_record/migration.rb"
+  ]
+  s.homepage = %q{http://github.com/mlomnicki/automatic_foreign_key}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Automatically generate foreign-key constraints when creating tables}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redhillonrails_core>, [">= 1.0.0"])
+    else
+      s.add_dependency(%q<redhillonrails_core>, [">= 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<redhillonrails_core>, [">= 1.0.0"])
+  end
+end
+

data/generators/foreign_key_migration/foreign_key_migration_generator.rb

@@ -0,0 +1,24 @@
+class ForeignKeyMigrationGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args << 'create_foreign_keys' if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    foreign_keys = []
+
+    connection = ActiveRecord::Base.connection
+    connection.tables.each do |table_name|
+      connection.columns(table_name).each do |column|
+        references = ActiveRecord::Base.references(table_name, column.name)
+        foreign_keys << RedHillConsulting::Core::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(nil, table_name, column.name, references.first, references.last) if references
+      end
+    end
+
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+        :migration_name => class_name, :foreign_keys => foreign_keys
+      }, :migration_file_name => file_name
+    end
+  end
+end

data/generators/foreign_key_migration/templates/migration.rb

@@ -0,0 +1,10 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% foreign_keys.each do |foreign_key| -%>
+    <%= foreign_key.to_dump %>
+<% end -%>
+  end
+
+  def self.down
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'automatic_foreign_key' unless defined?(RedHillConsulting::AutomaticForeignKey)

data/install.rb

@@ -0,0 +1 @@
+puts "WARNING: You also need to install redhillonrails_core" unless File.exists?(File.join(File.dirname(__FILE__), "..", "redhillonrails_core"))

data/lib/automatic_foreign_key.rb

@@ -0,0 +1,4 @@
+require 'redhillonrails_core'
+ActiveRecord::Base.send(:include, RedHillConsulting::AutomaticForeignKey::ActiveRecord::Base)
+ActiveRecord::Migration.send(:include, RedHillConsulting::AutomaticForeignKey::ActiveRecord::Migration)
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, RedHillConsulting::AutomaticForeignKey::ActiveRecord::ConnectionAdapters::TableDefinition)

data/lib/red_hill_consulting/automatic_foreign_key/active_record/base.rb

@@ -0,0 +1,22 @@
+module RedHillConsulting::AutomaticForeignKey::ActiveRecord
+  module Base
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      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/red_hill_consulting/automatic_foreign_key/active_record/connection_adapters/table_definition.rb

@@ -0,0 +1,28 @@
+module RedHillConsulting::AutomaticForeignKey::ActiveRecord::ConnectionAdapters
+  module TableDefinition
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :column, :automatic_foreign_key
+        alias_method_chain :primary_key, :automatic_foreign_key
+      end
+    end
+
+    def primary_key_with_automatic_foreign_key(name, options = {})
+      column(name, :primary_key, options)
+    end
+
+    def column_with_automatic_foreign_key(name, type, options = {})
+      column_without_automatic_foreign_key(name, type, options)
+      references = ActiveRecord::Base.references(self.name, name, options)
+      foreign_key(name, references.first, references.last, options) if references
+      self
+    end
+
+    # Some people liked this; personally I've decided against using it but I'll keep it nonetheless
+    def belongs_to(table, options = {})
+      options = options.merge(:references => table)
+      options[:on_delete] = options.delete(:dependent) if options.has_key?(:dependent)
+      column("#{table.to_s.singularize}_id".to_sym, :integer, options)
+    end
+  end
+end

data/lib/red_hill_consulting/automatic_foreign_key/active_record/migration.rb

@@ -0,0 +1,15 @@
+module RedHillConsulting::AutomaticForeignKey::ActiveRecord
+  module Migration
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def add_column(table_name, column_name, type, options = {})
+        super
+        references = ActiveRecord::Base.references(table_name, column_name, options)
+        add_foreign_key(table_name, column_name, references.first, references.last, options) if references
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: automatic_foreign_key
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Micha\xC5\x82 \xC5\x81omnicki"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redhillonrails_core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: |-
+  Automatic Key Migrations is a gem 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.
+email: michal.lomnicki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- automatic_foreign_key.gemspec
+- generators/foreign_key_migration/foreign_key_migration_generator.rb
+- generators/foreign_key_migration/templates/migration.rb
+- init.rb
+- install.rb
+- lib/automatic_foreign_key.rb
+- lib/red_hill_consulting/automatic_foreign_key/active_record/base.rb
+- lib/red_hill_consulting/automatic_foreign_key/active_record/connection_adapters/table_definition.rb
+- lib/red_hill_consulting/automatic_foreign_key/active_record/migration.rb
+has_rdoc: true
+homepage: http://github.com/mlomnicki/automatic_foreign_key
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Automatically generate foreign-key constraints when creating tables
+test_files: []
+