active_record_compose 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1638c67c9c0cebca26544e01db7b210a0bde69d581471d3fbe771ada25c124b9
-  data.tar.gz: d7c43f6b81793f349a2f4e33132616b8dca2971a607d49ecedaa102fed1b1f5f
+  metadata.gz: dd2ae31a400b17c7ab14c90bd1440060676590c23f91a61f7f54e9a7decf0294
+  data.tar.gz: 4a599ee2da8a5dcc3b0d9279a360b611b2e38f72304e8a837271f01e2b9821b2
 SHA512:
-  metadata.gz: 9b9aca1764d28fdeb52b0d32fdc6fb0ca13e6c1891efd47335f18660935b36ae64be28cb1a6db08bf1b8b0d3d65aa9daa94bccdea03982112fd59386e57e7e50
-  data.tar.gz: 6888e57191546c7d698bde1f2741f280b930d8b8f1f648c02ec0cd025d54a8f89d88bb4dd1cbe0feaf0e37e5f1fd8d4885032259481536edcd73aad1d067aed8
+  metadata.gz: 18f3632810ffc48ed4bd10f78c4e54ff3c383d34231289f9639e488f270bbfd623a5f002b9f4afc653762611621c6f96b85b52498c2ba34e942d0c7c7288bfe4
+  data.tar.gz: 45fc861a9d223da11b841800dbc0ab689160cabdfdfda3a69433cb1d98884f76f30c742319ffc1ad3601527e9464b322456e44b73c6f098355f898909b5e340c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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/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,6 +20,22 @@ module ActiveRecordCompose
       ret.presence_in(%i[save destroy]) || :save
     end
 
+    # 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.
+    #
     # @return [InnerModel] self
     def save!
       case context

data/lib/active_record_compose/model.rb

@@ -22,12 +22,23 @@ 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 } }
     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
 

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 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.6
 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
@@ -65,7 +65,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.6
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []