after_commit_everywhere 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6eb14b053c0170cfb885875b2b5c0f50fbd1d84f09847b939e87eb875aac28a4
+  data.tar.gz: 1610ebf77543a2d55ce3208ecc7d739667544ef6dfa5dc4f72f86d5b8e53c4ff
+SHA512:
+  metadata.gz: f308a4913a2b8557e3027cbdebe357d45cede83d4a0f818afb598d0157610c72bc4777a18409402b9c67f63a1e50b803a6bc87c34487f473e514799df0306cf6
+  data.tar.gz: f3aaddff157104f2afab4924cc84d94b83c02028e85b5119a98ec8e76aadb003133e3f3b24f4bd8dd062ffa5a0b861cd80d439db098e653e421160370cc40764

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/gemfiles/*.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  UseCache: false
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.*"
+    - "*.gemspec"
+
+Lint/HandleExceptions:
+  Exclude:
+    - "spec/**/*.*"
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,25 @@
+cache: bundler
+sudo: false
+language: ruby
+
+addons:
+  apt:
+    sources:
+      - travis-ci/sqlite3
+    packages:
+      - sqlite3
+
+matrix:
+  include:
+    - rvm: 2.5.0
+      gemfile: gemfiles/activerecord_5_0.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/activerecord_5_1.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/activerecord_5_2.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/activerecord_master.gemfile
+    - rvm: 2.4.3
+      gemfile: gemfiles/activerecord_5_2.gemfile
+    - rvm: 2.3.6
+      gemfile: gemfiles/activerecord_5_2.gemfile

data/Appraisals

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+appraise 'activerecord-5-0' do
+  gem 'activerecord', '~> 5.0.0'
+end
+
+appraise 'activerecord-5-1' do
+  gem 'activerecord', '~> 5.1.0'
+end
+
+appraise 'activerecord-5-2' do
+  gem 'activerecord', '~> 5.2.0.rc1'
+end
+
+appraise 'activerecord-master' do
+  gem 'activerecord', git: 'https://github.com/rails/rails.git'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in after_commit_everywhere.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+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,130 @@
+[![Gem Version](https://badge.fury.io/rb/after_commit_everywhere.svg)](https://rubygems.org/gems/after_commit_everywhere)
+[![Build Status](https://travis-ci.org/Envek/after_commit_everywhere.svg?branch=master)](https://travis-ci.org/Envek/after_commit_everywhere)
+
+# `after_commit` everywhere
+
+Allows to use ActiveRecord transactional callbacks outside of ActiveRecord models, literally everywhere in your application.
+
+Inspired by these articles:
+
+ - https://dev.to/evilmartians/rails-aftercommit-everywhere--4j9g
+ - https://blog.arkency.com/2015/10/run-it-in-background-job-after-commit/
+
+<a href="https://evilmartians.com/?utm_source=after_commit_everywhere&utm_campaign=project_page"><img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'after_commit_everywhere'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install after_commit_everywhere
+
+
+## Usage
+
+Recommended usage is to include it to your base service class or anything:
+
+```ruby
+class ServiceObjectBtw
+  include AfterCommitEverywhere
+
+  def call
+    ActiveRecord::Base.transaction do
+      after_commit { puts "We're all done!" }
+    end
+  end
+end
+```
+
+Or just extend it whenever you need it:
+
+```ruby
+extend AfterCommitEverywhere
+
+ActiveRecord::Base.transaction do
+  after_commit { puts "We're all done!" }
+end
+```
+
+That's it!
+
+But the main benefit is that it works with nested `transaction` blocks (may be even spread across many files in your codebase):
+
+```ruby
+include AfterCommitEverywhere
+
+ActiveRecord::Base.transaction do
+  puts "We're in transaction now"
+
+  ActiveRecord::Base.transaction do
+    puts "More transactions"
+    after_commit { puts "We're all done!" }
+  end
+
+  puts "Still in transaction…"
+end
+```
+
+Will output:
+
+```
+We're in transaction now
+More transactions
+Still in transaction…
+We're all done!
+```
+
+### Available callbacks
+
+#### `after_commit`
+
+Will be executed right after outermost transaction have been successfully committed and data become available to other DBMS clients.
+
+If called outside transaction will execute callback immediately.
+
+#### `before_commit`
+
+Will be executed right before outermost transaction will be commited _(I can't imagine use case for it but if you can, please open a pull request or issue)_.
+
+If called outside transaction will execute callback immediately.
+
+#### `after_rollback`
+
+Will be executed right after transaction in which it have been declared was rolled back (this might be nested savepoint transaction block with `requires_new: true`).
+
+If called outside transaction will raise an exception!
+
+Please keep in mind ActiveRecord's [limitations for rolling back nested transactions](http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html#module-ActiveRecord::Transactions::ClassMethods-label-Nested+transactions).
+
+### FAQ
+
+#### Does it works with transactional_test or DatabaseCleaner
+
+*Yes* but currently it is not tested (help wanted).
+
+
+## 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/Envek/after_commit_everywhere.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/after_commit_everywhere.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'after_commit_everywhere/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'after_commit_everywhere'
+  spec.version       = AfterCommitEverywhere::VERSION
+  spec.authors       = ['Andrey Novikov']
+  spec.email         = ['envek@envek.name']
+
+  spec.summary       = <<~MSG.strip
+    Executes code after database commit wherever you want in your application
+  MSG
+
+  spec.description = <<~MSG.strip
+    Brings before_commit, after_commit, and after_rollback transactional \
+    callbacks outside of your ActiveRecord models.
+  MSG
+  spec.homepage      = 'https://github.com/Envek/after_commit_everywhere'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'after_commit_everywhere'
+
+# 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.
+
+require 'pry'
+Pry.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/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/activerecord_5_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0.rc1"
+
+gemspec path: "../"

data/gemfiles/activerecord_master.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", git: "https://github.com/rails/rails.git"
+
+gemspec path: "../"

data/lib/after_commit_everywhere.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'after_commit_everywhere/version'
+require 'after_commit_everywhere/wrap'
+
+# Module allowing to use ActiveRecord transactional callbacks outside of
+# ActiveRecord models, literally everywhere in your application.
+#
+# Include it to your classes (e.g. your base service object class or whatever)
+module AfterCommitEverywhere
+  class NotInTransaction < RuntimeError; end
+
+  # Runs +callback+ after successful commit of outermost transaction for
+  # database +connection+.
+  #
+  # If called outside transaction it will execute callback immediately.
+  #
+  # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+  # @param callback   [#call] Callback to be executed
+  # @return           void
+  def after_commit(connection: ActiveRecord::Base.connection, &callback)
+    AfterCommitEverywhere.register_callback(
+      connection: connection,
+      name: __callee__,
+      callback: callback,
+      no_tx_action: :warn,
+    )
+  end
+
+  # Runs +callback+ before committing of outermost transaction for +connection+.
+  #
+  # If called outside transaction it will execute callback immediately.
+  #
+  # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+  # @param callback   [#call] Callback to be executed
+  # @return           void
+  def before_commit(connection: ActiveRecord::Base.connection, &callback)
+    AfterCommitEverywhere.register_callback(
+      connection: connection,
+      name: __callee__,
+      callback: callback,
+      no_tx_action: :warn,
+    )
+  end
+
+  # Runs +callback+ after rolling back of transaction or savepoint (if declared
+  # in nested transaction) for database +connection+.
+  #
+  # Caveat: do not raise +ActivRecord::Rollback+ in nested transaction block!
+  # See http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html#module-ActiveRecord::Transactions::ClassMethods-label-Nested+transactions
+  #
+  # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+  # @param callback   [#call] Callback to be executed
+  # @return           void
+  # @raise            [NotInTransaction] if called outside transaction.
+  def after_rollback(connection: ActiveRecord::Base.connection, &callback)
+    AfterCommitEverywhere.register_callback(
+      connection: connection,
+      name: __callee__,
+      callback: callback,
+      no_tx_action: :exception,
+    )
+  end
+
+  class << self
+    def register_callback(connection:, name:, no_tx_action:, callback:)
+      raise ArgumentError, "Provide callback to #{name}" unless callback
+      unless in_transaction?(connection)
+        case no_tx_action
+        when :warn
+          warn "#{name}: No transaction open. Executing callback immediately."
+          return callback.call
+        when :exception
+          raise NotInTransaction, "#{name} is useless outside transaction"
+        end
+      end
+      wrap = Wrap.new(connection: connection, "#{name}": callback)
+      connection.add_transaction_record(wrap)
+    end
+
+    private
+
+    def in_transaction?(connection)
+      # service transactions (tests and database_cleaner) are not joinable
+      connection.transaction_open? && connection.current_transaction.joinable?
+    end
+  end
+end

data/lib/after_commit_everywhere/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AfterCommitEverywhere
+  VERSION = '0.1.0'
+end

data/lib/after_commit_everywhere/wrap.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module AfterCommitEverywhere
+  # ActiveRecord model-like class to fake ActiveRecord to make it believe
+  # that it calls transactional callbacks on real model objects.
+  class Wrap
+    def initialize(connection: ActiveRecord::Base.connection, **handlers)
+      @connection = connection
+      @handlers = handlers
+    end
+
+    # rubocop: disable Naming/PredicateName
+    def has_transactional_callbacks?
+      true
+    end
+    # rubocop: enable Naming/PredicateName
+
+    def before_committed!(*)
+      @handlers[:before_commit]&.call
+    end
+
+    def committed!(*)
+      @handlers[:after_commit]&.call
+    end
+
+    def rolledback!(*)
+      @handlers[:after_rollback]&.call
+    end
+
+    # Required for +transaction(requires_new: true)+
+    def add_to_transaction(*)
+      @connection.add_transaction_record(self)
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: after_commit_everywhere
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 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: Brings before_commit, after_commit, and after_rollback transactional     callbacks
+  outside of your ActiveRecord models.
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- after_commit_everywhere.gemspec
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/activerecord_5_0.gemfile
+- gemfiles/activerecord_5_1.gemfile
+- gemfiles/activerecord_5_2.gemfile
+- gemfiles/activerecord_master.gemfile
+- lib/after_commit_everywhere.rb
+- lib/after_commit_everywhere/version.rb
+- lib/after_commit_everywhere/wrap.rb
+homepage: https://github.com/Envek/after_commit_everywhere
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Executes code after database commit wherever you want in your application
+test_files: []