active_job-performs 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 566acd14649609a2e16b658a93fe276f80609866c61fb37c11e720b581bc0f76
-  data.tar.gz: 5174b18e562c53966639bb16e3d729885d99f1ebe01163175a1513dded11cbff
+  metadata.gz: 673105da38e705ba9aa778566a9d711a631aea27467a354a4fc4413e16b31ac3
+  data.tar.gz: 632442f9d0c25be20d47ecc4038b8d36e20d2b4797b5a1b622d3b5dead074cc4
 SHA512:
-  metadata.gz: f2fd767c6bd1c66d26a046e84dea4cd2ea0bfdb0ec50452699151e90fba9856b14875ab1a98371cf2727423a31871db4af432a965784a9cf61d92b58917ce0d2
-  data.tar.gz: cd9628dce5378c14ecae35da1fc83ae4487ea0ece02a5e4a78226572778ca7d370c5975e99ff880fa9bf030f026c244d1d3cf2abac838fb7d1bec373f7327cbf
+  metadata.gz: 7f1569149e481246401f737e48a032d6d579bdfcf39751daafc5b4991eecd7017a3e646ed573101d8c65ae6acf36b371c75bf2ed793fa22fef77fd5ca93fa25d
+  data.tar.gz: f1df1f52d96bc4fff67af97b1f675669da1eec01423b48ecc36451e2c290111d205ef839da6abe36929ba3edf685998a473f73ee55f3b01286a2df083ebfa988

data/Gemfile

@@ -16,4 +16,4 @@ gem "debug"
 gem "activejob",    ">= 7.1"
 gem "activerecord", ">= 7.1"
 
-gem "sqlite3", "~> 1.4"
+gem "sqlite3"

data/Gemfile.lock

@@ -1,65 +1,83 @@
 PATH
   remote: .
   specs:
-    active_job-performs (0.3.2)
+    active_job-performs (0.3.3)
       activejob (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activejob (8.1.1)
+      activesupport (= 8.1.1)
       globalid (>= 0.3.6)
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activerecord (7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activemodel (8.1.1)
+      activesupport (= 8.1.1)
+    activerecord (8.1.1)
+      activemodel (= 8.1.1)
+      activesupport (= 8.1.1)
       timeout (>= 0.4.0)
-    activesupport (7.1.3.4)
+    activesupport (8.1.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
-    debug (1.9.2)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.5)
+    date (3.5.0)
+    debug (1.11.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    drb (2.2.1)
-    globalid (1.2.1)
+    drb (2.2.3)
+    erb (6.0.0)
+    globalid (1.3.0)
       activesupport (>= 6.1)
-    i18n (1.14.5)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.13.2)
+    io-console (0.8.1)
+    irb (1.15.3)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    minitest (5.24.0)
-    minitest-sprint (1.2.2)
+    json (2.16.0)
+    logger (1.7.0)
+    minitest (5.26.2)
+    minitest-sprint (1.4.1)
       path_expander (~> 1.1)
-    mutex_m (0.2.0)
-    path_expander (1.1.1)
-    psych (5.1.2)
+      prism (~> 1.5)
+    path_expander (1.1.3)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.6.0)
+    psych (5.2.6)
+      date
       stringio
-    rake (13.2.1)
-    rdoc (6.7.0)
+    rake (13.3.1)
+    rdoc (6.16.1)
+      erb
       psych (>= 4.0.0)
-    reline (0.5.9)
+      tsort
+    reline (0.6.3)
       io-console (~> 0.5)
-    sqlite3 (1.7.3-arm64-darwin)
-    sqlite3 (1.7.3-x86_64-linux)
-    stringio (3.1.1)
-    timeout (0.4.1)
+    securerandom (0.4.1)
+    sqlite3 (2.8.0-arm64-darwin)
+    sqlite3 (2.8.0-x86_64-linux-gnu)
+    stringio (3.1.8)
+    timeout (0.4.4)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.1.1)
 
 PLATFORMS
   arm64-darwin
@@ -73,7 +91,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-sprint
   rake (~> 13.0)
-  sqlite3 (~> 1.4)
+  sqlite3
 
 BUNDLED WITH
    2.5.14

data/README.md

@@ -13,7 +13,7 @@ class Post < ApplicationRecord
 end
 ```
 
-Then we build a job for the instance method and define a `post.publish_later` instance method, and more:
+Here's what `performs` generates under the hood:
 
 ```ruby
 class Post < ApplicationRecord
@@ -25,12 +25,12 @@ class Post < ApplicationRecord
     def perform(post, *, **) = post.publish(*, **)
   end
 
-  # On Rails 7.1, where `ActiveJob.perform_all_later` exists, we also generate
+  # 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) }
+  def self.publish_later_bulk(set = all)
+    ActiveJob.perform_all_later set.map { PublishJob.new(_1) }
   end
 
   # We generate `publish_later` to wrap the job execution forwarding arguments and options.
@@ -55,7 +55,12 @@ end
 > [!TIP]
 > On that last point, `performs` does put more logic back within your Active Records, so if you need further encapsulation to prevent them growing too large, consider checking out [active_record-associated_object](https://github.com/kaspth/active_record-associated_object).
 
-### Praise from people
+### Used in production & praise from people
+
+The https://www.rubyevents.org team uses `ActiveJob::Performs` quite a bit:
+
+- [See `performs` calls in RubyEvents](https://github.com/search?q=repo%3Arubyevents%2Frubyevents+performs+language%3ARuby&type=code&l=Ruby)
+
 
 Here's what [@claudiob](https://github.com/claudiob) had to say after using `ActiveJob::Performs`:
 
@@ -85,7 +90,7 @@ class Post < ActiveRecord::Base
   extend ActiveJob::Performs # We technically auto-extend ActiveRecord::Base, but other object hierarchies need this.
 
   # `performs` builds a `Post::PublishJob` and routes configs over to it.
-  performs :publish, queue_as: :important, discard_on: SomeError do
+  performs :publish, queue_adapter: :sidekiq, queue_as: :important, discard_on: SomeError do
     retry_on TimeoutError, wait: :polynomially_longer
   end
 
@@ -104,6 +109,7 @@ class Post < ActiveRecord::Base
 
   # Individual method jobs inherit from the `Post::Job` defined above.
   class PublishJob < Job
+    self.queue_adapter = :sidekiq
     queue_as :important
     discard_on SomeError
     retry_on TimeoutError, wait: :polynomially_longer
@@ -122,8 +128,8 @@ class Post < ActiveRecord::Base
   # Or pass in a subset of posts as an argument:
   #
   #   Post.publish_later_bulk Post.unpublished
-  def self.publish_later_bulk
-    ActiveJob.perform_all_later all.map { PublishJob.new(_1) }
+  def self.publish_later_bulk(set = all)
+    ActiveJob.perform_all_later set.map { PublishJob.new(_1) }
   end
 
   # We generate `publish_later` to wrap the job execution.
@@ -137,6 +143,9 @@ class Post < ActiveRecord::Base
 end
 ```
 
+> [!NOTE]
+> We prefer & call `{name}=` setter methods, but fall back to getters. That's how we support `self.queue_adapter=`, but also `queue_as` which is not configured via `queue_as=`.
+
 We generate the `Post::Job` class above to share configuration between method level jobs. E.g. if you had a `retract` method that was setup very similar, you could do:
 
 ```ruby
@@ -183,8 +192,7 @@ If there's an Active Record method that you'd like any model to be able to run f
 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"
+  # We're passing specific queues for monitoring, but they're optional.
   performs :update,  queue_as: "active_record.update"
   performs :destroy, queue_as: "active_record.destroy"
 end
@@ -193,19 +201,21 @@ 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.update_later reminded_at: 1.year.ago # Forward along arguments to the eventual `update` call.
 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!
+> [!TIP]
+> `destroy_later` could be particularly useful on a record with many `dependent: :destroy` associations.
+> If anything fails, the transaction will rollback and the job fails, so you can retry it later!
+
+> [!NOTE]
+> Maybe you'd rather architect your system such that these methods don't have so many side-effects, but having the option can be handy.
+
+> [!WARNING]
+> Don't use this pattern with `touch` because Rails has an internal [touch_later](https://github.com/rails/rails/blob/690ec8898318b8f50714e86676353ebe1551261e/activerecord/lib/active_record/touch_later.rb#L11) private API method used in `belongs_to <some_association>, touch: true` assocations. If your model is one day used in such an assocation and you were using this pattern your app would break.
 
-Also, I haven't tested all the Active Record methods, so please file an issue if you encounter any.
+I haven't tested all the Active Record methods, so please file an issue if you encounter any.
 
 #### Method suffixes
 

data/lib/active_job/performs/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Performs
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   end
 end

data/lib/active_job/performs.rb

@@ -5,18 +5,14 @@ require_relative "performs/version"
 module ActiveJob; end
 module ActiveJob::Performs
   module Waiting
-    def Proc(value)
-      value.respond_to?(:call) ? value : proc { value }
-    end unless Kernel.respond_to?(:Proc) # Optimistically assume Ruby gets this and it'll work fine.
+    attr_reader :wait, :wait_until
 
-    def wait(value = nil)
-      @wait = Proc(value) if value
-      @wait
+    def wait=(value)
+      @wait = value.respond_to?(:call) ? value : proc { value }
     end
 
-    def wait_until(value = nil)
-      @wait_until = Proc(value) if value
-      @wait_until
+    def wait_until=(value)
+      @wait_until = value.respond_to?(:call) ? value : proc { value }
     end
 
     def scoped_by_wait(record)
@@ -59,8 +55,6 @@ module ActiveJob::Performs
           #{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
 
@@ -69,9 +63,13 @@ module ActiveJob::Performs
       name.safe_constantize || const_set(name, Class.new(yield))
     end
 
-    def apply_performs_to(job_class, **configs, &block)
-      configs.each { job_class.public_send(_1, _2) }
-      job_class.class_exec(&block) if block_given?
+    def apply_performs_to(job, **configs, &block)
+      job.class_exec(&block) if block_given?
+
+      configs.each do |name, value|
+        name = "#{name}=".then.find { job.respond_to? _1 } || name
+        job.public_send name, value
+      end
     end
 
     def performs_later_methods

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_job-performs
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-description:
 email:
 - hey@kaspth.com
 executables: []
@@ -47,7 +45,6 @@ metadata:
   homepage_uri: https://github.com/kaspth/active_job-performs
   source_code_uri: https://github.com/kaspth/active_job-performs
   changelog_uri: https://github.com/kaspth/active_job-performs/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: ActiveJob::Performs adds the `performs` macro to set up jobs by convention.
 test_files: []