acidic_job 1.0.0.rc5 → 1.0.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af6f1d0a08680695a243f3b045eb9eedd0bd7d6568e14acf8caefeeca4dc45f6
-  data.tar.gz: 533f91d24f7a4cfc5cbd9b74ef55f7207abd1ae00984fec545ad5590ca0b73b6
+  metadata.gz: 6583544dc3b3545721d81facda79a461cb8a3a7a8078d2dc309dbc887c0dc1a7
+  data.tar.gz: 89f94171898b64372b85b6dcca3c4f6134e608f39c4aadeb8a776ce7c1a6e294
 SHA512:
-  metadata.gz: 12a444e4a971df69a1f6f15c64ce0d3609104fe0e8a42ffc4ece9a6d948a5f799981e8ee087fcac45befea46b4f2d4f1279ef39b625cdc1a4db6618e04a98098
-  data.tar.gz: 05b26e35b45823c32063d41e6ee82b9ad49239de0a412c4c38328ad95391cad60e1e404c04638d0811d27c8073666a5f42cebc36912ac5c44a64d84ab46ad859
+  metadata.gz: 25fb20afe5782e1e73f23c2c020948ba732f25e9abb9cf32dcc5803eb74fa7f3c3bb4e674aaf6bd80263d235251fc043b5ee23f2176cdb0b2e99397c1e74ef7a
+  data.tar.gz: a09e720a54df383804b54d63b1acf8bd6b2bc912e05dea373f2912b87bbaa5f4e7e60413491ae13e4c780ba99e5cc842e73774837a08dbc87d8e223502534a70

data/README.md

@@ -183,7 +183,7 @@ class Job < ActiveJob::Base
 ```
 
 > [!TIP]
-> You should think carefully about what constitutes a unique execution of a workflow. Imagine you had a workflow job for balance transers. Jill transfers $10 to John. Your system **must** be able to differentiate between retries of this transfer and new independent transfers. If you were only to use the `sender`, `recipient`, and `amount` as your `unique_by` values, then if Jill tries to transfer another $10 to John at some point in the future, that work will be considered a retry of the first transfer and not a new transfer.
+> You should think carefully about what constitutes a unique execution of a workflow. Imagine you had a workflow job for balance transfers. Jill transfers $10 to John. Your system **must** be able to differentiate between retries of this transfer and new independent transfers. If you were only to use the `sender`, `recipient`, and `amount` as your `unique_by` values, then if Jill tries to transfer another $10 to John at some point in the future, that work will be considered a retry of the first transfer and not a new transfer.
 
 
 ### Orchestrating steps

data/app/assets/stylesheets/acidic_job/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/acidic_job/application_controller.rb

@@ -0,0 +1,4 @@
+module AcidicJob
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/jobs/acidic_job/application_job.rb

@@ -0,0 +1,4 @@
+module AcidicJob
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/acidic_job/application_mailer.rb

@@ -0,0 +1,6 @@
+module AcidicJob
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/acidic_job/{record.rb → application_record.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  class Record < ActiveRecord::Base
+  class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
 
     connects_to(**AcidicJob.connects_to) if AcidicJob.connects_to
   end
 end
 
-ActiveSupport.run_load_hooks :acidic_job_record, AcidicJob::Record
+ActiveSupport.run_load_hooks :acidic_job_record, AcidicJob::ApplicationRecord

data/app/models/acidic_job/entry.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  class Entry < Record
+  class Entry < ApplicationRecord
     belongs_to :execution, class_name: "AcidicJob::Execution"
 
     serialize :data, coder: AcidicJob::Serializer
 
-    scope :for_step, -> (step) { where(step: step) }
-    scope :for_action, -> (action) { where(action: action) }
-    scope :ordered, -> { order(timestamp: :asc) }
+    scope :for_step, ->(step) { where(step: step) }
+    scope :for_action, ->(action) { where(action: action) }
+    scope :ordered, -> { order(timestamp: :asc, created_at: :asc) }
 
     def self.most_recent
       order(created_at: :desc).first

data/app/models/acidic_job/execution.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  class Execution < Record
+  class Execution < ApplicationRecord
     has_many :entries, class_name: "AcidicJob::Entry", dependent: :destroy
     has_many :values, class_name: "AcidicJob::Value", dependent: :destroy
 
@@ -14,9 +14,9 @@ module AcidicJob
       where(recover_to: FINISHED_RECOVERY_POINT)
     }
     scope :outstanding, -> {
-      where.not(recover_to: FINISHED_RECOVERY_POINT).or(where(recover_to: [nil, ""]))
+      where.not(recover_to: FINISHED_RECOVERY_POINT).or(where(recover_to: [ nil, "" ]))
     }
-    scope :clearable, -> (finished_before: AcidicJob.clear_finished_executions_after.ago) {
+    scope :clearable, ->(finished_before: AcidicJob.clear_finished_executions_after.ago) {
       finished.where(last_run_at: ...finished_before)
     }
 
@@ -34,7 +34,7 @@ module AcidicJob
           step: step,
           action: action,
           timestamp: timestamp,
-          data: kwargs.except(:ignored),
+          data: kwargs.except(:ignored)
         })
       end
     end

data/app/models/acidic_job/value.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  class Value < Record
+  class Value < ApplicationRecord
     belongs_to :execution, class_name: "AcidicJob::Execution"
 
     serialize :value, coder: AcidicJob::Serializer

data/app/views/layouts/acidic_job/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Acidic job</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "acidic_job/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lib/acidic_job/builder.rb

@@ -28,9 +28,9 @@ module AcidicJob
 
       definition = {
         "meta" => {
-          "version" => VERSION,
+          "version" => VERSION
         },
-        "steps" => {},
+        "steps" => {}
       }
 
       definition.tap do |workflow|

data/lib/acidic_job/context.rb

@@ -12,19 +12,19 @@ module AcidicJob
           {
             execution_id: @execution.id,
             key: key,
-            value: value,
+            value: value
           }
         end
 
         case AcidicJob::Value.connection.adapter_name.downcase.to_sym
         when :postgresql, :sqlite
-          AcidicJob::Value.upsert_all(records, unique_by: [:execution_id, :key])
+          AcidicJob::Value.upsert_all(records, unique_by: [ :execution_id, :key ])
         when :mysql2, :mysql, :trilogy
           AcidicJob::Value.upsert_all(records)
         else
           # Fallback for other adapters - try with unique_by first, fall back without
           begin
-            AcidicJob::Value.upsert_all(records, unique_by: [:execution_id, :key])
+            AcidicJob::Value.upsert_all(records, unique_by: [ :execution_id, :key ])
           rescue ArgumentError => e
             if e.message.include?("does not support :unique_by")
               AcidicJob::Value.upsert_all(records)

data/lib/acidic_job/engine.rb

@@ -26,14 +26,20 @@ module AcidicJob
         require_relative "serializers/exception_serializer"
         require_relative "serializers/new_record_serializer"
         require_relative "serializers/job_serializer"
-        require_relative "serializers/range_serializer"
-
-        ActiveJob::Serializers.add_serializers(
-          Serializers::ExceptionSerializer,
-          Serializers::NewRecordSerializer,
-          Serializers::JobSerializer,
-          Serializers::RangeSerializer
-        )
+
+        serializers = [
+          Serializers::ExceptionSerializer.instance,
+          Serializers::NewRecordSerializer.instance,
+          Serializers::JobSerializer.instance
+        ]
+
+        # Rails 7.1+ includes a RangeSerializer, so only add ours for older versions
+        unless defined?(ActiveJob::Serializers::RangeSerializer)
+          require_relative "serializers/range_serializer"
+          serializers << Serializers::RangeSerializer.instance
+        end
+
+        ActiveJob::Serializers.add_serializers(*serializers)
       end
     end
 

data/lib/acidic_job/log_subscriber.rb

@@ -37,7 +37,7 @@ module AcidicJob
     end
 
     private def formatted_error(error)
-      [error.class, error.message].compact.join(" ")
+      [ error.class, error.message ].compact.join(" ")
     end
 
     # Use the logger configured for AcidicJob

data/lib/acidic_job/serializers/exception_serializer.rb

@@ -26,6 +26,10 @@ module AcidicJob
       def serialize?(argument)
         defined?(Exception) && argument.is_a?(Exception)
       end
+
+      def klass
+        ::Exception
+      end
     end
   end
 end

data/lib/acidic_job/serializers/job_serializer.rb

@@ -22,6 +22,10 @@ module AcidicJob
       def serialize?(argument)
         defined?(::ActiveJob::Base) && argument.class < ::ActiveJob::Base
       end
+
+      def klass
+        ::ActiveJob::Base
+      end
     end
   end
 end

data/lib/acidic_job/serializers/new_record_serializer.rb

@@ -20,6 +20,10 @@ module AcidicJob
       def serialize?(argument)
         defined?(::ActiveRecord) && argument.respond_to?(:new_record?) && argument.new_record?
       end
+
+      def klass
+        ::ActiveRecord::Base
+      end
     end
   end
 end

data/lib/acidic_job/serializers/range_serializer.rb

@@ -2,25 +2,25 @@
 
 require "active_job/serializers/object_serializer"
 
-# :nocov:
 module AcidicJob
   module Serializers
+    # This serializer is only used for Rails versions prior to 7.1,
+    # which introduced ActiveJob::Serializers::RangeSerializer.
     class RangeSerializer < ::ActiveJob::Serializers::ObjectSerializer
       KEYS = %w[begin end exclude_end].freeze
 
       def serialize(range)
-        args = Arguments.serialize([range.begin, range.end, range.exclude_end?])
+        args = ::ActiveJob::Arguments.serialize([range.begin, range.end, range.exclude_end?])
         super(KEYS.zip(args).to_h)
       end
 
       def deserialize(hash)
-        klass.new(*Arguments.deserialize(hash.values_at(*KEYS)))
+        klass.new(*::ActiveJob::Arguments.deserialize(hash.values_at(*KEYS)))
       end
 
-      private def klass
+      def klass
         ::Range
       end
     end
   end
 end
-# :nocov:

data/lib/acidic_job/testing.rb

@@ -26,7 +26,7 @@ module AcidicJob
     # except that any `transaction` strategies for any ORMs are replaced with a `deletion` strategy.
     private def transaction_free_cleaners_for(original_cleaners)
       non_transaction_cleaners = original_cleaners.dup.to_h do |(orm, opts), cleaner|
-        [[orm, opts], ensure_no_transaction_strategies_for(cleaner)]
+        [ [ orm, opts ], ensure_no_transaction_strategies_for(cleaner) ]
       end
       ::DatabaseCleaner::Cleaners.new(non_transaction_cleaners)
     end
@@ -55,12 +55,12 @@ module AcidicJob
         .name                       # "DatabaseCleaner::ActiveRecord::Truncation"
         .rpartition("::")           # ["DatabaseCleaner::ActiveRecord", "::", "Truncation"]
         .first                      # "DatabaseCleaner::ActiveRecord"
-      deletion_strategy_class_name = [strategy_namespace, "::", "Deletion"].join
+      deletion_strategy_class_name = [ strategy_namespace, "::", "Deletion" ].join
       deletion_strategy_class = deletion_strategy_class_name.constantize
       instance_variable_hash = strategy.instance_variables.to_h do |var|
         [
           var.to_s.remove("@"),
-          strategy.instance_variable_get(var),
+          strategy.instance_variable_get(var)
         ]
       end
       options = instance_variable_hash.except("db", "connection_class")

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "1.0.0.rc5"
+  VERSION = "1.0.0.rc7"
 end

data/lib/acidic_job/workflow.rb

@@ -31,12 +31,12 @@ module AcidicJob
       AcidicJob.instrument(:initialize_workflow, definition: workflow_definition) do
         transaction_args = case ::ActiveRecord::Base.connection.adapter_name.downcase.to_sym
           # SQLite doesn't support `serializable` transactions
-          when :sqlite
+        when :sqlite
             {}
-          else
+        else
             { isolation: :serializable }
         end
-        idempotency_key = Digest::SHA256.hexdigest(JSON.generate([self.class.name, unique_by], strict: true))
+        idempotency_key = Digest::SHA256.hexdigest(JSON.generate([ self.class.name, unique_by ], strict: true))
 
         @__acidic_job_execution__ = ::ActiveRecord::Base.transaction(**transaction_args) do
           record = Execution.find_by(idempotency_key: idempotency_key)
@@ -162,7 +162,7 @@ module AcidicJob
             step: curr_step,
             action: :succeeded,
             ignored: {
-              result: result,
+              result: result
             }
           )
           next_step

data/lib/acidic_job.rb

@@ -22,7 +22,7 @@ module AcidicJob
 
   mattr_accessor :logger, default: DEFAULT_LOGGER
   mattr_accessor :connects_to
-  mattr_accessor :plugins, default: [Plugins::TransactionalStep]
+  mattr_accessor :plugins, default: [ Plugins::TransactionalStep ]
   mattr_accessor :clear_finished_executions_after, default: 1.week
 
   def instrument(channel, **options, &block)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc5
+  version: 1.0.0.rc7
 platform: ruby
 authors:
-- fractaledmind
-bindir: exe
+- Stephen Margheim
+bindir: bin
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -80,35 +80,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: chaotic_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 0.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
-  name: chaotic_job
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: combustion
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,7 +150,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,7 +164,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -191,7 +177,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Idempotent operations for Rails apps, built on top of ActiveJob.
+description: "Write reliable and repeatable multi-step distributed operations that
+  are Atomic ⚛️, Consistent \U0001F916, Isolated \U0001F574\U0001F3FC, and Durable
+  ⛰️."
 email:
 - stephen.margheim@gmail.com
 executables: []
@@ -200,10 +188,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- app/assets/stylesheets/acidic_job/application.css
+- app/controllers/acidic_job/application_controller.rb
+- app/jobs/acidic_job/application_job.rb
+- app/mailers/acidic_job/application_mailer.rb
+- app/models/acidic_job/application_record.rb
 - app/models/acidic_job/entry.rb
 - app/models/acidic_job/execution.rb
-- app/models/acidic_job/record.rb
 - app/models/acidic_job/value.rb
+- app/views/layouts/acidic_job/application.html.erb
 - lib/acidic_job.rb
 - lib/acidic_job/arguments.rb
 - lib/acidic_job/builder.rb
@@ -238,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Idempotent operations for Rails apps, built on top of ActiveJob.
+summary: "\U0001F9EA Durable execution workflows for Active Job"
 test_files: []