activerecord-wrapped_transaction 0.5.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8516f90c26bfd324c7e7cb99cb66f3e1293d09f6
-  data.tar.gz: 848e4b660600b027ca8f64a3a4aa669a2deebe0d
+SHA256:
+  metadata.gz: ec2e05ea513d0e8840e54718aa1c20e2e7427e47386dc95c9174312ae4912bae
+  data.tar.gz: 1d8278fcfc51110911a860b1434b26bac62056967c30c73272c7b4f5cf811f4f
 SHA512:
-  metadata.gz: bb0df845987d747f62e3079ca3ae7df3230f3932544ccaad7b048baa79b7a6cc77b95598e356f97673150e781d9e2b3713bb1ba1c6ff2ceed8890a3014c70c6f
-  data.tar.gz: c53d50ac11583b99d463288c9f3342b1328df51f6970e1e432715ce69214b301a16a05b7367609b76ee14f18ea2c9eead4c545a7e799f6bce6db1e04c70ae9f7
+  metadata.gz: cc8889bed01589292453020f988dc5249cdb26841988348e8f845b7c744fdb2f7578bc7c682c8368fc7da2f76a5e66dc6ec04d22cca1a51b21cc29db5e5931f1
+  data.tar.gz: fa0e8e95052fa790cbded234bf2f464f95b5706b4349a3f00b6761623b8730470dafd4148af451853a8f90cc06606c2b9e9ec60c79e8a8379701a5231db17e49

data/.github/workflows/main.yml

@@ -0,0 +1,89 @@
+name: "Main"
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'lib/**'
+      - 'spec/**'
+      - '.github/workflows/main.yml'
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+        rails_version: [5, 6]
+        db: [pg, mysql2, sqlite3]
+        exclude:
+          - rails_version: 6
+            ruby: 2.4
+    env:
+      APPRAISAL_NAME: rails-${{ matrix.rails_version }}-${{ matrix.db }}
+      BUNDLE_GEMFILE: ${{ format('./gemfiles/rails_{0}_{1}.gemfile', matrix.rails_version, matrix.db) }}
+      DB_NAME: wrapped_transaction_test
+      PG_USER: test
+      PG_PASS: test
+      MYSQL_USER: root
+      MYSQL_PASS: root
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: "Install postgresql client"
+        if: ${{ matrix.db == 'pg' }}
+        run: |
+          sudo apt-get update --fix-missing
+          sudo apt-get -yqq install libpq-dev
+      - name: "Set up PG"
+        uses: harmon758/postgresql-action@v1
+        if: ${{ matrix.db == 'pg' }}
+        with:
+          postgresql version: '11'
+          postgresql db: ${{ env.DB_NAME }}
+          postgresql user: ${{ env.PG_USER }}
+          postgresql password: ${{ env.PG_PASS }}
+      - name: "Set PG DATABASE_URL"
+        if: ${{ matrix.db == 'pg' }}
+        run: |
+          echo "::set-env name=DATABASE_URL::postgres://${PG_USER}:${PG_PASS}@localhost/${DB_NAME}"
+      - name: "Shut down default MySQL database"
+        if: ${{ matrix.db == 'mysql2' }}
+        run: |
+          sudo systemctl stop mysql.service
+      - name: "Set Up MySQL"
+        if: ${{ matrix.db == 'mysql2' }}
+        uses: mirromutth/mysql-action@v1.1
+        with:
+          mysql database: ${{ env.DB_NAME }}
+          mysql root password: ${{ env.MYSQL_PASS }}
+      - name: "Set MySQL DATABASE_URL"
+        if: ${{ matrix.db == 'mysql2' }}
+        run: |
+          echo "::set-env name=DATABASE_URL::mysql2://${MYSQL_USER}:${MYSQL_PASS}@127.0.0.1/${DB_NAME}"
+      - name: "Install sqlite3"
+        if: ${{ matrix.db == 'sqlite3' }}
+        run: |
+          sudo apt-get update --fix-missing
+          sudo apt-get -yqq install sqlite3 libsqlite3-dev
+          echo "::set-env name=DATABASE_URL::sqlite3::memory:"
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-use-ruby-ubuntu-latest-${{ matrix.ruby }}-${{ env.APPRAISAL_NAME }}-${{ hashFiles(format('{0}.lock', env.BUNDLE_GEMFILE)) }}
+          restore-keys: |
+            bundle-use-ruby-ubuntu-latest-${{ matrix.ruby }}-${{ env.APPRAISAL_NAME }}
+      - name: bundle install
+        run: |
+          gem update --system
+          bundle config deployment true
+          bundle config path vendor/bundle
+          bundle install --jobs 4
+      - name: "Run RSpec"
+        run: |
+          bin/rspec

data/.rspec

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

data/Appraisals

@@ -0,0 +1,29 @@
+appraise "rails-5-pg" do
+  gem "activerecord", "~> 5", "< 6"
+  gem "pg"
+end
+
+appraise "rails-6-pg" do
+  gem "activerecord", "~> 6", "< 7"
+  gem "pg"
+end
+
+appraise "rails-5-mysql2" do
+  gem "activerecord", "~> 5", "< 6"
+  gem "mysql2"
+end
+
+appraise "rails-6-mysql2" do
+  gem "activerecord", "~> 6", "< 7"
+  gem "mysql2"
+end
+
+appraise "rails-5-sqlite3" do
+  gem "activerecord", "~> 5", "< 6"
+  gem "sqlite3"
+end
+
+appraise "rails-6-sqlite3" do
+  gem "activerecord", "~> 6", "< 7"
+  gem "sqlite3"
+end

data/README.md

@@ -1,16 +1,20 @@
 # 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.
+Wrap transactions in an object-oriented way so that you can tell if an individual transaction
+succeeded, rolled back, or was cancelled.
 
-It supports MySQL, PostgreSQL, and SQLite.
+Supported versions and databases:
+
+* Rails 5 and 6
+* MySQL, PostgreSQL, and SQLite
+* Ruby 2.4, 2.5, 2.6, 2.7
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activerecord-wrapped_transaction'
+gem "activerecord-wrapped_transaction", "~> 0.9"
 ```
 
 And then execute:
@@ -19,29 +23,53 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install activerecord-wrapped_transaction
+    $ gem install activerecord-wrapped_transaction -v "~> 0.9"
 
 ## Usage
 
+Contrived example:
+
 ```ruby
 ActiveRecord::Base.include ActiveRecord::WrappedTransaction
 
-wrapped_result = ActiveRecord::Base.wrapped_transaction do
-  # Do something
+wrapped_result = ActiveRecord::Base.wrapped_transaction do |context|
+  user = User.create! attributes 
+
+  failable_result = OptionalThing.wrapped_transaction requires_new: true do
+    # This can fail, but we'll let it
+    OptionalThing.create! user: user, foo: "bar"
+  end
+
+  failable_result.rolled_back? # => true
+
+  # There is also a shorthand that uses the optional context helper
+  # This creates a new transaction layer that has requires_new: true
+  # set implicitly.
+  other_failable = context.maybe do
+	Something.explodes!
+  end
+
+  other_failable.rolled_back? # => true
+
+  cancelled = context.maybe do |inner_context|
+	inner_context.cancel! "arbitrarily"
+  end
+
+  cancelled.cancelled? # => true
+  cancelled.rolled_back? # => true
+  cancelled.cancellation_reason # => "arbitrarily"
+
+  # return our result
+  user
 end
 
-wrapped_result.result # 
-wrapped_result.success?
-wrapped_result.rolled_back?
+wrapped_result.result # => user
+wrapped_result.success? # => true
+wrapped_result.rolled_back? # => false
 ```
 
 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.
@@ -56,4 +84,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/scrypt
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -5,4 +5,4 @@ RSpec::Core::RakeTask.new(:spec) do |c|
   c.verbose = false
 end
 
-task :default => :spec
+task default: :spec

data/activerecord-wrapped_transaction.gemspec

@@ -19,14 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 3.2", "< 6"
+  spec.add_dependency "activerecord", ">= 5", "< 7"
 
-  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 "appraisal", "~> 2.3.0"
+  spec.add_development_dependency "simplecov", "~> 0.18.5"
+  spec.add_development_dependency "database_cleaner-active_record", "~> 1.8.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   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/appraisal

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'appraisal' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appraisal", "appraisal")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -16,5 +16,5 @@ IFS=$'\n\t'
 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
+mysql -u root -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

@@ -1,32 +1,50 @@
-require 'active_record'
+require "active_record"
 
 class DBConnector
   attr_reader :options
+  attr_reader :rails_version
+  attr_reader :type
+  attr_reader :url
 
   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'
+    raise "No BUNDLE_GEMFILE set" if ENV["BUNDLE_GEMFILE"].blank?
+
+    @gemfile = File.basename(ENV["BUNDLE_GEMFILE"] || "", ".gemfile")
+
+    @url = ENV["DATABASE_URL"]
+
+    @options[:url] = @url if @url.present?
+
+    _, @rails_version, @type = *@gemfile.match(/\Arails_(\d+)_(.+)\z/)
+
+    case @type
+    when /mysql2\z/
+      options[:adapter]   = "mysql2"
+      options[:username]  = ENV.fetch("MYSQL_USER", "root")
+      options[:password]  = ENV.fetch("MYSQL_PASS", nil)
+      options[:database]  = ENV.fetch("DB_NAME", "wrapped_transaction_test")
+      options[:encoding]  = "utf8"
+    when /pg\z/
+      options[:adapter]   = "postgresql"
+      options[:database]  = ENV.fetch("DB_NAME", "wrapped_transaction_test")
+    when /sqlite3\z/
+      options[:adapter]   = "sqlite3"
+      options[:database]  = File.join(__dir__, "wrapped_transaction_test.sqlite3")
     else
-      options[:adapter]   = 'sqlite3'
-      options[:database]  = File.join(__dir__, 'wrapped_transaction_test.sqlite3')
+      raise "Unknown db adapter: #{@type}"
     end
   end
 
   def ci?
-    ENV['CI'].present?
+    ENV["CI"].present?
   end
 end
 
-ActiveRecord::Base.establish_connection DBConnector.new.options
+DBENV = DBConnector.new
+
+ActiveRecord::Base.establish_connection DBENV.url || DBENV.options
 
-require_relative './schema'
-require_relative './models'
+require_relative "./schema"
+require_relative "./models"

data/db/models.rb

@@ -5,5 +5,5 @@ class ApplicationRecord < ActiveRecord::Base
 end
 
 class Widget < ApplicationRecord
-  validates_presence_of :name
+  validates :name, presence: true, uniqueness: true
 end

data/db/schema.rb

@@ -5,5 +5,7 @@ ActiveRecord::Schema.define do
     t.string :name
 
     t.timestamps null: false
+
+    t.index :name, unique: true
   end
 end

data/gemfiles/rails_5_mysql2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5", "< 6"
+gem "mysql2"
+
+gemspec path: "../"