schema_auto_foreign_keys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7bb4e877d1795bda1f593666141fcc43c154410
+  data.tar.gz: 171e3b7fafbb1b6cbce610b9a7a83c425b93b7ab
+SHA512:
+  metadata.gz: 207ed1d89fab44de59c78e882b0bc072707626a184045fcbc933e632f79f53871473762eaae3f8d71bc640e1f8735a38cbd18f064ccac496a68fc0de297ee5bf
+  data.tar.gz: c09043f5a1d8151b72c5432fde2e9106c6fb9cdb908736565710ac0fb467d0fca6716457a6740b7b515b6d7c66aeb7dfbf90143bc602157286595da3b142448e

data/.gitignore

@@ -0,0 +1,9 @@
+/coverage
+/tmp
+/pkg
+/Gemfile.local
+
+*.lock
+*.log
+*.sqlite3
+!gemfiles/**/*.sqlite3

data/.travis.yml

@@ -0,0 +1,21 @@
+# This file was auto-generated by the schema_dev tool, based on the data in
+#                 ./schema_dev.yml
+# Please do not edit this file; any changes will be overwritten next time
+# schema_dev gets run.
+---
+sudo: false
+rvm:
+- 2.1.5
+gemfile:
+- gemfiles/activerecord-4.2.0/Gemfile.mysql2
+- gemfiles/activerecord-4.2.0/Gemfile.postgresql
+- gemfiles/activerecord-4.2.0/Gemfile.sqlite3
+- gemfiles/activerecord-4.2.1/Gemfile.mysql2
+- gemfiles/activerecord-4.2.1/Gemfile.postgresql
+- gemfiles/activerecord-4.2.1/Gemfile.sqlite3
+env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
+addons:
+  postgresql: '9.4'
+before_script: bundle exec rake create_databases
+after_script: bundle exec rake drop_databases
+script: bundle exec rake travis

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ronen barzel 
+
+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,144 @@
+[![Gem Version](https://badge.fury.io/rb/schema_auto_foreign_keys.svg)](http://badge.fury.io/rb/schema_auto_foreign_keys)
+[![Build Status](https://secure.travis-ci.org/SchemaPlus/schema_auto_foreign_keys.svg)](http://travis-ci.org/SchemaPlus/schema_auto_foreign_keys)
+[![Coverage Status](https://img.shields.io/coveralls/SchemaPlus/schema_auto_foreign_keys.svg)](https://coveralls.io/r/SchemaPlus/schema_auto_foreign_keys)
+[![Dependency Status](https://gemnasium.com/lomba/schema_auto_foreign_keys.svg)](https://gemnasium.com/SchemaPlus/schema_auto_foreign_keys)
+
+# SchemaAutoForeignKeys
+
+
+SchemaAutoForeignKeys is part of the [SchemaPlus](https://github.com/SchemaPlus/) family of Ruby on Rails ActiveRecord extension gems.
+
+## Usage
+
+Many of us think that it should goes without saying that if you define a foreign key *relation* in your database you should also define a foreign key *constraint*.
+
+Similarly, it should go without saying that if you have a foreign key *constraint* on a column, you should also have an *index* on that column.
+
+And if you include the `schema_auto_foreign_keys` gem, these will also go without typing!  schema_auto_foreign_keys simply turns on some default behavior in your migrations:
+
+```ruby
+t.integer :user_id  # any column named xxxx_id defaults to...
+t.integer :user_id, foreign_key: true, index: true
+
+t.references :user # references defaults to...
+t.references :user, foreign_key: true, index: true
+
+t.belongs_to :user # belongs_to default to...
+t.belongs_to :user, foreign_key: true, index: true
+```
+
+Note that schema_auto_foreign_keys depends on the [schema_plus_foreign_keys](https://github.com/SchemaPlus/schema_plus_foreign_keys) and [schema_plus_indexes](https://github.com/SchemaPlus/schema_plus_indexes) gems, and so makes available their migration shortcuts.
+
+There is actually one difference between an auto-created index and specifying `index: true`: if you don't specify anything, schema_auto_foreign_keys will maintain "ownership" of the auto-created index:  It will remove the index if the foreign key gets removed; and it will rename the index if the table gets renamed.
+
+### Overriding
+
+If you need specific paramaters other than the default, you can of course specify them:
+
+```ruby
+t.integer :user_id, index: :unique  # "has one" relationship between users and this 
+model
+t.integer :user_id, on_delete: :cascade
+```
+
+If you don't want a foreign key constraint (e.g. because "product_id" is a domain-level string rather than a foreign key), or an index just specify falsey:
+
+```rugy
+t.integer :product_id, foreign_key: false # also implies index: false
+t.integer :product_id, references: nil
+t.integer :user_id, index: false
+```
+
+## Configuration
+
+SchemaAutoForeignKeys adds two new entries to SchemaPlus::ForeignKeys' config:
+
+```ruby
+SchemaPlus::ForeignKeys.setup do |config|
+   config.auto_create = true # default for schema_auto_foreign_keys
+   config.auto_index = true # default for schema_auto_foreign_keys
+end
+```
+
+You can also configure the behavior per-table in a migration:
+
+```ruby
+create_table :posts, foreign_keys: { auto_create: true, auto_index: true } do |t|
+   t.integer :author_id
+endf
+```
+
+
+## Installation
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+As usual:
+
+```ruby
+gem "schema_auto_foreign_keys"                # in a Gemfile
+gem.add_dependency "schema_auto_foreign_keys" # in a .gemspec
+```
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
+
+## Compatibility
+
+SchemaAutoForeignKeys is tested on:
+
+<!-- SCHEMA_DEV: MATRIX - begin -->
+<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->
+* ruby **2.1.5** with activerecord **4.2.0**, using **mysql2**, **sqlite3** or **postgresql**
+* ruby **2.1.5** with activerecord **4.2.1**, using **mysql2**, **sqlite3** or **postgresql**
+
+<!-- SCHEMA_DEV: MATRIX - end -->
+
+### Platform-specific Notes:
+
+MySQL automatically creates indexes for foreign key constraints, so when used with MySQL, schema_auto_foreign_keys doesn't include the auto-index capability.
+
+SQlite3 doesn't support renaming the auto-index whtn the table name changes.
+
+
+
+## History
+
+* 0.1.0 - Initial release, extracted from schema_plus 2.0.0.pre*
+
+## Development & Testing
+
+Are you interested in contributing to SchemaAutoForeignKeys?  Thanks!  Please follow
+the standard protocol: fork, feature branch, develop, push, and issue pull
+request.
+
+Some things to know about to help you develop and test:
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_DEV - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_dev**:  SchemaAutoForeignKeys uses [schema_dev](https://github.com/SchemaPlus/schema_dev) to
+  facilitate running rspec tests on the matrix of ruby, activerecord, and database
+  versions that the gem supports, both locally and on
+  [travis-ci](http://travis-ci.org/SchemaPlus/schema_auto_foreign_keys)
+
+  To to run rspec locally on the full matrix, do:
+
+        $ schema_dev bundle install
+        $ schema_dev rspec
+
+  You can also run on just one configuration at a time;  For info, see `schema_dev --help` or the [schema_dev](https://github.com/SchemaPlus/schema_dev) README.
+
+  The matrix of configurations is specified in `schema_dev.yml` in
+  the project root.
+
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_DEV - end -->
+
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_monkey**: SchemaAutoForeignKeys is implemented as a
+  [schema_monkey](https://github.com/SchemaPlus/schema_monkey) client,
+  using [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s
+  convention-based protocols for extending ActiveRecord and using middleware stacks.
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - end -->

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'schema_dev/tasks'
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/gemfiles/Gemfile.base

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec :path => File.expand_path('..', __FILE__)
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/gemfiles/activerecord-4.2.0/Gemfile.base

@@ -0,0 +1,3 @@
+eval File.read File.expand_path('../../Gemfile.base', __FILE__)
+
+gem "activerecord", "4.2.0"

data/gemfiles/activerecord-4.2.0/Gemfile.mysql2

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "mysql2"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+end

data/gemfiles/activerecord-4.2.0/Gemfile.postgresql

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "pg"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end

data/gemfiles/activerecord-4.2.0/Gemfile.sqlite3

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "sqlite3"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter', '>=1.3.0.beta2'
+end

data/gemfiles/activerecord-4.2.1/Gemfile.base

@@ -0,0 +1,3 @@
+eval File.read File.expand_path('../../Gemfile.base', __FILE__)
+
+gem "activerecord", "4.2.1"

data/gemfiles/activerecord-4.2.1/Gemfile.mysql2

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "mysql2"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+end

data/gemfiles/activerecord-4.2.1/Gemfile.postgresql

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "pg"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end

data/gemfiles/activerecord-4.2.1/Gemfile.sqlite3

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "sqlite3"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter', '>=1.3.0.beta2'
+end

data/lib/schema_auto_foreign_keys.rb

@@ -0,0 +1,31 @@
+require 'schema_plus/foreign_keys'
+require 'schema_plus/indexes'
+
+require_relative 'schema_auto_foreign_keys/middleware/migration'
+require_relative 'schema_auto_foreign_keys/middleware/schema'
+
+module SchemaAutoForeignKeys
+  module ActiveRecord
+    module ConnectionAdapters
+      autoload :Sqlite3Adapter, 'schema_auto_foreign_keys/active_record/connection_adapters/sqlite3_adapter'
+    end
+  end
+end
+
+class SchemaPlus::ForeignKeys::Config
+    ##
+    # :attr_accessor: auto_create
+    #
+    # Whether to automatically create foreign key constraints for columns
+    # suffixed with +_id+.  Boolean, default is +true+.
+    has_value :auto_create, :klass => :boolean, :default => true
+
+    ##
+    # :attr_accessor: auto_index
+    #
+    # Whether to automatically create indexes when creating foreign key constraints for columns.
+    # Boolean, default is +true+.
+    has_value :auto_index, :klass => :boolean, :default => true
+end
+
+SchemaMonkey.register SchemaAutoForeignKeys

data/lib/schema_auto_foreign_keys/active_record/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,22 @@
+module SchemaAutoForeignKeys
+  module ActiveRecord
+    module ConnectionAdapters
+
+      # SchemaPlus::ForeignKeys includes an Sqlite3 implementation of the AbstractAdapter
+      # extensions.
+      module Sqlite3Adapter
+
+        def copy_table(*args, &block)
+          fk_override = { :auto_create => false, :auto_index => false }
+          save = Hash[fk_override.keys.collect{|key| [key, SchemaPlus::ForeignKeys.config.send(key)]}]
+          begin
+            SchemaPlus::ForeignKeys.config.update_attributes(fk_override)
+            super
+          ensure
+            SchemaPlus::ForeignKeys.config.update_attributes(save)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/schema_auto_foreign_keys/middleware/migration.rb

@@ -0,0 +1,90 @@
+require 'openssl'
+
+module SchemaAutoForeignKeys
+  module AutoCreate
+    # defined below
+  end
+
+  module Middleware
+    module Migration
+      module Column
+        module PostgreSQL ; include AutoCreate ; end
+        module SQLite3 ; include AutoCreate ; end
+        module MySQL
+          include AutoCreate
+          def auto_index?(env, config) ; false end
+          def remove_auto_index?(env) ; false end
+        end
+      end
+
+      module RenameTable
+        def after(env)
+          newname = env.new_name
+          oldname = env.table_name
+          indexes = env.connection.indexes(newname)
+          env.connection.foreign_keys(newname).each do |fk|
+            index = indexes.find(&its.name == AutoCreate.auto_index_name(oldname, fk.column))
+            env.connection.rename_index(newname, index.name, AutoCreate.auto_index_name(newname, index.columns)) if index
+          end
+        end
+      end
+    end
+  end
+  
+  module AutoCreate
+    def before(env)
+      config ||= env.caller.try(:schema_plus_foreign_keys_config) || SchemaPlus::ForeignKeys.config
+      set_foreign_key(env) if auto_fk?(env, config)
+      set_auto_index(env) if auto_index?(env, config)
+    end
+
+    def after(env)
+      remove_auto_index(env) if env.operation == :change and remove_auto_index?(env)
+    end
+
+    def auto_fk?(env, config)
+      return false if env.options.include? :foreign_key
+      return false unless config.auto_create?
+      return true if env.type == :reference
+      return false if env.implements_reference
+      return true if env.column_name.to_s =~ /_id$/ # later on add a config option for this
+    end
+
+    def auto_index?(env, config)
+      return false if env.options.include? :index
+      return false unless env.options[:foreign_key]
+      return true if config.auto_index?
+    end
+
+    def remove_auto_index?(env)
+      env.options.include? :foreign_key and not env.options[:foreign_key]
+    end
+
+    def set_foreign_key(env)
+      env.options[:foreign_key] = true
+    end
+
+    def set_auto_index(env)
+      env.options[:index] = { name: auto_index_name(env) }
+    end
+
+    def remove_auto_index(env)
+      env.caller.remove_index(env.table_name, :name => auto_index_name(env), :column => env.column_name, :if_exists => true)
+    end
+
+    def auto_index_name(env)
+      AutoCreate.auto_index_name(env.table_name, env.column_name)
+    end
+
+    def self.auto_index_name(from_table, column_name)
+      name = "fk__#{fixup_schema_name(from_table)}_#{Array.wrap(column_name).join('_and_')}"
+      name = name.slice(0, 27) + "_" + OpenSSL::Digest::MD5.new.hexdigest(name) if name.length > 60
+      name
+    end
+
+    def self.fixup_schema_name(table_name)
+      # replace . with _
+      table_name.to_s.gsub(/[.]/, '_')
+    end
+  end
+end