activerecord-transactionable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 134ddc5a2d594c0ddf785ff45ff5ec2661f0660e
+  data.tar.gz: 3fb2afbaa552fbec81c70bb7824874646efacfde
+SHA512:
+  metadata.gz: 78d23d187b037feb977342e6120d001c92699b7db37dfd4cb953bd4add4dcc91762f822c359ce841dd3725d6c6232fcfe375d4b2f99f61415a9fc9aabff9e5a7
+  data.tar.gz: 71d8ae5296a058dca0ff90c746b15320824556c6fde806abcdf3e01e3556e7b8a4b1e09e438bec82473222c3b60631525e9b67632f275317122055b872b49590

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# So the gem can run the simple test suite against the raw bundled gems without the complex BUNDLE_GEMFILE setup
+gem "sqlite3", :platforms => [:ruby]
+
+# Specify your gem's dependencies in activerecord-transactionable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# Activerecord::Transactionable
+
+Provides a method, `transaction_wrapper` at the class and instance levels that can be used instead of `ActiveRecord#transaction`.
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-transactionable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-transactionable
+
+## Usage
+
+When creating, saving, deleting within the transaction make sure to use the bang methods (`!`) in order to ensure a rollback on failure.
+
+```
+car = Car.new(name: "Fiesta")
+car.transaction_wrapper do
+  car.save!
+end
+```
+
+Also see the specs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/activerecord-transactionable.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-transactionable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/transactionable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-transactionable"
+  spec.version       = Activerecord::Transactionable::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+  spec.licenses       = ["MIT"]
+
+  spec.summary       = %q{Do ActiveRecord transactions the right way.}
+  spec.description   = %q{Getting transactions right is hard, and this gem makes it easier.}
+  spec.homepage      = "http://www.railsbling.com/tags/activerecord-transactionable"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/transactionable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord/transactionable.rb

@@ -0,0 +1,83 @@
+require "activerecord/transactionable/version"
+require "active_model"
+require "active_record"
+
+module Activerecord
+  # SRP: Provides 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
+  module Transactionable
+    extend ActiveSupport::Concern
+
+    DEFAULT_ERRORS_TO_HANDLE = [ActiveRecord::RecordInvalid]
+    DEFAULT_ERRORS_WHICH_PREPARE_ERRORS_ON_SELF = [ActiveRecord::RecordInvalid]
+
+    def transaction_wrapper(**args)
+      self.class.transaction_wrapper(object: self, **args) do
+        yield
+      end
+    end
+
+    module ClassMethods
+      def transaction_wrapper(object: nil, **args)
+        rescued_errors = Array(args[:rescued_errors])
+        prepared_errors = Array(args[:prepared_errors])
+        retriable_errors = Array(args[:retriable_errors])
+        reraisable_errors = Array(args[:reraisable_errors])
+        rescued_errors.concat(DEFAULT_ERRORS_TO_HANDLE)
+        prepared_errors.concat(DEFAULT_ERRORS_WHICH_PREPARE_ERRORS_ON_SELF)
+        already_been_added_to_self, needing_added_to_self = rescued_errors.partition {|error_class| prepared_errors.include?(error_class)}
+        re_try = false
+        begin
+          ActiveRecord::Base.transaction do
+            yield
+          end
+          true # <= make the return value meaningful.  Meaning is either: transaction succeeded, OR raised ActiveRecord::Rollback
+        rescue *reraisable_errors => error
+          # This has highest precedence because raising is the most critical functionality of a raised error to keep
+          #   if that is in the intended behavior, and this way a specific child of StandardError can be reraised while
+          #   the parent can still be caught and added to self.errors
+          # Also adds the error to the object if there is an object.
+          transaction_error_logger(object: object, error: error, add_to: nil, additional_message: " [re-raising!]")
+          raise error
+        rescue *retriable_errors => error
+          # This will re-run the begin block above
+          # WARNING: If the same error keeps getting thrown this would infinitely recurse!
+          #          To avoid the infinite recursion, we track the retry state
+          if re_try
+            transaction_error_logger(object: object, error: error, additional_message: " [2nd attempt]")
+            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
+            #   prevent the subsequent save from working, in a catch-22
+            transaction_error_logger(object: object, error: error, add_to: nil, additional_message: " [1st attempt]")
+            retry
+          end
+        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: nil)
+          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: nil)
+          false # <= make the return value meaningful.  Meaning is: transaction failed
+        end
+      end
+
+      def transaction_error_logger(object:, error:, add_to: :base, additional_message: nil)
+        # Ruby arguments, like object, are passed by reference,
+        #   so this update to errors will be available to the caller
+        if object.nil?
+          # when a transaction wraps a bunch of CRUD actions,
+          #   the specific record that caused the ActiveRecord::RecordInvalid error may be out of scope
+          # Ideally you would rewrite the caller to call transaction_wrapper on a single record (even if updates happen on other records)
+          logger.error("[#{self}.transaction_wrapper] #{error.class}: #{error.message}#{additional_message}")
+        else
+          logger.error("[#{self}.transaction_wrapper] On #{object.class} #{error.class}: #{error.message}#{additional_message}")
+          object.errors.add(add_to, error.message) unless add_to.nil?
+        end
+      end
+    end
+
+  end
+end

data/lib/activerecord/transactionable/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module Transactionable
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-transactionable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Getting transactions right is hard, and this gem makes it easier.
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-transactionable.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/transactionable.rb
+- lib/activerecord/transactionable/version.rb
+homepage: http://www.railsbling.com/tags/activerecord-transactionable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Do ActiveRecord transactions the right way.
+test_files: []