active_record_foreign_keys 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Anton Ageev
+
+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,51 @@
+= active_record_foreign_keys
+
+Foreign keys support for ActiveRecord.
+
+== Install
+
+  Rails::Initializer.run do |config|
+    ...
+    config.gem "active_record_foreign_keys", :source => "http://gemcutter.org"
+    ...
+  end
+
+  $ rake gems:install
+
+== Usage
+
+  def self.up
+    # create reference table
+    create_table :users do |t|
+    end
+
+    # create referencing table
+    create_table :a_examples do |t|
+      t.references :user, :foreign_key => true
+    end
+
+    # or
+    create_table :b_examples do |t|
+      t.references :user, :foreign_key => { :on_update => :cascade, :on_delete => :restrict }
+    end
+
+    # or
+    create_table :c_examples do |t|
+    end
+
+    add_foreign_key :c_examples, :user_id, :users, :id, :on_update => :no_action, :on_delete => :set_null
+
+    # or change existing table
+    change_table :d_examples do |t|
+      t.references :user, :foreign_key => true
+    end
+  end
+
+  def self.down
+    # remove constraint
+    remove_foreign_key :examples, :user_id, :users, :id
+  end
+
+== Copyright
+
+Copyright (c) 2009 Anton Ageev. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_record_foreign_keys"
+    gem.summary = %Q{Foreign keys support for ActiveRecord}
+    gem.email = "antage@gmail.com"
+    gem.homepage = "http://github.com/antage/active_record_foreign_keys"
+    gem.authors = ["Anton Ageev"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_record_foreign_keys #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/active_record_foreign_keys.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_record_foreign_keys}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anton Ageev"]
+  s.date = %q{2009-10-21}
+  s.email = %q{antage@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "active_record_foreign_keys.gemspec",
+     "lib/active_record_foreign_keys.rb",
+     "rails/init.rb"
+  ]
+  s.homepage = %q{http://github.com/antage/active_record_foreign_keys}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Foreign keys support for ActiveRecord}
+
+  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
+    else
+    end
+  else
+  end
+end

data/lib/active_record_foreign_keys.rb

@@ -0,0 +1,96 @@
+require "active_record"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class TableDefinition
+      def references_with_foreign_key(*args)
+        options = args.extract_options!
+        cols = args.dup
+        fk_options = options.delete(:foreign_key) || false
+        references_without_foreign_key(*(args << options))
+        unless options[:polymorphic] || fk_options == false
+          @table_statements ||= []
+          fk_options = {} unless fk_options.is_a?(Hash)
+          cols.each do |col|
+            @table_statements << @base.foreign_key_sql(@table_name, "#{col}_id", col.to_s.pluralize, "id", fk_options)
+          end
+        end
+      end
+      alias_method_chain :references, :foreign_key
+
+      def to_sql_with_foreign_key
+        col_defs = to_sql_without_foreign_key
+        if @table_statements.is_a?(Array) && @table_statements.size > 0
+          sql = col_defs + ", " + (@table_statements * ", ")
+        else
+          sql = col_defs
+        end
+        sql
+      end
+      alias_method_chain :to_sql, :foreign_key
+    end
+
+    class Table
+      def references_with_foreign_key(*args)
+        options = args.extract_options!
+        cols = args.dup
+        fk_options = options.delete(:foreign_key) || false
+        references_without_foreign_key(*(args << options))
+        unless options[:polymorphic] || fk_options == false
+          fk_options = {} unless fk_options.is_a?(Hash)
+          cols.each { |col| @base.add_foreign_key(@table_name, "#{col}_id", col.to_s.pluralize, "id", fk_options) }
+        end
+      end
+      alias_method_chain :references, :foreign_key
+    end
+
+    module SchemaStatements
+      def add_foreign_key(table_name, column_name, reference_table_name, reference_column_name, options = {})
+        sql = <<-EOS
+          ALTER TABLE #{quote_table_name(table_name)}
+            ADD CONSTRAINT #{quote_table_name(foreign_key_constraint_name(table_name, column_name))}
+        EOS
+        sql += foreign_key_sql(table_name, column_name, reference_table_name, reference_column_name, options)
+        execute sql
+      end
+
+      def remove_foreign_key(table_name, column_name)
+        if foreign_key_exists?(table_name, column_name)
+          execute "ALTER TABLE #{quote_table_name(table_name)} DROP CONSTRAINT #{quote_table_name(foreign_key_constraint_name(table_name, column_name))}"
+        end 
+      end
+
+      def foreign_key_sql(table_name, column_name, reference_table_name, reference_column_name, options = {})
+        options = {
+          :on_update => :no_action,
+          :on_delete => :no_action
+        }.merge(options)
+
+        "FOREIGN KEY (#{quote_column_name(column_name)}) REFERENCES #{quote_table_name(reference_table_name)}(#{quote_column_name(reference_column_name)}) ON UPDATE #{foreign_key_action(options[:on_update])} ON DELETE #{foreign_key_action(options[:on_delete])}"
+      end
+
+      private
+
+        def foreign_key_constraint_name(table_name, column_name)
+          "#{table_name}_#{column_name}_fkey"
+        end
+
+        def foreign_key_exists?(table_name, column_name)
+          count = select_value("SELECT COUNT(*) FROM pg_constraint WHERE conname = #{quote(foreign_key_constraint_name(table_name, column_name))}")
+          count.to_i > 0
+        end
+
+        def foreign_key_action(action)
+          case action
+          when :no_action then "NO ACTION"
+          when :restrict then "RESTRICT"
+          when :cascade then "CASCADE"
+          when :set_null then "SET NULL"
+          when :set_default then "SET DEFAULT"
+          else
+            raise ArgumentError, "Invalid action type. Valid actions are :on_update can be :no_action, :restrict, :cascade, :set_null, :set_default"
+          end
+        end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "active_record_foreign_keys"

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: active_record_foreign_keys
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Anton Ageev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: antage@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- active_record_foreign_keys.gemspec
+- lib/active_record_foreign_keys.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/antage/active_record_foreign_keys
+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: Foreign keys support for ActiveRecord
+test_files: []
+