active_record_compose 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f089bd84bf403659ef6e4835080c952a07d7fb393aa7820c8b030294956f525
-  data.tar.gz: 9c9d6137b7c1d4715e89bc4c0f7c9e9965fdd3b9a2c265517ccac8568c3365fd
+  metadata.gz: 8d9e12c3cb3d2e8571d418957576a8cf5b5d3dbedb9e83e2bcd25f172def43f3
+  data.tar.gz: a991715192e6cb62e8b794860422667811b1fb1f985089e415b444f0b7bc0d4a
 SHA512:
-  metadata.gz: e6a6bc59528725186b32d4447de1b7883e831cbdbd0579bfd5dadc100290a385ecd8410da67d760bf8bccc8c5548f73401319cb18b2289d649ad06a70184d42d
-  data.tar.gz: 1b25e47a0c9a4c49d1b8141499357b7f32bd6d724e05958531e98d164db3d738c1cf19c1045df96eae4d441e1144af610a6472c2372f018c32021aff12d0fa3b
+  metadata.gz: 837b3d35c903eb0ff4400e5c83c438255d9ee02515407792fd19d24ab9a5a63cea1f9faa1d12a5fd5184d52fee2d662625e7c0d0b2a79e27ebb0866054a6b2a4
+  data.tar.gz: e245d8380a2d20f0c9bbbc1f24712f1d7982697bf90b172886dcd2c9bd666ace8ddd3b29a20b9bcc709d8a236a1395a41c0f53ccdb3869f66a527d5ad6be08dc

data/.rubocop.yml

@@ -12,6 +12,9 @@ Style/CommentedKeyword:
 Style/Documentation:
   Enabled: false
 
+Style/DoubleNegation:
+  Enabled: false
+
 Style/NumericPredicate:
   Enabled: false
 
@@ -39,6 +42,9 @@ Layout/LeadingCommentSpace:
 Layout/LineLength:
   Max: 120
 
+Metrics/AbcSize:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2024-09-15
+
+- support `destrpy` option. and deprecated `context` option.
+  `:context` will be removed in 0.5.0. Use `:destroy`  option instead.
+  for example,
+  - `models.push(model, context: :destroy)` is replaced by `models.push(model, destroy: true)`
+  - `models.push(model, context: -> { foo? ? :destroy : :save })` is replaced by `models.push(model, destroy: -> { foo? })`
+  - `models.push(model, context: ->(m) { m.bar? ? :destroy : :save })` is replaced by `models.push(model, destroy: ->(m) { m.bar? })`
+- `destroy` option can now be specified with a `Symbol` representing the method name.
+
 ## [0.3.4] - 2024-09-01
 
 - ci: removed sqlite3 version specifing for new AR.

data/README.md

@@ -156,7 +156,7 @@ Account.count  #=> 1
 Profile.count  #=> 1
 ```
 
-By adding to the `models` array while specifying `context: :destroy`, you can perform a delete instead of a save on the model at `#save` time.
+By adding to the `models` array while specifying `destroy: true`, you can perform a delete instead of a save on the model at `#save` time.
 
 ```ruby
 class AccountResignation < ActiveRecordCompose::Model
@@ -164,7 +164,7 @@ class AccountResignation < ActiveRecordCompose::Model
     @account = account
     @profile = account.profile  # Suppose that Account has_one Profile.
     models.push(account)
-    models.push(profile, context: :destroy)
+    models.push(profile, destroy: true)
   end
 
   attr_reader :account, :profile
@@ -193,6 +193,29 @@ account.resigned_at.present?  #=> Tue, 02 Jan 2024 22:58:01.991008870 JST +09:00
 account.profile.blank?        #=> true
 ```
 
+Conditional destroy (or save) can be written like this.
+
+```ruby
+class AccountRegistration < ActiveRecordCompose::Model
+  def initialize(account, attributes = {})
+    @account = account
+    @profile = account.profile || account.build_profile
+    super(attributes)
+    models.push(account)
+    models.push(profile, destroy: :all_blank?) # destroy if all blank, otherwise save.
+  end
+
+  delegate_attribute :name, :email, to: :account
+  delegate_attribute :firstname, :lastname, :age, to: :profile
+
+  private
+
+  attr_reader :account, :profile
+
+  def all_blank? = firstname.blank && lastname.blank? && age.blank?
+end
+```
+
 ### `delegate_attribute`
 
 It provides a macro description that expresses access to the attributes of the AR model through delegation.

data/lib/active_record_compose/inner_model.rb

@@ -5,67 +5,85 @@ require 'active_support/core_ext/object'
 module ActiveRecordCompose
   class InnerModel
     # @param model [Object] the model instance.
-    # @param context [Symbol] :save or :destroy
-    # @param context [Proc] proc returning either :save or :destroy
-    def initialize(model, context: :save)
+    # @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
       @model = model
-      @context = context
-    end
+      @destroy =
+        if context
+          c = context
 
-    delegate :errors, to: :model
+          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})`.",
+            )
 
-    # @return [Symbol] :save or :destroy
-    def context #: ActiveRecordCompose::context
-      c = @context
-      ret =
-        if c.is_a?(Proc)
-          if c.arity == 0
-            # @type var c: ^() -> context
-            c.call
+            # @type var c: (:save | :destory)
+            c == :destroy
           else
-            # @type var c: ^(_ARLike) -> context
-            c.call(model)
+            c
           end
         else
-          c
+          destroy
         end
-      ret.presence_in(%i[save destroy]) || :save
     end
 
-    # Execute save or destroy. Returns true on success, false on failure.
-    # Whether save or destroy is executed depends on the value of context.
-    #
-    # @return [Boolean] returns true on success, false on failure.
-    def save
-      case context
-      when :destroy
-        model.destroy
+    delegate :errors, to: :model
+
+    def destroy_context?
+      d = destroy
+      if d.is_a?(Proc)
+        if d.arity == 0
+          # @type var d: ^() -> (bool | context)
+          d.call
+        else
+          # @type var d: ^(_ARLike) -> (bool | context)
+          d.call(model)
+        end
+      elsif d.is_a?(Symbol)
+        owner.send(d)
       else
-        model.save
+        !!d
       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?`.
+    #
+    # @return [Boolean] returns true on success, false on failure.
+    def save = destroy_context? ? model.destroy : model.save
+
     # Execute save or destroy. Unlike #save, an exception is raises on failure.
-    # Whether save or destroy is executed depends on the value of context.
+    # Whether save or destroy is executed depends on the value of `#destroy_context?`.
     #
-    def save!
-      case context
-      when :destroy
-        model.destroy!
-      else
-        model.save!
-      end
-    end
+    def save! = destroy_context? ? model.destroy! : model.save!
 
     # @return [Boolean]
-    def invalid?
-      case context
-      when :destroy
-        false
-      else
-        model.invalid?
-      end
-    end
+    def invalid? = destroy_context? ? false : model.invalid?
 
     # @return [Boolean]
     def valid? = !invalid?
@@ -76,8 +94,8 @@ 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 context == other.context
+      return false unless __raw_model == other.__raw_model
+      return false unless __destroy == other.__destroy
 
       true
     end
@@ -88,8 +106,23 @@ module ActiveRecordCompose
     # @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 :model
+    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
   end
 end

data/lib/active_record_compose/inner_model_collection.rb

@@ -6,6 +6,10 @@ module ActiveRecordCompose
   class InnerModelCollection
     include Enumerable
 
+    def initialize(owner)
+      @owner = owner
+    end
+
     # Enumerates model objects.
     #
     # @yieldparam [Object] the model instance
@@ -23,17 +27,18 @@ module ActiveRecordCompose
     # @param model [Object] the model instance
     # @return [self] returns itself.
     def <<(model)
-      models << wrap(model, context: :save)
+      models << wrap(model, destroy: false)
       self
     end
 
     # Appends model to collection.
     #
     # @param model [Object] the model instance
+    # @param destroy [Boolean] given true, destroy model.
     # @param context [Symbol] :save or :destroy
     # @return [self] returns itself.
-    def push(model, context: :save)
-      models << wrap(model, context:)
+    def push(model, destroy: false, context: nil)
+      models << wrap(model, destroy:, context:)
       self
     end
 
@@ -54,11 +59,12 @@ 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, context: :save)
-      wrapped = wrap(model, context:)
+    def delete(model, destroy: false, context: nil)
+      wrapped = wrap(model, destroy:, context:)
       return nil unless models.delete(wrapped)
 
       self
@@ -79,15 +85,17 @@ module ActiveRecordCompose
 
     private
 
+    attr_reader :owner
+
     def models = @models ||= []
 
-    def wrap(model, context:)
+    def wrap(model, destroy:, context: nil)
       if model.is_a?(ActiveRecordCompose::InnerModel) # steep:ignore
         # @type var model: ActiveRecordCompose::InnerModel
         model
       else
         # @type var model: ActiveRecordCompose::_ARLike
-        ActiveRecordCompose::InnerModel.new(model, context:)
+        ActiveRecordCompose::InnerModel.new(owner, model, destroy:, context:)
       end
     end
   end

data/lib/active_record_compose/model.rb

@@ -148,7 +148,7 @@ module ActiveRecordCompose
 
     private
 
-    def models = @__models ||= ActiveRecordCompose::InnerModelCollection.new
+    def models = @__models ||= ActiveRecordCompose::InnerModelCollection.new(self)
 
     def wrapped_models = models.__each_by_wrapped # steep:ignore
 

data/lib/active_record_compose/version.rb

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

data/sig/active_record_compose.rbs

@@ -30,25 +30,29 @@ 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, ?context: (context | context_proc)) -> self
+    def push: (_ARLike, ?destroy: bool, ?context: (nil | context | context_proc)) -> self
     def empty?: -> bool
     def clear: -> self
-    def delete: (_ARLike | InnerModel, ?context: (context | context_proc)) -> InnerModelCollection?
+    def delete: (_ARLike | InnerModel, ?destroy: bool, ?context: (nil | context | context_proc)) -> InnerModelCollection?
 
     private
+    attr_reader owner: Model
     def models: -> Array[InnerModel]
-    def wrap: (_ARLike | InnerModel, context: (context | context_proc)) -> InnerModel
+    def wrap: (_ARLike | InnerModel, destroy: bool, ?context: (nil | context | context_proc)) -> InnerModel
   end
 
   class InnerModel
+    @owner: Model
     @context: (context | context_proc)
 
-    def initialize: (_ARLike, ?context: (context | context_proc)) -> void
-    def context: -> context
+    def initialize: (Model, _ARLike, ?destroy: bool, ?context: (nil | context | context_proc)) -> void
+    def destroy_context?: -> bool
     def save: -> bool
     def save!: -> untyped
     def invalid?: -> bool
@@ -56,6 +60,7 @@ module ActiveRecordCompose
     def ==: (untyped) -> bool
 
     private
+    attr_reader owner: Model
     attr_reader model: _ARLike
   end
 

metadata

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