active_record_compose 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d9e12c3cb3d2e8571d418957576a8cf5b5d3dbedb9e83e2bcd25f172def43f3
-  data.tar.gz: a991715192e6cb62e8b794860422667811b1fb1f985089e415b444f0b7bc0d4a
+  metadata.gz: 5fe788a613275af9e9784ba51b84af314792e0a5761e0c8d5e985602dfe7d586
+  data.tar.gz: 0621ff28f43377240efc94a97b12ffde861e71142f6ba2ac349d4d9a165d6401
 SHA512:
-  metadata.gz: 837b3d35c903eb0ff4400e5c83c438255d9ee02515407792fd19d24ab9a5a63cea1f9faa1d12a5fd5184d52fee2d662625e7c0d0b2a79e27ebb0866054a6b2a4
-  data.tar.gz: e245d8380a2d20f0c9bbbc1f24712f1d7982697bf90b172886dcd2c9bd666ace8ddd3b29a20b9bcc709d8a236a1395a41c0f53ccdb3869f66a527d5ad6be08dc
+  metadata.gz: d67bf25365ccad6f049a17cbc311cbf19c48ee4719e51afefc149fb0227989ec8f1c55684ab26328839ae7c79897fed27ac6b5c7db90c42bf0b81e3bc4437c97
+  data.tar.gz: ab71a4b2bd61619136f8685b0b1346d4ad111fec0717a1527ce714985f5eaee91f0c91dd9713ba835a2633acbdc2a197f2ae2c77767d2028b13eb4bcb5f21887

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.4.1] - 2024-09-20
+
+- Omitted optional argument for `InnerModelCollection#destroy`.
+  `InnerModel` equivalence is always performed based on the instance of the inner `model`.
+  Since there are no use cases that depend on the original behavior.
+
 ## [0.4.0] - 2024-09-15
 
 - support `destrpy` option. and deprecated `context` option.

data/lib/active_record_compose/inner_model.rb

@@ -7,10 +7,9 @@ module ActiveRecordCompose
     # @param model [Object] the model instance.
     # @param destroy [Boolean] given true, destroy model.
     # @param destroy [Proc] when proc returning true, destroy model.
-    def initialize(owner, model, destroy: false, context: nil)
-      @owner = owner
+    def initialize(model, destroy: false, context: nil)
       @model = model
-      @destroy =
+      @destroy_context_type =
         if context
           c = context
 
@@ -55,17 +54,15 @@ module ActiveRecordCompose
     delegate :errors, to: :model
 
     def destroy_context?
-      d = destroy
+      d = destroy_context_type
       if d.is_a?(Proc)
         if d.arity == 0
           # @type var d: ^() -> (bool | context)
-          d.call
+          !!d.call
         else
           # @type var d: ^(_ARLike) -> (bool | context)
-          d.call(model)
+          !!d.call(model)
         end
-      elsif d.is_a?(Symbol)
-        owner.send(d)
       else
         !!d
       end
@@ -94,28 +91,21 @@ module ActiveRecordCompose
     # @return [Boolean]
     def ==(other)
       return false unless self.class == other.class
-      return false unless __raw_model == other.__raw_model
-      return false unless __destroy == other.__destroy
+      return false unless __raw_model == other.__raw_model # steep:ignore
 
       true
     end
 
+    # @private
     # Returns a model instance of raw, but it should
     # be noted that application developers are not expected to use this interface.
     #
     # @return [Object] raw model instance
     def __raw_model = model
 
-    # Returns a model instance of raw, but it should
-    # be noted that application developers are not expected to use this interface.
-    #
-    # @return [Boolean] raw destroy instance
-    # @return [Proc] raw destroy instance
-    def __destroy = destroy
-
     private
 
-    attr_reader :owner, :model, :destroy
+    attr_reader :model, :destroy_context_type
 
     def deprecator
       if ActiveRecord.respond_to?(:deprecator)

data/lib/active_record_compose/inner_model_collection.rb

@@ -8,6 +8,7 @@ module ActiveRecordCompose
 
     def initialize(owner)
       @owner = owner
+      @models = []
     end
 
     # Enumerates model objects.
@@ -35,7 +36,8 @@ module ActiveRecordCompose
     #
     # @param model [Object] the model instance
     # @param destroy [Boolean] given true, destroy model.
-    # @param context [Symbol] :save or :destroy
+    # @param destroy [Proc] when proc returning true, destroy model.
+    # @param destroy [Symbol] applies boolean value of result of sending a message to `owner` to evaluation.
     # @return [self] returns itself.
     def push(model, destroy: false, context: nil)
       models << wrap(model, destroy:, context:)
@@ -59,17 +61,25 @@ module ActiveRecordCompose
     # Returns nil if the deletion fails, self if it succeeds.
     #
     # @param model [Object] the model instance
-    # @param destroy [Boolean] given true, destroy model.
-    # @param context [Symbol] :save or :destroy
     # @return [self] Successful deletion
     # @return [nil] If deletion fails
-    def delete(model, destroy: false, context: nil)
-      wrapped = wrap(model, destroy:, context:)
+    def delete(model, destroy: nil, context: nil)
+      if !destroy.nil? || !context.nil?
+        # steep:ignore:start
+        deprecator.warn(
+          'In `InnerModelConnection#destroy`, the option values `destroy` and `context` are ignored. ' \
+          'These options will be removed in 0.5.0.',
+        )
+        # steep:ignore:end
+      end
+
+      wrapped = wrap(model)
       return nil unless models.delete(wrapped)
 
       self
     end
 
+    # @private
     # Enumerates model objects, but it should be noted that
     # application developers are not expected to use this interface.
     #
@@ -85,17 +95,27 @@ module ActiveRecordCompose
 
     private
 
-    attr_reader :owner
-
-    def models = @models ||= []
+    attr_reader :owner, :models
 
-    def wrap(model, destroy:, context: nil)
+    def wrap(model, destroy: false, context: nil)
       if model.is_a?(ActiveRecordCompose::InnerModel) # steep:ignore
         # @type var model: ActiveRecordCompose::InnerModel
         model
       else
+        if destroy.is_a?(Symbol)
+          method = destroy
+          destroy = -> { owner.__send__(method) }
+        end
         # @type var model: ActiveRecordCompose::_ARLike
-        ActiveRecordCompose::InnerModel.new(owner, model, destroy:, context:)
+        ActiveRecordCompose::InnerModel.new(model, destroy:, context:)
+      end
+    end
+
+    def deprecator
+      if ActiveRecord.respond_to?(:deprecator)
+        ActiveRecord.deprecator # steep:ignore
+      else # for rails 7.0.x or lower
+        ActiveSupport::Deprecation
       end
     end
   end

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/lib/active_record_compose.rb

@@ -3,8 +3,6 @@
 require 'active_record'
 
 require_relative 'active_record_compose/version'
-require_relative 'active_record_compose/inner_model'
-require_relative 'active_record_compose/inner_model_collection'
 require_relative 'active_record_compose/model'
 
 module ActiveRecordCompose

data/sig/active_record_compose.rbs

@@ -17,6 +17,7 @@ module ActiveRecordCompose
   type attribute_name = (String | Symbol)
   type context = (:save | :destroy)
   type context_proc = ((^() -> context) | (^(_ARLike) -> context))
+  type destroy_context_type = (bool | Symbol | (^() -> boolish) | (^(_ARLike) -> boolish))
 
   module DelegateAttribute
     extend ActiveSupport::Concern
@@ -30,28 +31,23 @@ module ActiveRecordCompose
 
   class InnerModelCollection
     include ::Enumerable[_ARLike]
-    @owner: Model
-    @models: Array[InnerModel]
 
     def initialize: (Model) -> void
     def each: () { (_ARLike) -> void } -> InnerModelCollection | () -> Enumerator[_ARLike, self]
     def <<: (_ARLike) -> self
-    def push: (_ARLike, ?destroy: bool, ?context: (nil | context | context_proc)) -> self
+    def push: (_ARLike, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> self
     def empty?: -> bool
     def clear: -> self
-    def delete: (_ARLike | InnerModel, ?destroy: bool, ?context: (nil | context | context_proc)) -> InnerModelCollection?
+    def delete: (_ARLike | InnerModel, ?destroy: (nil | destroy_context_type), ?context: (nil | context | context_proc)) -> InnerModelCollection?
 
     private
     attr_reader owner: Model
-    def models: -> Array[InnerModel]
-    def wrap: (_ARLike | InnerModel, destroy: bool, ?context: (nil | context | context_proc)) -> InnerModel
+    attr_reader models: Array[InnerModel]
+    def wrap: (_ARLike | InnerModel, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> InnerModel
   end
 
   class InnerModel
-    @owner: Model
-    @context: (context | context_proc)
-
-    def initialize: (Model, _ARLike, ?destroy: bool, ?context: (nil | context | context_proc)) -> void
+    def initialize: (_ARLike, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> void
     def destroy_context?: -> bool
     def save: -> bool
     def save!: -> untyped
@@ -60,8 +56,8 @@ module ActiveRecordCompose
     def ==: (untyped) -> bool
 
     private
-    attr_reader owner: Model
     attr_reader model: _ARLike
+    attr_reader destroy_context_type: destroy_context_type
   end
 
   class Model

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-14 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,7 +52,7 @@ metadata:
   homepage_uri: https://github.com/hamajyotan/active_record_compose
   source_code_uri: https://github.com/hamajyotan/active_record_compose
   changelog_uri: https://github.com/hamajyotan/active_record_compose/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.4.0
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.4.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []