schema_plus_foreign_keys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd82359f12e9dfcd2ee7413a727637098fa160a3
+  data.tar.gz: c8b86be4f354952b4f64c5681c28336b4c77153a
+SHA512:
+  metadata.gz: ac770774c777fbae496152c989b884f613148eefbcc2574a7e0359fa8f95ec34514b58329b965200aa46f3da628ae5b026104bdd6a3f75df0a9e4ea6aff360a4
+  data.tar.gz: fd9687b783c5204c743f9646187751b8f519f1e847326a796cb88817a1a0e79d3d6d63c71cad4b99f15545a6aa820420ea4552cf78c50d7d1e068ddf85ca99ea

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,200 @@
+[![Gem Version](https://badge.fury.io/rb/schema_plus_foreign_keys.svg)](http://badge.fury.io/rb/schema_plus_foreign_keys)
+[![Build Status](https://secure.travis-ci.org/SchemaPlus/schema_plus_foreign_keys.svg)](http://travis-ci.org/SchemaPlus/schema_plus_foreign_keys)
+[![Coverage Status](https://img.shields.io/coveralls/SchemaPlus/schema_plus_foreign_keys.svg)](https://coveralls.io/r/SchemaPlus/schema_plus_foreign_keys)
+[![Dependency Status](https://gemnasium.com/lomba/schema_plus_foreign_keys.svg)](https://gemnasium.com/SchemaPlus/schema_plus_foreign_keys)
+
+# SchemaPlus::ForeignKeys
+
+SchemaPlus::ForeignKeys provides extended support in ActiveRecord.  This includes extended support for declaraing foreign key constraints in migrations; support for deferrable constraints; support for SQLite3; cleaner schema dumps.
+
+SchemaPlus::ForeignKeys is part of the [SchemaPlus](https://github.com/SchemaPlus/) family of Ruby on Rails ActiveRecord extension gems.
+
+For extra convenience, see also [schema_auto_foreign_keys](https://github.com/SchemaPlus/schema_auto_foreign_keys), which creates foriegn key constraints automatically.
+
+
+## Installation
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+As usual:
+
+```ruby
+gem "schema_plus_foreign_keys"                # in a Gemfile
+gem.add_dependency "schema_plus_foreign_keys" # in a .gemspec
+```
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
+
+## Usage
+
+### Migrations
+
+To declare a foreign key constraint for a column, use the `:foreign_key`
+option.  The same options can be used with `t.integer`, `t.references`, `t.belongs_to`, `t.foreign_key`, `change_column`, and `add_foreign_key`:
+
+    t.integer :author_id, foreign_key: true           # create a foreign_key to table "authors"
+    t.integer :author_id, foreign_key: {}             # create a foreign_key to table "authors"
+    t.integer :author_id, foreign_key: false          # don't create a constraint (this is the default)
+    t.integer :author,    foreign_key: true           # create a foreign_key to table "authors"
+
+    t.integer :parent_id, foreign_key: true           # special column parent_id defaults to referencing its own table
+
+Specify the target table and its primary key using the `:references` and `:primary_key`:
+
+    t.integer :author_id, foreign_key: { references: :authors }        # the default
+    t.integer :author,    foreign_key: { references: :authors }        # the default
+    t.integer :author_id, foreign_key: { references: :people }         # choose table name
+    t.integer :author_id, foreign_key: { primary_key: :ssn] }          # choose primary key
+    t.integer :author_id, foreign_key: { references: :people, primary_key: :ssn] } # choose both
+    t.integer :author_id, foreign_key: { references: [:people, :ssn] } # shortcut for both
+    t.integer :author_id, foreign_key: { references: nil }             # same as foreign_key: false
+
+You can also specify other attributes:
+
+    t.integer :author_id, foreign_key: { name: "my_fk" }               # override default auto-generated constraint name
+    t.integer :author_id, foreign_key: { on_delete: :cascade }
+    t.integer :author_id, foreign_key: { on_update: :set_null }
+    t.integer :author_id, foreign_key: { deferrable: true }
+    t.integer :author_id, foreign_key: { deferrable: :initially_deferred }
+
+Of course the options can be combined:
+
+    t.integer :author_id, foreign_key: { references: :people, primary_key: :ssn, name: "my_fk", on_delet: :no_action }
+
+
+As a shorthand, all options except `:name` can be specified without placing
+them in a `foreign_key` hash, e.g.
+
+    t.integer :author_id, on_delete: :cascade  # shorthand for foreign_key: { on_delete: :cascade }
+    t.integer :author_id, references: :people  # shorthand for foreign_key: { references: :people }
+
+To remove a foreign key constraint, you can either change the column, specifying `foreign_key: false`, or use `migration.remove_foreign_key(table, column)`
+
+### Introspection
+
+To examine the foreign keys on a model, you can use:
+
+    Model.foreign_keys            # foreign key constraints from this model to another
+    Model.reverse_foreign_keys    # foreign key constraints from other models to this
+
+(These results are cached along with other column-specific information; if you change the table definition, call `Model.reset_column_information` to clear the cache)
+
+You can also query at the connection level (uncached):
+
+    connection.foreign_keys(table_name)
+    connection.reverse_foreign_keys(table_name)
+
+These calls all return an array of ForeignKeyDefinition objects, which support these methods:
+
+    fk.from_table
+    fk.column
+    fk.to_table
+    fk.primary_key
+    fk.on_update
+    fk.on_delete
+    fk.deferrable
+
+### Configuring Defaults
+
+If you don't specify `on_update` and `on_delete` when creating a foreign key
+constraint, they normally default to whatever the DBMS's default behavior is.
+
+But you can also configure a global default (e.g. in a Rails initializer):
+
+```ruby
+SchemaPlus::ForeignKey.setup do |config|
+    config.on_update = :cascade   # default is nil, meaning use default dbms behavior
+    config.on_delete = :nullify   # default is nil, meaning use default dbms behavior
+end
+```
+
+Or you can configure a per-table default in a migration:
+
+```ruby
+create_table :things, foreign_key: { on_update: :set_null } do |t|
+    ...
+end
+```
+
+### SQLite 3 Notes
+
+SchemaPlus::ForeignKeys supports foreign key constraints in SQLite3. 
+
+However note that SQLite3 requires you to declare the constraints as part of
+the table definition, and does not allow you to add, remove, or change
+constraints after the fact.  Thus you'll get an exception if you try
+`add_foreign_key`, `remove_foreign_key`, or `change_column` changing the
+foreign key options.
+
+
+### Schema Dump
+
+For clarity (and because it's required for SQLite3), in the generated `schema_dump.rb` file, the foreign key definitions are inluded within the table definitions.
+
+This means that the tables are output sorted that a table is
+defined before others that depend on it.  If, however, there are circularities in the
+foreign key relations, this won't be possible; In that case some table definitions will include comments indicating a "forward reference" to a table that's farther down in the file, and the constraint will be defined once that table is defined (this can never happen with SQLite3).
+
+
+## Compatibility
+
+SchemaPlus::ForeignKeys 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 -->
+
+## History
+
+* 0.1.0 - Initial release, brought over from schema_plus 1.x via 2.0.0.pre*
+
+## Development & Testing
+
+Are you interested in contributing to SchemaPlus::ForeignKeys?  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**:  SchemaPlus::ForeignKeys 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_plus_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_PLUS_CORE - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_plus_core**: SchemaPlus::ForeignKeys uses the SchemaPlus::Core API that
+  provides middleware callback stacks to make it easy to extend
+  ActiveRecord's behavior.  If that API is missing something you need for
+  your contribution, please head over to
+  [schema_plus_core](https://github.com/SchemaPlus/schema_plus_core) and open
+  an issue or pull request.
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_PLUS_CORE - end -->
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_monkey**: SchemaPlus::ForeignKeys 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_plus/foreign_keys.rb

@@ -0,0 +1,78 @@
+require 'schema_plus/core'
+require 'valuable'
+
+require_relative 'foreign_keys/version'
+require_relative 'foreign_keys/active_record/base'
+require_relative 'foreign_keys/active_record/connection_adapters/abstract_adapter'
+require_relative 'foreign_keys/active_record/connection_adapters/table_definition'
+require_relative 'foreign_keys/active_record/connection_adapters/foreign_key_definition'
+require_relative 'foreign_keys/active_record/migration/command_recorder'
+require_relative 'foreign_keys/middleware/dumper'
+require_relative 'foreign_keys/middleware/migration'
+require_relative 'foreign_keys/middleware/model'
+require_relative 'foreign_keys/middleware/mysql'
+require_relative 'foreign_keys/middleware/sql'
+
+module SchemaPlus::ForeignKeys
+  module ActiveRecord
+    module ConnectionAdapters
+      autoload :Mysql2Adapter, 'schema_plus/foreign_keys/active_record/connection_adapters/mysql2_adapter'
+      autoload :PostgresqlAdapter, 'schema_plus/foreign_keys/active_record/connection_adapters/postgresql_adapter'
+      autoload :Sqlite3Adapter, 'schema_plus/foreign_keys/active_record/connection_adapters/sqlite3_adapter'
+    end
+  end
+
+  # This global configuation options for SchemaPlus::ForeignKeys.
+  # Set them in +config/initializers/schema_plus_foreign_keys.rb+ using:
+  #
+  #    SchemaPlus::ForeignKeys.setup do |config|
+  #       ...
+  #    end
+  #
+  class Config < Valuable
+
+
+    ##
+    # :attr_accessor: on_update
+    #
+    # The default value for +:on_update+ when creating foreign key
+    # constraints for columns.  Valid values are as described in
+    # ForeignKeyDefinition, or +nil+ to let the database connection use
+    # its own default.  Default is +nil+.
+    has_value :on_update
+
+    ##
+    # :attr_accessor: on_delete
+    #
+    # The default value for +:on_delete+ when creating foreign key
+    # constraints for columns.  Valid values are as described in
+    # ForeignKeyDefinition, or +nil+ to let the database connection use
+    # its own default.  Default is +nil+.
+    has_value :on_delete
+
+    def merge(opts)
+      dup.update_attributes(opts)
+    end
+  end
+
+
+  # Returns the global configuration, i.e., the singleton instance of Config
+  def self.config
+    @config ||= Config.new
+  end
+
+  # Initialization block is passed a global Config instance that can be
+  # used to configure SchemaPlus::ForeignKeys behavior.  E.g., put
+  # something like the following in config/initializers/schema_plus_foreign_keys.rb :
+  #
+  #    SchemaPlus::ForeignKeys.setup do |config|
+  #       config.on_update = :cascade
+  #    end
+  #
+  def self.setup # :yields: config
+    yield config
+  end
+
+end
+
+SchemaMonkey.register SchemaPlus::ForeignKeys