acidic_job 0.8.1 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0924564388ca928e9923161a95788dfb393e71f48d82ab6474e221793befc6af'
-  data.tar.gz: 0a06d0e7f933a9e0e319bc698a3ab216502033b9c9df46fa7646cd77bdb1109c
+  metadata.gz: 041e2488af3dc4780e6112b92195dc805063ebc4c631bd3d7012017efe4e1583
+  data.tar.gz: d035a4d739e3cc7b6f6a2f223aefa7d600ab67dae537814363f16a478dd8c00c
 SHA512:
-  metadata.gz: db1b579a5887707c41534d825d261a024a25cab2c5619af1179d41360af85e8271bf16dc9fb29442aa1442f9d49366dbec60a8d8d3ea010eb15d4a413238fe40
-  data.tar.gz: 1c371720712b4eb34aec5c8b2aba077906100cc0b69bd72624844260c01522dfa4c5d843fea21b08efdc199dedfd08e8966c602b12bd73e04c8615c4e00f7487
+  metadata.gz: 96792f3e03f71aa19a83773a3eded77de541e6ea72c9aa2ca421f5298aa5e0e234b0705b0a27f417ebdb02b8e0b621ab935571b5ffc728a729c22bff7f97d809
+  data.tar.gz: 7dc53950ebf1d1c425f02f2c12a065cefa71c8c57173a4aa27478d9fcab7ffc0cdc822034da9179d59da9a0c544bd8b7c81108ef4da99a941de4b1d9ec63eb28

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.8.1)
+    acidic_job (0.8.4)
       activejob
       activerecord
       activesupport

data/README.md

@@ -1,7 +1,10 @@
 # AcidicJob
 
-[![Gem Version](https://badge.fury.io/rb/acidic_job.svg)](https://badge.fury.io/rb/acidic_job)
-![main workflow](https://github.com/fractaledmind/acidic_job/actions/workflows/main.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/acidic_job.svg)](https://rubygems.org/gems/acidic_job)
+[![Gem Downloads](https://img.shields.io/gem/dt/acidic_job)](https://rubygems.org/gems/acidic_job)
+![Tests](https://github.com/fractaledmind/acidic_job/actions/workflows/main.yml/badge.svg)
+![Coverage](https://img.shields.io/badge/code%20coverage-98%25-success)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e0df63f7a6f141d4aecc3c477314fdb2)](https://www.codacy.com/gh/fractaledmind/acidic_job/dashboard?utm_source=github.com&utm_medium=referral&utm_content=fractaledmind/acidic_job&utm_campaign=Badge_Grade)
 
 ## Idempotent operations for Rails apps (for ActiveJob or Sidekiq)
 
@@ -306,24 +309,22 @@ class ExampleJob < AcidicJob::Base
 end
 ```
 
-These options cover the two common situations, but sometimes our systems need finer-grained control. For example, our job might take some record as the job argument, but we need to use a combination of the record identifier and record status as the foundation for the idempotency key. In these cases you can pass a `Proc` to an `acidic_by` class method:
+These options cover the two common situations, but sometimes our systems need finer-grained control. For example, our job might take some record as the job argument, but we need to use a combination of the record identifier and record status as the foundation for the idempotency key. In these cases you can pass a `Proc` or a `Block` to an `acidic_by` class method. This code will be executed in the context of the newly initialized job instance, so you will have access to whatever data the job is initialized with (like the `arguments`, for example):
 
 ```ruby
 class ExampleJob < AcidicJob::Base
-  acidic_by -> { [@record.id, @record.status] }
+  acidic_by do
+    record = arguments.first[:record]
+    [record.id, record.status]
+  end
 
   def perform(record:)
-    @record = record
-
-    # the idempotency key will be based on whatever the values of `@record.id` and `@record.status` are
-    with_acidic_workflow do |workflow|
-      workflow.step :do_something
-    end
+    # ...
   end
 end
 ```
 
-> **Note:** The `acidic_by` proc _will be executed in the context of the job instance_ at the moment the `with_acidic_workflow` method is called. This means it will have access to any instance variables defined in your `perform` method up to that point.
+> **Note:** The `acidic_by` proc/block _will be executed in the context of the job instance_ at the moment the job is initialized. This means it will **not** have access to any instance variables defined in your `perform` method.
 
 
 ### Sidekiq Callbacks

data/lib/acidic_job/mixin.rb

@@ -18,7 +18,7 @@ module AcidicJob
       # You could unique job runs by the arguments passed to the job (e.g. memoization)
       other.define_singleton_method(:acidic_by_job_arguments) { @acidic_identifier = :job_arguments }
       # Or, you could unique jobs run by any logic you'd like using a block
-      other.define_singleton_method(:acidic_by) { |&block| @acidic_identifier = block }
+      other.define_singleton_method(:acidic_by) { |proc = nil, &block| @acidic_identifier = proc || block }
 
       # We add a callback to ensure that staged, non-workflow jobs are "finished" after they are "performed".
       # This allows us to ensure that we can always inspect whether a run is finished and get correct data
@@ -77,8 +77,7 @@ module AcidicJob
     end
 
     def with_acidic_workflow(persisting: {}, &block)
-      raise UnknownJobAdapter unless (defined?(::AcidicJob::Base) && self.class < ::AcidicJob::Base) ||
-                                     (defined?(::AcidicJob::ActiveKiq) && self.class < ::AcidicJob::ActiveKiq)
+      raise UnknownJobAdapter unless known_job_adapter?
 
       raise RedefiningWorkflow if defined? @workflow_builder
 
@@ -250,5 +249,13 @@ module AcidicJob
         :serializable
       end
     end
+
+    def known_job_adapter?
+      return true if defined?(::AcidicJob::Base) && self.class < ::AcidicJob::Base
+      return true if defined?(::AcidicJob::ActiveKiq) && self.class < ::AcidicJob::ActiveKiq
+      return true if defined?(::ActiveJob) && self.class < ::ActiveJob::Base
+
+      false
+    end
   end
 end

data/lib/acidic_job/perform_wrapper.rb

@@ -8,9 +8,9 @@ module AcidicJob
       @arguments = args
 
       # we don't want to run the `perform` callbacks twice, since ActiveJob already handles that for us
-      if defined?(ActiveJob) && self.class < ActiveJob::Base
+      if defined?(::ActiveJob) && self.class < ::ActiveJob::Base
         super(*args)
-      elsif defined?(Sidekiq) && self.class.include?(Sidekiq::Worker)
+      elsif defined?(::Sidekiq) && self.class.include?(::Sidekiq::Worker)
         run_callbacks :perform do
           super(*args)
         end

data/lib/acidic_job/rails.rb

@@ -20,14 +20,17 @@ module AcidicJob
           Serializers::JobSerializer,
           Serializers::RangeSerializer,
           Serializers::RecoveryPointSerializer,
-          Serializers::WorkerSerializer
+          Serializers::WorkerSerializer,
+          Serializers::ActiveKiqSerializer
         )
       end
     end
 
+    # :nocov:
     generators do
       require "generators/acidic_job/install_generator"
     end
+    # :nocov:
 
     # This hook happens after all initializers are run, just before returning
     config.after_initialize do

data/lib/acidic_job/serializers/active_kiq_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_job/serializers/object_serializer"
+
+module AcidicJob
+  module Serializers
+    class ActiveKiqSerializer < ::ActiveJob::Serializers::ObjectSerializer
+      def serialize(worker)
+        super(
+          "job_class" => worker.class.name,
+          "arguments" => Arguments.serialize(worker.arguments),
+        )
+      end
+
+      def deserialize(hash)
+        worker_class = hash["job_class"].constantize
+        worker_class.new(*hash["arguments"])
+      end
+
+      def serialize?(argument)
+        defined?(::AcidicJob::ActiveKiq) && argument.class < ::AcidicJob::ActiveKiq
+      end
+    end
+  end
+end

data/lib/acidic_job/serializers/exception_serializer.rb

@@ -13,7 +13,7 @@ module AcidicJob
           "backtrace" => {}
         }
 
-        exception.backtrace.map do |trace|
+        exception&.backtrace&.map do |trace|
           path, _, location = trace.rpartition("/")
 
           next if hash["backtrace"].key?(path)

data/lib/acidic_job/serializers/job_serializer.rb

@@ -10,7 +10,7 @@ module AcidicJob
         # by comparing the deserialized database value with a temporary in-memory generated value.
         # That temporary in-memory generated value can sometimes have an `enqueued_at` value that is 1 second off
         # from the original. In this case, ActiveRecord will think the record has unsaved changes and block the lock.
-        super(job.as_json.merge("job_class" => job.class.name))
+        super(job.serialize.except("enqueued_at"))
       end
 
       def deserialize(hash)

data/lib/acidic_job/serializers/worker_serializer.rb

@@ -2,26 +2,24 @@
 
 require "active_job/serializers/object_serializer"
 
-# :nocov:
 module AcidicJob
   module Serializers
     class WorkerSerializer < ::ActiveJob::Serializers::ObjectSerializer
       def serialize(worker)
         super(
-          "job_class" => worker.class.name,
-          "arguments" => worker.arguments,
+          "job_class" => worker.class.name
         )
       end
 
       def deserialize(hash)
         worker_class = hash["job_class"].constantize
-        worker_class.new(*hash["arguments"])
+        worker_class.new
       end
 
       def serialize?(argument)
-        defined?(::Sidekiq) && argument.class.include?(::Sidekiq::Worker)
+        defined?(::Sidekiq) && argument.class.include?(::Sidekiq::Worker) &&
+          !(defined?(::AcidicJob::ActiveKiq) && argument.class < ::AcidicJob::ActiveKiq)
       end
     end
   end
 end
-# :nocov:

data/lib/acidic_job/version.rb

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

data/lib/acidic_job.rb

@@ -27,6 +27,7 @@ require_relative "acidic_job/serializers/job_serializer"
 require_relative "acidic_job/serializers/range_serializer"
 require_relative "acidic_job/serializers/recovery_point_serializer"
 require_relative "acidic_job/serializers/worker_serializer"
+require_relative "acidic_job/serializers/active_kiq_serializer"
 
 require_relative "acidic_job/rails"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.4
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -266,6 +266,7 @@ files:
 - lib/acidic_job/recovery_point.rb
 - lib/acidic_job/run.rb
 - lib/acidic_job/serializer.rb
+- lib/acidic_job/serializers/active_kiq_serializer.rb
 - lib/acidic_job/serializers/exception_serializer.rb
 - lib/acidic_job/serializers/finished_point_serializer.rb
 - lib/acidic_job/serializers/job_serializer.rb