active_record_compose 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701c396babd7d30d3e13779c5237bd1fbaf2fb719a75439154d17a167dc645dc
-  data.tar.gz: 72cf835561b903fc913e9feadff380f8ca986f621320b1fdd1ebd7dc341539cb
+  metadata.gz: 88e574f327847973e3b931ee6663de0d395fa6ff26de5830f92ac21d1445fe20
+  data.tar.gz: bb50aa19e200f15c3b16d6b7fe65dc4e94afc7e44eec3c94ef37ab18fc610b88
 SHA512:
-  metadata.gz: fddabb884fb62e215cc5a67abe823b563cf5be201f2e05b8057871e2c188025e04d46b5953b84f23e7cdc064840291882cb3f77a93efb221bed3b0c99a6dfe71
-  data.tar.gz: 7b550abe98e5391de53a9b017b8ae214270844f8d6536dadb012587c1d553e4e01cab99f480ec59ae01eaf3d0b742c612ea676546cc7ce82ea945d0e99e0168d
+  metadata.gz: 77a492aea1e8c5aec20bea84dbbd242c2f94d9d5674a705cacea4ad4b8b3991b54630009fb78ed425a6dee5f10d28dd5f473b7b581a92711701de07472d7a88f
+  data.tar.gz: a8386a77e58cb7db6c2478137af7bf24e606448987009257b151c695b746be9818de2d963b65672cc60e23b9a8dc7d0b29790087ea3a8271152c0115d2212bdf

data/.rubocop.yml

@@ -9,6 +9,9 @@ Style/ArgumentsForwarding:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -51,6 +54,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.6.2] - 2025-01-04
+
+- fix: `delegate_attribute` defined in a subclass had an unintended side effect on the superclass.
+- support ruby 3.4.x
+- refactor: remove some `steep:ignore` by private rbs.
+- refactor: place definitions that you don't want to be used much in private rbs.
+- make `DelegateAttribute` dependent on `ActiveModel::Attributes` since it will not change in practice.
+
+## [0.6.1] - 2024-12-23
+
+- refactor: reorganize the overall structure of the test. Change from rspec to minitest
+- ci: fix CI for rails new version.
+
 ## [0.6.0] - 2024-11-11
 
 - refactor: limit the scope of methods needed only for internal library purposes.

data/README.md

@@ -37,7 +37,7 @@ If the callbacks are written in a class that inherits from `ActiveRecordCompose:
 class AccountRegistration < ActiveRecordCompose::Model
   def initialize(account = Account.new, attributes = {})
     @account = account
-    super(attributes)
+    super(attributes) # When overrides `#initialize`, be sure to call `super`.
 
     # By including AR instance in models, AR instance itself is saved when this model is saved.
     models.push(account)

data/lib/active_record_compose/delegate_attribute.rb

@@ -38,7 +38,8 @@ module ActiveRecordCompose
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :delegated_attributes, instance_writer: false # steep:ignore
+      # @type self: Class
+      class_attribute :delegated_attributes, instance_writer: false
     end
 
     module ClassMethods
@@ -52,9 +53,8 @@ module ActiveRecordCompose
           [reader, writer]
         end
 
-        delegate(*delegates, to:, allow_nil:, private:) # steep:ignore
-        delegated_attributes = (self.delegated_attributes ||= []) # steep:ignore
-        attributes.each { delegated_attributes.push(_1.to_s) }
+        delegate(*delegates, to:, allow_nil:, private:)
+        self.delegated_attributes = delegated_attributes.to_a + attributes.map { _1.to_s }
       end
     end
 
@@ -63,12 +63,7 @@ module ActiveRecordCompose
     #
     # @return [Hash] hash with the attribute name as key and the attribute value as value.
     def attributes
-      attrs = defined?(super) ? super : {} # steep:ignore
-      delegates = delegated_attributes # steep:ignore
-
-      # @type var attrs: Hash[String, untyped]
-      # @type var delegates: Array[String]
-      attrs.merge(delegates.to_h { [_1, public_send(_1)] })
+      super.merge(delegated_attributes.to_h { [_1, public_send(_1)] })
     end
   end
 end

data/lib/active_record_compose/inner_model.rb

@@ -93,7 +93,6 @@ module ActiveRecordCompose
     attr_reader :destroy_context_type, :if_option
 
     # @private
-    # steep:ignore:start
     module PackagePrivate
       refine InnerModel do
         # @private
@@ -104,6 +103,5 @@ module ActiveRecordCompose
         def __raw_model = model
       end
     end
-    # steep:ignore:end
   end
 end

data/lib/active_record_compose/inner_model_collection.rb

@@ -3,7 +3,7 @@
 require 'active_record_compose/inner_model'
 
 module ActiveRecordCompose
-  using InnerModel::PackagePrivate # steep:ignore
+  using InnerModel::PackagePrivate
 
   class InnerModelCollection
     include Enumerable
@@ -21,7 +21,7 @@ module ActiveRecordCompose
     def each
       return enum_for(:each) unless block_given?
 
-      models.each { yield _1.__raw_model } # steep:ignore
+      models.each { yield _1.__raw_model }
       self
     end
 
@@ -79,7 +79,7 @@ module ActiveRecordCompose
     attr_reader :owner, :models
 
     def wrap(model, destroy: false, if: nil)
-      if model.is_a?(ActiveRecordCompose::InnerModel) # steep:ignore
+      if model.is_a?(ActiveRecordCompose::InnerModel)
         # @type var model: ActiveRecordCompose::InnerModel
         model
       else
@@ -97,7 +97,6 @@ module ActiveRecordCompose
     end
 
     # @private
-    # steep:ignore:start
     module PackagePrivate
       refine InnerModelCollection do
         # Returns array of wrapped model instance.
@@ -107,6 +106,5 @@ module ActiveRecordCompose
         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,7 +5,7 @@ require 'active_record_compose/inner_model_collection'
 require 'active_record_compose/transaction_support'
 
 module ActiveRecordCompose
-  using InnerModelCollection::PackagePrivate # steep:ignore
+  using InnerModelCollection::PackagePrivate
 
   class Model
     include ActiveModel::Model
@@ -153,12 +153,12 @@ module ActiveRecordCompose
     def models = @__models ||= ActiveRecordCompose::InnerModelCollection.new(self)
 
     def validate_models
-      wms = models.__wrapped_models # steep:ignore
+      wms = models.__wrapped_models
       wms.select { _1.invalid? }.each { errors.merge!(_1) }
     end
 
     def save_models(bang:)
-      wms = models.__wrapped_models # steep:ignore
+      wms = models.__wrapped_models
       wms.all? { bang ? _1.save! : _1.save }
     end
 

data/lib/active_record_compose/version.rb

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

data/sig/_internal/package_private.rbs

@@ -0,0 +1,82 @@
+module ActiveRecordCompose
+  module DelegateAttribute : ActiveModel::Attributes
+    extend ActiveSupport::Concern
+
+    def attributes: -> Hash[String, untyped]
+    def delegated_attributes: () -> Array[String]
+
+    module ClassMethods : Module
+      def delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?, ?private: untyped?) -> untyped
+      def delegated_attributes: () -> Array[String]
+      def delegated_attributes=: (Array[String]) -> untyped
+    end
+  end
+
+  class InnerModelCollection
+    def initialize: (Model) -> void
+
+    private
+    attr_reader owner: Model
+    attr_reader models: Array[InnerModel]
+    def wrap: (_ARLike | InnerModel, ?destroy: (bool | Symbol | destroy_context_type), ?if: (nil | Symbol | condition_type)) -> InnerModel
+
+    module PackagePrivate
+      def __wrapped_models: () -> Array[InnerModel]
+
+      private
+      def models: () -> Array[InnerModel]
+    end
+
+    include PackagePrivate
+  end
+
+  class InnerModel
+    def initialize: (_ARLike, ?destroy: (bool | destroy_context_type), ?if: (nil | condition_type)) -> void
+    def destroy_context?: -> bool
+    def ignore?: -> bool
+    def save: -> bool
+    def save!: -> untyped
+    def invalid?: -> bool
+    def valid?: -> bool
+    def is_a?: (untyped) -> bool
+    def ==: (untyped) -> bool
+
+    private
+    attr_reader model: _ARLike
+    attr_reader destroy_context_type: (bool | destroy_context_type)
+    attr_reader if_option: (nil | condition_type)
+
+    module PackagePrivate
+      def __raw_model: () -> _ARLike
+
+      private
+      def model: () -> _ARLike
+    end
+
+    include PackagePrivate
+  end
+
+  class Model
+    include DelegateAttribute
+    extend DelegateAttribute::ClassMethods
+    include TransactionSupport
+    extend TransactionSupport::ClassMethods
+
+    @__models: InnerModelCollection
+  end
+
+  module TransactionSupport
+    include ActiveRecord::Transactions
+
+    def id: -> untyped
+
+    module ClassMethods
+      def connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+      def lease_connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+      def with_connection: [T] () { () -> T } -> T
+
+      private
+      def ar_class: -> singleton(ActiveRecord::Base)
+    end
+  end
+end

data/sig/active_record_compose.rbs

@@ -12,54 +12,23 @@ module ActiveRecordCompose
     def invalid?: -> bool
     def valid?: -> bool
     def errors: -> untyped
+    def is_a?: (untyped) -> bool
     def ==: (untyped) -> bool
   end
 
   type attribute_name = (String | Symbol)
-  type destroy_context_type = (bool | Symbol | (^() -> boolish) | (^(_ARLike) -> boolish))
+  type destroy_context_type = ((^() -> boolish) | (^(_ARLike) -> boolish))
   type condition_type = ((^() -> boolish) | (^(_ARLike) -> boolish))
 
-  module DelegateAttribute
-    extend ActiveSupport::Concern
-
-    def attributes: -> Hash[String, untyped]
-
-    module ClassMethods
-      def delegate_attribute: (*untyped methods, to: untyped?, ?allow_nil: untyped?, ?private: untyped?) -> untyped
-    end
-  end
-
   class InnerModelCollection
     include ::Enumerable[_ARLike]
 
-    def initialize: (Model) -> void
     def each: () { (_ARLike) -> void } -> InnerModelCollection | () -> Enumerator[_ARLike, self]
     def <<: (_ARLike) -> self
-    def push: (_ARLike, ?destroy: destroy_context_type, ?if: (nil | Symbol | condition_type)) -> self
+    def push: (_ARLike, ?destroy: (bool | Symbol | destroy_context_type), ?if: (nil | Symbol | condition_type)) -> self
     def empty?: -> bool
     def clear: -> self
-    def delete: (_ARLike | InnerModel) -> InnerModelCollection?
-
-    private
-    attr_reader owner: Model
-    attr_reader models: Array[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, ?if: (nil | condition_type)) -> void
-    def destroy_context?: -> bool
-    def ignore?: -> bool
-    def save: -> bool
-    def save!: -> untyped
-    def invalid?: -> bool
-    def valid?: -> bool
-    def ==: (untyped) -> bool
-
-    private
-    attr_reader model: _ARLike
-    attr_reader destroy_context_type: destroy_context_type
-    attr_reader if_option: (nil | condition_type)
+    def delete: (_ARLike) -> InnerModelCollection?
   end
 
   class Model
@@ -68,12 +37,11 @@ module ActiveRecordCompose
     include ActiveModel::Validations::Callbacks
     extend ActiveModel::Validations::ClassMethods
     include ActiveModel::Attributes
-    include DelegateAttribute
-    extend DelegateAttribute::ClassMethods
-    include TransactionSupport
-    extend TransactionSupport::ClassMethods
 
-    @__models: InnerModelCollection
+    def self.delegate_attribute: (*untyped methods, to: untyped, ?allow_nil: untyped?, ?private: untyped?) -> untyped
+    def self.connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+    def self.lease_connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+    def self.with_connection: [T] () { () -> T } -> T
 
     def initialize: (?Hash[attribute_name, untyped]) -> void
     def save: -> bool
@@ -82,6 +50,7 @@ module ActiveRecordCompose
     def create!: (?Hash[attribute_name, untyped]) -> untyped
     def update: (?Hash[attribute_name, untyped]) -> bool
     def update!: (?Hash[attribute_name, untyped]) -> untyped
+    def id: -> untyped
 
     private
     def models: -> InnerModelCollection
@@ -91,19 +60,4 @@ module ActiveRecordCompose
     def raise_on_save_error: -> bot
     def raise_on_save_error_message: -> String
   end
-
-  module TransactionSupport
-    include ActiveRecord::Transactions
-
-    def id: -> untyped
-
-    module ClassMethods
-      def connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
-      def lease_connection: -> ActiveRecord::ConnectionAdapters::AbstractAdapter
-      def with_connection: [T] () { () -> T } -> T
-
-      private
-      def ar_class: -> singleton(ActiveRecord::Base)
-    end
-  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - hamajyotan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -31,7 +30,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -44,6 +42,7 @@ files:
 - lib/active_record_compose/model.rb
 - lib/active_record_compose/transaction_support.rb
 - lib/active_record_compose/version.rb
+- sig/_internal/package_private.rbs
 - sig/active_record_compose.rbs
 homepage: https://github.com/hamajyotan/active_record_compose
 licenses:
@@ -52,9 +51,8 @@ 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.6.0
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.6.2
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: activemodel form object pattern
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper