active_record_compose 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1638c67c9c0cebca26544e01db7b210a0bde69d581471d3fbe771ada25c124b9
-  data.tar.gz: d7c43f6b81793f349a2f4e33132616b8dca2971a607d49ecedaa102fed1b1f5f
+  metadata.gz: bff1c2fd72a225a89ada1c0cab86b6d32f31c0052d8857e665eb2796f4a40883
+  data.tar.gz: 307e8ecf50282b9a19e224870796944de47d37f8802d0ffe63cca465eb663cc4
 SHA512:
-  metadata.gz: 9b9aca1764d28fdeb52b0d32fdc6fb0ca13e6c1891efd47335f18660935b36ae64be28cb1a6db08bf1b8b0d3d65aa9daa94bccdea03982112fd59386e57e7e50
-  data.tar.gz: 6888e57191546c7d698bde1f2741f280b930d8b8f1f648c02ec0cd025d54a8f89d88bb4dd1cbe0feaf0e37e5f1fd8d4885032259481536edcd73aad1d067aed8
+  metadata.gz: 12f503a644d60932a095a587e8152d37af25b8eccfb0cc5cd32dc5941eb896104880328ff6e3ed2b7fd53ee78fad9f7962e23b5ffc1070bbaa00518e482dccf4
+  data.tar.gz: 91d912f794a250e44e8ad5fea2694f00a52eb98df3f217364e8eb637a6971692998526e86c2d908dc28ce7b0ff99ada394ca287b39342714377af63a1869c4be

data/.rubocop.yml

@@ -3,9 +3,6 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
 
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 
@@ -33,5 +30,8 @@ Layout/LineLength:
 Metrics/BlockLength:
   Enabled: false
 
+Naming/BlockForwarding:
+  Enabled: false
+
 Naming/MemoizedInstanceVariableName:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.1.7] - 2024-01-15
+
+- remove `add_development_dependency` from gemspec
+- add spec for DelegateAttribute module
+- add and refactor doc.
+
+## [0.1.6] - 2024-01-14
+
+- add doc for `#save` and `#save!`.
+- implement `#save` for symmetry with `#save!`
+- add `InnerModel#initialize` doc.
+
 ## [0.1.5] - 2024-01-11
 
 - when invalid, raises ActiveRecord::RecordInvalid on #save!

data/lib/active_record_compose/delegate_attribute.rb

@@ -42,6 +42,8 @@ module ActiveRecordCompose
     end
 
     class_methods do
+      # Defines the reader and writer for the specified attribute.
+      #
       def delegate_attribute(*attributes, to:, **options)
         delegates = attributes.flat_map do |attribute|
           reader = attribute
@@ -56,8 +58,12 @@ module ActiveRecordCompose
       end
     end
 
+    # Returns a hash with the attribute name as key and the attribute value as value.
+    # Attributes declared with `delegate_attribute` are also merged.
+    #
+    # @return [Hash] hash with the attribute name as key and the attribute value as value.
     def attributes
-      super.merge(delegated_attributes.to_h { [_1, public_send(_1)] })
+      (defined?(super) ? super : {}).merge(delegated_attributes.to_h { [_1, public_send(_1)] })
     end
   end
 end

data/lib/active_record_compose/inner_model.rb

@@ -6,6 +6,7 @@ module ActiveRecordCompose
   class InnerModel
     # @param model [Object] the model instance.
     # @param context [Symbol] :save or :destroy
+    # @param context [Proc] proc returning either :save or :destroy
     def initialize(model, context: :save)
       @model = model
       @context = context
@@ -19,7 +20,22 @@ module ActiveRecordCompose
       ret.presence_in(%i[save destroy]) || :save
     end
 
-    # @return [InnerModel] self
+    # Execute save or destroy. Returns true on success, false on failure.
+    # Whether save or destroy is executed depends on the value of context.
+    #
+    # @return [Boolean] returns true on success, false on failure.
+    def save
+      case context
+      when :destroy
+        model.destroy
+      else
+        model.save
+      end
+    end
+
+    # Execute save or destroy. Unlike #save, an exception is raises on failure.
+    # Whether save or destroy is executed depends on the value of context.
+    #
     def save!
       case context
       when :destroy
@@ -44,7 +60,8 @@ module ActiveRecordCompose
 
     # Returns true if equivalent.
     #
-    # @return [Object] other
+    # @param [Object] other
+    # @return [Boolean]
     def ==(other)
       return false unless self.class == other.class
       return false unless __raw_model == other.__raw_model

data/lib/active_record_compose/inner_model_collection.rb

@@ -10,7 +10,7 @@ module ActiveRecordCompose
     #
     # @yieldparam [Object] the model instance
     # @return [Enumerator] when not block given.
-    # @return [InnerModelCollection] self
+    # @return [self] when block given, returns itself.
     def each
       return enum_for(:each) unless block_given?
 
@@ -21,7 +21,7 @@ module ActiveRecordCompose
     # Appends model to collection.
     #
     # @param model [Object] the model instance
-    # @return [InnerModelCollection] self
+    # @return [self] returns itself.
     def <<(model)
       models << wrap(model, context: :save)
       self
@@ -31,7 +31,7 @@ module ActiveRecordCompose
     #
     # @param model [Object] the model instance
     # @param context [Symbol] :save or :destroy
-    # @return [InnerModelCollection] self
+    # @return [self] returns itself.
     def push(model, context: :save)
       models << wrap(model, context:)
       self
@@ -44,7 +44,7 @@ module ActiveRecordCompose
 
     # Set to empty.
     #
-    # @return [InnerModelCollection] self
+    # @return [self] returns itself.
     def clear
       models.clear
       self
@@ -55,7 +55,7 @@ module ActiveRecordCompose
     #
     # @param model [Object] the model instance
     # @param context [Symbol] :save or :destroy
-    # @return [InnerModelCollection] Successful deletion
+    # @return [self] Successful deletion
     # @return [nil] If deletion fails
     def delete(model, context: :save)
       wrapped = wrap(model, context:)
@@ -69,7 +69,7 @@ module ActiveRecordCompose
     #
     # @yieldparam [InnerModel] rawpped model instance.
     # @return [Enumerator] when not block given.
-    # @return [InnerModelCollection] self
+    # @return [self] when block given, returns itself.
     def __each_by_wrapped
       return enum_for(:__each_by_wrapped) unless block_given?
 

data/lib/active_record_compose/model.rb

@@ -22,16 +22,27 @@ module ActiveRecordCompose
       super(attributes)
     end
 
+    # Save the models that exist in models.
+    # Returns false if any of the targets fail, true if all succeed.
+    #
+    # The save is performed within a single transaction.
+    #
+    # @return [Boolean] returns true on success, false on failure.
     def save
       return false if invalid?
 
-      save_in_transaction { run_callbacks(:save) { save_models } }
+      save_in_transaction { save_models }
     end
 
+    # Save the models that exist in models.
+    # Unlike #save, an exception is raises on failure.
+    #
+    # Saving, like `#save`, is performed within a single transaction.
+    #
     def save!
       valid? || raise_validation_error
 
-      save_in_transaction { run_callbacks(:save) { save_models } } || raise_on_save_error
+      save_in_transaction { save_models } || raise_on_save_error
     end
 
     # Behavior is same to `#save`, but `before_create` and `after_create` hooks fires.
@@ -63,7 +74,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       return false if invalid?
 
-      save_in_transaction { run_callbacks(:save) { run_callbacks(:create) { save_models } } }
+      save_in_transaction { run_callbacks(:create) { save_models } }
     end
 
     # Behavior is same to `#create`, but raises an exception prematurely on failure.
@@ -72,7 +83,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       valid? || raise_validation_error
 
-      save_in_transaction { run_callbacks(:save) { run_callbacks(:create) { save_models } } } || raise_on_save_error
+      save_in_transaction { run_callbacks(:create) { save_models } } || raise_on_save_error
     end
 
     # Behavior is same to `#save`, but `before_update` and `after_update` hooks fires.
@@ -104,7 +115,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       return false if invalid?
 
-      save_in_transaction { run_callbacks(:save) { run_callbacks(:update) { save_models } } }
+      save_in_transaction { run_callbacks(:update) { save_models } }
     end
 
     # Behavior is same to `#update`, but raises an exception prematurely on failure.
@@ -113,7 +124,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       valid? || raise_validation_error
 
-      save_in_transaction { run_callbacks(:save) { run_callbacks(:update) { save_models } } } || raise_on_save_error
+      save_in_transaction { run_callbacks(:update) { save_models } } || raise_on_save_error
     end
 
     private
@@ -124,10 +135,10 @@ module ActiveRecordCompose
 
     def validate_models = wrapped_models.select { _1.invalid? }.each { errors.merge!(_1) }
 
-    def save_in_transaction
+    def save_in_transaction(&block)
       run_callbacks(:commit) do
         result = ::ActiveRecord::Base.transaction do
-          raise ActiveRecord::Rollback unless yield
+          raise ActiveRecord::Rollback unless run_callbacks(:save, &block)
 
           true
         end
@@ -142,6 +153,8 @@ module ActiveRecordCompose
 
     def raise_validation_error = raise ActiveRecord::RecordInvalid, self
 
-    def raise_on_save_error = raise ActiveRecord::RecordNotSaved.new('Failed to save the model.', self)
+    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.'
   end
 end

data/lib/active_record_compose/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: activemodel form object pattern
 email:
 - hamajyotan@gmail.com
@@ -65,7 +51,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.1.5
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.1.7
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []