active_record_compose 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 690ecf032eb0a4c59c97394702c838142a4d519145f72e58f9a381d956cad5ce
-  data.tar.gz: 7133a2f5defa0d1c97dac41b207936512f6d5375e8f534ea77dc6c13c3f61dde
+  metadata.gz: dba7d13bf8f2dc9ef449ead00c1a7ae3fff83e216f07b5d11606659a3c1f4650
+  data.tar.gz: 883a9480ff3e6bd4c99246c12200a7b5a6e44103c0d1c967ce97c4536aa478b1
 SHA512:
-  metadata.gz: 2680382210cf6eb2f8371cca7e656f8b00211361f00bf9aed7d2ee4f006a816eee6298a917e48c67d5b4f6149545f2ebb3e67bd5905946279c9e203e9e378d82
-  data.tar.gz: 63aa5b0a8abcbcd59eb81aadadf4c8207622988ad417b09d2e8f977615ed8726233ae8f257f8d8847e16e38f400955e0bda1d9340f9c7733f06ea8d76fa4854a
+  metadata.gz: 905bf7969733f738e00726f0dc7ed1442bce1f598485a72a0478fd67069c556b5d8299fdc5485636b1194e095649df550ba9f3c01ffb42c107a8a69afcde85ae
+  data.tar.gz: 22f44a63d515d31682f22641e112c3bf720c5b3ff29c8fb0a30ceb777b23847a74f053eb3591211c35bfe2e2f96de345523236d08b30365059fc3a7421437bf4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.9.0] - 2025-03-16
+
+- removed `persisted_flag_callback_control` support.
+- Omitted `:private` option from `delegate_attribute` because, assuming the
+  behavior and use cases of `ActiveModel::Attributes.attribute`, making it private is unnecessary.
+- Added the URL for the sample application to the README
+
 ## [0.8.0] - 2025-02-22
 
 - changed `persisted_flag_callback_control` default from `false` to `true`.

data/README.md

@@ -286,18 +286,11 @@ end
 
 ### Callback ordering by `#persisted?`
 
-The behavior of `(before|after|around)_create` and `(before|after|around)_update` hooks depends on
-the state of the `persisted_flag_callback_control` setting.
-default value is `true`, behavior when set to `false` will be removed in the next release.
-
-When `persisted_flag_callback_control` is set to `true`, it behaves almost like callback control in ActiveRecord.
-Depending on the evaluation result of `#persisted?`,
+The behavior of `(before|after|around)_create` and `(before|after|around)_update` hooks depending on the evaluation result of `#persisted?`,
 either the create-related callbacks or the update-related callbacks will be triggered.
 
 ```ruby
 class ComposedModel < ActiveRecordCompose::Model
-  self.persisted_flag_callback_control = true # In the future, true will be the default and false will no longer be supported.
-
   # ...
 
   before_save { puts 'before_save called!' }
@@ -345,48 +338,10 @@ model.save # or `model.update` (the same callbacks will be triggered in all case
 # after_save called!
 ```
 
-When `persisted_flag_callback_control` is set to false,
-the execution of `#create`, `#update`, or `#save` determines which callbacks will be triggered.
-This behavior will no longer be supported in the next release.
-
-```ruby
-class ComposedModel < ActiveRecordCompose::Model
-  self.persisted_flag_callback_control = false # Currently defaults to false, but will no longer be supported in the future.
-
-  # ...
-
-  before_save { puts 'before_save called!' }
-  before_create { puts 'before_create called!' }
-  before_update { puts 'before_update called!' }
-  after_save { puts 'after_save called!' }
-  after_create { puts 'after_create called!' }
-  after_update { puts 'after_update called!' }
-end
-```
-
-```ruby
-model = ComposedModel.new
-
-model.save
-# before_save called!
-# after_save called!
-
-model.create
-# before_save called!
-# before_create called!
-# after_create called!
-# after_save called!
-
-model.update
-# before_save called!
-# before_update called!
-# after_update called!
-# after_save called!
-```
-
 ## Links
 
 - [Smart way to update multiple models simultaneously in Rails](https://dev.to/hamajyotan/smart-way-to-update-multiple-models-simultaneously-in-rails-51b6)
+- [Sample application as an example](https://github.com/hamajyotan/active_record_compose-example)
 
 ## Development
 

data/lib/active_record_compose/delegate_attribute.rb

@@ -45,7 +45,7 @@ module ActiveRecordCompose
     module ClassMethods
       # Defines the reader and writer for the specified attribute.
       #
-      def delegate_attribute(*attributes, to:, allow_nil: nil, private: nil)
+      def delegate_attribute(*attributes, to:, allow_nil: nil)
         delegates = attributes.flat_map do |attribute|
           reader = attribute.to_s
           writer = "#{attribute}="
@@ -53,7 +53,7 @@ module ActiveRecordCompose
           [reader, writer]
         end
 
-        delegate(*delegates, to:, allow_nil:, private:)
+        delegate(*delegates, to:, allow_nil:)
         self.delegated_attributes = delegated_attributes.to_a + attributes.map { _1.to_s }
       end
     end

data/lib/active_record_compose/model.rb

@@ -15,46 +15,6 @@ module ActiveRecordCompose
     include ActiveRecordCompose::DelegateAttribute
     include ActiveRecordCompose::TransactionSupport
 
-    # This flag controls the callback sequence for models.
-    # The current default value is `true`, behavior when set to `false` will be removed in the next release.
-    #
-    # When `persisted_flag_callback_control` is set to `true`,
-    # the occurrence of callbacks depends on the evaluation result of `#persisted?`.
-    # Additionally, the definition of `#persisted?` itself can be appropriately overridden in subclasses.
-    #
-    # if `#persisted?` returns `false`:
-    # * before_save
-    # * before_create
-    # * after_create
-    # * after_save
-    #
-    # if `#persisted?` returns `true`:
-    # * before_save
-    # * before_update
-    # * after_update
-    # * after_save
-    #
-    # On the other hand, when `persisted_flag_callback_control` is set to `false`,
-    # the invoked methods during saving operations vary depending on the method used.
-    #
-    # when performing `#save` or `#save!`:
-    # * before_save
-    # * after_save
-    #
-    # when performing `#update` or `#update!`:
-    # * before_save
-    # * before_update
-    # * after_update
-    # * after_save
-    #
-    # when performing `#create` or `#create!`:
-    # * before_save
-    # * before_create
-    # * after_create
-    # * after_save
-    #
-    class_attribute :persisted_flag_callback_control, instance_accessor: false, default: true
-
     define_model_callbacks :save
     define_model_callbacks :create
     define_model_callbacks :update
@@ -70,23 +30,16 @@ module ActiveRecordCompose
     #
     # The save is performed within a single transaction.
     #
+    # Options like `:validate` and `:context` are not accepted as arguments.
+    # The need for such values indicates that operations from multiple contexts are being handled.
+    # However, if the contexts are different, it is recommended to separate them into different model definitions.
+    #
     # @return [Boolean] returns true on success, false on failure.
     def save
       return false if invalid?
 
       with_transaction_returning_status do
-        if self.class.persisted_flag_callback_control
-          with_callbacks { save_models(bang: false) }
-        else
-          # steep:ignore:start
-          deprecator.warn(
-            'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-            'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-            '(Alternatively, exclude statements that set `false`)',
-          )
-          # steep:ignore:end
-          run_callbacks(:save) { save_models(bang: false) }
-        end
+        with_callbacks { save_models(bang: false) }
       rescue ActiveRecord::RecordInvalid
         false
       end
@@ -97,165 +50,31 @@ module ActiveRecordCompose
     #
     # Saving, like `#save`, is performed within a single transaction.
     #
-    def save!
-      valid? || raise_validation_error
-
-      with_transaction_returning_status do
-        if self.class.persisted_flag_callback_control
-          with_callbacks { save_models(bang: true) }
-        else
-          # steep:ignore:start
-          deprecator.warn(
-            'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-            'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-            '(Alternatively, exclude statements that set `false`)',
-          )
-          # steep:ignore:end
-          run_callbacks(:save) { save_models(bang: true) }
-        end
-      end || raise_on_save_error
-    end
-
-    # Behavior is same to `#save`, but `before_create` and `after_create` hooks fires.
-    #
-    #   class ComposedModel < ActiveRecordCompose::Model
-    #     # ...
-    #
-    #     before_save { puts 'before_save called!' }
-    #     before_create { puts 'before_create called!' }
-    #     before_update { puts 'before_update called!' }
-    #     after_save { puts 'after_save called!' }
-    #     after_create { puts 'after_create called!' }
-    #     after_update { puts 'after_update called!' }
-    #   end
-    #
-    #   model = ComposedModel.new
+    # Options like `:validate` and `:context` are not accepted as arguments.
+    # The need for such values indicates that operations from multiple contexts are being handled.
+    # However, if the contexts are different, it is recommended to separate them into different model definitions.
     #
-    #   model.save
-    #   # before_save called!
-    #   # after_save called!
-    #
-    #   model.create
-    #   # before_save called!
-    #   # before_create called!
-    #   # after_create called!
-    #   # after_save called!
-    #
-    # @deprecated
-    def create(attributes = {})
-      if self.class.persisted_flag_callback_control
-        raise '`#create` cannot be called. The context for creation or update is determined by the `#persisted` flag.'
-      end
-
-      # steep:ignore:start
-      deprecator.warn(
-        'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-        'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-        '(Alternatively, exclude statements that set `false`)',
-      )
-      # steep:ignore:end
-
-      assign_attributes(attributes)
-      return false if invalid?
-
-      with_transaction_returning_status do
-        with_callbacks(context: :create) { save_models(bang: false) }
-      rescue ActiveRecord::RecordInvalid
-        false
-      end
-    end
-
-    # Behavior is same to `#create`, but raises an exception prematurely on failure.
-    #
-    # @deprecated
-    def create!(attributes = {})
-      if self.class.persisted_flag_callback_control
-        raise '`#create` cannot be called. The context for creation or update is determined by the `#persisted` flag.'
-      end
-
-      # steep:ignore:start
-      deprecator.warn(
-        'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-        'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-        '(Alternatively, exclude statements that set `false`)',
-      )
-      # steep:ignore:end
-
-      assign_attributes(attributes)
+    def save!
       valid? || raise_validation_error
 
       with_transaction_returning_status do
-        with_callbacks(context: :create) { save_models(bang: true) }
+        with_callbacks { save_models(bang: true) }
       end || raise_on_save_error
     end
 
-    # Behavior is same to `#save`, but `before_update` and `after_update` hooks fires.
-    #
-    #   class ComposedModel < ActiveRecordCompose::Model
-    #     # ...
-    #
-    #     before_save { puts 'before_save called!' }
-    #     before_create { puts 'before_create called!' }
-    #     before_update { puts 'before_update called!' }
-    #     after_save { puts 'after_save called!' }
-    #     after_create { puts 'after_create called!' }
-    #     after_update { puts 'after_update called!' }
-    #   end
-    #
-    #   model = ComposedModel.new
-    #
-    #   model.save
-    #   # before_save called!
-    #   # after_save called!
-    #
-    #   model.update
-    #   # before_save called!
-    #   # before_update called!
-    #   # after_update called!
-    #   # after_save called!
+    # Assign attributes and save.
     #
+    # @return [Boolean] returns true on success, false on failure.
     def update(attributes = {})
       assign_attributes(attributes)
-      return false if invalid?
-
-      with_transaction_returning_status do
-        if self.class.persisted_flag_callback_control
-          with_callbacks { save_models(bang: false) }
-        else
-          # steep:ignore:start
-          deprecator.warn(
-            'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-            'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-            '(Alternatively, exclude statements that set `false`)',
-          )
-          # steep:ignore:end
-          with_callbacks(context: :update) { save_models(bang: false) }
-        end
-      rescue ActiveRecord::RecordInvalid
-        false
-      end
+      save
     end
 
     # Behavior is same to `#update`, but raises an exception prematurely on failure.
     #
     def update!(attributes = {})
       assign_attributes(attributes)
-      valid? || raise_validation_error
-
-      with_transaction_returning_status do
-        if self.class.persisted_flag_callback_control
-          with_callbacks { save_models(bang: true) }
-        else
-          # steep:ignore:start
-          deprecator.warn(
-            'The behavior with `persisted_flag_callback_control` set to `false` will be removed in 0.9.0. ' \
-            'Use `self.persisted_flag_callback_control = true` set to `true`. ' \
-            '(Alternatively, exclude statements that set `false`)',
-          )
-          # steep:ignore:end
-          with_callbacks(context: :update) { save_models(bang: true) }
-        end
-      end || raise_on_save_error
+      save!
     end
 
     # Returns true if model is persisted.
@@ -275,13 +94,9 @@ module ActiveRecordCompose
       models.__wrapped_models.lazy.select { _1.invalid? }.each { errors.merge!(_1) }
     end
 
-    def with_callbacks(context: nil, &block)
-      run_callbacks(:save) { run_callbacks(callback_context(context:), &block) }
-    end
+    def with_callbacks(&block) = run_callbacks(:save) { run_callbacks(callback_context, &block) }
 
-    def callback_context(context: nil)
-      context || (persisted? ? :update : :create)
-    end
+    def callback_context = persisted? ? :update : :create
 
     def save_models(bang:)
       models.__wrapped_models.all? { bang ? _1.save! : _1.save }
@@ -292,13 +107,5 @@ module ActiveRecordCompose
     def raise_on_save_error = raise ActiveRecord::RecordNotSaved.new(raise_on_save_error_message, self)
 
     def raise_on_save_error_message = 'Failed to save the model.'
-
-    def deprecator
-      if ActiveRecord.respond_to?(:deprecator)
-        ActiveRecord.deprecator # steep:ignore
-      else # for rails 7.0.x or lower
-        ActiveSupport::Deprecation
-      end
-    end
   end
 end

data/lib/active_record_compose/version.rb

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

data/sig/_internal/package_private.rbs

@@ -24,7 +24,7 @@ module ActiveRecordCompose
     def delegated_attributes: () -> Array[String]
 
     module ClassMethods : Module
-      def delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?, ?private: untyped?) -> untyped
+      def delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?) -> untyped
       def delegated_attributes: () -> Array[String]
       def delegated_attributes=: (Array[String]) -> untyped
     end

data/sig/active_record_compose.rbs

@@ -69,10 +69,7 @@ module ActiveRecordCompose
     def self.after_commit: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
     def self.after_rollback: (*callback[instance], ?if: condition[instance], ?unless: condition[instance], **untyped) ?{ () [self: instance] -> void } -> void
 
-    def self.persisted_flag_callback_control: () -> boolish
-    def self.persisted_flag_callback_control=: (boolish) -> untyped
-
-    def self.delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?, ?private: untyped?) -> untyped
+    def self.delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?) -> untyped
     def self.connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
     def self.lease_connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
     def self.with_connection: [T] () { () -> T } -> T
@@ -88,8 +85,8 @@ module ActiveRecordCompose
 
     private
     def models: -> ComposedCollection
-    def with_callbacks: (?context: (nil | :create | :update)) { () -> bool } -> bool
-    def callback_context: (?context: (nil | :create | :update)) -> (:create | :update)
+    def with_callbacks: { () -> bool } -> bool
+    def callback_context: -> (:create | :update)
     def validate_models: -> void
     def save_models: (bang: bool) -> bool
     def raise_validation_error: -> bot

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - hamajyotan
 bindir: bin
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-03-16 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.8.0
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.9.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: