active_record_compose 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe788a613275af9e9784ba51b84af314792e0a5761e0c8d5e985602dfe7d586
-  data.tar.gz: 0621ff28f43377240efc94a97b12ffde861e71142f6ba2ac349d4d9a165d6401
+  metadata.gz: 701c396babd7d30d3e13779c5237bd1fbaf2fb719a75439154d17a167dc645dc
+  data.tar.gz: 72cf835561b903fc913e9feadff380f8ca986f621320b1fdd1ebd7dc341539cb
 SHA512:
-  metadata.gz: d67bf25365ccad6f049a17cbc311cbf19c48ee4719e51afefc149fb0227989ec8f1c55684ab26328839ae7c79897fed27ac6b5c7db90c42bf0b81e3bc4437c97
-  data.tar.gz: ab71a4b2bd61619136f8685b0b1346d4ad111fec0717a1527ce714985f5eaee91f0c91dd9713ba835a2633acbdc2a197f2ae2c77767d2028b13eb4bcb5f21887
+  metadata.gz: fddabb884fb62e215cc5a67abe823b563cf5be201f2e05b8057871e2c188025e04d46b5953b84f23e7cdc064840291882cb3f77a93efb221bed3b0c99a6dfe71
+  data.tar.gz: 7b550abe98e5391de53a9b017b8ae214270844f8d6536dadb012587c1d553e4e01cab99f480ec59ae01eaf3d0b742c612ea676546cc7ce82ea945d0e99e0168d

data/.rubocop.yml

@@ -24,6 +24,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
 
+Style/SuperArguments:
+  Enabled: false
+
 Style/SymbolProc:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.6.0] - 2024-11-11
+
+- refactor: limit the scope of methods needed only for internal library purposes.
+- support rails 8.0.x
+- add optional value `if` to exclude from save (or destroy).
+
+## [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`.

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,60 +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(model, destroy: false, context: nil)
+    # @param if [Proc] evaluation result is false, it will not be included in the renewal.
+    def initialize(model, destroy: false, if: nil)
       @model = model
-      @destroy_context_type =
-        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
+      @if_option = binding.local_variable_get(:if)
     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_context_type
       if d.is_a?(Proc)
         if d.arity == 0
-          # @type var d: ^() -> (bool | context)
+          # @type var d: ^() -> bool
           !!d.call
         else
-          # @type var d: ^(_ARLike) -> (bool | context)
+          # @type var d: ^(_ARLike) -> bool
           !!d.call(model)
         end
       else
@@ -68,6 +40,22 @@ module ActiveRecordCompose
       end
     end
 
+    # Returns a boolean indicating whether or not to exclude the user from the update.
+    #
+    # @return [Boolean] if true, exclude from update.
+    def ignore?
+      i = if_option
+      if i.nil?
+        false
+      elsif i.arity == 0
+        # @type var i: ^() -> bool
+        !i.call
+      else
+        # @type var i: ^(_ARLike) -> bool
+        !i.call(model)
+      end
+    end
+
     # Execute save or destroy. Returns true on success, false on failure.
     # Whether save or destroy is executed depends on the value of `#destroy_context?`.
     #
@@ -91,28 +79,31 @@ module ActiveRecordCompose
     # @return [Boolean]
     def ==(other)
       return false unless self.class == other.class
-      return false unless __raw_model == other.__raw_model # steep:ignore
+      return false unless model == other.model
 
       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
+    protected
+
+    attr_reader :model
 
     private
 
-    attr_reader :model, :destroy_context_type
+    attr_reader :destroy_context_type, :if_option
 
-    def deprecator
-      if ActiveRecord.respond_to?(:deprecator)
-        ActiveRecord.deprecator
-      else # for rails 7.0.x or lower
-        ActiveSupport::Deprecation
+    # @private
+    # steep:ignore:start
+    module PackagePrivate
+      refine InnerModel do
+        # @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
       end
     end
+    # steep:ignore:end
   end
 end

data/lib/active_record_compose/inner_model_collection.rb

@@ -3,6 +3,8 @@
 require 'active_record_compose/inner_model'
 
 module ActiveRecordCompose
+  using InnerModel::PackagePrivate # steep:ignore
+
   class InnerModelCollection
     include Enumerable
 
@@ -38,9 +40,11 @@ module ActiveRecordCompose
     # @param destroy [Boolean] given true, destroy model.
     # @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.
+    # @param if [Proc] evaluation result is false, it will not be included in the renewal.
+    # @param if [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, if: nil)
+      models << wrap(model, destroy:, if:)
       self
     end
 
@@ -63,41 +67,18 @@ module ActiveRecordCompose
     # @param model [Object] the model instance
     # @return [self] Successful deletion
     # @return [nil] If deletion fails
-    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
-
+    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.
-    #
-    # @yieldparam [InnerModel] rawpped model instance.
-    # @return [Enumerator] when not block given.
-    # @return [self] when block given, returns itself.
-    def __each_by_wrapped
-      return enum_for(:__each_by_wrapped) unless block_given?
-
-      models.each { yield _1 if _1.__raw_model } # steep:ignore
-      self
-    end
-
     private
 
     attr_reader :owner, :models
 
-    def wrap(model, destroy: false, context: nil)
+    def wrap(model, destroy: false, if: nil)
       if model.is_a?(ActiveRecordCompose::InnerModel) # steep:ignore
         # @type var model: ActiveRecordCompose::InnerModel
         model
@@ -106,17 +87,26 @@ module ActiveRecordCompose
           method = destroy
           destroy = -> { owner.__send__(method) }
         end
-        # @type var model: ActiveRecordCompose::_ARLike
-        ActiveRecordCompose::InnerModel.new(model, destroy:, context:)
+        if_option = binding.local_variable_get(:if)
+        if if_option.is_a?(Symbol)
+          method = if_option
+          if_option = -> { owner.__send__(method) }
+        end
+        ActiveRecordCompose::InnerModel.new(model, destroy:, if: if_option)
       end
     end
 
-    def deprecator
-      if ActiveRecord.respond_to?(:deprecator)
-        ActiveRecord.deprecator # steep:ignore
-      else # for rails 7.0.x or lower
-        ActiveSupport::Deprecation
+    # @private
+    # steep:ignore:start
+    module PackagePrivate
+      refine InnerModelCollection do
+        # Returns array of wrapped model instance.
+        #
+        # @private
+        # @return [Array[InnerModel] array of wrapped model instance.
+        def __wrapped_models = models.reject { _1.ignore? }.select { _1.__raw_model }
       end
     end
+    # steep:ignore:end
   end
 end

data/lib/active_record_compose/model.rb

@@ -5,6 +5,8 @@ require 'active_record_compose/inner_model_collection'
 require 'active_record_compose/transaction_support'
 
 module ActiveRecordCompose
+  using InnerModelCollection::PackagePrivate # steep:ignore
+
   class Model
     include ActiveModel::Model
     include ActiveModel::Validations::Callbacks
@@ -150,11 +152,15 @@ module ActiveRecordCompose
 
     def models = @__models ||= ActiveRecordCompose::InnerModelCollection.new(self)
 
-    def wrapped_models = models.__each_by_wrapped # steep:ignore
-
-    def validate_models = wrapped_models.select { _1.invalid? }.each { errors.merge!(_1) }
+    def validate_models
+      wms = models.__wrapped_models # steep:ignore
+      wms.select { _1.invalid? }.each { errors.merge!(_1) }
+    end
 
-    def save_models(bang:) = wrapped_models.all? { bang ? _1.save! : _1.save }
+    def save_models(bang:)
+      wms = models.__wrapped_models # steep:ignore
+      wms.all? { bang ? _1.save! : _1.save }
+    end
 
     def raise_validation_error = raise ActiveRecord::RecordInvalid, self
 

data/lib/active_record_compose/version.rb

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

data/sig/active_record_compose.rbs

@@ -12,12 +12,12 @@ module ActiveRecordCompose
     def invalid?: -> bool
     def valid?: -> bool
     def errors: -> untyped
+    def ==: (untyped) -> bool
   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))
+  type condition_type = ((^() -> boolish) | (^(_ARLike) -> boolish))
 
   module DelegateAttribute
     extend ActiveSupport::Concern
@@ -35,20 +35,21 @@ module ActiveRecordCompose
     def initialize: (Model) -> void
     def each: () { (_ARLike) -> void } -> InnerModelCollection | () -> Enumerator[_ARLike, self]
     def <<: (_ARLike) -> self
-    def push: (_ARLike, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> self
+    def push: (_ARLike, ?destroy: destroy_context_type, ?if: (nil | Symbol | condition_type)) -> self
     def empty?: -> bool
     def clear: -> self
-    def delete: (_ARLike | InnerModel, ?destroy: (nil | destroy_context_type), ?context: (nil | context | context_proc)) -> InnerModelCollection?
+    def delete: (_ARLike | InnerModel) -> InnerModelCollection?
 
     private
     attr_reader owner: Model
     attr_reader models: Array[InnerModel]
-    def wrap: (_ARLike | InnerModel, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> InnerModel
+    def wrap: (_ARLike | InnerModel, ?destroy: destroy_context_type, ?if: (nil | Symbol | condition_type)) -> InnerModel
   end
 
   class InnerModel
-    def initialize: (_ARLike, ?destroy: destroy_context_type, ?context: (nil | context | context_proc)) -> void
+    def initialize: (_ARLike, ?destroy: destroy_context_type, ?if: (nil | condition_type)) -> void
     def destroy_context?: -> bool
+    def ignore?: -> bool
     def save: -> bool
     def save!: -> untyped
     def invalid?: -> bool
@@ -58,6 +59,7 @@ module ActiveRecordCompose
     private
     attr_reader model: _ARLike
     attr_reader destroy_context_type: destroy_context_type
+    attr_reader if_option: (nil | condition_type)
   end
 
   class Model
@@ -83,7 +85,6 @@ module ActiveRecordCompose
 
     private
     def models: -> InnerModelCollection
-    def wrapped_models: -> Enumerator[InnerModel, InnerModelCollection]
     def validate_models: -> void
     def save_models: (bang: bool) -> bool
     def raise_validation_error: -> bot

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-11-11 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.1
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.6.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.21
 signing_key:
 specification_version: 4
 summary: activemodel form object pattern