strict_associations 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e631cb0e94a7fd616afc1c62fd686625008b0f30916a6f45a3614038e4a460
-  data.tar.gz: a229561f5c4b1a54abf6433e54cfa1e13ec0480cd2274906fef3f5c52aa85049
+  metadata.gz: 413a5326728f775abc9050baf64f35ab7f0f90d88ebb32627d360ade8156fb3e
+  data.tar.gz: e2eb32329274995e220142c30c9c7055d2f6a675849b3df7d7680cddd17f8537
 SHA512:
-  metadata.gz: 57336b91485f245790e47e8e6afe1974024f308b747c628b7eb370640e30873e2f190c196974f182dede3591fbcec43e2ba3fec03cb1536b9a1ad600cf6cc32e
-  data.tar.gz: 24dadd9079a717411b2a76a7df76c2bf056140ab13d662e6879e4de7b3b070100ffeef25669e1ba65526f51cfe5e28b741654efd01db2561bbe7a12944b9936c
+  metadata.gz: e9aa8d31880309f3338f40dff593f768b6fee510e47a160e2a0a28f76c1cf949182f2e340cc8ef9a2ca40b70b812380e74386a5623e0489425406a0f0295b85e
+  data.tar.gz: b558d3374c0b552323b73c47b5b34c2e37a873e8f0999d6fbd0687982e481854718322774b94f8444fad58ba724de899c16a784209ff07a936c3cac0e8595d29

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+
+
+## [0.1.1] - Unreleased
+
 ## [0.1.0] - 2026-03-12
 
 ### Added

data/lib/strict_associations/validator.rb

@@ -13,8 +13,10 @@ module StrictAssociations
       models_to_check.each do |model|
         check_habtm(model, violations)
         check_belongs_to_inverses(model, violations)
+        check_has_many_inverses(model, violations)
         check_polymorphic_inverses(model, violations)
         check_dependent_options(model, violations)
+        check_orphaned_foreign_keys(model, violations)
       end
 
       violations
@@ -84,10 +86,10 @@ module StrictAssociations
             rule: :missing_inverse,
             message: <<~MSG.squish
               #{target} has no has_many/has_one pointing back to \
-              #{model.table_name} with foreign key #{fk}. \
-              Define the inverse. \
-              Or mark this association with strict: false. \
-              Or call skip_strict_association :#{inverse_name} \
+              #{model.table_name} with foreign key #{fk}.
+              Define the inverse.
+              Or mark this association with strict: false.
+              Or call skip_strict_association :#{inverse_name}
               on #{target}
             MSG
           )
@@ -95,6 +97,34 @@ module StrictAssociations
       end
     end
 
+    def check_has_many_inverses(model, violations)
+      %i[has_many has_one].each do |macro|
+        model.reflect_on_all_associations(macro).each do |ref|
+          next if skipped?(model, ref)
+          next if ref.is_a?(ActiveRecord::Reflection::ThroughReflection)
+          next if ref.options[:as] # skip for polymorphic inverse
+
+          target = resolve_target(ref)
+          next unless target
+
+          unless belongs_to_exists?(model, ref, target)
+            violations << Violation.new(
+              model:,
+              association_name: ref.name,
+              rule: :missing_belongs_to,
+              message: <<~MSG.squish
+                #{model} has #{macro} :#{ref.name} but #{target} has no belongs_to \
+                pointing back with foreign key #{ref.foreign_key}.
+                Define the belongs_to on #{target}.
+                Or mark with strict: false.
+                Or call skip_strict_association :#{ref.name} on #{model}.
+              MSG
+            )
+          end
+        end
+      end
+    end
+
     def check_polymorphic_inverses(model, violations)
       refs = model.reflect_on_all_associations(:belongs_to)
       refs.each do |ref|
@@ -109,20 +139,16 @@ module StrictAssociations
             association_name: ref.name,
             rule: :unregistered_polymorphic,
             message: <<~MSG.squish
-              #{model}##{ref.name} is polymorphic but has no \
-              valid_types declared. Add valid_types: to the \
-              association. Or mark with strict: false.
+              #{model}##{ref.name} is polymorphic but has no valid_types declared.
+              Add valid_types: to the association. Or mark with strict: false.
             MSG
           )
           next
         end
 
-        type_violations, types =
-          resolved.partition { |r| r.is_a?(Violation) }
+        type_violations, types = resolved.partition { |r| r.is_a?(Violation) }
         violations.concat(type_violations)
-        check_registered_polymorphic_types(
-          model, ref, types, violations
-        )
+        check_registered_polymorphic_types(model, ref, types, violations)
       end
     end
 
@@ -139,9 +165,8 @@ module StrictAssociations
           association_name: ref.name,
           rule: :invalid_valid_type,
           message: <<~MSG.squish
-            #{model}##{ref.name} declares valid_types \
-            containing "#{t}" but #{e.message}. \
-            Check for typos in valid_types.
+            #{model}##{ref.name} declares valid_types containing "#{t}" but \
+            #{e.message}. Check for typos in valid_types.
           MSG
         )
       end
@@ -149,26 +174,20 @@ module StrictAssociations
       resolved
     end
 
-    def check_registered_polymorphic_types(
-      model, ref, types, violations
-    )
+    def check_registered_polymorphic_types(model, ref, types, violations)
       fk = ref.foreign_key.to_s
       source_table = model.table_name
 
       types.each do |type_class|
-        next if polymorphic_inverse_exists?(
-          type_class, source_table, fk
-        )
+        next if polymorphic_inverse_exists?(type_class, source_table, fk)
 
         violations << Violation.new(
           model:,
           association_name: ref.name,
           rule: :missing_polymorphic_inverse,
           message: <<~MSG.squish
-            #{type_class} is registered for \
-            #{model}##{ref.name} but has no has_many/has_one \
-            pointing back to #{source_table} with foreign \
-            key #{fk}.
+            #{type_class} is registered for #{model}##{ref.name} but has no \
+            has_many/has_one pointing back to #{source_table} with foreign key #{fk}.
           MSG
         )
       end
@@ -178,9 +197,7 @@ module StrictAssociations
       %i[has_many has_one].each do |macro|
         model.reflect_on_all_associations(macro).each do |ref|
           next if skipped?(model, ref)
-          next if ref.is_a?(
-            ActiveRecord::Reflection::ThroughReflection
-          )
+          next if ref.is_a?(ActiveRecord::Reflection::ThroughReflection)
           next if target_is_view?(ref)
 
           unless ref.options.key?(:dependent)
@@ -189,12 +206,11 @@ module StrictAssociations
               association_name: ref.name,
               rule: :missing_dependent,
               message: <<~MSG.squish
-                #{model}##{ref.name} is missing a :dependent \
-                option. Add dependent: :destroy, :delete_all, \
-                :nullify, or :restrict_with_exception. \
-                Or mark with strict: false. \
-                Or call skip_strict_association :#{ref.name} \
-                on #{model}.
+                #{model}##{ref.name} is missing a :dependent option.
+                Add dependent: :destroy, :delete_all, :nullify, or \
+                :restrict_with_exception.
+                Or mark with strict: false.
+                Or call skip_strict_association :#{ref.name} on #{model}.
               MSG
             )
           end
@@ -202,25 +218,70 @@ module StrictAssociations
       end
     end
 
+    def check_orphaned_foreign_keys(model, violations)
+      indexed_fk_columns = indexed_foreign_key_columns(model)
+      defined_fk_columns = model
+        .reflect_on_all_associations(:belongs_to)
+        .map { |ref| ref.foreign_key.to_s }
+
+      (indexed_fk_columns - defined_fk_columns).each do |column|
+        assoc_name = column.delete_suffix("_id").to_sym
+        next if model.strict_association_skipped?(assoc_name)
+
+        violations << Violation.new(
+          model:,
+          association_name: assoc_name,
+          rule: :orphaned_foreign_key,
+          message: <<~MSG.squish
+            #{model.table_name} has an indexed column #{column} but #{model} has no \
+            belongs_to association for it.
+            Define a belongs_to.
+            Or remove the index.
+            Or call skip_strict_association :#{assoc_name} on #{model}.
+          MSG
+        )
+      end
+    end
+
+    def indexed_foreign_key_columns(model)
+      model.connection.indexes(model.table_name).filter_map do |index|
+        column = index.columns.first
+        next unless index.columns.one? && column.end_with?("_id")
+
+        column
+      end
+    end
+
     def resolve_target(reflection)
       reflection.klass
     rescue NameError
       nil
     end
 
+    def belongs_to_exists?(source_model, has_many_ref, target)
+      fk = has_many_ref.foreign_key.to_s
+
+      target.reflect_on_all_associations(:belongs_to).any? do |ref|
+        next if ref.options[:polymorphic]
+
+        begin
+          ref.klass == source_model && ref.foreign_key.to_s == fk
+        rescue NameError
+          false
+        end
+      end
+    end
+
     def inverse_exists?(source_model, belongs_to_ref, target)
       fk = belongs_to_ref.foreign_key.to_s
       source_table = source_model.table_name
 
       target.reflect_on_all_associations.any? do |ref|
         next unless %i[has_many has_one].include?(ref.macro)
-        next if ref.is_a?(
-          ActiveRecord::Reflection::ThroughReflection
-        )
+        next if ref.is_a?(ActiveRecord::Reflection::ThroughReflection)
 
         begin
-          ref.klass.table_name == source_table &&
-            ref.foreign_key.to_s == fk
+          ref.klass.table_name == source_table && ref.foreign_key.to_s == fk
         rescue NameError
           false
         end
@@ -230,13 +291,10 @@ module StrictAssociations
     def polymorphic_inverse_exists?(type, table, fk)
       type.reflect_on_all_associations.any? do |ref|
         next unless %i[has_many has_one].include?(ref.macro)
-        next if ref.is_a?(
-          ActiveRecord::Reflection::ThroughReflection
-        )
+        next if ref.is_a?(ActiveRecord::Reflection::ThroughReflection)
 
         begin
-          ref.klass.table_name == table &&
-            ref.foreign_key.to_s == fk
+          ref.klass.table_name == table && ref.foreign_key.to_s == fk
         rescue NameError
           false
         end
@@ -249,8 +307,7 @@ module StrictAssociations
     end
 
     def skipped?(model, ref)
-      ref.options[:strict] == false ||
-        model.strict_association_skipped?(ref.name)
+      ref.options[:strict] == false || model.strict_association_skipped?(ref.name)
     end
   end
 end

data/lib/strict_associations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrictAssociations
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strict_associations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeff Lange