active_job-performs 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d8648f755507d3bec0ae72e16af2382c925fa488ac19ee6db64ba7ddc25db63
-  data.tar.gz: 67dd04fef65c5a107a59a9f89af5a5c437fc5f686613ac7ed505fb7afac09ddc
+  metadata.gz: 5741d785f1439dac15d6ec2734d40e5560013f69025977713771309c7f15c4c7
+  data.tar.gz: c01e5d7ebe8f599024cd5eba79011a959d2e31c8d5141b787b46d55b1150b73b
 SHA512:
-  metadata.gz: c577b88ae29756cd24203b6ec98af0910bbcddf66faf444fd225bae7a257996084ac292a3b418518a20847749abb8b31c5fe5bde65a2c61eb4534194aa81e7e7
-  data.tar.gz: 9f604e7ce1a7dc7fe0289b592f1e3dd859d2b96874c1fbb8cbfe008a9fb5ca1e2fa7ee4d133634552d29bfadb5fb146422524c99d89c00e1edf335a69f6c40ef
+  metadata.gz: 7ea09dcf8da5a0c7c1f5181ed70e07c3a3028d7d12c5c84cece6c6d59ab6a7921ea7ddc05180fd2b8f551332277a2e032bee0c057398a33b4e7f3a645f451c3f
+  data.tar.gz: 32899d17334f35819a1aa61ffa56c58a492d1b304a003b1e5d6156a26450087e2ac7083021a312269d2c2ee0519e43ad78d129629c6641036f5ad222130f6c3a

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-01-12
+
+- Supports `private performs :some_method`
+
+  Which then generates a private `some_method_later` method.
+
+  This was already technically supported but a test was added to declare it expected.
+
+- Support method suffixes ! and ?
+
+  You can call `performs :some_method!` and have `some_method_later!` generated. Same for `?`.
+
+- Support `performs` on private methods
+
+  Method jobs will now call methods with `send`, in case you only want to expose the generated later method to the outside world.
+
+  ```ruby
+  class Post < ActiveRecord::Base
+    performs :something_low_level
+
+    private
+
+    # We don't want other objects to call this, they should always use the generated later method.
+    def something_low_level
+      # …
+    end
+  end
+  ```
+
+  Here, the generated `Post#something_low_level_later` is public and available but can still call into the immediate version of `something_low_level`.
+
 ## [0.1.1] - 2022-09-27
 
 - Fixed: extend ActiveRecord::Base with ActiveJob::Performs as the README says.

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"

data/Gemfile.lock

@@ -1,42 +1,82 @@
 PATH
   remote: .
   specs:
-    active_job-performs (0.1.1)
+    active_job-performs (0.3.0)
       activejob (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.0.4)
-      activesupport (= 7.0.4)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
       globalid (>= 0.3.6)
-    activesupport (7.0.4)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activesupport (7.1.1)
+      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.1.1)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    drb (2.1.1)
+      ruby2_keywords
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.0)
+      rdoc (~> 6.5)
+      reline (>= 0.3.6)
     minitest (5.16.3)
     minitest-sprint (1.2.2)
       path_expander (~> 1.1)
+    mutex_m (0.1.2)
     path_expander (1.1.1)
+    psych (5.1.0)
+      stringio
     rake (13.0.6)
-    tzinfo (2.0.5)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    reline (0.3.8)
+      io-console (~> 0.5)
+    ruby2_keywords (0.0.5)
+    sqlite3 (1.6.4-arm64-darwin)
+    sqlite3 (1.6.4-x86_64-linux)
+    stringio (3.0.8)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
   active_job-performs!
+  activejob (>= 7.1)
+  activerecord (>= 7.1)
+  debug
   minitest (~> 5.0)
   minitest-sprint
   rake (~> 13.0)
+  sqlite3
 
 BUNDLED WITH
-   2.3.21
+   2.4.19

data/README.md

@@ -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,44 @@ class Post < ActiveRecord::Base
 end
 ```
 
+#### Method suffixes
+
+`ActiveJob::Performs` supports Ruby's stylistic method suffixes, i.e. ? and ! respectively.
+
+```ruby
+class Post < ActiveRecord::Base
+  performs :publish! # Generates `publish_later!` which calls `publish!`.
+  performs :retract? # Generates `retract_later?` which calls `retract?`.
+
+  def publish!
+    …
+  end
+
+  def retract?
+    …
+  end
+end
+```
+
+#### Private methods
+
+`ActiveJob::Performs` also works with private methods in case you only want to expose the generated `_later` method.
+
+```ruby
+class Post < ActiveRecord::Base
+  performs :publish # Generates the public `publish_later` instance method.
+
+  # Private implementation, only call `publish_later` please!
+  private def publish
+    …
+  end
+end
+```
+
+Additionally, in case the job is meant to be internal to the object, `performs :some_method` returns `:some_method_later` which you can pass to `private`.
+
+E.g. `private performs :some_method` will generate a private `some_method_later` method.
+
 ### 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:

data/lib/active_job/performs/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Performs
-    VERSION = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/active_job/performs.rb

@@ -34,20 +34,33 @@ module ActiveJob::Performs
     if method.nil?
       apply_performs_to(@job, **configs, &block)
     else
+      method = method.to_s.dup
+      suffix = $1 if method.gsub!(/([!?])$/, "")
+
       job = safe_define("#{method}_job".classify) { @job }
       apply_performs_to(job, **configs, &block)
 
       job.class_eval <<~RUBY, __FILE__, __LINE__ + 1 unless job.instance_method(:perform).owner == job
         def perform(object, *arguments, **options)
-          object.#{method}(*arguments, **options)
+          object.send(:#{method}#{suffix}, *arguments, **options)
         end
       RUBY
 
+      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
+
       class_eval <<~RUBY, __FILE__, __LINE__ + 1
-        def #{method}_later(*arguments, **options)
+        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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job-performs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2023-11-04 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.3.21
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: ActiveJob::Performs adds the `performs` macro to set up jobs by convention.