activerecord-transactionable 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3becf9bed4568fc5073445b3ae7beb01d86c8e99
-  data.tar.gz: e771c0221f7ea32ec42a2f4d2628508fd9aa56d2
+  metadata.gz: ebf67428aaf44c1ac7ffb5b7515c8e5d927f4966
+  data.tar.gz: fe553cbee8e6502b5b68ba04c0a3d296032f1cf4
 SHA512:
-  metadata.gz: '019b592ea646a19664e20914d9c3ac42bdd3766fb6f61b4079f6b8d1c36b74542d057570f7322b985f288a7572e3667ba75672311aa55f7c0842f0ad69fff998'
-  data.tar.gz: 1dd3ac5bc3e1a670c380c1ce6241919e4e313d77249d1cdb279e4d8a0fd49d260134b8a6a5eb50ff62634dce3f6ce7fbf544a328890910f12b1f91e496105513
+  metadata.gz: 27f1f73531b9efc309d056c44603c882b4f08e731fb5ed65fd170432aa4a3e64dd4f12785171a36e0828e625b6093ea6edd63a4bea0b3287b67ac4fd9e29fe9b
+  data.tar.gz: 70451d8c0c5f4fe156a6153307aad8eca3ff61d063fa0d2b8c3d222897918c7d75cca8ee0f924e1a83c7bb8b4d6af7fc3bf50eb6d8327d3ea0b62e93d585ab49

data/.gitignore

@@ -1,4 +1,4 @@
-/.bundle/
+.bundle/
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/README.md

@@ -65,7 +65,7 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 class Car < ActiveRecord::Base
   include Activerecord::Transactionable # Note lowercase "r" in Activerecord (different namespace than rails' module)
 
@@ -76,7 +76,8 @@ end
 When creating, saving, deleting within the transaction make sure to use the bang methods (`!`) in order to ensure a rollback on failure.
 
 When everything works:
-```
+
+```ruby
 car = Car.new(name: "Fiesta")
 car.transaction_wrapper do
   car.save!
@@ -85,7 +86,8 @@ car.persisted? # => true
 ```
 
 When something goes wrong:
-```
+
+```ruby
 car = Car.new(name: nil)
 car.transaction_wrapper do
   car.save!
@@ -99,7 +101,8 @@ These examples are too simple to be useful with transactions, but if you are wor
 Also see the specs.
 
 If you need to lock the car as well as have a transaction (note: will reload the `car`):
-```
+
+```ruby
 car = Car.new(name: nil)
 car.transaction_wrapper(lock: true) do # uses ActiveRecord's with_lock
   car.save!
@@ -109,7 +112,8 @@ car.errors.full_messages # => ["Name can't be blank"]
 ```
 
 If you need to know if the transaction succeeded:
-```
+
+```ruby
 car = Car.new(name: nil)
 result = car.transaction_wrapper(lock: true) do # uses ActiveRecord's with_lock
            car.save!
@@ -126,7 +130,7 @@ Meanings of `transaction_wrapper` return values:
 
 ## Update Example
 
-```
+```ruby
 @client = Client.find(params[:id])
 transaction_result =  @client.transaction_wrapper(lock: true) do
                         @client.assign_attributes(client_params)
@@ -140,11 +144,41 @@ else
 end
 ```
 
+## Find or create
+
+NOTE: The `is_retry` is passed to the block by the gem, and indicates whether the block is running for the first time or the second time.
+The block will never be retried more than once.
+
+```ruby
+Car.transaction_wrapper(outside_retriable_errors: ActivRecord::RecordNotFound) do |is_retry|
+  if is_retry
+    Car.create!(vin: vin)
+  else
+    Car.find_by!(vin: vin)
+  end
+end
+```
+
+## Create or find
+
+NOTE: The `is_retry` is passed to the block by the gem, and indicates whether the block is running for the first time or the second time.
+The block will never be retried more than once.
+
+```ruby
+Car.transaction_wrapper(outside_retriable_errors: ActivRecord::RecordNotUnique) do |is_retry|
+  if is_retry
+    Car.find_by!(vin: vin)
+  else
+    Car.create!(vin: vin)
+  end
+end
+```
+
 ## Reporting to SAAS Error Tools (like Raygun, etc)
 
 Hopefully there will be a better integration at some point, but for now, somewhere in your code do:
 
-```
+```ruby
 module SendToRaygun
   def transaction_error_logger(**args)
     super

data/lib/activerecord/transactionable.rb

@@ -74,8 +74,8 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
           end
         end
         error_handler_outside_transaction(object: object, transaction_open: transaction_open, **outside_args) do
-          run_inside_transaction_block(transaction_args: transaction_args, inside_args: inside_args, lock: lock, transaction_open: transaction_open, object: object) do
-            yield
+          run_inside_transaction_block(transaction_args: transaction_args, inside_args: inside_args, lock: lock, transaction_open: transaction_open, object: object) do |is_retry|
+            yield is_retry
           end
         end
       end
@@ -88,22 +88,22 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
             # Note: with_lock will reload object!
             # Note: with_lock does not accept arguments like transaction does.
             object.with_lock do
-              error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do
-                yield
+              error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do |is_retry|
+                yield is_retry
               end
             end
           else
             object.transaction(**transaction_args) do
-              error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do
-                yield
+              error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do |is_retry|
+                yield is_retry
               end
             end
           end
         else
           raise ArgumentError, "No object to lock!" if lock
           ActiveRecord::Base.transaction(**transaction_args) do
-            error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do
-              yield
+            error_handler_inside_transaction(object: object, transaction_open: transaction_open, **inside_args) do |is_retry|
+              yield is_retry
             end
           end
         end
@@ -125,8 +125,8 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
         prepared_errors.concat(DEFAULT_ERRORS_PREPARE_ON_SELF_INSIDE)
         already_been_added_to_self, needing_added_to_self = rescued_errors.partition {|error_class| prepared_errors.include?(error_class)}
         local_context = INSIDE_CONTEXT
-        run_block_with_retry(object, local_context, transaction_open, retriable_errors, reraisable_errors, already_been_added_to_self, needing_added_to_self) do
-          yield
+        run_block_with_retry(object, local_context, transaction_open, retriable_errors, reraisable_errors, already_been_added_to_self, needing_added_to_self) do |is_retry|
+          yield is_retry
         end
       end
 
@@ -139,8 +139,8 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
         prepared_errors.concat(DEFAULT_ERRORS_PREPARE_ON_SELF_OUTSIDE)
         already_been_added_to_self, needing_added_to_self = rescued_errors.partition {|error_class| prepared_errors.include?(error_class)}
         local_context = OUTSIDE_CONTEXT
-        run_block_with_retry(object, local_context, transaction_open, retriable_errors, reraisable_errors, already_been_added_to_self, needing_added_to_self) do
-          yield
+        run_block_with_retry(object, local_context, transaction_open, retriable_errors, reraisable_errors, already_been_added_to_self, needing_added_to_self) do |is_retry|
+          yield is_retry
         end
       end
 
@@ -153,7 +153,10 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
           # If the error is not rescued higher up the error will continue to bubble
           # If we were already inside a transaction, such that this one is nested,
           #   then the result of the yield is what we want to return, to preserve the innermost result
-          result = yield
+          # We pass the retry state along to yield so that the code implementing
+          #   the transaction_wrapper can switch behavior on a retry
+          #   (e.g. create => find)
+          result = yield re_try
           # When in the outside context we need to preserve the inside result so it bubbles up unmolested with the "meaningful" result of the transaction.
           if result.is_a?(Activerecord::Transactionable::Result)
             result # <= preserve the meaningful return value

data/lib/activerecord/transactionable/version.rb

@@ -1,5 +1,5 @@
 module Activerecord
   module Transactionable
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-transactionable
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2018-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel