declare_schema 1.4.0.colin.5 → 1.4.0.colin.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 770c10f063190aa951ca0ab0956c1988876e9a60c235e08ac9013d6a2f55dc3d
-  data.tar.gz: e0935d656bc3dd48e21c41edfbfbaf8fa416dee00bac305fcaa8b08a85bc0c02
+  metadata.gz: 0f8226540260a887af839da5afcb4641217c03ac5a6eb2d7a00da2806188f1ce
+  data.tar.gz: 7eeb464b5bfc9b1fbf88446696ede88b8ea582060658421cf2772e62a6205797
 SHA512:
-  metadata.gz: d8e261efe79f5b6fdbb86f1fec4a81445e65baf664d26dd6db2c3e85d2d94c305967a4e0f9f5dcce0106daab83480975034dd20c47a319b9365a60b031ec7d49
-  data.tar.gz: 22da299dd84f766df2668d4a81f86d3398be03cab012ac098fc1d7d1fab10d65e6ecc0b3fec126ff7c4b57ee18df6c5cab0219fc681b146891f98c06131e3f74
+  metadata.gz: 2294e94f2165ec156807fbf9ba98dea10f191bfda1b4c630f5444ab08ee7f80323e86a9af80e968e20e579e21ba24ddef520312a7f0a146d850b6f8927aa50aa
+  data.tar.gz: 2742ce98af1fb6ef8eb4ba1fa40563a635abb584cc1860efd373a474c6dce9fc1a27b630141f94ea6a23f36602d8381b08d6a33b13b6fd3d352b40df85f37daf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.4.0.colin.5)
+    declare_schema (1.4.0.colin.7)
       rails (>= 5.0)
 
 GEM

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -7,7 +7,7 @@ module DeclareSchema
     class ForeignKeyDefinition
       include Comparable
 
-      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :parent_table_name, :child_table_name, :options, :on_delete_cascade
+      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :child_table_name, :options, :on_delete_cascade
 
 
       def initialize(model, foreign_key, **options)
@@ -19,6 +19,17 @@ module DeclareSchema
         @parent_table_name = options[:parent_table]&.to_s
         @foreign_key_name = options[:foreign_key]&.to_s || @foreign_key
 
+        @parent_class_name =
+          case class_name = options[:class_name]
+          when String, Symbol
+            class_name.to_s
+          when Class
+            @parent_class = class_name
+            @parent_class.name
+          when nil
+            @foreign_key.sub(/_id\z/, '').camelize
+          end
+
         @constraint_name = options[:constraint_name]&.to_s.presence ||
                              model.connection.index_name(model.table_name, column: @foreign_key_name)
         @on_delete_cascade = options[:dependent] == :delete
@@ -44,21 +55,13 @@ module DeclareSchema
       end
 
       # returns the parent class as a Class object
-      # or nil if no :class_name option given
+      # lazy loaded so that we don't require the parent class until we need it
       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
+        @parent_class ||= @parent_class_name.constantize
       end
 
       def parent_table_name
-        @parent_table_name ||=
-          parent_class&.try(:table_name) ||
-            foreign_key.sub(/_id\z/, '').camelize.constantize.table_name
+        @parent_table_name ||= parent_class.table_name
       end
 
       def <=>(rhs)
@@ -67,14 +70,14 @@ module DeclareSchema
 
       alias eql? ==
 
+      def hash
+        key.hash
+      end
+
       private
 
       def key
-        @key ||= [@child_table_name, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
-      end
-
-      def hash
-        key.hash
+        @key ||= [@child_table_name, @parent_class_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
       end
     end
   end

data/lib/declare_schema/model.rb

@@ -57,11 +57,8 @@ module DeclareSchema
         index(fields.flatten, unique: true, name: ::DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME)
       end
 
-      def constraint(fkey, **options)
-        fkey_s = fkey.to_s
-        unless constraint_specs.any? { |constraint_spec| constraint_spec.foreign_key == fkey_s }
-          constraint_specs << DeclareSchema::Model::ForeignKeyDefinition.new(self, fkey, **options)
-        end
+      def constraint(foreign_key, **options)
+        constraint_specs << DeclareSchema::Model::ForeignKeyDefinition.new(self, foreign_key.to_s, **options)
       end
 
       # tell the migration generator to ignore the named index. Useful for existing indexes, or for indexes
@@ -152,9 +149,9 @@ module DeclareSchema
 
         super
 
-        refl = reflections[name.to_s] or raise "Couldn't find reflection #{name} in #{reflections.keys}"
-        fkey = refl.foreign_key or raise "Couldn't find foreign_key for #{name} in #{refl.inspect}"
-        fkey_id_column_options = column_options.dup
+        reflection = reflections[name.to_s] or raise "Couldn't find reflection #{name} in #{reflections.keys}"
+        foreign_key = reflection.foreign_key or raise "Couldn't find foreign_key for #{name} in #{reflection.inspect}"
+        foreign_key_id_column_options = column_options.dup
 
         # Note: the foreign key limit: should match the primary key limit:. (If there is a foreign key constraint,
         # those limits _must_ match.) We'd like to call _infer_fk_limit and get the limit right from the PK.
@@ -165,31 +162,31 @@ module DeclareSchema
         # The one downside of this approach is that application code that asks the field_spec for the declared
         # foreign key limit: will always get 8 back even if this is a grandfathered foreign key that points to
         # a limit: 4 primary key. It seems unlikely that any application code would do this.
-        fkey_id_column_options[:pre_migration] = ->(field_spec) do
-          if (inferred_limit = _infer_fk_limit(fkey, refl))
+        foreign_key_id_column_options[:pre_migration] = ->(field_spec) do
+          if (inferred_limit = _infer_fk_limit(foreign_key, reflection))
             field_spec.sql_options[:limit] = inferred_limit
           end
         end
 
-        declare_field(fkey.to_sym, :bigint, **fkey_id_column_options)
+        declare_field(foreign_key.to_sym, :bigint, **foreign_key_id_column_options)
 
-        if refl.options[:polymorphic]
+        if reflection.options[:polymorphic]
           foreign_type = options[:foreign_type] || "#{name}_type"
           _declare_polymorphic_type_field(foreign_type, column_options)
-          index([foreign_type, fkey], **index_options) if index_options
+          index([foreign_type, foreign_key], **index_options) if index_options
         else
-          index(fkey, **index_options) if index_options
-          constraint(fkey, **fk_options) if fk_options[:constraint_name] != false
+          index(foreign_key, **index_options) if index_options
+          constraint(foreign_key, **fk_options) if fk_options[:constraint_name] != false
         end
       end
 
-      def _infer_fk_limit(fkey, refl)
-        if refl.options[:polymorphic]
-          if (fkey_column = columns_hash[fkey.to_s]) && fkey_column.type == :integer
-            fkey_column.limit
+      def _infer_fk_limit(foreign_key, reflection)
+        if reflection.options[:polymorphic]
+          if (foreign_key_column = columns_hash[foreign_key.to_s]) && foreign_key_column.type == :integer
+            foreign_key_column.limit
           end
         else
-          klass = refl.klass or raise "Couldn't find belongs_to klass for #{name} in #{refl.inspect}"
+          klass = reflection.klass or raise "Couldn't find belongs_to klass for #{name} in #{reflection.inspect}"
           if (pk_id_type = klass._table_options&.[](:id))
             if pk_id_type == :integer
               4
@@ -320,11 +317,11 @@ module DeclareSchema
         end
 
         attr_types[name] ||
-          if (refl = reflections[name.to_s])
-            if refl.macro.in?([:has_one, :belongs_to]) && !refl.options[:polymorphic]
-              refl.klass
+          if (reflection = reflections[name.to_s])
+            if reflection.macro.in?([:has_one, :belongs_to]) && !reflection.options[:polymorphic]
+              reflection.klass
             else
-              refl
+              reflection
             end
           end ||
           if (col = _column(name.to_s))

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "1.4.0.colin.5"
+  VERSION = "1.4.0.colin.7"
 end

data/lib/generators/declare_schema/migration/migrator.rb

@@ -426,7 +426,7 @@ module Generators
 
           new_table_name = model.table_name
           existing_indexes = ::DeclareSchema::Model::IndexDefinition.for_model(model, old_table_name)
-          model_indexes_with_equivalents = model.index_definitions_with_primary_key
+          model_indexes_with_equivalents = model.index_definitions_with_primary_key.to_a
           model_indexes = model_indexes_with_equivalents.map do |i|
             if i.explicit_name.nil?
               if (existing = existing_indexes.find { |e| i != e && e.equivalent?(i) })
@@ -486,7 +486,7 @@ module Generators
           ::DeclareSchema.default_generate_foreign_keys or return []
 
           existing_fks = ::DeclareSchema::Model::ForeignKeyDefinition.for_model(model, old_table_name)
-          model_fks = model.constraint_specs
+          model_fks = model.constraint_specs.to_a
 
           fks_to_drop = existing_fks - model_fks
           fks_to_add = model_fks - existing_fks

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

@@ -60,6 +60,24 @@ RSpec.describe DeclareSchema::Model::ForeignKeyDefinition do
           end
         end
 
+        describe `#<=>` do
+          context 'when class name not passed' do
+            let(:options) { { foreign_key: :the_network_id, constraint_name: :constraint_1, dependent: :delete } }
+
+            it 'compares equal without requring the parent class' do
+              expect(subject <=> subject).to eq(0)
+            end
+          end
+
+          context 'when class name passed' do
+            let(:options) { { foreign_key: :the_network_id, class_name: 'TheNetwork', constraint_name: :constraint_1 } }
+
+            it 'compares equal without requring the parent class' do
+              expect(subject <=> subject).to eq(0)
+            end
+          end
+        end
+
         context 'when constraint name passed as empty string' do
           let(:options) { { constraint_name: "" } }
           it 'defaults to rails constraint name' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.4.0.colin.5
+  version: 1.4.0.colin.7
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails