active_record_compose 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154ee35310ede836e5d89ecd703efadbbc2b7fba0a6229797e9b38b5288eba47
-  data.tar.gz: 42c565c5093680ae089bac356541561dc83ff73759941f268af22365338126db
+  metadata.gz: 954ce34124a1c8e83a45710e104dd965c407afb5ba296b74d4a4e5f9d13d971a
+  data.tar.gz: c1bb35ef5458a804f243b886c037aff3794822477ea2aaf5a57bfb12a4001477
 SHA512:
-  metadata.gz: a5a9f0a46534ea0dbb3423275a68b521543c67074d8fcd7c637d46f86fcc42f93ac6792b2d80f83b6a0aae367f6dd461e6fb4d0e06730f40da3aefd0751393e9
-  data.tar.gz: c5bb3aaae6e84b23bc264ce5a1ad7b369f248c1fb1f1494b2753a1a82681ecc3df8c5f10a6b68854cda319c65da59e69435dd1c4381f44ff585d81a2400b5bac
+  metadata.gz: 2e7f81f304cec10420cb4f405ad8ad7f93f3811c7f43bf9952c05dbca84e651bbf0c851e648349d7e93986cf67cb177110785588a47c8951718f4d271cf53944
+  data.tar.gz: 8ac490bd69c0d51e6e89f1f198a4e052eccbeedcf1b234edfa8c9635819fe336bbe10b6b64b6b55907524543ad34eb9343892b00f54f2737a65c45c120456afa

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.12.0] - 2025-08-21
+
+- Omits default arguments for `#update` and `#update!`. It's to align I/F with ActiveRecord.
+  (https://github.com/hamajyotan/active_record_compose/pull/25)
+  - `#update(attributes = {})` to `#update(attributes)`
+  - `#update!(attributes = {})` to `#update!(attributes)`
+- Omitted Specify instance variables in the `:to` option of `delegate_attribute`.
+  (https://github.com/hamajyotan/active_record_compose/pull/29)
+- Omitted `#destroy` and `#touch` from `ActiveRecordCompose::Model`.
+  These were unintentionally provided by the `ActiveRecord::Transactions` module. The but in fact did not work correctly.
+  (https://github.com/hamajyotan/active_record_compose/pull/27)
+
 ## [0.11.3] - 2025-07-13
 
 - refactor: Aggregation attribute module.

data/lib/active_record_compose/attributes/attribute_predicate.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActiveRecordCompose
+  module Attributes
+    # @private
+    class AttributePredicate
+      def initialize(value)
+        @value = value
+      end
+
+      def call
+        case value
+        when true then true
+        when false, nil then false
+        else
+          if value.respond_to?(:zero?)
+            !value.zero?
+          else
+            value.present?
+          end
+        end
+      end
+
+      private
+
+      attr_reader :value
+    end
+  end
+end

data/lib/active_record_compose/attributes/delegation.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "attribute_predicate"
+
 module ActiveRecordCompose
   module Attributes
     # @private
@@ -17,7 +19,11 @@ module ActiveRecordCompose
 
       def define_delegated_attribute(klass)
         klass.delegate(reader, writer, to:, allow_nil:)
-        klass.define_attribute_methods(attribute)
+        klass.module_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{reader}?
+            ActiveRecordCompose::Attributes::AttributePredicate.new(#{reader}).call
+          end
+        RUBY
       end
 
       # @return [String] The attribute name as string

data/lib/active_record_compose/attributes/querying.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "attribute_predicate"
+
 module ActiveRecordCompose
   module Attributes
     # @private
@@ -50,19 +52,10 @@ module ActiveRecordCompose
 
       private
 
-      def attribute?(attr_name)
-        value = public_send(attr_name)
+      def attribute?(attr_name) = query?(public_send(attr_name))
 
-        case value
-        when true then true
-        when false, nil then false
-        else
-          if value.respond_to?(:zero?)
-            !value.zero?
-          else
-            value.present?
-          end
-        end
+      def query?(value)
+        ActiveRecordCompose::Attributes::AttributePredicate.new(value).call
       end
     end
   end

data/lib/active_record_compose/attributes.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "attributes/attribute_predicate"
 require_relative "attributes/delegation"
 require_relative "attributes/querying"
 
@@ -62,9 +63,6 @@ module ActiveRecordCompose
     end
 
     module ClassMethods
-      ALLOW_NIL_DEFAULT = Object.new.freeze # steep:ignore
-      private_constant :ALLOW_NIL_DEFAULT
-
       # Defines the reader and writer for the specified attribute.
       #
       # @example
@@ -97,34 +95,10 @@ module ActiveRecordCompose
       #   registration.attributes
       #   # => { "original_attribute" => "qux", "name" => "bar" }
       #
-      def delegate_attribute(*attributes, to:, allow_nil: ALLOW_NIL_DEFAULT) # steep:ignore
-        # steep:ignore:start
+      def delegate_attribute(*attributes, to:, allow_nil: false)
         if to.start_with?("@")
-          suggested_reader_name = to.to_s.sub(/^@+/, "")
-          suggested_method =
-            if to.start_with?("@@")
-              "def #{suggested_reader_name} = #{to}"
-            else
-              "attr_reader :#{suggested_reader_name}"
-            end
-
-          message = <<~MSG
-            Direct use of instance or class variables in `to:` will be removed in the next minor version.
-            Please define a reader method (private is fine) and refer to it by name instead.
-
-            For example,
-                delegate_attribute #{attributes.map { ":#{_1}" }.join(", ")}, to: :#{to}#{", allow_nil: #{allow_nil}" if allow_nil != ALLOW_NIL_DEFAULT}
-
-            Instead of the above, use the following
-                delegate_attribute #{attributes.map { ":#{_1}" }.join(", ")}, to: :#{suggested_reader_name}#{", allow_nil: #{allow_nil}" if allow_nil != ALLOW_NIL_DEFAULT}
-                private
-                #{suggested_method}
-
-          MSG
-          (ActiveRecord.respond_to?(:deprecator) ? ActiveRecord.deprecator : ActiveSupport::Deprecation).warn(message)
+          raise ArgumentError, "Instance variables cannot be specified in delegate to. (#{to})"
         end
-        allow_nil = false if allow_nil == ALLOW_NIL_DEFAULT
-        # steep:ignore:end
 
         delegations = attributes.map { Delegation.new(attribute: _1, to:, allow_nil:) }
         delegations.each { _1.define_delegated_attribute(self) }

data/lib/active_record_compose/callbacks.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "validations"
-
 module ActiveRecordCompose
   # @private
   #
@@ -23,8 +21,6 @@ module ActiveRecordCompose
     include ActiveModel::Validations::Callbacks
 
     included do
-      include ActiveRecordCompose::Validations
-
       define_model_callbacks :save
       define_model_callbacks :create
       define_model_callbacks :update

data/lib/active_record_compose/model.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "attributes"
-require_relative "callbacks"
 require_relative "composed_collection"
 require_relative "persistence"
+require_relative "transaction_support"
+require_relative "validations"
 
 module ActiveRecordCompose
   # This is the core class of {ActiveRecordCompose}.
@@ -83,7 +84,8 @@ module ActiveRecordCompose
 
     include ActiveRecordCompose::Attributes
     include ActiveRecordCompose::Persistence
-    include ActiveRecordCompose::Callbacks
+    include ActiveRecordCompose::Validations
+    include ActiveRecordCompose::TransactionSupport
 
     begin
       # @group Model Core

data/lib/active_record_compose/persistence.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "callbacks"
 require_relative "composed_collection"
-require_relative "transaction_support"
 
 module ActiveRecordCompose
   using ComposedCollection::PackagePrivate
@@ -9,7 +9,7 @@ module ActiveRecordCompose
   # @private
   module Persistence
     extend ActiveSupport::Concern
-    include ActiveRecordCompose::TransactionSupport
+    include ActiveRecordCompose::Callbacks
 
     # Save the models that exist in models.
     # Returns false if any of the targets fail, true if all succeed.
@@ -24,11 +24,9 @@ module ActiveRecordCompose
     #
     # @return [Boolean] returns true on success, false on failure.
     def save(**options)
-      with_transaction_returning_status do
-        with_callbacks { save_models(**options, bang: false) }
-      rescue ActiveRecord::RecordInvalid
-        false
-      end
+      with_callbacks { save_models(**options, bang: false) }
+    rescue ActiveRecord::RecordInvalid
+      false
     end
 
     # Save the models that exist in models.
@@ -43,28 +41,22 @@ module ActiveRecordCompose
     # If the contexts differ, we recommend separating them into different model definitions.
     #
     def save!(**options)
-      with_transaction_returning_status do
-        with_callbacks { save_models(**options, bang: true) }
-      end || raise_on_save_error
+      with_callbacks { save_models(**options, bang: true) } || raise_on_save_error
     end
 
     # Assign attributes and save.
     #
     # @return [Boolean] returns true on success, false on failure.
-    def update(attributes = {})
-      with_transaction_returning_status do
-        assign_attributes(attributes)
-        save
-      end
+    def update(attributes)
+      assign_attributes(attributes)
+      save
     end
 
     # Behavior is same to `#update`, but raises an exception prematurely on failure.
     #
-    def update!(attributes = {})
-      with_transaction_returning_status do
-        assign_attributes(attributes)
-        save!
-      end
+    def update!(attributes)
+      assign_attributes(attributes)
+      save!
     end
 
     private

data/lib/active_record_compose/transaction_support.rb

@@ -6,18 +6,19 @@ module ActiveRecordCompose
     extend ActiveSupport::Concern
     include ActiveRecord::Transactions
 
-    module ClassMethods
-      def lease_connection
-        if ar_class.respond_to?(:lease_connection)
-          ar_class.lease_connection # steep:ignore
-        else
-          ar_class.connection
-        end
-      end
+    included do
+      # ActiveRecord::Transactions is defined so that methods such as save,
+      # destroy and touch are wrapped with_transaction_returning_status.
+      # However, ActiveRecordCompose::Model does not support destroy and touch, and
+      # we want to keep these operations as undefined behavior, so we remove the definition here.
+      undef_method :destroy, :touch
+    end
 
-      def connection = ar_class.connection
+    module ClassMethods
+      delegate :with_connection, :lease_connection, to: :ar_class
 
-      def with_connection(&) = ar_class.with_connection(&) # steep:ignore
+      # In ActiveRecord, it is soft deprecated.
+      delegate :connection, to: :ar_class
 
       def composite_primary_key? = false # steep:ignore
 

data/lib/active_record_compose/validations.rb

@@ -8,6 +8,7 @@ module ActiveRecordCompose
   # @private
   module Validations
     extend ActiveSupport::Concern
+    include ActiveModel::Validations::Callbacks
 
     included do
       validate :validate_models

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = "0.11.3"
+  VERSION = "0.12.0"
 end

data/sig/_internal/package_private.rbs

@@ -15,6 +15,16 @@ module ActiveRecordCompose
       def delegated_attributes=: (Array[Delegation]) -> untyped
     end
 
+    class AttributePredicate
+      def initialize: (untyped value) -> void
+      def call: -> bool
+
+      @value: untyped
+
+      private
+      attr_reader value: untyped
+    end
+
     class Delegation
       def initialize: (attribute: String, to: Symbol, ?allow_nil: bool) -> void
       def attribute: () -> Symbol
@@ -40,6 +50,7 @@ module ActiveRecordCompose
 
       private
       def attribute?: (attribute_name) -> untyped
+      def query?: (untyped value) -> bool
     end
   end
 
@@ -87,6 +98,7 @@ module ActiveRecordCompose
   end
 
   module TransactionSupport
+    extend ActiveSupport::Concern
     include ActiveRecord::Transactions
 
     def id: -> untyped
@@ -108,8 +120,8 @@ module ActiveRecordCompose
 
     def save: (**untyped options) -> bool
     def save!: (**untyped options) -> untyped
-    def update: (?Hash[attribute_name, untyped]) -> bool
-    def update!: (?Hash[attribute_name, untyped]) -> untyped
+    def update: (Hash[attribute_name, untyped]) -> bool
+    def update!: (Hash[attribute_name, untyped]) -> untyped
 
     private
     def models: -> ComposedCollection

data/sig/active_record_compose.rbs

@@ -79,14 +79,10 @@ module ActiveRecordCompose
     def initialize: (?Hash[attribute_name, untyped]) -> void
     def save: (**untyped options) -> bool
     def save!: (**untyped options) -> untyped
-    def update: (?Hash[attribute_name, untyped]) -> bool
-    def update!: (?Hash[attribute_name, untyped]) -> untyped
-    def id: -> untyped
+    def update: (Hash[attribute_name, untyped]) -> bool
+    def update!: (Hash[attribute_name, untyped]) -> untyped
 
     private
     def models: -> ComposedCollection
-    def save_models: (bang: bool, **untyped options) -> bool
-    def raise_on_save_error: -> bot
-    def raise_on_save_error_message: -> String
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - hamajyotan
@@ -45,6 +45,7 @@ files:
 - README.md
 - lib/active_record_compose.rb
 - lib/active_record_compose/attributes.rb
+- lib/active_record_compose/attributes/attribute_predicate.rb
 - lib/active_record_compose/attributes/delegation.rb
 - lib/active_record_compose/attributes/querying.rb
 - lib/active_record_compose/callbacks.rb