active_job-performs 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afad0c3e092f329deb71fea10b4f2105d1a2fbff2d581eb46304411c8cf5c592
-  data.tar.gz: ec2db477f5e639b8dd8f4e1958f2f2813e9d32a85b6526693878a10927da6f0a
+  metadata.gz: a4395366ab43af9510f569bcc141c9404a15fd2d6da529029eedc970c7a8f886
+  data.tar.gz: 9e239bf9a60e4e2785ae4b104f2cfd01e9b832729202f78ad9443c82046a7be6
 SHA512:
-  metadata.gz: 0213fcbdd14ecc60adbbff93d2f515b1ec1dee6f9511d9b69037ac2e85610cbaa9b3458a0b5256cba2f18f2d5e3f814dddf04e2993e89e3b0e44151b0cbc5819
-  data.tar.gz: 6bf98a858966a833b872643a3fc5b33f23d27d1499eaf8b917f5c470bb43b49cd2e8c68c8f0cad251714a84c7da2a531d4809e72b8db364818a8d76bbe827107
+  metadata.gz: 678c75e3a24b9faa407b01a063c15fadefc23747489b9e55db52641298385f2632b91268ae20ef9bf4964562e36ed5b6df99d46b1384605fb0ee694e29c0ae3d
+  data.tar.gz: 22231da5fc1856e480d00329e5a0cbf2482840d48eb2b2ea716751cbcc0d413d65169252aa8f3cc021b6f474e80f2a98912ce63bc1916ad2d2c1b29a3c7d273a

data/Gemfile

@@ -9,3 +9,11 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 gem "minitest-sprint"
+
+gem "debug"
+
+# Fetch latest Active Job to test `ActiveJob.perform_all_later`
+gem "activejob",    ">= 7.1"
+gem "activerecord", ">= 7.1"
+
+gem "sqlite3", "~> 1.4"

data/Gemfile.lock

@@ -1,42 +1,79 @@
 PATH
   remote: .
   specs:
-    active_job-performs (0.2.0)
+    active_job-performs (0.3.1)
       activejob (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.0.4)
-      activesupport (= 7.0.4)
+    activejob (7.1.3.3)
+      activesupport (= 7.1.3.3)
       globalid (>= 0.3.6)
-    activesupport (7.0.4)
+    activemodel (7.1.3.3)
+      activesupport (= 7.1.3.3)
+    activerecord (7.1.3.3)
+      activemodel (= 7.1.3.3)
+      activesupport (= 7.1.3.3)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    concurrent-ruby (1.1.10)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.3)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    minitest (5.23.1)
     minitest-sprint (1.2.2)
       path_expander (~> 1.1)
+    mutex_m (0.2.0)
     path_expander (1.1.1)
-    rake (13.0.6)
-    tzinfo (2.0.5)
+    psych (5.1.2)
+      stringio
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.7)
+      io-console (~> 0.5)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    stringio (3.1.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
-  arm64-darwin-20
+  arm64-darwin
   x86_64-linux
 
 DEPENDENCIES
   active_job-performs!
+  activejob (>= 7.1)
+  activerecord (>= 7.1)
+  debug
   minitest (~> 5.0)
   minitest-sprint
   rake (~> 13.0)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   2.3.21
+   2.5.4

data/README.md

@@ -2,7 +2,7 @@
 
 `ActiveJob::Performs` adds the `performs` macro to set up jobs by convention.
 
-## Usage with `include GlobalID::Identification` objects
+## Usage with `ActiveRecord::Base` & other `GlobalID::Identification` objects
 
 `ActiveJob::Performs` works with any object that has `include GlobalID::Identification` and responds to that interface.
 
@@ -14,7 +14,7 @@ class Post < ActiveRecord::Base
 
   # `performs` builds a `Post::PublishJob` and routes configs over to it.
   performs :publish, queue_as: :important, discard_on: SomeError do
-    retry_on TimeoutError, wait: :exponentially_longer
+    retry_on TimeoutError, wait: :polynomially_longer
   end
 
   def publish
@@ -34,7 +34,7 @@ class Post < ActiveRecord::Base
   class PublishJob < Job
     queue_as :important
     discard_on SomeError
-    retry_on TimeoutError, wait: :exponentially_longer
+    retry_on TimeoutError, wait: :polynomially_longer
 
     # We generate `perform` passing in the `post` and calling `publish` on it.
     def perform(post, *arguments, **options)
@@ -42,6 +42,14 @@ class Post < ActiveRecord::Base
     end
   end
 
+  # On Rails 7.1, where `ActiveJob.perform_all_later` exists, we also generate
+  # a bulk method to enqueue many jobs at once. So you can do this:
+  #
+  #   Post.unpublished.in_batches.each(&:publish_later_bulk)
+  def self.publish_later_bulk
+    ActiveJob.perform_all_later all.map { PublishJob.new(_1) }
+  end
+
   # We generate `publish_later` to wrap the job execution.
   def publish_later(*arguments, **options)
     PublishJob.perform_later(self, *arguments, **options)
@@ -91,6 +99,38 @@ class Post < ActiveRecord::Base
 end
 ```
 
+#### Establishing patterns across your app
+
+If there's an Active Record method that you'd like any model to be able to run from a background job, you can set them up in your `ApplicationRecord`:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  # We're passing specific queues for monitoring, but you may not need or want them.
+  performs :touch,   queue_as: "active_record.touch"
+  performs :update,  queue_as: "active_record.update"
+  performs :destroy, queue_as: "active_record.destroy"
+end
+```
+
+Then a model could now run things like:
+
+```ruby
+record.touch_later
+record.touch_later :reminded_at, time: 5.minutes.from_now # Pass supported arguments to `touch`
+
+record.update_later reminded_at: 1.year.ago
+
+# Particularly handy to use on a record with many `dependent: :destroy` associations.
+# Plus if anything fails, the transaction will rollback and the job fails, so you can retry it later!
+record.destroy_later
+```
+
+You may not want this for `touch` and `update`, and maybe you'd rather architect your system in such a way that they don't have so many side-effects, but having the option can be handy!
+
+Also, I haven't tested all the Active Record methods, so please file an issue if you encounter any.
+
 #### Method suffixes
 
 `ActiveJob::Performs` supports Ruby's stylistic method suffixes, i.e. ? and ! respectively.
@@ -129,7 +169,20 @@ Additionally, in case the job is meant to be internal to the object, `performs :
 
 E.g. `private performs :some_method` will generate a private `some_method_later` method.
 
-### Usage with ActiveRecord::AssociatedObject
+#### Overriding the generated instance `_later` method
+
+The instance level `_later` methods, like `publish_later` above, are generated into an included module. So in case you have a condition where you'd like to prevent the enqueue, you can override the method and call `super`:
+
+```ruby
+class Post < ApplicationRecord
+  performs def publish
+    # …
+  end
+  def publish_later = some_condition? && super
+end
+```
+
+### Usage with `ActiveRecord::AssociatedObject`
 
 The [`ActiveRecord::AssociatedObject`](https://github.com/kaspth/active_record-associated_object) gem also implements `GlobalID::Identification`, so you can do this too:
 
@@ -177,6 +230,12 @@ class Post < ActiveRecord::Base
 end
 ```
 
+### Praise from people
+
+Here's what [@nshki](https://github.com/nshki) found when they tried `ActiveJob::Performs`:
+
+> Spent some time playing with [@kaspth](https://github.com/kaspth)'s [`ActiveRecord::AssociatedObject`](https://github.com/kaspth/active_record-associated_object) and `ActiveJob::Performs` and wow! The conventions these gems put in place help simplify a codebase drastically. I particularly love `ActiveJob::Performs`—it helped me refactor out all `ApplicationJob` classes I had and keep important context in the right domain model.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/active_job/performs/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Performs
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/active_job/performs.rb

@@ -46,11 +46,21 @@ module ActiveJob::Performs
         end
       RUBY
 
-      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+      if ActiveJob.respond_to?(:perform_all_later) && respond_to?(:all)
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def self.#{method}_later_bulk#{suffix}
+            ActiveJob.perform_all_later all.map { #{job}.scoped_by_wait(_1).new(_1) }
+          end
+        RUBY
+      end
+
+      performs_later_methods.class_eval <<~RUBY, __FILE__, __LINE__ + 1
         def #{method}_later#{suffix}(*arguments, **options)
           #{job}.scoped_by_wait(self).perform_later(self, *arguments, **options)
         end
       RUBY
+
+      [method, :"#{method}_later#{suffix}"] # Ensure `private performs :some_method` privates both names.
     end
   end
 
@@ -63,6 +73,10 @@ module ActiveJob::Performs
       configs.each { job_class.public_send(_1, _2) }
       job_class.class_exec(&block) if block_given?
     end
+
+    def performs_later_methods
+      @performs_later_methods ||= Module.new.tap { include _1 }
+    end
 end
 
 ActiveSupport.on_load(:active_record) { extend ActiveJob::Performs }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job-performs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: ActiveJob::Performs adds the `performs` macro to set up jobs by convention.