active_model_persistence 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4358309182de30b6d706336fdebb8d8e4b803d35cfc75c86074cb2fe96230a92
-  data.tar.gz: 3003146bc077bacff57e3d62ee55fb4ced6a3cec443a6250bd27e1b59cb17285
+  metadata.gz: 5c9021a01608e4ac248001eafc0a7c2265ab82666bc33add62e9a3f3586f6bbf
+  data.tar.gz: 4225a766baeb076abce4a27cbde7d8c742f02e660632855198ba6dda7a20434f
 SHA512:
-  metadata.gz: ec9030ea8eff12cf3d05bcaee715b846069cc4c7358c473c2688d198c73db949b79364089c10860a28b9a9ee83fe1a22f3d2bc049c4078026cfd2204d3b61082
-  data.tar.gz: 74a2bcd9bf79fbd3747f365cf8c7c7059fec276d61e2880d36870daba6c2c12cb9e85d359d6216edff526c5f3a39da5f7e655272e06c8dbe89eb3de6c6781193
+  metadata.gz: 8499b0d13d3acafcd5b45df2d8c3d22a171f2f428f7b1d6de961855af7d18b839c0be9c40163bbf74bb91fa5f9956e62e37a7bcfe691eeac3eb6057508abb412
+  data.tar.gz: fa9bab5a614c233c7c505f7f66f181abf87787d51902322c88408fe8802334f701ef5b7742e01bfa80ab3352a4765e9b811da1ba6ee145e3a80496e80a3fbaa6

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+<!--
+# @markup markdown
+# @title Change Log
+-->
+
+# Change Log
+
+The full change log is stored on [this project's GitHub releases page](https://github.com/jcouball/active_model_persistence/releases).

data/Dockerfile.changelog-rs

@@ -0,0 +1,12 @@
+FROM rust
+
+# Build the docker image (from this project's root directory):
+# docker build --file Dockerfile.changelog-rs --tag changelog-rs .
+#
+# Use this image to output a changelog (from this project's root directory):
+# docker run --rm --volume "$PWD:/worktree" changelog-rs v1.9.1 v1.10.0
+
+RUN cargo install changelog-rs
+WORKDIR /worktree
+
+ENTRYPOINT ["/usr/local/cargo/bin/changelog-rs", "/worktree"]

data/lib/active_model_persistence/persistence.rb

@@ -14,6 +14,7 @@ module ActiveModelPersistence
   #     attribute :id, :integer
   #     attribute :name, :string
   #     index :id, unique: true
+  #     validates :id, presence: true
   #   end
   #
   #   # Creating a model instance with `.new` does not save it to the object store
@@ -274,6 +275,28 @@ module ActiveModelPersistence
         result != false
       end
 
+      # Calls #save and raises an error if #save returns false
+      #
+      # @example
+      #   object = ModelExample.new(id: nil, name: 'James')
+      #   object.save! #=> raises ObjectNotSavedError
+      #
+      # @param _options [Hash] save options (currently unused)
+      #
+      # @param block [Proc] a block to call after the save
+      #
+      # @yield [self] a block to call after the save
+      # @yieldparam saved_model [self] the model object after it was saved
+      # @yieldreturn [void]
+      #
+      # @raise [ObjectNotSavedError] if the model object was not saved
+      #
+      # @return [Boolean] returns true or raises an error
+      #
+      def save!(**options, &block)
+        save(**options, &block) || raise(ObjectNotSavedError.new('Failed to save the object', self))
+      end
+
       # Deletes the object from the object store
       #
       # This model object is frozen to reflect that no changes should be made

data/lib/active_model_persistence/version.rb

@@ -2,5 +2,5 @@
 
 module ActiveModelPersistence
   # The version of the active_model_persistence gem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/active_model_persistence.rb

@@ -5,6 +5,8 @@ require 'active_model'
 
 # A set of mixins to add to ActiveModel classes to support persistence
 #
+# @api public
+#
 module ActiveModelPersistence
   # A base class for all ActiveModelPersistence errors
   class ModelError < StandardError; end
@@ -14,6 +16,33 @@ module ActiveModelPersistence
 
   # Raised when trying to add an object to an index when the key already exists in the index for another object
   class UniqueConstraintError < ModelError; end
+
+  # Raised when trying to save an invalid object
+  class ObjectNotSavedError < ModelError
+    # The object that was not saved
+    #
+    # @example
+    #   object = Object.new
+    #   error = ObjectNotSavedError.new('Invalid object', object)
+    #   error.object == object #=> true
+    #
+    # @return [Object] The object that was not saved
+    #
+    attr_reader :object
+
+    # Create a new error
+    #
+    # @example
+    #   ObjectNotSavedError.new('Invalid object', self)
+    #
+    # @param message [String] The error message
+    # @param object [Object] The object that was not saved
+    #
+    def initialize(message = nil, object = nil)
+      @object = object
+      super(message)
+    end
+  end
 end
 
 require_relative 'active_model_persistence/index'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_persistence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -189,6 +189,8 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
+- Dockerfile.changelog-rs
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -227,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Adds in-memory persistence to ActiveModel models