after_commit_everywhere 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b2847b6af9346bd5c042b364ccc1d94bbb696d82ef118362ad8085c2a96715
-  data.tar.gz: b0089a18d4087f800e161477678a8dd69871d2413801e33556751a5e7d6731f4
+  metadata.gz: 4425b11aa2651bd44ec24dc839e1338537f087f89c3f19f250d3ad2aeb0fad07
+  data.tar.gz: 143406ceecd3d9d3e1f7999f8cbb3754c19186036a7b2f47f19996c932048e26
 SHA512:
-  metadata.gz: 2c8342d72f9a2d076d62f52842aff823cdef8a8024e23f45c3360fdb662338878258efde0e2f09fe1f471d5830ed068d723af46f3ac628ef62daea843efdc723
-  data.tar.gz: b6a74ddc5d7e8f34db311fd44d9b88627c2213c70931e6ebaf635f64cc74a3051724af088b4c2ba04f4420b856779626a1fbab2bc0f07c2c9c22168f5a9ff779
+  metadata.gz: fdaa287369af57e90b69699fdbd11b687491ea9c938af714e8a68871954b3685e07c4a9ba16939094ea6f082cec84ce351c9354341685f42bcd58bcc0307ee29
+  data.tar.gz: 5a42c24b63cbdf2d84597e3fa6071d588a76e8821736239a146708dd155a8492dc657c29577022d7072c13ecdcc4d0b1ee22243701d1e1058ebcd13ee6072573

data/Appraisals

@@ -39,7 +39,4 @@ appraise "activerecord-master" do
 
   gem "sqlite3", "~> 1.4"
   gem "rspec-rails", "~> 4.0"
-
-  # See https://github.com/cgriego/active_attr/pull/183
-  gem "active_attr", git: "https://github.com/Envek/active_attr.git", branch: "chore/loose-dependency-constraint"
 end

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## 1.1.0 (2021-08-05)
+
+### Added
+
+- Allow to call transactional callbacks directly on `AfterCommitEverywhere` module:
+
+  ```ruby
+  AfterCommitEverywhere.after_commit { puts "If you see me then transaction has been successfully commited!" }
+  ```
+
+- Allow to call `in_transaction?` helper method from instance methods in classes that includes `AfterCommitEverywhere` module.
+
 ## 1.0.0 (2021-02-17)
 
 Declare gem as stable. No changes since 0.1.5.

data/Gemfile.lock

@@ -1,70 +1,71 @@
 PATH
   remote: .
   specs:
-    after_commit_everywhere (0.1.5)
+    after_commit_everywhere (1.0.0)
       activerecord (>= 4.2)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
       mail (>= 2.7.1)
-    actionmailer (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      actionview (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.2.1)
-      actionview (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
       nokogiri (>= 1.8.5)
-    actionview (6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    active_attr (0.15.1)
-      actionpack (>= 3.0.2, < 6.2)
-      activemodel (>= 3.0.2, < 6.2)
-      activesupport (>= 3.0.2, < 6.2)
-    activejob (6.1.2.1)
-      activesupport (= 6.1.2.1)
+    active_attr (0.15.3)
+      actionpack (>= 3.0.2, < 7.0)
+      activemodel (>= 3.0.2, < 7.0)
+      activesupport (>= 3.0.2, < 7.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
       globalid (>= 0.3.6)
-    activemodel (6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activerecord (6.1.2.1)
-      activemodel (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activestorage (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.2.1)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -72,79 +73,77 @@ GEM
       zeitwerk (~> 2.3)
     anyway_config (2.1.0)
       ruby-next-core (>= 0.11.0)
-    appraisal (2.3.0)
+    appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.9)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     isolator (0.7.0)
       sniffer (>= 0.3.1)
     jaro_winkler (1.5.4)
-    loofah (2.9.0)
+    loofah (2.11.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
-    minitest (5.14.3)
-    nio4r (2.5.5)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    mini_mime (1.1.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.2)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.2.1)
-      actioncable (= 6.1.2.1)
-      actionmailbox (= 6.1.2.1)
-      actionmailer (= 6.1.2.1)
-      actionpack (= 6.1.2.1)
-      actiontext (= 6.1.2.1)
-      actionview (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activemodel (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
       bundler (>= 1.15.0)
-      railties (= 6.1.2.1)
+      railties (= 6.1.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.3)
-    rexml (3.2.4)
+    rake (13.0.6)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -157,10 +156,10 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (4.0.2)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
@@ -191,7 +190,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
@@ -213,4 +212,4 @@ DEPENDENCIES
   sqlite3 (~> 1.3, >= 1.3.6)
 
 BUNDLED WITH
-   2.2.9
+   2.2.25

data/README.md

@@ -55,6 +55,12 @@ ActiveRecord::Base.transaction do
 end
 ```
 
+Or call it directly on module:
+
+```ruby
+AfterCommitEverywhere.after_commit { puts "We're all done!" }
+```
+
 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):
@@ -107,6 +113,12 @@ 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).
 
+### Available helper methods
+
+#### `in_transaction?`
+
+Returns `true` when called inside open transaction, `false` otherwise.
+
 ### FAQ
 
 #### Does it works with transactional_test or DatabaseCleaner
@@ -133,6 +145,34 @@ By calling [the class level `after_commit` method on models](https://api.rubyonr
 
 See https://github.com/Envek/after_commit_everywhere/issues/13 for details.
 
+#### But what if I want to use it inside models anyway?
+
+In class-level methods call `AfterCommitEverywhere.after_commit` directly:
+
+```ruby
+class Post < ActiveRecord::Base
+  def self.bulk_ops
+    find_each do
+       AfterCommitEverywhere.after_commit { puts "Now it works as expected!" }
+    end
+  end
+end
+```
+
+For usage in instance-level methods include this module to your model class (or right into your `ApplicationRecord`):
+
+```ruby
+class Post < ActiveRecord::Base
+  include AfterCommitEverywhere
+
+  def do_some_stuff
+    after_commit { puts "Now it works!" }
+  end
+end
+```
+
+However, if you do something in models that requires defining such ad-hoc transactional callbacks, it may indicate that your models have too many responsibilities and these methods should be extracted to separate secialized layers (service objects, etc).
+
 ## 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.

data/after_commit_everywhere.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 4.2"
+  spec.add_dependency "activesupport"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "isolator", "~> 0.7"

data/gemfiles/activerecord_master.gemfile

@@ -9,6 +9,5 @@ end
 
 gem "sqlite3", "~> 1.4"
 gem "rspec-rails", "~> 4.0"
-gem "active_attr", git: "https://github.com/Envek/active_attr.git", branch: "chore/loose-dependency-constraint"
 
 gemspec path: "../"

data/lib/after_commit_everywhere.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_record"
+require "active_support/core_ext/module/delegation"
 
 require "after_commit_everywhere/version"
 require "after_commit_everywhere/wrap"
@@ -12,65 +13,69 @@ require "after_commit_everywhere/wrap"
 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: __method__,
-      callback: callback,
-      no_tx_action: :execute,
-    )
-  end
+  delegate :after_commit, :before_commit, :after_rollback, to: AfterCommitEverywhere
+  delegate :in_transaction?, to: AfterCommitEverywhere
 
-  # Runs +callback+ before committing of outermost transaction for +connection+.
-  #
-  # If called outside transaction it will execute callback immediately.
-  #
-  # Available only since Ruby on Rails 5.0. See https://github.com/rails/rails/pull/18936
-  #
-  # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
-  # @param callback   [#call] Callback to be executed
-  # @return           void
-  def before_commit(connection: ActiveRecord::Base.connection, &callback)
-    if ActiveRecord::VERSION::MAJOR < 5
-      raise NotImplementedError, "#{__method__} works only with Rails 5.0+"
+  class << self
+    # 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)
+      register_callback(
+        connection: connection,
+        name: __method__,
+        callback: callback,
+        no_tx_action: :execute,
+      )
     end
 
-    AfterCommitEverywhere.register_callback(
-      connection: connection,
-      name: __method__,
-      callback: callback,
-      no_tx_action: :warn_and_execute,
-    )
-  end
+    # Runs +callback+ before committing of outermost transaction for +connection+.
+    #
+    # If called outside transaction it will execute callback immediately.
+    #
+    # Available only since Ruby on Rails 5.0. See https://github.com/rails/rails/pull/18936
+    #
+    # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+    # @param callback   [#call] Callback to be executed
+    # @return           void
+    def before_commit(connection: ActiveRecord::Base.connection, &callback)
+      if ActiveRecord::VERSION::MAJOR < 5
+        raise NotImplementedError, "#{__method__} works only with Rails 5.0+"
+      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: __method__,
-      callback: callback,
-      no_tx_action: :exception,
-    )
-  end
+      register_callback(
+        connection: connection,
+        name: __method__,
+        callback: callback,
+        no_tx_action: :warn_and_execute,
+      )
+    end
 
-  class << self
+    # 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)
+      register_callback(
+        connection: connection,
+        name: __method__,
+        callback: callback,
+        no_tx_action: :exception,
+      )
+    end
+
+    # @api private
     def register_callback(connection:, name:, no_tx_action:, callback:)
       raise ArgumentError, "Provide callback to #{name}" unless callback
 

data/lib/after_commit_everywhere/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AfterCommitEverywhere
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: after_commit_everywhere
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Executes code after database commit wherever you want in your application