active_record_compose 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3112ceb79671ca112aa5dde2222e10a0bd4daed96f82ebaa641746165d8991
-  data.tar.gz: e021f41a5e3334b0e91f170712c011679023a384bbfe17c3df2a97858747323e
+  metadata.gz: 701c396babd7d30d3e13779c5237bd1fbaf2fb719a75439154d17a167dc645dc
+  data.tar.gz: 72cf835561b903fc913e9feadff380f8ca986f621320b1fdd1ebd7dc341539cb
 SHA512:
-  metadata.gz: 56cb8c6d615cbefb58fc774e96caa9add4cb72a8ca34188ce2d713f6b4f32ef75b7df4f273da2bd6966d08c1a8f1aadbeef838f3c5b436e5f1122efb7af5a961
-  data.tar.gz: 0aec57e80f57d0c3d1bf1d45e4cb39c3cebcae47c53a35b630817de592bd3893604ff58563eed2c6b23f4199d2f27bc39804a1a9e6fe20bbdb809defaae30e28
+  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,11 @@
 ## [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.

data/lib/active_record_compose/inner_model.rb

@@ -7,9 +7,11 @@ 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)
+    # @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 = destroy
+      @if_option = binding.local_variable_get(:if)
     end
 
     delegate :errors, to: :model
@@ -38,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?`.
     #
@@ -61,20 +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
+
+    # @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)
-      models << wrap(model, destroy:)
+    def push(model, destroy: false, if: nil)
+      models << wrap(model, destroy:, if:)
       self
     end
 
@@ -70,25 +74,11 @@ module ActiveRecordCompose
       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)
+    def wrap(model, destroy: false, if: nil)
       if model.is_a?(ActiveRecordCompose::InnerModel) # steep:ignore
         # @type var model: ActiveRecordCompose::InnerModel
         model
@@ -97,9 +87,26 @@ module ActiveRecordCompose
           method = destroy
           destroy = -> { owner.__send__(method) }
         end
-        # @type var model: ActiveRecordCompose::_ARLike
-        ActiveRecordCompose::InnerModel.new(model, destroy:)
+        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
+
+    # @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.5.0'
+  VERSION = '0.6.0'
 end

data/sig/active_record_compose.rbs

@@ -12,10 +12,12 @@ module ActiveRecordCompose
     def invalid?: -> bool
     def valid?: -> bool
     def errors: -> untyped
+    def ==: (untyped) -> bool
   end
 
   type attribute_name = (String | Symbol)
   type destroy_context_type = (bool | Symbol | (^() -> boolish) | (^(_ARLike) -> boolish))
+  type condition_type = ((^() -> boolish) | (^(_ARLike) -> boolish))
 
   module DelegateAttribute
     extend ActiveSupport::Concern
@@ -33,7 +35,7 @@ module ActiveRecordCompose
     def initialize: (Model) -> void
     def each: () { (_ARLike) -> void } -> InnerModelCollection | () -> Enumerator[_ARLike, self]
     def <<: (_ARLike) -> self
-    def push: (_ARLike, ?destroy: destroy_context_type) -> self
+    def push: (_ARLike, ?destroy: destroy_context_type, ?if: (nil | Symbol | condition_type)) -> self
     def empty?: -> bool
     def clear: -> self
     def delete: (_ARLike | InnerModel) -> InnerModelCollection?
@@ -41,12 +43,13 @@ module ActiveRecordCompose
     private
     attr_reader owner: Model
     attr_reader models: Array[InnerModel]
-    def wrap: (_ARLike | InnerModel, ?destroy: destroy_context_type) -> 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) -> 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
@@ -56,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
@@ -81,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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 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.5.0
+  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.11
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: activemodel form object pattern