acidic_job 0.7.3 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dd5ef2a75562917c4bc4340c794ba8d0bfe8cd16e16f87648281e55915cc415
-  data.tar.gz: beccac205aeac449f163a3474b0f0d906b0331a8f5495c3f48883378c3d08392
+  metadata.gz: 1ded2615559a3d31060c34d9b7e17717cb6f0afa60081f98df1cf451d8aa61c9
+  data.tar.gz: ce66fe904f29a0a5d47a834414de8b50f4de945cd41b0087e5d85265238c31b5
 SHA512:
-  metadata.gz: 8bef8f4e65efa86de60a3d44bdf2cfff86593a6da6bd7f6cc0c7261272b8fdb775f95bfee2990c1f7d03681fe182b1b54bbe8449cf068b8a97f2d54144b75bec
-  data.tar.gz: b5ad802967a4f5096fcffd6ee682c429d70194b9c4b549e2542fcc7be8206e0e3b7111824815c2f207504307af4a644bd81020a5be3ac6416728bebafa8c1c84
+  metadata.gz: 8dd451aeb1da7539193db26a4a42adc0b04b1ad48ecf71438cee14a78c8b352e287d43f838716eb4f4d8957210aba583b12c0d8e064dcbf6d4aa746310e4489f
+  data.tar.gz: aab8e61fc8292a6354e993ea98eaffe30350649c0cfce56ba974c732aa5c43f4c51b3f94a9aeec7cf0613ff36ebf1af6e761df85196426867ae1e1dd33679e0d

data/.github/workflows/main.yml

@@ -13,6 +13,6 @@ jobs:
         ruby-version: 2.7.1
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.5
+        gem install bundler -v 2.2.31
         bundle install
         bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.7.3)
+    acidic_job (0.7.7)
       activerecord (>= 4.0.0)
       activesupport
 

data/README.md

@@ -57,14 +57,14 @@ It provides a suite of functionality that empowers you to create complex, robust
 
 ### Transactional Steps
 
-The first and foundational feature `acidic_job` provides is the `idempotently` method, which takes a block of transactional step methods (defined via the `step`) method:
+The first and foundational feature `acidic_job` provides is the `with_acidity` method, which takes a block of transactional step methods (defined via the `step`) method:
 
 ```ruby
 class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { user: current_user, params: ride_params, ride: nil } do
+    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -85,20 +85,20 @@ class RideCreateJob < ActiveJob::Base
 end
 ```
 
-`idempotently` takes only the `with:` named parameter and a block where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
+`with_acidity` takes only the `given:` named parameter and a block where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
 
 Now, each execution of this job will find or create an `AcidicJob::Key` record, which we leverage to wrap every step in a database transaction. Moreover, this database record allows `acidic_job` to ensure that if your job fails on step 3, when it retries, it will simply jump right back to trying to execute the method defined for the 3rd step, and won't even execute the first two step methods. This means your step methods only need to be idempotent on failure, not on success, since they will never be run again if they succeed.
 
 ### Persisted Attributes
 
-Any objects passed to the `with` option on the `idempotently` method are not just made available to each of your step methods, they are made available across retries. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Key` and manually providing getters and setters that sync with the database record.
+Any objects passed to the `given` option on the `with_acidity` method are not just made available to each of your step methods, they are made available across retries. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Key` and manually providing getters and setters that sync with the database record.
 
 ```ruby
 class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { ride: nil } do
+    with_acidity given: { ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -132,7 +132,7 @@ class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { user: current_user, params: ride_params, ride: nil } do
+    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "0.7.3"
+  VERSION = "0.7.7"
 end

data/lib/acidic_job.rb

@@ -61,7 +61,7 @@ module AcidicJob
   IDEMPOTENCY_KEY_LOCK_TIMEOUT = 90
 
   # takes a block
-  def idempotently(with:)
+  def with_acidity(given:)
     # execute the block to gather the info on what steps are defined for this job workflow
     steps = yield || []
 
@@ -76,11 +76,16 @@ module AcidicJob
     # close proximity, one of the two will be aborted by Postgres because we're
     # using a transaction with SERIALIZABLE isolation level. It may not look
     # it, but this code is safe from races.
-    key = ensure_idempotency_key_record(idempotency_key_value, workflow, with)
+    key = ensure_idempotency_key_record(idempotency_key_value, workflow, given)
 
     # begin the workflow
     process_key(key)
   end
+  
+  # DEPRECATED
+  def idempotently(with:, &blk)
+    with_acidity(given: with, &blk)
+  end 
 
   def process_key(key)
     @key = key
@@ -180,7 +185,7 @@ module AcidicJob
         raise LockedIdempotencyKey if key.locked_at && key.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
 
         # Lock the key and update latest run unless the job is already finished.
-        key.update!(last_run_at: Time.current, locked_at: Time.current) unless key.finished?
+        key.update!(last_run_at: Time.current, locked_at: Time.current, workflow: workflow) unless key.finished?
       else
         key = Key.create!(
           idempotency_key: key_val,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.7
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord