schema_plus 2.0.0.pre15 → 2.0.0.pre16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33f3e9b7a9b9bd74e21216f8f7c309556a660709
-  data.tar.gz: 00277e248e33a72fbfd052aa2124704f11a25b1b
+  metadata.gz: c99278211ca16613b477d638db63506511855b55
+  data.tar.gz: 70bc7a4a0085cc04d381b2e013002d9516159174
 SHA512:
-  metadata.gz: 853671712bd6a18f8ca52dade7785d7a0450f6e4e5cd3e66f63c24e548a545f9e6feb1d308d75d79202e0d7c8ecc16971e50528d04b3c4995d6a1b687c10dd21
-  data.tar.gz: 3561d6d3cdd731354254895c81a9b800e1848164a8d47b85549c8e2a56fe56ad64518c8a091d4e1124bfa39273318a034147020fca80ceac6dba4724435d8fce
+  metadata.gz: abdc2561b776542283c32e85fb3ec6e37ae4a412114d45b268262a787777edfed250002f28906829294ad87f2ccf3104f783bb875539c78dada889bf3341856c
+  data.tar.gz: 9ff399f35e5a5efb6c2163912352355ab833769a6337b8105cebdcae05ca53849ae67e4c2a78fc533a9e123dd607d9d266f8b0772889454fb9f2d9be93496a23

data/README.md

@@ -15,7 +15,7 @@ Gem | Description | Included In `schema_plus` gem?
 [schema_plus_db_default](https://github.com/SchemaPlus/schema_plus_db_default) | Use `ActiveRecord::DB_DEFAULT` to set an attribute to the database default | Y
 [schema_plus_default_expr](https://github.com/SchemaPlus/schema_plus_default_expr)  | Use SQL expressions for database default values | Y
 [schema_plus_enums](https://github.com/SchemaPlus/schema_plus_enums) | Define enum types in migrations | Y
-<p style="color:grey">schema_plus_foreign_keys | Extended support for foreign keys, including creation as column options, `:deferrable`, and SQLite3 support | Y
+[schema_plus_foreign_keys](https://github.com/SchemaPlus/schema_plus_foreign_keys) | Extended support for foreign keys, including creation as column options, `:deferrable`, and SQLite3 support | Y
 [schema_plus_indexes](https://github.com/SchemaPlus/schema_plus_indexes) | Convenience and consistency in using indexes | Y
 [schema_plus_pg_indexes](https://github.com/SchemaPlus/schema_plus_pg_indexes) |PostgreSQL index features: `case_insenstive`, `expression` and `operator_class` | Y
 [schema_plus_tables](https://github.com/SchemaPlus/schema_plus_tables) | Convenience and consistency in using tables | Y
@@ -35,7 +35,7 @@ See detailed documentation in each gem's README.
 [![Dependency Status](https://gemnasium.com/lomba/schema_plus.svg)](https://gemnasium.com/SchemaPlus/schema_plus)
 
 
-> ## This is the README for schema_plus 2.0.0.pre15
+> ## This is the README for schema_plus 2.0.0.pre16
 > which supports Rails >= 4.2.0.  This prerelease is completely usable. It's still officially a prerelease rather than formal release because some features have yet to be migrated into their own gems.
 >  
 > For info about the 1.x releases which support Rails 3.1, 4.0, 4.1, and 4.2.0, see the [schema_plus 1.x](https://github.com/SchemaPlus/schema_plus/tree/1.x) branch
@@ -120,13 +120,11 @@ or in a Gemfile
 # Prerelease:  Documentation of features still be moved into separate feature gems
 
 
-> **NOTE** The documentation in this README is leftover from the 1.x branch; the functionality is the same, but some of the core features of schema_plus (such as foreign keys) are now provided by ActiveRecord 4.2.  schema_plus still provides extra functionality beyond AR 4.2, but the documentation needs to be updated to be clear what's an enhancement of AR 4.2 capabilities rather than completely new features.
+### Auto Foreign Key Constraints
 
-### Foreign Key Constraints
-
-SchemaPlus adds support for foreign key constraints. In fact, for the common
-convention that you name a column with suffix `_id` to indicate that it's a
-foreign key, SchemaPlus automatically defines the appropriate constraint.
+SchemaPlus adds support for the common convention that you name a column
+with suffix `_id` to indicate that it's a foreign key, SchemaPlus
+automatically defines the appropriate constraint.
 
 SchemaPlus also creates foreign key constraints for rails' `t.references` or
 `t.belongs_to`, which take the singular of the referenced table name and
@@ -144,73 +142,3 @@ Here are some examples:
     t.integer :author,    foreign_key: true           # non-conventional column name needs to force creation, table name is assumed to be 'authors'
     t.integer :author_id, foreign_key: false          # don't create a constraint
 
-    t.integer :author_id, foreign_key: { references: :authors }        # same as automatic behavior
-    t.integer :author,    foreign_key: { reference: :authors}          # same default name
-    t.integer :author_id, foreign_key: { references: [:authors, :id] } # same as automatic behavior
-    t.integer :author_id, foreign_key: { references: :people }         # override table name
-    t.integer :author_id, foreign_key: { references: [:people, :ssn] } # override table name and key
-    t.integer :author_id, foreign_key: { references: nil }             # don't create a constraint
-    t.integer :author_id, foreign_key: { name: "my_fk" }               # override default 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, e.g.
-
-    t.integer :author_id, foreign_key: { name: "my_fk", on_delete: :no_action }
-
-As a shorthand, all options except `:name` can be specified without placing
-them in a hash, e.g.
-
-    t.integer :author_id, on_delete: :cascade
-    t.integer :author_id, references: nil
-
-The foreign key behavior can be configured globally (see Config) or per-table
-(see create_table).
-
-To examine your foreign key constraints, `connection.foreign_keys` returns a
-list of foreign key constraints defined for a given table, and
-`connection.reverse_foreign_keys` returns a list of foreign key constraints
-that reference a given table.  See doc at
-[SchemaPlus::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition](http://rubydoc.info/gems/schema_plus/SchemaPlus/ActiveRecord/ConnectionAdapters/ForeignKeyDefinition).
-
-#### Foreign Key Issues
-
-Foreign keys can cause issues for Rails utilities that delete or load data
-because referential integrity imposes a sequencing requirement that those
-utilities may not take into consideration.  Monkey-patching may be required
-to address some of these issues.  The Wiki article [Making yaml_db work with
-foreign key constraints in PostgreSQL](https://github.com/SchemaPlus/schema_plus/wiki/Making-yaml_db-work-with-foreign-key-constraints-in-PostgreSQL)
-has some information that may be of assistance in resolving these issues.
-
-### Tables
-
-SchemaPlus extends `create_table ... force: true` to use `:cascade`
-
-### Schema Dump and Load (schema.rb)
-
-When dumping `schema.rb`, SchemaPlus orders the views and tables in the schema
-dump alphabetically, but subject to the requirement that each table or view be
-defined before those that depend on it.  This allows all foreign key
-constraints to be defined within the scope of the table definition. (Unless
-there are cyclical dependencies, in which case some foreign keys constraints
-must be defined later.)
-
-Also, when dumping `schema.rb`, SchemaPlus dumps explicit foreign key
-definition statements rather than relying on the auto-creation behavior, for
-maximum clarity and for independence from global config.  And correspondingly,
-when loading a schema, i.e. with the context of `ActiveRecord::Schema.define`,
-SchemaPlus ensures that auto creation of foreign key constraints is turned off
-regardless of the global setting.  But if for some reason you are creating
-your schema.rb file by hand, and would like to take advantage of auto-creation
-of foreign key constraints, you can re-enable it:
-
-    ActiveRecord::Schema.define do
-        SchemaPlus::ForeignKeys.config.auto_create = true
-        SchemaPlus::ForeignKeys.config.auto_index = true
-
-        create_table ...etc...
-    end
-
-

data/lib/schema_plus.rb

@@ -7,6 +7,7 @@ require 'schema_plus/indexes'
 require 'schema_plus/tables'
 require 'schema_plus/views'
 require 'schema_plus_pg_indexes'
+require 'schema_plus/auto_foreign_keys'
 
 require_relative 'schema_plus/version'
 

data/lib/schema_plus/auto_foreign_keys.rb

@@ -0,0 +1,31 @@
+require 'schema_plus/foreign_keys'
+
+require_relative 'auto_foreign_keys/active_record/migration/command_recorder'
+require_relative 'auto_foreign_keys/middleware/migration'
+require_relative 'auto_foreign_keys/middleware/schema'
+
+module SchemaAutoForeignKeys
+  module ActiveRecord
+    module ConnectionAdapters
+      autoload :Sqlite3Adapter, 'schema_plus/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_plus/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_plus/auto_foreign_keys/active_record/migration/command_recorder.rb

@@ -0,0 +1,14 @@
+module SchemaAutoForeignKeys
+  module ActiveRecord
+    module Migration
+      module CommandRecorder
+
+        # overrides to add if_exists option
+        def invert_add_index(args)
+          table, columns, options = *args
+          [:remove_index, [table, (options||{}).merge(column: columns, if_exists: true)]]
+        end
+      end
+    end
+  end
+end

data/lib/schema_plus/auto_foreign_keys/middleware/migration.rb

@@ -0,0 +1,66 @@
+module SchemaAutoForeignKeys
+  module Middleware
+    module Migration
+
+      module Column
+
+        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
+
+        private
+
+        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)
+          SchemaAutoForeignKeys.auto_index_name(env.table_name, env.column_name)
+        end
+
+      end
+    end
+  end
+
+  def self.auto_index_name(from_table, column_name)
+    "fk__#{fixup_schema_name(from_table)}_#{Array.wrap(column_name).join('_and_')}"
+    # this should enforce a maximum length
+  end
+
+  def self.fixup_schema_name(table_name)
+    # replace . with _
+    table_name.to_s.gsub(/[.]/, '_')
+  end
+end

data/lib/schema_plus/{foreign_keys → auto_foreign_keys}/middleware/schema.rb

@@ -1,4 +1,4 @@
-module SchemaPlus::ForeignKeys
+module SchemaAutoForeignKeys
   module Middleware
     module Schema
       module Define

data/lib/schema_plus/version.rb

@@ -1,3 +1,3 @@
 module SchemaPlus
-  VERSION = "2.0.0.pre15"
+  VERSION = "2.0.0.pre16"
 end

data/schema_plus.gemspec

@@ -23,12 +23,13 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "activerecord", "~> 4.2"
   gem.add_dependency "valuable"
-  gem.add_dependency "schema_plus_core", "~> 0.2"
+  gem.add_dependency "schema_plus_core", "~> 0.4"
   gem.add_dependency "schema_monkey", "~> 2.1"
   gem.add_dependency "schema_plus_columns", "~> 0.1"
   gem.add_dependency "schema_plus_enums", "~> 0.1"
   gem.add_dependency "schema_plus_db_default", "~> 0.1"
   gem.add_dependency "schema_plus_default_expr", "~> 0.1"
+  gem.add_dependency "schema_plus_foreign_keys", "~> 0.1"
   gem.add_dependency "schema_plus_indexes", "~> 0.1", ">= 0.1.3"
   gem.add_dependency "schema_plus_pg_indexes", "~> 0.1", ">= 0.1.3"
   gem.add_dependency "schema_plus_tables", "~> 0.1"

data/spec/{schema_plus_foreign_keys → schema_auto_foreign_keys}/migration_spec.rb

@@ -102,6 +102,7 @@ describe ActiveRecord::Migration do
 
     it "should allow multiple foreign keys to be made" do
       recreate_table(@model) do |t|
+        t.integer :user_id, :references => :users
         t.integer :updater_id, :references => :users
       end
       expect(@model).to reference(:users, :id).on(:user_id)
@@ -715,7 +716,7 @@ describe ActiveRecord::Migration do
   end
 
 
-  context "when table is renamed" do
+  context "when table is renamed", :sqlite3 => :skip do
 
     before(:each) do
       @model = Comment
@@ -733,7 +734,7 @@ describe ActiveRecord::Migration do
       expect(index.name).to match(/^fk__newname_/)
     end
 
-    it "should rename foreign key constraints", :sqlite3 => :skip do
+    it "should rename foreign key constraints" do
       expect(ActiveRecord::Base.connection.foreign_keys(:newname).first.name).to match(/newname/)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre15
+  version: 2.0.0.pre16
 platform: ruby
 authors:
 - Ronen Barzel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: schema_monkey
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: schema_plus_foreign_keys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: schema_plus_indexes
   requirement: !ruby/object:Gem::Requirement
@@ -304,33 +318,20 @@ files:
 - gemfiles/activerecord-4.2.1/Gemfile.postgresql
 - gemfiles/activerecord-4.2.1/Gemfile.sqlite3
 - lib/schema_plus.rb
-- lib/schema_plus/foreign_keys.rb
-- lib/schema_plus/foreign_keys/active_record/base.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/abstract_adapter.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/foreign_key_definition.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/mysql2_adapter.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/postgresql_adapter.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/sqlite3_adapter.rb
-- lib/schema_plus/foreign_keys/active_record/connection_adapters/table_definition.rb
-- lib/schema_plus/foreign_keys/active_record/migration/command_recorder.rb
-- lib/schema_plus/foreign_keys/middleware/dumper.rb
-- lib/schema_plus/foreign_keys/middleware/migration.rb
-- lib/schema_plus/foreign_keys/middleware/model.rb
-- lib/schema_plus/foreign_keys/middleware/mysql.rb
-- lib/schema_plus/foreign_keys/middleware/schema.rb
-- lib/schema_plus/foreign_keys/middleware/sql.rb
-- lib/schema_plus/foreign_keys/version.rb
+- lib/schema_plus/auto_foreign_keys.rb
+- lib/schema_plus/auto_foreign_keys/active_record/connection_adapters/sqlite3_adapter.rb
+- lib/schema_plus/auto_foreign_keys/active_record/migration/command_recorder.rb
+- lib/schema_plus/auto_foreign_keys/middleware/migration.rb
+- lib/schema_plus/auto_foreign_keys/middleware/schema.rb
 - lib/schema_plus/version.rb
 - schema_dev.yml
 - schema_plus.gemspec
 - spec/schema/auto_schema.rb
 - spec/schema/core_schema.rb
-- spec/schema_plus_foreign_keys/foreign_key_definition_spec.rb
-- spec/schema_plus_foreign_keys/foreign_key_spec.rb
-- spec/schema_plus_foreign_keys/migration_spec.rb
-- spec/schema_plus_foreign_keys/named_schemas_spec.rb
-- spec/schema_plus_foreign_keys/schema_dumper_spec.rb
-- spec/schema_plus_foreign_keys/schema_spec.rb
+- spec/schema_auto_foreign_keys/foreign_key_spec.rb
+- spec/schema_auto_foreign_keys/migration_spec.rb
+- spec/schema_auto_foreign_keys/schema_dumper_spec.rb
+- spec/schema_auto_foreign_keys/schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/matchers/automatic_foreign_key_matchers.rb
@@ -364,12 +365,10 @@ summary: Enhances ActiveRecord schema mechanism, including more DRY index creati
 test_files:
 - spec/schema/auto_schema.rb
 - spec/schema/core_schema.rb
-- spec/schema_plus_foreign_keys/foreign_key_definition_spec.rb
-- spec/schema_plus_foreign_keys/foreign_key_spec.rb
-- spec/schema_plus_foreign_keys/migration_spec.rb
-- spec/schema_plus_foreign_keys/named_schemas_spec.rb
-- spec/schema_plus_foreign_keys/schema_dumper_spec.rb
-- spec/schema_plus_foreign_keys/schema_spec.rb
+- spec/schema_auto_foreign_keys/foreign_key_spec.rb
+- spec/schema_auto_foreign_keys/migration_spec.rb
+- spec/schema_auto_foreign_keys/schema_dumper_spec.rb
+- spec/schema_auto_foreign_keys/schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/matchers/automatic_foreign_key_matchers.rb