schema_plus_core 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a59aa0134494234f7d1601e3f5c764035c00969
-  data.tar.gz: d8af7c134c42e18f69f749d31bc3b9908179736e
+  metadata.gz: 6c31ad40eecda53151aef2e6b0faac2a6f99385e
+  data.tar.gz: eb7b4fa4146a8d2b6746391564b011f77f366b9a
 SHA512:
-  metadata.gz: 07bb287598da65c41da7c50e7a0ae7711e45653012cebcb9e8bf69f66c4c9e96ff363ef6ebdbe0cfd8965d927b518aa2cefc84a2168f8f11ca847ae2cb653a31
-  data.tar.gz: d0834cc8c8da80f8aa19395c5a25f06c6eee457bb0aabdde90d957fad0fad5879bf7d88d9925a716e1e826df3d4457f296fbba9af1530d9504e91a4440dacaba
+  metadata.gz: 90aad35397d7224e1ea32e712f27f4c1597b562245e9b6cdddb7d15add80e772d61bfbdfb7584b41e63192794ee110c354798cc119237870ac3dd3972bcf42dd
+  data.tar.gz: 2fbdbb53cd67cf6830caba374d039c7e4e1419cb1986008005f04363566ad794b47146d8aa86c139454b4177c69e611680fff25d5678245d6fc5646b8a5b82a2

data/README.md

@@ -192,6 +192,7 @@ Stacks for operations that change the schema.  In some cases the operation immed
     `:table_name` | The name of the table | *arg*
     `:column_name` | The name of the column | *arg*
     `:type`       | The ActiveRecord column type (`:integer`, `:datetime`, etc.) | *arg*
+    `:implements_reference` | This implements a `migration.add_reference`, `t.references` or `t.belongs_to` [See below]| *context*
     `:options`    | The column options | *arg*, default `{}`
 
   The base implementation performs the column operation.  No value is returned.
@@ -207,7 +208,9 @@ Stacks for operations that change the schema.  In some cases the operation immed
 
   2. In the case of a table definition using `t.references` or `t.belongs_to`, the `:type` field will be set to `:reference` and the `:column_name` will include the `"_id"` suffix
 
-  3. ActiveRecord's base implementation may make nested calls to column creation.  For example: References result in a nested call to create an integer column; Polymorphic references nest calls to create two columns; Sqlite3 implements `:change` by a nested call to a new table definition.  SchemaPlus::Core doesn't attempt to normalize or suppress these; each such nested call will result in its own `Migration::Column` stack execution.
+  3. ActiveRecord's base implementation handles `migration.add_reference`, `t.references` and `t.belongs_to` by making nested calls to `migration.add_column` or `t.column` to create the resulting column (or two columns, for polymorphic references).  SchemaPlus::Core invokes the `Migration::Column` stack for both the outer `migration.add_reference`, `t.references` or `t.belongs_to` call, as well as for the nested `migration.add_column` or `t.column` call; in the nested call, `env.implements_reference` will be truthy.
+
+  4. Sqlite3 implements `change_column` by a creating a new table. This will result in nested calls to `add_column`, invoking the `Migration::Column` stack for each; SchemaPlus::Core does not currently provide a way to distinguish those calls from explicit top-level calls.
 
 * `Migration::CreateTable`
 
@@ -435,6 +438,7 @@ SchemaPlus::Core provides a state object and of callbacks to various phases of t
 
 ## History
 
+* 0.4.0 Add `implements_reference` to `Migration::Column` stack env
 * 0.3.1 Pass along (undocumented) return values from association declarations
 * 0.3.0 Added `Model::Association::Declaration`
 * 0.2.1 Added `Migration::CreateTable` and `Schema::Define`; removed dependency on (defunct) `schema_monkey_rails` gem.  [Oops, this should have been a minor version bump]

data/lib/schema_plus/core/active_record/connection_adapters/abstract_adapter.rb

@@ -5,7 +5,8 @@ module SchemaPlus
         module AbstractAdapter
 
           def add_column(table_name, name, type, options = {})
-            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :add, table_name: table_name, column_name: name, type: type, options: options.deep_dup) do |env|
+            options = options.deep_dup
+            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :add, table_name: table_name, column_name: name, type: type, implements_reference: options.delete(:_implements_reference), options: options) do |env|
               super env.table_name, env.column_name, env.type, env.options
             end
           end
@@ -18,7 +19,7 @@ module SchemaPlus
 
           def add_reference(table_name, name, options = {})
             SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :add, table_name: table_name, column_name: "#{name}_id", type: :reference, options: options.deep_dup) do |env|
-              super env.table_name, env.column_name.sub(/_id$/, ''), env.options
+              super env.table_name, env.column_name.sub(/_id$/, ''), env.options.merge(_implements_reference: true)
             end
           end
 

data/lib/schema_plus/core/active_record/connection_adapters/table_definition.rb

@@ -5,20 +5,23 @@ module SchemaPlus
         module TableDefinition
 
           def column(name, type, options = {})
-            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: name, type: type, options: options.deep_dup) do |env|
+            options = options.deep_dup
+            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: name, type: type, implements_reference: options.delete(:_implements_reference), options: options) do |env|
               super env.column_name, env.type, env.options
             end
           end
 
           def references(name, options = {})
-            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: "#{name}_id", type: :reference, options: options.deep_dup) do |env|
-              super env.column_name.sub(/_id$/, ''), env.options
+            options = options.deep_dup
+            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: "#{name}_id", type: :reference, options: options) do |env|
+              super env.column_name.sub(/_id$/, ''), env.options.merge(_implements_reference: true)
             end
           end
 
           def belongs_to(name, options = {})
-            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: "#{name}_id", type: :reference, options: options.deep_dup) do |env|
-              super env.column_name.sub(/_id$/, ''), env.options
+            options = options.deep_dup
+            SchemaMonkey::Middleware::Migration::Column.start(caller: self, operation: :define, table_name: self.name, column_name: "#{name}_id", type: :reference, options: options) do |env|
+              super env.column_name.sub(/_id$/, ''), env.options.merge(_implements_reference: true)
             end
           end
 

data/lib/schema_plus/core/middleware.rb

@@ -26,7 +26,7 @@ module SchemaPlus
 
       module Migration
         module Column
-          ENV = [:caller, :operation, :table_name, :column_name, :type, :options]
+          ENV = [:caller, :operation, :table_name, :column_name, :type, :implements_reference, :options]
         end
 
         module CreateTable

data/lib/schema_plus/core/version.rb

@@ -1,5 +1,5 @@
 module SchemaPlus
   module Core
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/spec/column_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+module TestImplementsReference
+  module Middleware
+    module Migration
+      module Column
+        SPY = []
+
+        include Enableable
+
+        def before(env)
+          return unless middleware = enabled_middleware(TestImplementsReference, env)
+          SPY << env.to_hash.slice(:column_name, :type, :implements_reference)
+        end
+      end
+    end
+  end
+end
+
+SchemaMonkey.register TestImplementsReference
+
+describe SchemaMonkey::Middleware::Migration::Column do
+
+  let(:migration) { ::ActiveRecord::Migration }
+
+  context TestImplementsReference::Middleware::Migration::Column do
+    let (:spy) { described_class.const_get(:SPY) }
+
+    around(:each) do |example|
+      middleware = described_class
+      begin
+        spy.clear
+        middleware.enable once: false
+        example.run
+      ensure
+        middleware.disable
+      end
+    end
+
+    context "when add ordinary column" do
+      When { migration.create_table("things") { |t| t.integer "test_column" } }
+      Then { expect(spy).to eq [
+        { column_name: "id", type: :primary_key, implements_reference: nil },
+        { column_name: "test_column", type: :integer, implements_reference: nil }
+      ] }
+    end
+
+    [:references, :belongs_to].each do |method|
+
+      context "when add reference using t.#{method}" do
+        When { migration.create_table("things") { |t| t.send method, "test_reference" } }
+        Then { expect(spy).to eq [
+          { column_name: "id", type: :primary_key, implements_reference: nil },
+          { column_name: "test_reference_id", type: :reference, implements_reference: nil },
+          { column_name: "test_reference_id", type: :integer, implements_reference: true }
+        ] }
+      end
+
+      context "when add polymorphic reference using t.#{method}" do
+        When { migration.create_table("things") { |t| t.send method, "test_reference", polymorphic: true } }
+        Then { expect(spy).to eq [
+          { column_name: "id", type: :primary_key, implements_reference: nil },
+          { column_name: "test_reference_id", type: :reference, implements_reference: nil },
+          { column_name: "test_reference_id", type: :integer, implements_reference: true },
+          { column_name: "test_reference_type", type: :string, implements_reference: true }
+        ] }
+      end
+    end
+
+    context "with an existing table" do
+      Given {
+        migration.create_table("things") { |t| }
+        spy.clear
+      }
+
+      context "when add reference using migration.add_reference" do
+
+        When { migration.add_reference("things", "test_reference") }
+        Then { expect(spy).to eq [
+          { column_name: "test_reference_id", type: :reference, implements_reference: nil },
+          { column_name: "test_reference_id", type: :integer, implements_reference: true }
+        ] }
+      end
+
+      context "when add polymorphic reference using migration.add_reference" do
+
+        When {
+          migration.add_reference("things", "test_reference", polymorphic: true)
+        }
+        Then { expect(spy).to eq [
+          { column_name: "test_reference_id", type: :reference, implements_reference: nil },
+          { column_name: "test_reference_id", type: :integer, implements_reference: true },
+          { column_name: "test_reference_type", type: :string, implements_reference: true }
+        ] }
+      end
+
+    end
+
+  end
+end

data/spec/support/enableable.rb

@@ -3,14 +3,15 @@ module Enableable
   def enabled_middleware(root, env)
     middleware = self.singleton_class.ancestors.find(&it.to_s.start_with?("#{root}::Middleware"))
     return nil unless middleware.enabled?(env)
-    middleware.disable
+    middleware.disable if middleware.once?(env)
     middleware
   end
 
   def self.included(base)
     base.module_eval do
-      def self.enable(condition = true)
+      def self.enable(condition = true, once:true)
         @enabled = condition
+        @once = once
       end
       def self.enabled?(env)
         case @enabled
@@ -18,6 +19,9 @@ module Enableable
         else @enabled
         end
       end
+      def self.once?(env)
+        @once
+      end
       def self.disable
         @enabled = false
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_core
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-26 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -172,6 +172,7 @@ files:
 - lib/schema_plus/core/version.rb
 - schema_dev.yml
 - schema_plus_core.gemspec
+- spec/column_spec.rb
 - spec/dumper_spec.rb
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
@@ -204,6 +205,7 @@ signing_key:
 specification_version: 4
 summary: Provides an internal extension API to ActiveRecord
 test_files:
+- spec/column_spec.rb
 - spec/dumper_spec.rb
 - spec/middleware_spec.rb
 - spec/spec_helper.rb