active_record_compose 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87118b489cd061b4912c625ec2b9bdc91ad4b024e69cd6a6c45ab9c884018f3
-  data.tar.gz: 22eec41668831a5f97d5935502d4c4d61de723b78dd2f70d2dca2bbfb4d9fa52
+  metadata.gz: b6881ca78dfbf9fc5fc15cf72ac6073c4780d4b7b32747fc1b58a0147adce3fe
+  data.tar.gz: 37a7dfa3d4de10d2a35ea6a10a9d3e131809eba27ef60cb5b917b1b736f209e7
 SHA512:
-  metadata.gz: 180d9e45c2e18dc362d0169a22040759614882e09254c4fc8ad80ead07302c280446cab288c5042f81f33d339ab00b114d888536f691ab817063dc5dc6765cc0
-  data.tar.gz: a4ba3164829709bbdbb38f0232b555ef210b6ce0783348317c430ffb9d1931f9b9b48bec3f28fefe757ee9ce6f9c8b3dcfb3a53ec557650eab4d6e7a8870e13f
+  metadata.gz: abc371fd146961cec4f4b8d234367734e772aaab9b08450debb1a79adba4fa5703fd169090d1d636c95f56a89ec0184e5c7db2f4bb04f61609dc925e5fe08ffa
+  data.tar.gz: 427c2bd3151f1fba2541795aa36f645952a87930ccd92fb0d1d7a9a1144d7486c30180cd0b021c1660aab380dd1cb887191fe37c1dc069b0d3cd5197f7c3ace0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-07-29
+## [0.1.1] - 2024-01-08
+
+- fix 0.1.0 release date.
+- add doc.
+- Make it easier for application developers to work with `#models`
+
+## [0.1.0] - 2024-01-06
 
 - Initial release

data/README.md

@@ -199,7 +199,7 @@ It provides a macro description that expresses access to the attributes of the A
 
 ```ruby
 class AccountRegistration < ActiveRecordCompose::Model
-  def initialize(account)
+  def initialize(account, attributes = {})
     @account = account
     super(attributes)
     models.push(account)

data/lib/active_record_compose/delegate_attribute.rb

@@ -1,6 +1,39 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
+  # = Delegate \Attribute
+  #
+  # It provides a macro description that expresses access to the attributes of the AR model through delegation.
+  #
+  #   class AccountRegistration < ActiveRecordCompose::Model
+  #     def initialize(account, attributes = {})
+  #       @account = account
+  #       super(attributes)
+  #       models.push(account)
+  #     end
+  #
+  #     attribute :original_attribute, :string, default: 'qux'
+  #
+  #     # like a `delegate :name, :name=, to: :account`
+  #     delegate_attribute :name, to: :account
+  #
+  #     private
+  #
+  #     attr_reader :account
+  #   end
+  #
+  #   account = Account.new
+  #   account.name = 'foo'
+  #
+  #   registration = AccountRegistration.new(account)
+  #   registration.name  #=> 'foo'  # delegate to account#name
+  #
+  #   registration.name = 'bar'  # delegate to account#name=
+  #   account.name  #=> 'bar'
+  #
+  #   # Attributes defined in delegate_attribute will be included in the original `#attributes`.
+  #   registration.attributes  #=> { 'original_attribute' => 'qux', 'name' => 'bar' }
+  #
   module DelegateAttribute
     extend ActiveSupport::Concern
 

data/lib/active_record_compose/inner_model.rb

@@ -1,40 +1,55 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object'
+
 module ActiveRecordCompose
   class InnerModel
-    def initialize(inner_model, context: :save)
-      @inner_model = inner_model
+    # @param model [Object] the model instance.
+    # @param context [Symbol] :save or :destroy
+    def initialize(model, context: :save)
+      @model = model
       @context = context
     end
 
-    delegate :errors, to: :inner_model
+    delegate :errors, to: :model
 
+    # @return [Symbol] :save or :destroy
     def context
-      @context.respond_to?(:call) ? @context.call(inner_model) : @context
+      ret = @context.respond_to?(:call) ? @context.call(model) : @context
+      ret.presence_in(%i[save destroy]) || :save
     end
 
+    # @return [InnerModel] self
     def save!
       case context
       when :destroy
-        inner_model.destroy!
+        model.destroy!
       else
-        inner_model.save!
+        model.save!
       end
     end
 
+    # @return [Boolean]
     def invalid?
       case context
       when :destroy
         false
       else
-        inner_model.invalid?
+        model.invalid?
       end
     end
 
+    # @return [Boolean]
     def valid? = !invalid?
 
+    # Returns a model instance of raw, but it should
+    # be noted that application developers are not expected to use this interface.
+    #
+    # @return [Object] raw model instance
+    def __raw_model = model
+
     private
 
-    attr_reader :inner_model
+    attr_reader :model
   end
 end

data/lib/active_record_compose/inner_model_collection.rb

@@ -6,36 +6,59 @@ module ActiveRecordCompose
   class InnerModelCollection
     include Enumerable
 
-    def initialize
-      @inner_models = []
-    end
-
+    # Enumerates model objects.
+    #
+    # @yieldparam [Object] the model instance
+    # @return [Enumerator] when not block given.
+    # @return [InnerModelCollection] self
     def each
       return enum_for(:each) unless block_given?
 
-      inner_models.each { yield _1 }
+      models.each { yield _1.__raw_model }
+      self
+    end
+
+    # Appends model to collection.
+    #
+    # @param model [Object] the model instance
+    # @param context [Symbol] :save or :destroy
+    # @return [InnerModelCollection] self
+    def <<(model)
+      models << wrap(model, context: :save)
       self
     end
 
-    def <<(inner_model)
-      inner_models << wrap(inner_model, context: :save)
+    # Appends model to collection.
+    #
+    # @param model [Object] the model instance
+    # @return [InnerModelCollection] self
+    def push(model, context: :save)
+      models << wrap(model, context:)
       self
     end
 
-    def push(inner_model, context: :save)
-      inner_models << wrap(inner_model, context:)
+    # Enumerates model objects, but it should be noted that
+    # application developers are not expected to use this interface.
+    #
+    # @yieldparam [InnerModel] rawpped model instance.
+    # @return [Enumerator] when not block given.
+    # @return [InnerModelCollection] self
+    def __each_by_wrapped
+      return enum_for(:__each_by_wrapped) unless block_given?
+
+      models.each { yield _1 }
       self
     end
 
     private
 
-    attr_reader :inner_models
+    def models = @models ||= []
 
-    def wrap(inner_model, context:)
-      if inner_model.is_a?(ActiveRecordCompose::InnerModel)
-        inner_model
+    def wrap(model, context:)
+      if model.is_a?(ActiveRecordCompose::InnerModel)
+        model
       else
-        ActiveRecordCompose::InnerModel.new(inner_model, context:)
+        ActiveRecordCompose::InnerModel.new(model, context:)
       end
     end
   end

data/lib/active_record_compose/model.rb

@@ -32,6 +32,31 @@ module ActiveRecordCompose
 
     def save! = save || raise(error_class_on_save_error.new('Failed to save the model.', self))
 
+    # 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
+    #
+    #   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 = {})
       assign_attributes(attributes)
       return false if invalid?
@@ -39,10 +64,37 @@ module ActiveRecordCompose
       save_in_transaction { run_callbacks(:save) { run_callbacks(:create) { save_models } } }
     end
 
+    # Behavior is same to `#create`, but raises an exception prematurely on failure.
+    #
     def create!(attributes = {})
       create(attributes) || raise(error_class_on_save_error.new('Failed to create the model.', self))
     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!
+    #
     def update(attributes = {})
       assign_attributes(attributes)
       return false if invalid?
@@ -50,6 +102,8 @@ module ActiveRecordCompose
       save_in_transaction { run_callbacks(:save) { run_callbacks(:update) { save_models } } }
     end
 
+    # Behavior is same to `#update`, but raises an exception prematurely on failure.
+    #
     def update!(attributes = {})
       update(attributes) || raise(error_class_on_save_error.new('Failed to update the model.', self))
     end
@@ -58,7 +112,9 @@ module ActiveRecordCompose
 
     def models = @models ||= ActiveRecordCompose::InnerModelCollection.new
 
-    def validate_models = models.select { _1.invalid? }.each { errors.merge!(_1) }
+    def wrapped_models = models.__each_by_wrapped
+
+    def validate_models = wrapped_models.select { _1.invalid? }.each { errors.merge!(_1) }
 
     def save_in_transaction
       run_callbacks(:commit) do
@@ -74,6 +130,6 @@ module ActiveRecordCompose
       end.present?
     end
 
-    def save_models = models.all? { _1.save! }
+    def save_models = wrapped_models.all? { _1.save! }
   end
 end

data/lib/active_record_compose/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -49,6 +49,8 @@ homepage: https://github.com/active_record_compose
 licenses:
 - MIT
 metadata:
+  changelog_uri: https://github.com/hamajyotan/active_record_compose/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/hamajyotan/active_record_compose
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []