active_record_compose 1.1.0 → 1.2.0

data/lib/active_record_compose/validations.rb

@@ -5,7 +5,6 @@ require_relative "composed_collection"
 module ActiveRecordCompose
   using ComposedCollection::PackagePrivate
 
-  # @private
   module Validations
     extend ActiveSupport::Concern
     include ActiveModel::Validations::Callbacks
@@ -22,27 +21,100 @@ module ActiveRecordCompose
       perform_validations(options) ? super : raise_validation_error
     end
 
+    # Runs all the validations and returns the result as true or false.
+    #
+    # @param context Validation context.
+    # @return [Boolean] true on success, false on failure.
     def valid?(context = nil) = context_for_override_validation.with_override(context) { super }
 
+    # @!method validate(context = nil)
+    #   Alias for {#valid?}
+    #   @see #valid? Validation context.
+    #   @param context
+    #   @return [Boolean] true on success, false on failure.
+
+    # @!method validate!(context = nil)
+    #   @see #valid?
+    #   Runs all the validations within the specified context.
+    #   no errors are found, raises `ActiveRecord::RecordInvalid` otherwise.
+    #   @param context Validation context.
+    #   @raise ActiveRecord::RecordInvalid
+
+    # @!method errors
+    #   Returns the `ActiveModel::Errors` object that holds all information about attribute error messages.
+    #
+    #   The `ActiveModel::Base` implementation itself,
+    #   but also aggregates error information for objects stored in {#models} when validation is performed.
+    #
+    #       class Account < ActiveRecord::Base
+    #         validates :name, :email, presence: true
+    #       end
+    #
+    #       class AccountRegistration < ActiveRecordCompose::Model
+    #         def initialize(attributes = {})
+    #           @account = Account.new
+    #           super(attributes)
+    #           models << account
+    #         end
+    #
+    #         attribute :confirmation, :boolean, default: false
+    #         validates :confirmation, presence: true
+    #
+    #         private
+    #
+    #         attr_reader :account
+    #       end
+    #
+    #       registration = AccountRegistration
+    #       registration.valid?
+    #       #=> false
+    #
+    #       # In addition to the model's own validation error information (`confirmation`), also aggregates
+    #       # error information for objects stored in `account` (`name`, `email`) when validation is performed.
+    #
+    #       registration.errors.map { _1.attribute }  #=> [:name, :email, :confirmation]
+    #
+    #   @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
 
+    # @private
     def perform_validations(options)
       options[:validate] == false || valid?(options[:context])
     end
 
+    # @private
     def raise_validation_error = raise ActiveRecord::RecordInvalid, self
 
+    # @private
     def context_for_override_validation
       @context_for_override_validation ||= OverrideValidationContext.new
     end
 
+    # @private
     def override_validation_context = context_for_override_validation.context
 
+    # @private
     class OverrideValidationContext
       attr_reader :context
 

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = "1.1.0"
+  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

@@ -4,19 +4,13 @@ module ActiveRecordCompose
     include ActiveModel::Attributes
     include Querying
 
+    def self.delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: bool) -> untyped
+    def self.delegated_attributes: () -> Array[Delegation]
+    def self.delegated_attributes=: (Array[Delegation]) -> untyped
     def delegated_attributes: () -> Array[Delegation]
 
     @attributes: untyped
 
-    module ClassMethods : Module
-      include ActiveModel::Attributes::ClassMethods
-      include ActiveModel::AttributeMethods::ClassMethods
-
-      def delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: bool) -> untyped
-      def delegated_attributes: () -> Array[Delegation]
-      def delegated_attributes=: (Array[Delegation]) -> untyped
-    end
-
     class AttributePredicate
       def initialize: (untyped value) -> void
       def call: -> bool
@@ -70,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
@@ -88,31 +86,20 @@ module ActiveRecordCompose
   module Inspectable
     extend ActiveSupport::Concern
     include Attributes
-    extend Inspectable::ClassMethods
 
+    def self.inspection_filter: () -> ActiveSupport::ParameterFilter
+    def self.filter_attributes: () -> Array[untyped]
+    def self.filter_attributes=: (Array[untyped]) -> void
     def inspect: () -> String
     def pretty_print: (untyped q) -> void
 
     private
     def format_for_inspect: (String name, untyped value) -> String
-
-    module ClassMethods
-      FILTERED_MASK: String
-
-      def inspection_filter: () -> ActiveSupport::ParameterFilter
-      def filter_attributes: () -> Array[untyped]
-      def filter_attributes=: (Array[untyped]) -> void
-
-      @inspection_filter: ActiveSupport::ParameterFilter?
-      @filter_attributes: untyped
-    end
   end
 
   class Model
     include Attributes
-    extend Attributes::ClassMethods
     include TransactionSupport
-    extend TransactionSupport::ClassMethods
     include Callbacks
 
     @__models: ComposedCollection
@@ -125,19 +112,12 @@ module ActiveRecordCompose
   module TransactionSupport
     extend ActiveSupport::Concern
     include ActiveRecord::Transactions
-    extend TransactionSupport::ClassMethods
-
-    module ClassMethods
-      include ActiveSupport::Callbacks::ClassMethods
+    include ActiveSupport::Callbacks
+    extend ActiveSupport::Callbacks::ClassMethods
 
-      def before_commit: (*untyped) -> untyped
-      def after_commit: (*untyped) -> untyped
-      def after_rollback: (*untyped) -> untyped
-
-      private
-      def prepend_option: -> ({ prepend: true } | {})
-      def set_options_for_callbacks!: (untyped, ?({ prepend: true } | {})) -> untyped
-    end
+    def self.before_commit: (*untyped) -> untyped
+    def self.after_commit: (*untyped) -> untyped
+    def self.after_rollback: (*untyped) -> untyped
 
     def save: (**untyped options) -> bool
     def save!: (**untyped options) -> untyped
@@ -154,7 +134,6 @@ module ActiveRecordCompose
   module Persistence
     include Callbacks
     include TransactionSupport
-    extend TransactionSupport::ClassMethods
 
     def save: (**untyped options) -> bool
     def save!: (**untyped options) -> untyped
@@ -168,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
@@ -179,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
 
@@ -212,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.0
+  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: []