active_record_compose 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d9e12c3cb3d2e8571d418957576a8cf5b5d3dbedb9e83e2bcd25f172def43f3
-  data.tar.gz: a991715192e6cb62e8b794860422667811b1fb1f985089e415b444f0b7bc0d4a
+  metadata.gz: 7a3112ceb79671ca112aa5dde2222e10a0bd4daed96f82ebaa641746165d8991
+  data.tar.gz: e021f41a5e3334b0e91f170712c011679023a384bbfe17c3df2a97858747323e
 SHA512:
-  metadata.gz: 837b3d35c903eb0ff4400e5c83c438255d9ee02515407792fd19d24ab9a5a63cea1f9faa1d12a5fd5184d52fee2d662625e7c0d0b2a79e27ebb0866054a6b2a4
-  data.tar.gz: e245d8380a2d20f0c9bbbc1f24712f1d7982697bf90b172886dcd2c9bd666ace8ddd3b29a20b9bcc709d8a236a1395a41c0f53ccdb3869f66a527d5ad6be08dc
+  metadata.gz: 56cb8c6d615cbefb58fc774e96caa9add4cb72a8ca34188ce2d713f6b4f32ef75b7df4f273da2bd6966d08c1a8f1aadbeef838f3c5b436e5f1122efb7af5a961
+  data.tar.gz: 0aec57e80f57d0c3d1bf1d45e4cb39c3cebcae47c53a35b630817de592bd3893604ff58563eed2c6b23f4199d2f27bc39804a1a9e6fe20bbdb809defaae30e28

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.5.0] - 2024-10-09
+
+- remove `:context` option. use `:destroy` option instead.
+- remove `:destroy` option from `InnerModelCollection#destroy`.
+
+## [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/README.md

@@ -31,7 +31,7 @@ A callback is useful to define some processing before or after a save in a parti
 However, if a callback is written directly in the AR model, it is necessary to consider the case where the model is updated in other contexts.
 In particular, if you frequently create with test data, previously unnecessary processing will be called at every point of creation.
 In addition to cost, the more complicated the callbacks you write, the more difficult it will be to create even a single test data.
-If the callbacks are written in a class that inherits from `ApplicationRecordCompose::Model`, the AR model itself will not be polluted, and the context can be limited.
+If the callbacks are written in a class that inherits from `ActiveRecordCompose::Model`, the AR model itself will not be polluted, and the context can be limited.
 
 ```ruby
 class AccountRegistration < ActiveRecordCompose::Model
@@ -70,7 +70,7 @@ Validates are basically fired in all cases where the model is manipulated. To av
 and so on to work only in specific cases. This allows you to create context-sensitive validations for the same model operation.
 However, this is the first step in making the model more and more complex. You will have to go around with `update(context: :foo)`
 In some cases, you may have to go around with the context option, such as `update(context: :foo)` everywhere.
-By writing validates in a class that extends `ApplicationRecordCompose::Model`, you can define context-specific validation without polluting the AR model itself.
+By writing validates in a class that extends `ActiveRecordCompose::Model`, you can define context-specific validation without polluting the AR model itself.
 
 ```ruby
 class AccountRegistration < ActiveRecordCompose::Model
@@ -116,7 +116,7 @@ account_registration.valid?  #=> false
 
 In an AR model, you can add, for example, `autosave: true` or `accepts_nested_attributes_for` to an association to update the related models at the same time.
 There are ways to update related models at the same time. The operation is safe because it is transactional.
-`ApplicationRecordCompose::Model` has an internal array called models. By adding an AR object to this models array
+`ActiveRecordCompose::Model` has an internal array called models. By adding an AR object to this models array
 By adding an AR object to the models, the object stored in the models provides an atomic update operation via #save.
 
 ```ruby
@@ -167,12 +167,12 @@ class AccountResignation < ActiveRecordCompose::Model
     models.push(profile, destroy: true)
   end
 
-  attr_reader :account, :profile
-
   before_save :set_resigned_at
 
   private
 
+  attr_reader :account, :profile
+
   def set_resigned_at
     account.resigned_at = Time.zone.now
   end

data/lib/active_record_compose/inner_model.rb

@@ -7,65 +7,32 @@ 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)
       @model = model
-      @destroy =
-        if context
-          c = context
-
-          if c.is_a?(Proc)
-            # @type var c: ((^() -> (context)) | (^(_ARLike) -> (context)))
-            if c.arity == 0
-              deprecator.warn(
-                '`:context` will be removed in 0.5.0. Use `:destroy` option instead. ' \
-                'for example, `models.push(model, context: -> { foo? ? :destroy : :save })` ' \
-                'is replaced by `models.push(model, destroy: -> { foo? })`.',
-              )
-
-              # @type var c: ^() -> (context)
-              -> { c.call == :destroy }
-            else
-              deprecator.warn(
-                '`:context` will be removed in 0.5.0. Use `:destroy` option instead. ' \
-                'for example, `models.push(model, context: ->(m) { m.bar? ? :destroy : :save })` ' \
-                'is replaced by `models.push(model, destroy: ->(m) { m.bar? })`.',
-              )
-
-              # @type var c: ^(_ARLike) -> (context)
-              ->(model) { c.call(model) == :destroy }
-            end
-          elsif %i[save destroy].include?(c)
-            deprecator.warn(
-              '`:context` will be removed in 0.5.0. Use `:destroy` option instead. ' \
-              "for example, `models.push(model, context: #{c.inspect})` " \
-              "is replaced by `models.push(model, destroy: #{(c == :destroy).inspect})`.",
-            )
-
-            # @type var c: (:save | :destory)
-            c == :destroy
-          else
-            c
-          end
-        else
-          destroy
-        end
+      @destroy_context_type = destroy
     end
 
     delegate :errors, to: :model
 
+    # Determines whether to save or delete the target object.
+    # Depends on the `destroy` value of the InnerModel object initialization option.
+    #
+    # On the other hand, there are values `mark_for_destruction` and `marked_for_destruction?` in ActiveRecord.
+    # However, these values are not substituted here.
+    # These values only work if the `autosave` option is enabled for the parent model,
+    # and are not appropriate for other cases.
+    #
+    # @return [Boolean] returns true on destroy, false on save.
     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
+          # @type var d: ^() -> bool
+          !!d.call
         else
-          # @type var d: ^(_ARLike) -> (bool | context)
-          d.call(model)
+          # @type var d: ^(_ARLike) -> bool
+          !!d.call(model)
         end
-      elsif d.is_a?(Symbol)
-        owner.send(d)
       else
         !!d
       end
@@ -94,35 +61,20 @@ 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
-
-    def deprecator
-      if ActiveRecord.respond_to?(:deprecator)
-        ActiveRecord.deprecator
-      else # for rails 7.0.x or lower
-        ActiveSupport::Deprecation
-      end
-    end
+    attr_reader :model, :destroy_context_type
   end
 end

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,10 +36,11 @@ 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:)
+    def push(model, destroy: false)
+      models << wrap(model, destroy:)
       self
     end
 
@@ -59,17 +61,16 @@ 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)
+      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 +86,19 @@ module ActiveRecordCompose
 
     private
 
-    attr_reader :owner
-
-    def models = @models ||= []
+    attr_reader :owner, :models
 
-    def wrap(model, destroy:, context: nil)
+    def wrap(model, destroy: false)
       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:)
       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.5.0'
 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

@@ -15,8 +15,7 @@ module ActiveRecordCompose
   end
 
   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 +29,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) -> self
     def empty?: -> bool
     def clear: -> self
-    def delete: (_ARLike | InnerModel, ?destroy: bool, ?context: (nil | context | context_proc)) -> InnerModelCollection?
+    def delete: (_ARLike | InnerModel) -> 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) -> 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) -> void
     def destroy_context?: -> bool
     def save: -> bool
     def save!: -> untyped
@@ -60,8 +54,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.5.0
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-14 00:00:00.000000000 Z
+date: 2024-10-09 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.5.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: activemodel form object pattern