activerecord-wrapped_transaction 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8516f90c26bfd324c7e7cb99cb66f3e1293d09f6
+  data.tar.gz: 848e4b660600b027ca8f64a3a4aa669a2deebe0d
+SHA512:
+  metadata.gz: bb0df845987d747f62e3079ca3ae7df3230f3932544ccaad7b048baa79b7a6cc77b95598e356f97673150e781d9e2b3713bb1ba1c6ff2ceed8890a3014c70c6f
+  data.tar.gz: c53d50ac11583b99d463288c9f3342b1328df51f6970e1e432715ce69214b301a16a05b7367609b76ee14f18ea2c9eead4c545a7e799f6bce6db1e04c70ae9f7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/db/*.sqlite3
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+env:
+  - DB=mysql
+  - DB=postgres
+  - DB=sqlite 
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at devel@mouse.vc. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-wrapped_transaction.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexa Grey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Activerecord::WrappedTransaction
+
+Wrap transactions in a way that lets you easily detect if the block succeeded or rolled back
+for complex, procedural usage with an object interface.
+
+It supports MySQL, PostgreSQL, and SQLite.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-wrapped_transaction'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-wrapped_transaction
+
+## Usage
+
+```ruby
+ActiveRecord::Base.include ActiveRecord::WrappedTransaction
+
+wrapped_result = ActiveRecord::Base.wrapped_transaction do
+  # Do something
+end
+
+wrapped_result.result # 
+wrapped_result.success?
+wrapped_result.rolled_back?
+```
+
+You can pass the same options you would to `ActiveRecord::Base.transaction`: `requires_new`, `isolation`, `joinable`
+
+## Todo
+
+* Test coverage for multiple connections (should be supported, but not guaranteed)
+* `Maybe` monad support for being able to execute complex logic more fluently.
+
+## 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/scryptmouse/activerecord-wrapped_transaction. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |c|
+  c.verbose = false
+end
+
+task :default => :spec

data/activerecord-wrapped_transaction.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/wrapped_transaction/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-wrapped_transaction"
+  spec.version       = ActiveRecord::WrappedTransaction::VERSION
+  spec.authors       = ["Alexa Grey"]
+  spec.email         = ["devel@mouse.vc"]
+
+  spec.summary       = %q{Wrap transactions in a manner that detects if the transaction completed}
+  spec.description   = %q{Wrap transactions in a manner that detects if the transaction completed}
+  spec.homepage      = "https://github.com/scryptmouse/activerecord-wrapped_transaction"
+  spec.license       = "MIT"
+
+  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 "activerecord", ">= 3.2", "< 6"
+
+  spec.add_development_dependency "simplecov", "~> 0.12.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pg",       "~> 0.18.0"
+  spec.add_development_dependency "mysql2",   "~> 0.4.4"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/wrapped_transaction"
+require_relative "../db/connection"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+PROJECT_ROOT=$(realpath "$(dirname $0)/../")
+
+if [ -z "$PG_USER" ]; then
+  if [[ "$(uname)" =~ "Darwin" ]]; then
+    PG_USER=$(whoami)
+  else
+    PG_USER=postgres
+  fi
+fi
+
+set -euo pipefail
+IFS=$'\n\t'
+#set -vx
+
+bundle install >/dev/null
+
+sqlite3 "$PROJECT_ROOT/db/wrapped_transaction_test.sqlite3" '.databases' >/dev/null
+mysql -e 'CREATE DATABASE IF NOT EXISTS wrapped_transaction_test;' >/dev/null
+psql -U $PG_USER -tc "SELECT 1 FROM pg_database WHERE datname = 'wrapped_transaction_test'" | grep -q 1 || psql -U $PG_USER -c "CREATE DATABASE wrapped_transaction_test"

data/db/connection.rb

@@ -0,0 +1,32 @@
+require 'active_record'
+
+class DBConnector
+  attr_reader :options
+
+  def initialize
+    @options = {}
+
+    case ENV['DB']
+    when /mysql/
+      options[:adapter]   = 'mysql2'
+      options[:username]  = 'root'
+      options[:database]  = 'wrapped_transaction_test'
+      options[:encoding]  = 'utf8'
+    when /postgres/
+      options[:adapter]   = 'postgresql'
+      options[:database]  = 'wrapped_transaction_test'
+    else
+      options[:adapter]   = 'sqlite3'
+      options[:database]  = File.join(__dir__, 'wrapped_transaction_test.sqlite3')
+    end
+  end
+
+  def ci?
+    ENV['CI'].present?
+  end
+end
+
+ActiveRecord::Base.establish_connection DBConnector.new.options
+
+require_relative './schema'
+require_relative './models'

data/db/models.rb

@@ -0,0 +1,9 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  include ActiveRecord::WrappedTransaction
+end
+
+class Widget < ApplicationRecord
+  validates_presence_of :name
+end

data/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :widgets, force: true do |t|
+    t.string :name
+
+    t.timestamps null: false
+  end
+end

data/lib/activerecord-wrapped_transaction.rb

@@ -0,0 +1 @@
+require 'activerecord/wrapped_transaction'

data/lib/activerecord/wrapped_transaction.rb

@@ -0,0 +1,26 @@
+require "active_record"
+require "activerecord/wrapped_transaction/version"
+require "activerecord/wrapped_transaction/result"
+
+module ActiveRecord
+  module WrappedTransaction
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :wrapped_transaction, to: :class
+    end
+
+    class_methods do
+      # @return [ActiveRecord::WrappedTransaction::Result]
+      def wrapped_transaction(options = {}, &block)
+        ActiveRecord::WrappedTransaction::Result.new(transactor: connection, transaction_options: options, &block)
+      end
+    end
+
+    class << self
+      def call(transactor: ActiveRecord::Base, **options)
+        ActiveRecord::WrappedTransaction::Result.new(transactor: transactor, transaction_options: options) { yield }
+      end
+    end
+  end
+end

data/lib/activerecord/wrapped_transaction/result.rb

@@ -0,0 +1,93 @@
+module ActiveRecord
+  module WrappedTransaction
+    class Result
+      TXN_COMPLETE  = Object.new.freeze
+      NOT_CANCELLED = Object.new.freeze
+
+      private_constant :TXN_COMPLETE
+      private_constant :NOT_CANCELLED
+
+      # @!attribute [r] cancellation_reason
+      # @return [Object, nil]
+      attr_reader :cancellation_reason
+
+      # @!attribute [r] error
+      # @return [Exception, nil]
+      attr_reader :error
+
+      # @!attribute [r] result
+      # @return [Object, nil]
+      attr_reader :result
+
+      # @!attribute [r] transactor
+      # @return [#transaction, ActiveRecord::ConnectionAdapters::AbstractAdapter]
+      attr_reader :transactor
+
+      # @param [#transaction, ActiveRecord::ConnectionAdapters::AbstractAdapter] transactor
+      # @yield A block that goes in the transaction.
+      # @yieldreturn [Object]
+      def initialize(transactor: ActiveRecord::Base, transaction_options: {})
+        unless block_given?
+          raise ArgumentError, "Must call with a block to run in the transaction"
+        end
+
+        unless transactor.respond_to?(:transaction)
+          raise ArgumentError, "transactor `#{transactor.inspect} must respond to :transaction"
+        else
+          @transactor = transactor
+        end
+
+        wrap_transaction transaction_options do
+          execute_transaction do
+            watch_for_cancellation do
+              @result = yield
+            end
+          end
+        end
+
+        freeze
+      end
+
+      def cancelled?
+        @cancelled
+      end
+
+      def success?
+        @success
+      end
+
+      def rolled_back?
+        !success?
+      end
+
+      private
+      def wrap_transaction(transaction_options = {})
+        caught = transactor.transaction(transaction_options) do
+          yield
+        end
+      ensure
+        @success = caught.eql?(TXN_COMPLETE)
+      end
+
+      def execute_transaction
+        yield
+      rescue Exception => e
+        @error = e
+
+        raise ActiveRecord::Rollback
+      else
+        TXN_COMPLETE
+      end
+
+      def watch_for_cancellation
+        cancellation_reason = catch(:cancel_transaction) { yield; NOT_CANCELLED }
+
+        unless cancellation_reason.eql?(NOT_CANCELLED)
+          @cancelled = true
+          @cancellation_reason = cancellation_reason
+          raise ActiveRecord::Rollback, "Cancelled transaction"
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/wrapped_transaction/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module WrappedTransaction
+    VERSION = "0.5.1"
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-wrapped_transaction
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Alexa Grey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrap transactions in a manner that detects if the transaction completed
+email:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-wrapped_transaction.gemspec
+- bin/console
+- bin/setup
+- db/connection.rb
+- db/models.rb
+- db/schema.rb
+- lib/activerecord-wrapped_transaction.rb
+- lib/activerecord/wrapped_transaction.rb
+- lib/activerecord/wrapped_transaction/result.rb
+- lib/activerecord/wrapped_transaction/version.rb
+homepage: https://github.com/scryptmouse/activerecord-wrapped_transaction
+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.5
+signing_key: 
+specification_version: 4
+summary: Wrap transactions in a manner that detects if the transaction completed
+test_files: []