fakey 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+test/*.log
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fakey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2014 Tutuf Ltd
+
+MIT License
+
+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,70 @@
+# Fakey - foreign keys support for ActiveRecord migrations
+
+
+Before resorting to write yet another foreign key plugin I tried
+[foreign_key_migrations](http://github.com/harukizaemon/foreign_key_migrations)
+(no longer available) and
+[foreigner](http://github.com/matthuhiggins/foreigner), but they have annoying
+shortcomings. *foreign_key_migrations* assumes every column ending on `_id` to
+be a foreign key and tries to infer the table name, which in my case was not
+the right one. *foreigner* doesn't let you declare foreign key in
+`create_table` block, instead you have to call explicitly
+`add_foreign_key(:comments, :posts)` after it. Not quite helpful for tables
+containing a lot of foreign keys.
+
+Fakey is fully tested by directly inspecting schema in the database and
+supports both MySQL and PostgreSQL.
+
+##Example
+  Fakey hooks foreign keys to the standard `belongs_to` and `references` methods in migrations.
+
+    # Standard usage
+    create_table :books do |t|
+      t.belongs_to :author
+    end
+    # => CREATE TABLE "books" ("id" serial primary key, "author_id" integer REFERENCES "authors")
+
+    # Table name specified explicitly
+    create_table :poems do |t|
+      t.belongs_to :author, :references => :poets
+    end
+    # => CREATE TABLE "poems" ("id" serial primary key, "author_id" integer REFERENCES "poets")
+
+    # Column name specified explicitly (if you don't want _id suffix)
+    create_table :books do |t|
+      t.belongs_to :author, :column => :author
+    end
+    # => CREATE TABLE "books" ("id" serial primary key, "author" integer REFERENCES "books")
+
+    # Non-integer primary key (for those with legacy databases) - this only works in PostgreSQL now!
+    execute "CREATE TABLE authors( name VARCHAR(255) PRIMARY KEY)"
+    create_table :books do |t|
+      t.belongs_to :author_name, :column => :author_name, :references => :authors, :type => :string
+    end
+    # => CREATE TABLE "books" ("id" serial primary key, "author_name" VARCHAR(255) REFERENCES "authors")
+
+    # Non-primary key (for those with legacy databases)
+    create_table :authors do |t|
+      t.integer :ssid
+    end
+    execute("ALTER TABLE authors ADD UNIQUE(ssid)") # note that add_index doesn't create constraint!
+    create_table :books do |t|
+      t.belongs_to :author_ssid, :column => :author_ssid, :references => :authors, :referenced_column => :ssid
+    end
+    # => CREATE TABLE "books" ("id" serial primary key, "author_ssid" integer REFERENCES "authors"(ssid))
+
+
+    # Changing table too
+    change_table :atuhors do |t|
+      t.belongs_to :author
+    end
+
+##Compatibility
+
+Rails: 3.2+
+
+PostgreSQL 7.0+
+
+MySQL 5.0+
+
+Copyright (c) 2009-2014 Tutuf Ltd, released under the MIT license. Thanks to Bryan Evans for database introspection query (taken from drysql gem).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+

data/fakey.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fakey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fakey"
+  spec.version       = Fakey::VERSION
+  spec.authors       = ["Sava Chankov"]
+  spec.email         = ["sava@tutuf.com"]
+  spec.description   = %q{Foreign keys support for ActiveRecord migrations}
+  spec.summary       = %q{Foreign keys support for ActiveRecord migrations}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~>3.2.18"
+
+  spec.add_development_dependency "rails", "~>3.2.18"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/fakey.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+require 'fakey/schema_definitions'
+
+module ActiveRecord
+  module ConnectionAdapters
+    TableDefinition.class_eval { include Fakey::TableDefinition }
+    Table.class_eval { include Fakey::Table }
+  end
+end
+
+if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+  require 'fakey/postgresql_adapter'
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval { include Fakey::PostgreSQLAdapter }
+elsif defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+  require 'fakey/mysql_adapter'
+  ActiveRecord::ConnectionAdapters::MysqlAdapter.class_eval { include Fakey::MysqlAdapter }
+else
+  raise "Only PostgreSQL and MySQL are currently supported by the fakey plugin."
+end

data/lib/fakey/mysql_adapter.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+module Fakey #:nodoc:
+  module MysqlAdapter
+    def add_foreign_key(to_table, column, options={})
+      to_table = options[:references] if options[:references]
+      referenced_column = options[:referenced_column] || primary_key(to_table)
+      "FOREIGN KEY(#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)} (#{referenced_column})"
+    end
+  end
+end

data/lib/fakey/postgresql_adapter.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+module Fakey #:nodoc:
+  module PostgreSQLAdapter
+    def add_foreign_key(to_table, column, options={})
+      to_table = options[:references] if options[:references]
+      res = "FOREIGN KEY(#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}"
+      referenced_column = options[:referenced_column] || options[:primary_key]
+      res += "(#{referenced_column})" if referenced_column
+      res
+    end
+
+    # Adds a new column to the named table.
+    # See TableDefinition#column for details of the options you can use.
+    def add_column_with_foreign_key(table_name, column_name, type, options = {})
+      default = options[:default]
+      notnull = options[:null] == false
+      foreign_key = "REFERENCES #{quote_table_name(options[:references])}"
+      foreign_key +="(#{quote_column_name(options[:referenced_column] || options[:primary_key])})" if options[:referenced_column] || options[:primary_key]
+
+      # Add the column.
+      execute("ALTER TABLE #{quote_table_name(table_name)} ADD COLUMN #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])} #{foreign_key}")
+
+      change_column_default(table_name, column_name, default) if options_include_default?(options)
+      change_column_null(table_name, column_name, false, default) if notnull
+    end
+  end
+end

data/lib/fakey/schema_definitions.rb

@@ -0,0 +1,74 @@
+# -*- encoding : utf-8 -*-
+module Fakey
+  module TableDefinition
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :to_sql, :foreign_keys
+        alias_method_chain :references, :foreign_keys
+        alias_method_chain :belongs_to, :foreign_keys
+      end
+    end
+
+    def references_with_foreign_keys(*args)
+      options = args.extract_options!
+      polymorphic = options.delete(:polymorphic)
+      args.each do |col|
+        column_name =  options[:column] || "#{col}_id"
+        column_database_type = options[:type] || :integer
+        column(column_name, column_database_type, options)
+        if polymorphic
+          column("#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options)
+        else
+          table_name = options[:references] || col.to_s.pluralize
+          add_foreign_key(column_name, table_name, options)
+        end
+      end
+    end
+    alias :belongs_to_with_foreign_keys :references_with_foreign_keys
+
+    def add_foreign_key(column_name,table_name,options)
+      @foreign_keys ||= []
+      @foreign_keys << {:column_name => column_name, :to_table => table_name, :options => options}
+    end
+
+    def to_sql_with_foreign_keys
+      sql = to_sql_without_foreign_keys
+      if @foreign_keys
+        sql << ',' <<  @foreign_keys.map{|fk| @base.add_foreign_key(fk[:to_table],fk[:column_name],fk[:options])}.join(",")
+      end
+      sql
+    end
+
+    def foreign_key(*args)
+      return unless Array === args.first
+      composite_foreign_key, options = args.first, args.last
+      
+    end
+  end
+
+  module Table
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :references, :foreign_keys
+        alias_method_chain :belongs_to, :foreign_keys
+      end
+    end
+
+    def references_with_foreign_keys(*args)
+      options = args.extract_options!
+      polymorphic = options.delete(:polymorphic)
+      args.each do |col|
+        column_name =  options[:column] || "#{col}_id"
+        column_database_type = options[:type] || :integer
+        if polymorphic
+          @base.add_column(@table_name, column_name, column_database_type, options)
+          @base.add_column(@table_name, "#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options)
+        else
+          options[:references] ||= col.to_s.pluralize
+          @base.add_column_with_foreign_key(@table_name, column_name, column_database_type, options)
+        end
+      end
+    end
+    alias :belongs_to_with_foreign_keys :references_with_foreign_keys
+  end
+end

data/lib/fakey/version.rb

@@ -0,0 +1,3 @@
+module Fakey
+  VERSION = "1.0.0"
+end

data/test/database.yml

@@ -0,0 +1,8 @@
+postgresql:
+  adapter: postgresql
+  database: fakey_plugin_test
+  min_messages: warning
+mysql:
+  adapter: mysql
+  database: fakey_plugin_test
+  min_messages: warning

data/test/fakey_test.rb

@@ -0,0 +1,189 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+class FakeyTest < ActiveSupport::TestCase
+  def inspect_foreign_keys(table)
+    connection = ActiveRecord::Base.connection
+    if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+      connection.select_all <<-SQL
+SELECT tc.table_name,
+       kcu.column_name,
+       kcu2.table_name AS referenced_table_name,
+       kcu2.column_name AS referenced_column_name
+FROM information_schema.table_constraints       AS tc
+JOIN information_schema.key_column_usage        AS kcu  ON (tc.constraint_name        = kcu.constraint_name)
+JOIN information_schema.referential_constraints AS rc   ON (tc.constraint_name        = rc.constraint_name)
+JOIN information_schema.key_column_usage        AS kcu2 ON (rc.unique_constraint_name = kcu2.constraint_name)
+WHERE tc.constraint_type = 'FOREIGN KEY'
+  AND tc.table_name='#{table}'
+ORDER BY table_name,
+        column_name
+SQL
+    elsif defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+      connection.select_all <<-SQL
+SELECT kcu.table_name,
+       kcu.column_name,
+       kcu.referenced_table_name,
+       kcu.referenced_column_name
+FROM information_schema.table_constraints tc
+JOIN information_schema.key_column_usage kcu USING(constraint_name)
+WHERE tc.constraint_type = 'FOREIGN KEY'
+ORDER BY table_name,
+         column_name
+SQL
+    end
+  end
+
+  def teardown
+    self.class.const_get(@method_name.match(/test_(.+)/)[1].camelize + "Migration").down if defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+  end
+
+  class BelongsToMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:authors) {}
+      create_table :books do |t|
+        t.belongs_to :author
+      end
+    end
+
+    def self.down
+      drop_table :books
+      drop_table :authors
+    end
+  end
+
+  def test_belongs_to
+    BelongsToMigration.up
+    assert_equal( {'table_name' => 'books', 'column_name' => 'author_id', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'id'},
+                   inspect_foreign_keys(:books).first)
+  end
+
+  class ReferencesMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:authors) {}
+      create_table :articles do |t|
+        t.references :author
+      end
+    end
+
+    def self.down
+      drop_table :articles
+      drop_table :authors
+    end
+  end
+
+  def test_references
+    ReferencesMigration.up
+    assert_equal( {'table_name' => 'articles', 'column_name' => 'author_id', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'id'},
+                  inspect_foreign_keys(:articles).first)
+  end
+
+  class ExplicitColumnNameMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:poets) {}
+      create_table :poems do |t|
+        t.belongs_to :author, :column => :author, :references => :poets
+      end
+    end
+
+    def self.down
+      drop_table :poems
+      drop_table :poets
+    end
+  end
+
+  def test_explicit_column_name
+    ExplicitColumnNameMigration.up
+    assert_equal( {'table_name' => 'poems', 'column_name' => 'author', 'referenced_table_name' => 'poets', 'referenced_column_name' => 'id'},
+                  inspect_foreign_keys(:poems).first)
+  end
+
+  class MoreThanOneForeignKeyMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:authors) {}
+      create_table(:editors) {}
+      create_table :scientific_articles do |t|
+        t.belongs_to :author
+        t.belongs_to :editor
+      end
+    end
+
+    def self.down
+      drop_table :scientific_articles
+      drop_table :editors
+      drop_table :authors
+    end
+  end
+
+  def test_more_than_one_foreign_key
+    MoreThanOneForeignKeyMigration.up
+    assert_equal [{'table_name' => 'scientific_articles', 'column_name' => 'author_id', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'id'},
+                  {'table_name' => 'scientific_articles', 'column_name' => 'editor_id', 'referenced_table_name' => 'editors', 'referenced_column_name' => 'id'}],
+                 inspect_foreign_keys(:scientific_articles)
+  end
+
+  class StringForeignKeyMigration < ActiveRecord::Migration
+    class Author < ActiveRecord::Base; end
+    def self.up
+      execute "CREATE TABLE authors( name VARCHAR(255) PRIMARY KEY)"
+      create_table :books do |t|
+        t.belongs_to :author_name, :column => :author_name, :references => :authors, :type => :string
+      end
+    end
+    def self.down
+      drop_table :books if ActiveRecord::Base.connection.tables.include? "books"
+      drop_table :authors if ActiveRecord::Base.connection.tables.include? "authors"
+    end
+  end
+
+  def test_string_foreign_key
+    StringForeignKeyMigration.up
+    assert_equal :string, StringForeignKeyMigration::Author.columns.detect{|c| c.name =='name'}.type
+    assert_equal({'table_name' => 'books', 'column_name' => 'author_name', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'name'},
+                 inspect_foreign_keys(:books).first)
+
+  end
+
+  class ReferenceToNonPrimaryKeyMigration < ActiveRecord::Migration
+    def self.up
+      create_table :authors do |t|
+        t.integer :ssid
+      end
+      execute("ALTER TABLE authors ADD UNIQUE(ssid)")
+      create_table :books do |t|
+        t.belongs_to :author_ssid, :column => :author_ssid, :references => :authors, :referenced_column => :ssid
+      end
+    end
+
+    def self.down
+      drop_table :books
+      drop_table :authors
+    end
+  end
+
+  def test_reference_to_non_primary_key
+    ReferenceToNonPrimaryKeyMigration.up
+    assert_equal({'table_name' => 'books', 'column_name' => 'author_ssid', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'ssid'},
+                 inspect_foreign_keys(:books).first)
+  end
+
+  class ChangeTableMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:authors) {}
+      create_table(:books) {}
+      change_table :books do |t|
+        t.belongs_to :author
+      end
+    end
+
+    def self.down
+      drop_table :books
+      drop_table :authors
+    end
+  end
+
+  def test_change_table
+    ChangeTableMigration.up
+    assert_equal( {'table_name' => 'books', 'column_name' => 'author_id', 'referenced_table_name' => 'authors', 'referenced_column_name' => 'id'},
+                   inspect_foreign_keys(:books).first)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+plugin_test_dir = File.dirname(__FILE__)
+$:.unshift(plugin_test_dir + '/../lib')
+
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+  # no debugger available
+end
+
+config = ActiveRecord::Base.configurations = YAML::load(IO.read(plugin_test_dir + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(plugin_test_dir + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB']] || config['postgresql'])
+
+require 'fakey'
+
+class ActiveSupport::TestCase #:nodoc:
+  # allow testing in Rails < 2.3
+  include ActiveRecord::TestFixtures rescue NameError
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+  ActiveRecord::Migration.verbose = false
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fakey
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Sava Chankov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Foreign keys support for ActiveRecord migrations
+email:
+- sava@tutuf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fakey.gemspec
+- lib/fakey.rb
+- lib/fakey/mysql_adapter.rb
+- lib/fakey/postgresql_adapter.rb
+- lib/fakey/schema_definitions.rb
+- lib/fakey/version.rb
+- test/database.yml
+- test/fakey_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Foreign keys support for ActiveRecord migrations
+test_files:
+- test/database.yml
+- test/fakey_test.rb
+- test/test_helper.rb
+has_rdoc: