active_job-performs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d8648f755507d3bec0ae72e16af2382c925fa488ac19ee6db64ba7ddc25db63
-  data.tar.gz: 67dd04fef65c5a107a59a9f89af5a5c437fc5f686613ac7ed505fb7afac09ddc
+  metadata.gz: afad0c3e092f329deb71fea10b4f2105d1a2fbff2d581eb46304411c8cf5c592
+  data.tar.gz: ec2db477f5e639b8dd8f4e1958f2f2813e9d32a85b6526693878a10927da6f0a
 SHA512:
-  metadata.gz: c577b88ae29756cd24203b6ec98af0910bbcddf66faf444fd225bae7a257996084ac292a3b418518a20847749abb8b31c5fe5bde65a2c61eb4534194aa81e7e7
-  data.tar.gz: 9f604e7ce1a7dc7fe0289b592f1e3dd859d2b96874c1fbb8cbfe008a9fb5ca1e2fa7ee4d133634552d29bfadb5fb146422524c99d89c00e1edf335a69f6c40ef
+  metadata.gz: 0213fcbdd14ecc60adbbff93d2f515b1ec1dee6f9511d9b69037ac2e85610cbaa9b3458a0b5256cba2f18f2d5e3f814dddf04e2993e89e3b0e44151b0cbc5819
+  data.tar.gz: 6bf98a858966a833b872643a3fc5b33f23d27d1499eaf8b917f5c470bb43b49cd2e8c68c8f0cad251714a84c7da2a531d4809e72b8db364818a8d76bbe827107

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_job-performs (0.1.1)
+    active_job-performs (0.2.0)
       activejob (>= 6.1)
 
 GEM

data/README.md

@@ -91,6 +91,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.2.0"
   end
 end

data/lib/active_job/performs.rb

@@ -34,17 +34,20 @@ 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
 
       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

metadata

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