activerecord-transactionable 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45ff61a88a97f5e887d2782237e27bf2ea65075c
-  data.tar.gz: f6706016a55fcb7eb575c4957168d118a39bbc7f
+  metadata.gz: 3becf9bed4568fc5073445b3ae7beb01d86c8e99
+  data.tar.gz: e771c0221f7ea32ec42a2f4d2628508fd9aa56d2
 SHA512:
-  metadata.gz: 21ec04bb084c2e7bbb52b1c68c0861e3bb2feb0f9e1141bbf1c6961990fd2f85d4bdfa1e2573b59519e5b5693b57db6a3f7e8e7962ad8e8f664af0061e56f8b2
-  data.tar.gz: 02d33ee1345a027f51b75139a4408ffda9c9426a59c0316525cbdfa01089ea37b1174426199216b80c2bffefac91f240ae74c01b2e039cfa39038c098f4f110a
+  metadata.gz: '019b592ea646a19664e20914d9c3ac42bdd3766fb6f61b4079f6b8d1c36b74542d057570f7322b985f288a7572e3667ba75672311aa55f7c0842f0ad69fff998'
+  data.tar.gz: 1dd3ac5bc3e1a670c380c1ce6241919e4e313d77249d1cdb279e4d8a0fd49d260134b8a6a5eb50ff62634dce3f6ce7fbf544a328890910f12b1f91e496105513

data/README.md

@@ -5,7 +5,7 @@ Provides a method, `transaction_wrapper` at the class and instance levels that c
 | Project                 | Activerecord::Transactionable    |
 |------------------------ | ----------------- |
 | gem name                |  activerecord-transactionable    |
-| license                 |  MIT              |
+| license                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
 | expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
 | download rank               |  [![Total Downloads](https://img.shields.io/gem/rt/activerecord-transactionable.svg)](https://rubygems.org/gems/activerecord-transactionable) |
 | version                 |  [![Gem Version](https://badge.fury.io/rb/activerecord-transactionable.png)](http://badge.fury.io/rb/activerecord-transactionable) |
@@ -24,6 +24,29 @@ Useful as an example of correct behavior for wrapping transactions.
 NOTE: Rails' transactions are per-database connection, not per-model, nor per-instance,
       see: http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html
 
+## Upgrading to Version 2
+
+In version 1 the `transaction_wrapper` returned `true` or `false`.  In version 2 it returns an instance of `Activerecord::Transactionable::Result`, which has a `value`, and two methods:
+```ruby
+result = transaction_wrapper(...) do
+  something
+end
+result.fail?
+result.success?
+```
+Where you used to have:
+```ruby
+if result
+  # ...
+end
+```
+You must update to:
+```ruby
+if result.success?
+  # ...
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -91,7 +114,8 @@ car = Car.new(name: nil)
 result = car.transaction_wrapper(lock: true) do # uses ActiveRecord's with_lock
            car.save!
          end
-result # => true, false or nil
+result # => an instance of Activerecord::Transactionable::Result
+result.success? # => true or false
 ```
 
 Meanings of `transaction_wrapper` return values:
@@ -108,7 +132,7 @@ transaction_result =  @client.transaction_wrapper(lock: true) do
                         @client.assign_attributes(client_params)
                         @client.save!
                       end
-if transaction_result
+if transaction_result.success?
   render :show, locals: { client: @client }, status: :ok
 else
   # Something prevented update

data/activerecord-transactionable.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord"
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rake", "~> 12.2"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "appraisal", "~> 2.2"
   spec.add_development_dependency "wwtd", "~> 1.3"

data/lib/activerecord/transactionable.rb

@@ -1,4 +1,3 @@
-require "activerecord/transactionable/version"
 require "active_model"
 require "active_record"
 # apparently needed for Rails 4.0 compatibility with rspec, when
@@ -6,6 +5,9 @@ require "active_record"
 #   keep your Gemfile sorted alphabetically.
 require "active_record/validations"
 
+require "activerecord/transactionable/version"
+require "activerecord/transactionable/result"
+
 module Activerecord # Note lowercase "r" in Activerecord (different namespace than rails' module)
   # SRP: Provides an example of correct behavior for wrapping transactions.
   # NOTE: Rails' transactions are per-database connection, not per-model, nor per-instance,
@@ -70,15 +72,11 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
           else
             logger.debug("[#{self}.transaction_wrapper] Will start a nested transaction.")
           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
           end
-        else
-          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
-            end
-          end
         end
       end
 
@@ -156,11 +154,11 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
           # 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
-          # When in the outside context we need to preserve the inside result so it bubles up unmolested with the "meaningful" result of the transaction.
-          if transaction_open || local_context == OUTSIDE_CONTEXT
-            result # <= preserve the meaningful return value.  Meaning: transaction succeeded, no errors raised
+          # 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
           else
-            true # <= make the return value meaningful.  Meaning: transaction succeeded, no errors raised
+            Activerecord::Transactionable::Result.new(true) # <= make the return value meaningful.  Meaning: transaction succeeded, no errors raised
           end
         rescue *reraisable_errors => error
           # This has highest precedence because raising is the most critical functionality of a raised error to keep
@@ -175,7 +173,7 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
           #          To avoid the infinite recursion, we track the retry state
           if re_try
             transaction_error_logger(object: object, error: error, additional_message: " [#{transaction_open ? 'nested ' : ''}#{local_context} 2nd attempt]")
-            false # <= make the return value meaningful.  Meaning is: transaction failed after two attempts
+            Activerecord::Transactionable::Result.new(false) # <= make the return value meaningful.  Meaning is: transaction failed after two attempts
           else
             re_try = true
             # Not adding error to base when retrying, because otherwise the added error may
@@ -186,10 +184,10 @@ module Activerecord # Note lowercase "r" in Activerecord (different namespace th
         rescue *already_been_added_to_self => error
           # ActiveRecord::RecordInvalid, when done correctly, will have already added the error to object.
           transaction_error_logger(object: nil, error: error, additional_message: " [#{transaction_open ? 'nested ' : ''}#{local_context}]")
-          false # <= make the return value meaningful.  Meaning is: transaction failed
+          Activerecord::Transactionable::Result.new(false) # <= make the return value meaningful.  Meaning is: transaction failed
         rescue *needing_added_to_self => error
           transaction_error_logger(object: object, error: error, additional_message: " [#{transaction_open ? 'nested ' : ''}#{local_context}]")
-          false # <= make the return value meaningful.  Meaning is: transaction failed
+          Activerecord::Transactionable::Result.new(false) # <= make the return value meaningful.  Meaning is: transaction failed
         end
       end
 

data/lib/activerecord/transactionable/result.rb

@@ -0,0 +1,18 @@
+module Activerecord
+  module Transactionable
+    class Result
+      attr_reader :value
+      def initialize(value)
+        @value = value
+      end
+      
+      def fail?
+        value == false
+      end
+      
+      def success?
+        value == true
+      end
+    end
+  end
+end

data/lib/activerecord/transactionable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-transactionable
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-16 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +160,7 @@ files:
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_1.gemfile
 - lib/activerecord/transactionable.rb
+- lib/activerecord/transactionable/result.rb
 - lib/activerecord/transactionable/version.rb
 homepage: http://www.railsbling.com/tags/activerecord-transactionable
 licenses: