active_record_compose 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491f46737a3744c5c5d3e0319de3ee9f64ae21a9adfab39f36cedc478bfa0e7c
-  data.tar.gz: 406f4c471e0d7c40ec7b3a0d492f8e7e6c96d93fd4b43204a128bf52c1f7ed4c
+  metadata.gz: 2622aa32a886a2c21fcc7836254285cb92f1ce7745674297c3e7fe46bcbe556a
+  data.tar.gz: 747acd3e97cb78aba78b9d3f2c87ab4d9bd34b0727aaf2a1c94d9520ea9eaa08
 SHA512:
-  metadata.gz: 9ff0e91cfb0ca22322d1b9ca47c32f09372afa206e9fa6690c1dfe5ca30d221269ccc55fe17556627234ea8a7019118ddec8a46ad24a52c47239e694dbcac323
-  data.tar.gz: 925001a566ee81600ce91862c0c95f241dba2cd735f6ecbc3e987e83e6cd6f59d217e67afa4bed0a981f35c16645661ef7eeb00adb18df92999f9127e22116e0
+  metadata.gz: e6002732e8e6fa09269ccb4a7635af4ef683d06af14e829aa062846c6dbb90c2942d5b3cc2b4d715eeef2182498e732d33b5ae004836ff703f8d8235fec12c70
+  data.tar.gz: 18d3f9a635d3f4bf940eeb4020824fa7fc7d91cf27b0a99aa253af53e31fdca6bebd69d402537bea29749de26eba3f5a261e10a3ef2ebf079294e7fc3dbd5127

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [1.2.0] - 2026-01-05
+
+* Avoid issuing multiple saves on the same object.
+  (https://github.com/hamajyotan/active_record_compose/pull/56)
+* The storage of `#models` has been changed from an Array to a Set.
+  This prevents duplicate additions of the same object and option combinations.
+  Also, `#models#delete` now deletes the model regardless of the options used when it was added.
+  (https://github.com/hamajyotan/active_record_compose/pull/57)
+* Adding an `ActiveRecordCompose::Model` to `#models` now throws an error if there is a circular reference.
+  (https://github.com/hamajyotan/active_record_compose/pull/58)
+
 ## [1.1.1] - 2025-12-04
 
 * fix: the save method would return nil instead of false.

data/lib/active_record_compose/composed_collection.rb

@@ -13,7 +13,7 @@ module ActiveRecordCompose
 
     def initialize(owner)
       @owner = owner
-      @models = []
+      @models = Set.new
     end
 
     # Enumerates model objects.
@@ -69,13 +69,28 @@ module ActiveRecordCompose
     # Removes the specified model from the collection.
     # Returns nil if the deletion fails, self if it succeeds.
     #
+    # The specified model instance will be deleted regardless of the options used when it was added.
+    #
+    # @example
+    #   model_a = Model.new
+    #   model_b = Model.new
+    #
+    #   collection.push(model_a, destroy: true)
+    #   collection.push(model_b)
+    #   collection.push(model_a, destroy: false)
+    #   collection.count  #=> 3
+    #
+    #   collection.delete(model_a)
+    #   collection.count  #=> 1
+    #
     # @param model [Object] model instance
     # @return [self] Successful deletion
     # @return [nil] If deletion fails
     def delete(model)
-      wrapped = wrap(model)
-      return nil unless models.delete(wrapped)
+      matched = models.select { _1.__raw_model == model }
+      return nil if matched.blank?
 
+      matched.each { models.delete(_1) }
       self
     end
 
@@ -87,17 +102,27 @@ module ActiveRecordCompose
     # @private
     def wrap(model, destroy: false, if: nil)
       if destroy.is_a?(Symbol)
-        method = destroy
-        destroy = -> { owner.__send__(method) }
+        destroy = symbol_proc_map[destroy]
       end
+
       if_option = binding.local_variable_get(:if)
       if if_option.is_a?(Symbol)
-        method = if_option
-        if_option = -> { owner.__send__(method) }
+        if_option = symbol_proc_map[if_option]
       end
+
       ActiveRecordCompose::WrappedModel.new(model, destroy:, if: if_option)
     end
 
+    # @private
+    def symbol_proc_map
+      @symbol_proc_map ||=
+        Hash.new do |h, k|
+          h[k] = -> { owner.__send__(k) }
+        end
+    end
+
+    def instance_variables_to_inspect = %i[@owner @models]
+
     # @private
     module PackagePrivate
       refine ComposedCollection do
@@ -105,7 +130,9 @@ module ActiveRecordCompose
         #
         # @private
         # @return [Array[WrappedModel]] array of wrapped model instance.
-        def __wrapped_models = models.reject { _1.ignore? }.select { _1.__raw_model }
+        def __wrapped_models
+          models.reject { _1.ignore? }.uniq { [ _1.__raw_model, !!_1.destroy_context? ] }.select { _1.__raw_model }
+        end
       end
     end
   end

data/lib/active_record_compose/exceptions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActiveRecordCompose
+  # Occurs when a circular reference is detected in the containing model.
+  #
+  # @example
+  #     class Model < ActiveRecordCompose::Model
+  #       def initialize
+  #         super()
+  #         models << self  # Adding itself to models creates a circular reference.
+  #       end
+  #     end
+  #     model = Model.new
+  #     model.save  #=> raises ActiveRecordCompose::CircularReferenceDetected
+  #
+  # @example
+  #     class Model < ActiveRecordCompose::Model
+  #       attribute :model
+  #       before_validation { models << model }
+  #     end
+  #     inner = Model.new
+  #     middle = Model.new(model: inner)
+  #     outer = Model.new(model: middle)
+  #
+  #     inner.model = outer  # There is a circular reference in the form outer > middle > inner > outer.
+  #     outer.save  #=> raises ActiveRecordCompose::CircularReferenceDetected
+  #
+  class CircularReferenceDetected < StandardError; end
+end

data/lib/active_record_compose/validations.rb

@@ -76,10 +76,24 @@ module ActiveRecordCompose
     #
     #   @return [ActiveModel::Errors]
 
+    # @private
+    def detect_circular_reference(targets = [])
+      raise CircularReferenceDetected if targets.include?(object_id)
+
+      targets += [ object_id ]
+      # steep:ignore:start
+      models.select { _1.respond_to?(:detect_circular_reference) }.each do |m|
+        m.detect_circular_reference(targets)
+      end
+      # steep:ignore:end
+    end
+
     private
 
     # @private
     def validate_models
+      detect_circular_reference
+
       context = override_validation_context
       models.__wrapped_models.lazy.select { _1.invalid?(context) }.each { errors.merge!(_1) }
     end

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/active_record_compose/wrapped_model.rb

@@ -104,19 +104,28 @@ module ActiveRecordCompose
     # @param [Object] other
     # @return [Boolean]
     def ==(other)
+      return true if equal?(other)
       return false unless self.class == other.class
-      return false unless model == other.model
 
-      true
+      equality_key == other.equality_key
     end
 
+    def eql?(other)
+      return true if equal?(other)
+      return false unless self.class == other.class
+
+      equality_key.eql?(other.equality_key)
+    end
+
+    def hash = equality_key.hash
+
     protected
 
-    attr_reader :model
+    def equality_key = [ model, destroy_context_type, if_option ]
 
     private
 
-    attr_reader :destroy_context_type, :if_option
+    attr_reader :model, :destroy_context_type, :if_option
 
     # @private
     module PackagePrivate

data/lib/active_record_compose.rb

@@ -3,6 +3,7 @@
 require "active_record"
 
 require_relative "active_record_compose/version"
+require_relative "active_record_compose/exceptions"
 require_relative "active_record_compose/model"
 
 # namespaces in gem `active_record_compose`.

data/sig/_internal/package_private.rbs

@@ -64,16 +64,20 @@ module ActiveRecordCompose
   class ComposedCollection
     def initialize: (Model) -> void
 
+    @symbol_proc_map: Hash[Symbol, (destroy_context_type | condition_type)]
+
     private
     attr_reader owner: Model
-    attr_reader models: Array[WrappedModel]
+    attr_reader models: Set[WrappedModel]
     def wrap: (ar_like, ?destroy: (bool | Symbol | destroy_context_type), ?if: (nil | Symbol | condition_type)) -> WrappedModel
+    def symbol_proc_map: () -> Hash[Symbol, (destroy_context_type | condition_type)]
+    def instance_variables_to_inspect: () -> Array[Symbol]
 
     module PackagePrivate
-      def __wrapped_models: () -> Array[WrappedModel]
+      def __wrapped_models: () -> Enumerable[WrappedModel]
 
       private
-      def models: () -> Array[WrappedModel]
+      def models: () -> Set[WrappedModel]
     end
 
     include PackagePrivate
@@ -143,10 +147,6 @@ module ActiveRecordCompose
     def raise_on_save_error_message: -> String
   end
 
-  class Railtie < Rails::Railtie
-    extend Rails::Initializable::ClassMethods
-  end
-
   module Validations : Model
     extend ActiveSupport::Concern
     extend ActiveModel::Validations::ClassMethods
@@ -154,6 +154,7 @@ module ActiveRecordCompose
     def save: (**untyped options) -> bool
     def save!: (**untyped options) -> untyped
     def valid?: (?validation_context context) -> bool
+    def detect_circular_reference: (?Array[Integer])-> untyped
 
     @context_for_override_validation: OverrideValidationContext
 
@@ -187,6 +188,7 @@ module ActiveRecordCompose
     attr_reader model: ar_like
     attr_reader destroy_context_type: (bool | destroy_context_type)
     attr_reader if_option: (nil | condition_type)
+    def equality_key: () -> [ar_like, (bool | destroy_context_type), (nil | condition_type)]
 
     module PackagePrivate
       def __raw_model: () -> ar_like

data/sig/active_record_compose.rbs

@@ -47,6 +47,9 @@ module ActiveRecordCompose
     def delete: (ar_like) -> ComposedCollection?
   end
 
+  class CircularReferenceDetected < StandardError
+  end
+
   class Model
     include ActiveModel::Model
     include ActiveModel::Validations::Callbacks
@@ -68,6 +71,7 @@ module ActiveRecordCompose
     def self.around_update: (*around_callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
     def self.after_update: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
 
+    def self.before_commit: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
     def self.after_commit: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
     def self.after_rollback: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
 
@@ -90,4 +94,8 @@ module ActiveRecordCompose
     private
     def models: -> ComposedCollection
   end
+
+  class Railtie < Rails::Railtie
+    extend Rails::Initializable::ClassMethods
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - hamajyotan
@@ -50,6 +50,7 @@ files:
 - lib/active_record_compose/attributes/querying.rb
 - lib/active_record_compose/callbacks.rb
 - lib/active_record_compose/composed_collection.rb
+- lib/active_record_compose/exceptions.rb
 - lib/active_record_compose/inspectable.rb
 - lib/active_record_compose/model.rb
 - lib/active_record_compose/persistence.rb
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: activemodel form object pattern
 test_files: []