declare_schema 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a2f9216c43a3ba2d669d966a4f645edb0faa78a6697cb2a008f017bab2d7534
-  data.tar.gz: 3223fad1929f4d75c41e12d8cabd20b6a95775308edf4e4e078b8dcd34ec54cc
+  metadata.gz: 523660550181d173c4ff4d6dc181b6d790419a3fdfb1e956076eed2d4c9f7f3b
+  data.tar.gz: '0380d2f800fd64c770c87631090ee792875034211b6ba9d18f5acc34e5ba9f0b'
 SHA512:
-  metadata.gz: 45318951ec1e963d3eea783def6ee7d9828cdf1826e14ae5977c48cd7f1599bb04712ef95899750ed40a21cccfdd0789b24c993e080d898a10e689c7a9618072
-  data.tar.gz: eb1cf73bb3628ea498785b74b4d78029cd2858de1286657ca3f625181100c9daddfd1cb21c7c079f1518ee388e7112e30923ead79dd6e4d6333ee562f2daa2e2
+  metadata.gz: 824d98b6bb3b30d0eebf594db7cead5e954fed227eefdb8f627811da3a7f8c9bc76f62552c3c3a87b0ff3adf51a95a1e666e903d6993430aaa3521607b6ee260
+  data.tar.gz: e8b45fb7dd6df1b314b3ada7e3da6223c631911ce88233165dff486ddb0bfc4a09e42255c018e7d00a456f95d0c1a8af010fe5531f6c2d64516cf3a09f51eb19

data/CHANGELOG.md

@@ -4,7 +4,11 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.6.3] - UNRELEASED
+## [0.6.4] - 2020-02-08
+- Fixed a bug where the generated call to add_foreign_key() was not setting `column:`,
+  so it only worked in cases where Rails could infer the foreign key by convention.
+
+## [0.6.3] - 2020-01-21
 ### Added
 - Added `add_foreign_key` native rails call in `DeclareSchema::Model::ForeignKeyDefinition#to_add_statement`.
 
@@ -12,7 +16,7 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 - Fixed a bug in migration generation caused by `DeclareSchema::Migration#create_constraints`
   calling `DeclareSchema::Model::ForeignKeyDefinition#to_add_statement` with unused parameters.
  
- - Fixed a bug in `DeclareSchema::Migration#remove_foreign_key` where special characters would not be quoted properly.
+- Fixed a bug in `DeclareSchema::Migration#remove_foreign_key` where special characters would not be quoted properly.
 
 ## [0.6.2] - 2021-01-06
 ### Added
@@ -110,6 +114,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.6.4]: https://github.com/Invoca/declare_schema/compare/v0.6.3...v0.6.4
 [0.6.3]: https://github.com/Invoca/declare_schema/compare/v0.6.2...v0.6.3
 [0.6.2]: https://github.com/Invoca/declare_schema/compare/v0.6.1...v0.6.2
 [0.6.1]: https://github.com/Invoca/declare_schema/compare/v0.6.0...v0.6.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.6.3)
+    declare_schema (0.6.4)
       rails (>= 4.2)
 
 GEM

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -5,21 +5,21 @@ module DeclareSchema
     class ForeignKeyDefinition
       include Comparable
 
-      attr_reader :constraint_name, :model, :foreign_key, :options, :on_delete_cascade
+      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :options, :on_delete_cascade
 
       def initialize(model, foreign_key, options = {})
         @model = model
-        @foreign_key = foreign_key.presence
+        @foreign_key = foreign_key.to_s.presence
         @options = options
 
         @child_table = model.table_name # unless a table rename, which would happen when a class is renamed??
-        @parent_table_name = options[:parent_table]
-        @foreign_key_name = options[:foreign_key] || self.foreign_key
-        @index_name = options[:index_name] || model.connection.index_name(model.table_name, column: foreign_key)
-        @constraint_name = options[:constraint_name] || @index_name || ''
-        @on_delete_cascade = options[:dependent] == :delete
+        @parent_table_name = options[:parent_table]&.to_s
+        @foreign_key_name = options[:foreign_key]&.to_s || @foreign_key
+        @index_name = options[:index_name]&.to_s || model.connection.index_name(model.table_name, column: @foreign_key_name)
 
         # Empty constraint lets mysql generate the name
+        @constraint_name = options[:constraint_name]&.to_s || @index_name&.to_s || ''
+        @on_delete_cascade = options[:dependent] == :delete
       end
 
       class << self
@@ -28,11 +28,12 @@ module DeclareSchema
           constraints = show_create_table.split("\n").map { |line| line.strip if line['CONSTRAINT'] }.compact
 
           constraints.map do |fkc|
-            options = {}
             name, foreign_key, parent_table = fkc.match(/CONSTRAINT `([^`]*)` FOREIGN KEY \(`([^`]*)`\) REFERENCES `([^`]*)`/).captures
-            options[:constraint_name] = name
-            options[:parent_table] = parent_table
-            options[:foreign_key] = foreign_key
+            options = {
+              constraint_name: name,
+              parent_table:    parent_table,
+              foreign_key:     foreign_key
+            }
             options[:dependent] = :delete if fkc['ON DELETE CASCADE']
 
             new(model, foreign_key, options)
@@ -40,20 +41,37 @@ module DeclareSchema
         end
       end
 
+      # returns the parent class as a Class object
+      # or nil if no :class_name option given
+      def parent_class
+        if (class_name = options[:class_name])
+          if class_name.is_a?(Class)
+            class_name
+          else
+            class_name.to_s.constantize
+          end
+        end
+      end
+
       def parent_table_name
         @parent_table_name ||=
-          if (klass = options[:class_name])
-            klass = klass.to_s.constantize unless klass.is_a?(Class)
-            klass.try(:table_name)
-          end || foreign_key.sub(/_id\z/, '').camelize.constantize.table_name
+          parent_class&.try(:table_name) ||
+            foreign_key.sub(/_id\z/, '').camelize.constantize.table_name
       end
 
-      attr_writer :parent_table_name
-
       def to_add_statement
-        "add_foreign_key(#{@child_table.inspect}, #{parent_table_name.inspect}, name: #{@constraint_name.inspect})"
+        "add_foreign_key(#{@child_table.inspect}, #{parent_table_name.inspect}, " +
+          "column: #{@foreign_key_name.inspect}, name: #{@constraint_name.inspect})"
+      end
+
+      def <=>(rhs)
+        key <=> rhs.send(:key)
       end
 
+      alias eql? ==
+
+      private
+
       def key
         @key ||= [@child_table, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
       end
@@ -61,12 +79,6 @@ module DeclareSchema
       def hash
         key.hash
       end
-
-      def <=>(rhs)
-        key <=> rhs.key
-      end
-
-      alias eql? ==
     end
   end
 end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -369,7 +369,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'on_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :category_id
@@ -397,8 +397,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:c_id], name: 'on_c_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -417,8 +417,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       migrate_up(<<~EOS.strip)
         add_column :adverts, :category_id, :integer, limit: 8, null: false
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -439,8 +439,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -465,8 +465,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         add_column :adverts, :updated_at, :datetime
         add_column :adverts, :lock_version, :integer, null: false, default: 1
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :created_at
@@ -498,8 +498,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -519,8 +519,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -540,8 +540,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -559,8 +559,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -578,8 +578,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -597,8 +597,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -634,8 +634,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             "add_index :ads, [:id], unique: true, name: 'PRIMARY'\n"
           elsif defined?(Mysql2)
             "execute \"ALTER TABLE ads DROP PRIMARY KEY, ADD PRIMARY KEY (id)\"\n\n" +
-            "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_category_id\")\n" +
-            "add_foreign_key(\"adverts\", \"categories\", name: \"index_adverts_on_c_id\")"
+            "add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
+            "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")"
           end}
       EOS
       .and migrate_down(<<~EOS.strip)

data/spec/lib/declare_schema/model/foreign_key_definition_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative '../../../../lib/declare_schema/model/foreign_key_definition'
+
+RSpec.describe DeclareSchema::Model::ForeignKeyDefinition do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+
+    class Network < ActiveRecord::Base
+      fields do
+        name :string, limit: 127, index: true
+
+        timestamps
+      end
+    end
+  end
+
+  let(:model_class) { Network }
+
+  describe 'instance methods' do
+    let(:connection) { instance_double(ActiveRecord::Base.connection.class) }
+    let(:model) { instance_double('Model', table_name: 'models', connection: connection) }
+    let(:foreign_key) { :network_id }
+    let(:options) { {} }
+    subject { described_class.new(model, foreign_key, options)}
+
+    before do
+      allow(connection).to receive(:index_name).with('models', column: 'network_id') { 'on_network_id' }
+    end
+
+    describe '#initialize' do
+      it 'normalizes symbols to strings' do
+        expect(subject.foreign_key).to eq('network_id')
+        expect(subject.parent_table_name).to eq('networks')
+      end
+
+      context 'when most options passed' do
+        let(:options) { { parent_table: :networks, foreign_key: :the_network_id, index_name: :index_on_network_id } }
+
+        it 'normalizes symbols to strings' do
+          expect(subject.foreign_key).to eq('network_id')
+          expect(subject.foreign_key_name).to eq('the_network_id')
+          expect(subject.parent_table_name).to eq('networks')
+          expect(subject.foreign_key).to eq('network_id')
+          expect(subject.constraint_name).to eq('index_on_network_id')
+          expect(subject.on_delete_cascade).to be_falsey
+        end
+      end
+
+      context 'when all options passed' do
+        let(:foreign_key) { nil }
+        let(:options) { { parent_table: :networks, foreign_key: :the_network_id, index_name: :index_on_network_id,
+                          constraint_name: :constraint_1, dependent: :delete } }
+
+        it 'normalizes symbols to strings' do
+          expect(subject.foreign_key).to be_nil
+          expect(subject.foreign_key_name).to eq('the_network_id')
+          expect(subject.parent_table_name).to eq('networks')
+          expect(subject.constraint_name).to eq('constraint_1')
+          expect(subject.on_delete_cascade).to be_truthy
+        end
+      end
+    end
+
+    describe '#to_add_statement' do
+      it 'returns add_foreign_key command' do
+        expect(subject.to_add_statement).to eq('add_foreign_key("models", "networks", column: "network_id", name: "on_network_id")')
+      end
+    end
+  end
+
+  describe 'class << self' do
+    let(:connection) { instance_double(ActiveRecord::Base.connection.class) }
+    let(:model) { instance_double('Model', table_name: 'models', connection: connection) }
+    let(:old_table_name) { 'networks' }
+    before do
+      allow(connection).to receive(:quote_table_name).with('networks') { 'networks' }
+      allow(connection).to receive(:select_rows) { [['CONSTRAINT `constraint` FOREIGN KEY (`network_id`) REFERENCES `networks` (`id`)']] }
+      allow(connection).to receive(:index_name).with('models', column: 'network_id') { }
+    end
+
+    describe '.for_model' do
+      subject { described_class.for_model(model, old_table_name) }
+
+      it 'returns new object' do
+        expect(subject.size).to eq(1), subject.inspect
+        expect(subject.first).to be_kind_of(described_class)
+        expect(subject.first.foreign_key).to eq('network_id')
+      end
+    end
+  end
+  # TODO: fill out remaining tests
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,6 +82,7 @@ files:
 - spec/lib/declare_schema/generator_spec.rb
 - spec/lib/declare_schema/interactive_primary_key_spec.rb
 - spec/lib/declare_schema/migration_generator_spec.rb
+- spec/lib/declare_schema/model/foreign_key_definition_spec.rb
 - spec/lib/declare_schema/model/index_definition_spec.rb
 - spec/lib/declare_schema/model/table_options_definition_spec.rb
 - spec/lib/declare_schema/prepare_testapp.rb
@@ -93,7 +94,7 @@ homepage: https://github.com/Invoca/declare_schema
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Database schema declaration and migration generator for Rails
 test_files: []