active_record_compose 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab0bb2d4ff8813ad8fb9a4830c2b1d3887aaa29702f11561c9c8624719a5082f
-  data.tar.gz: a3fcfb870aaf5a0825a218556423cc1af16644b41ec22f0b4d656cb42cd33790
+  metadata.gz: dba7d13bf8f2dc9ef449ead00c1a7ae3fff83e216f07b5d11606659a3c1f4650
+  data.tar.gz: 883a9480ff3e6bd4c99246c12200a7b5a6e44103c0d1c967ce97c4536aa478b1
 SHA512:
-  metadata.gz: d5a1ea42bd83a986437faac38b2543ee48aff7f2003afa6267a7adcd325db1bbb0506f4f1f25e2aaa13b733df7956ebd820627821f19101fc36dd4f046a51c43
-  data.tar.gz: 4a9cc98fddbcf1068720387207469cb527b96e536a9f109a6174b5a439daa383f54a1625e916c731d01883cf360c6e01281858a238796b5cb64b92665c2405c3
+  metadata.gz: 905bf7969733f738e00726f0dc7ed1442bce1f598485a72a0478fd67069c556b5d8299fdc5485636b1194e095649df550ba9f3c01ffb42c107a8a69afcde85ae
+  data.tar.gz: 22f44a63d515d31682f22641e112c3bf720c5b3ff29c8fb0a30ceb777b23847a74f053eb3591211c35bfe2e2f96de345523236d08b30365059fc3a7421437bf4

data/.rubocop.yml

@@ -21,6 +21,9 @@ Style/DoubleNegation:
 Style/NumericPredicate:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
 
@@ -48,6 +51,9 @@ Layout/LeadingCommentSpace:
 Layout/LineLength:
   Max: 120
 
+Lint/UselessMethodDefinition:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [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`.
+- adjusted to save errors as soon as an invalid is found.
+- drop support rails 6.1.x.
+
 ## [0.7.0] - 2025-02-12
 
 - rename ActiveRecordCompose::InnerModel to ActiveRecordCompose::WrappedModel

data/README.md

@@ -15,7 +15,7 @@ activemodel (activerecord) form object pattern. it embraces multiple AR models a
   - [I18n](#i18n)
 - [Advanced Usage](#advanced-usage)
   - [`destroy` option](#destroy-option)
-  - [Callback ordering by `#save`, `#create` and `#update`](#callback-ordering-by-save-create-and-update)
+  - [Callback ordering by `#persisted?`](#callback-ordering-by-persisted)
 - [Links](#links)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -284,57 +284,13 @@ class AccountRegistration < ActiveRecordCompose::Model
 end
 ```
 
-### Callback ordering by `#save`, `#create` and `#update`.
+### 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.
-
-When `persisted_flag_callback_control` is set to false,
-the execution of `#create`, `#update`, or `#save` determines which callbacks will be triggered.
-Currently, the default value is `false`, but it will no longer be supported in the future.
-
-```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!
-```
-
-When `persisted_flag_callback_control` is set to `true`, it behaves almost like callback control in ActiveRecord.
-This behavior will be the default in the future.
+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!' }
@@ -382,15 +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 `true`, `#create` is not supported.
-
-```ruby
-model.create  # => raises RuntimeError
-```
-
 ## 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 `false`, but support for `false` is planned to be discontinued in the future.
-    #
-    # 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: false
-
     define_model_callbacks :save
     define_model_callbacks :create
     define_model_callbacks :update
@@ -70,16 +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
-          run_callbacks(:save) { save_models(bang: false) }
-        end
+        with_callbacks { save_models(bang: false) }
       rescue ActiveRecord::RecordInvalid
         false
       end
@@ -90,140 +50,53 @@ 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
-          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
+    # 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 = ComposedModel.new
-    #
-    #   model.save
-    #   # before_save called!
-    #   # after_save called!
-    #
-    #   model.create
-    #   # before_save called!
-    #   # before_create called!
-    #   # after_create called!
-    #   # after_save called!
-    #
-    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
-
-      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.
-    #
-    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
-
-      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
-          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
-          with_callbacks(context: :update) { save_models(bang: true) }
-        end
-      end || raise_on_save_error
+      save!
     end
 
+    # Returns true if model is persisted.
+    #
+    # By overriding this definition, you can control the callbacks that are triggered when a save is made.
+    # For example, returning false will trigger before_create, around_create and after_create,
+    # and returning true will trigger before_update, around_update and after_update.
+    #
+    # @return [Boolean] returns true if model is persisted.
+    def persisted? = super
+
     private
 
     def models = @__models ||= ActiveRecordCompose::ComposedCollection.new(self)
 
     def validate_models
-      models.__wrapped_models.select { _1.invalid? }.each { errors.merge!(_1) }
+      models.__wrapped_models.lazy.select { _1.invalid? }.each { errors.merge!(_1) }
     end
 
-    def with_callbacks(context: nil, &block)
-      context ||= persisted? ? :update : :create
-      run_callbacks(:save) { run_callbacks(context, &block) }
-    end
+    def with_callbacks(&block) = run_callbacks(:save) { run_callbacks(callback_context, &block) }
+
+    def callback_context = persisted? ? :update : :create
 
     def save_models(bang:)
       models.__wrapped_models.all? { bang ? _1.save! : _1.save }

data/lib/active_record_compose/transaction_support.rb

@@ -28,6 +28,6 @@ module ActiveRecordCompose
     def id = nil
 
     def trigger_transactional_callbacks? = true
-    def restore_transaction_record_state(_force_restore_state = false) = nil # rubocop:disable Style/OptionalBooleanParameter
+    def restore_transaction_record_state(_force_restore_state = false) = nil
   end
 end

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = '0.7.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,7 +85,8 @@ module ActiveRecordCompose
 
     private
     def models: -> ComposedCollection
-    def with_callbacks: (?context: (nil | :create | :update)) { () -> bool } -> bool
+    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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - hamajyotan
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 description: activemodel form object pattern. it embraces multiple AR models and provides
   a transparent interface as if they were a single model.
 email:
@@ -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.7.0
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.9.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: