acidic_job 0.7.7 → 0.8.0

data/lib/generators/acidic_job/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module AcidicJob
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a migration for the AcidicJob::Run table."
+
+      # Copies the migration template to db/migrate.
+      def copy_acidic_job_runs_migration_files
+        migration_template "create_acidic_job_runs_migration.rb.erb",
+                           "db/migrate/create_acidic_job_runs.rb",
+                           migration_version: migration_version
+      end
+
+      protected
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/acidic_job/templates/create_acidic_job_runs_migration.rb.erb

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :acidic_job_runs do |t|
+      t.boolean     :staged, 					null: false,  default: -> { false }
+      t.string      :idempotency_key, null: false,  index: { unique: true }
+      t.text        :serialized_job, 	null: false
+      t.string      :job_class, 			null: false
+      t.datetime    :last_run_at, 		null: true,   default: -> { "CURRENT_TIMESTAMP" }
+      t.datetime    :locked_at, 			null: true
+      t.string      :recovery_point, 	null: true
+      t.text        :error_object, 		null: true
+      t.text        :attr_accessors, 	null: true
+      t.text        :workflow, 				null: true
+      t.references  :awaited_by,      null: true,   index: true
+      t.text        :returning_to,    null: true
+      t.timestamps
+    end
+  end
+end

data/lib/generators/{templates/create_acidic_job_keys_migration.rb.erb → acidic_job/templates/drop_acidic_job_keys_migration.rb.erb}

@@ -1,6 +1,6 @@
-class CreateAcidicJobKeys < <%= migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :acidic_job_keys do |t|
+    drop_table :acidic_job_keys do |t|
       t.string :idempotency_key, null: false
       t.string :job_name, null: false
       t.text :job_args, null: true
@@ -11,10 +11,17 @@ class CreateAcidicJobKeys < <%= migration_class %>
       t.text :attr_accessors
       t.text :workflow
       t.timestamps
-
+    
       t.index %i[idempotency_key job_name job_args],
         unique: true,
         name: "idx_acidic_job_keys_on_idempotency_key_n_job_name_n_job_args"
     end
+    
+    drop_table :staged_acidic_jobs do |t|
+      t.string :adapter, null: false
+      t.string :job_name, null: false
+      t.text :job_args, null: true
+      t.timestamps
+    end
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +52,174 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: noticed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Idempotent operations for Rails apps, built on top of ActiveJob.
 email:
 - stephen.margheim@gmail.com
@@ -59,34 +227,61 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby_version"
+- ".tool-versions"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADE_GUIDE.md
 - acidic_job.gemspec
 - bin/console
 - bin/setup
 - blog_post.md
+- combustion/log/test.log
+- gemfiles/rails_6.1_sidekiq_6.4.gemfile
+- gemfiles/rails_6.1_sidekiq_6.5.gemfile
+- gemfiles/rails_7.0_sidekiq_6.4.gemfile
+- gemfiles/rails_7.0_sidekiq_6.5.gemfile
+- gemfiles/rails_7.1_sidekiq_6.4.gemfile
+- gemfiles/rails_7.1_sidekiq_6.5.gemfile
 - lib/acidic_job.rb
-- lib/acidic_job/deliver_transactionally_extension.rb
+- lib/acidic_job/active_kiq.rb
+- lib/acidic_job/arguments.rb
+- lib/acidic_job/base.rb
 - lib/acidic_job/errors.rb
-- lib/acidic_job/key.rb
-- lib/acidic_job/no_op.rb
-- lib/acidic_job/perform_transactionally_extension.rb
+- lib/acidic_job/extensions/action_mailer.rb
+- lib/acidic_job/extensions/noticed.rb
+- lib/acidic_job/finished_point.rb
+- lib/acidic_job/idempotency_key.rb
+- lib/acidic_job/logger.rb
+- lib/acidic_job/mixin.rb
 - lib/acidic_job/perform_wrapper.rb
+- lib/acidic_job/processor.rb
+- lib/acidic_job/rails.rb
 - lib/acidic_job/recovery_point.rb
-- lib/acidic_job/response.rb
-- lib/acidic_job/sidekiq_callbacks.rb
-- lib/acidic_job/staged.rb
+- lib/acidic_job/run.rb
+- lib/acidic_job/serializer.rb
+- lib/acidic_job/serializers/exception_serializer.rb
+- lib/acidic_job/serializers/finished_point_serializer.rb
+- lib/acidic_job/serializers/job_serializer.rb
+- lib/acidic_job/serializers/range_serializer.rb
+- lib/acidic_job/serializers/recovery_point_serializer.rb
+- lib/acidic_job/serializers/worker_serializer.rb
+- lib/acidic_job/test_case.rb
+- lib/acidic_job/testing.rb
 - lib/acidic_job/version.rb
-- lib/generators/acidic_job_generator.rb
-- lib/generators/templates/create_acidic_job_keys_migration.rb.erb
-- lib/generators/templates/create_staged_acidic_jobs_migration.rb.erb
+- lib/acidic_job/workflow.rb
+- lib/acidic_job/workflow_builder.rb
+- lib/acidic_job/workflow_step.rb
+- lib/generators/acidic_job/drop_tables_generator.rb
+- lib/generators/acidic_job/install_generator.rb
+- lib/generators/acidic_job/templates/create_acidic_job_runs_migration.rb.erb
+- lib/generators/acidic_job/templates/drop_acidic_job_keys_migration.rb.erb
 homepage: https://github.com/fractaledmind/acidic_job
 licenses:
 - MIT
@@ -94,6 +289,7 @@ metadata:
   homepage_uri: https://github.com/fractaledmind/acidic_job
   source_code_uri: https://github.com/fractaledmind/acidic_job
   changelog_uri: https://github.com/fractaledmind/acidic_job/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -109,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Idempotent operations for Rails apps, built on top of ActiveJob.

data/.ruby_version

@@ -1 +0,0 @@
-2.7.1

data/lib/acidic_job/deliver_transactionally_extension.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module AcidicJob
-  module DeliverTransactionallyExtension
-    # rubocop:disable Metrics/MethodLength
-    def deliver_transactionally(_options = {})
-      job = delivery_job_class
-
-      attributes = {
-        adapter: "activejob",
-        job_name: job.name
-      }
-
-      job_args = if job <= ActionMailer::Parameterized::MailDeliveryJob
-                   [@mailer_class.name, @action.to_s, "deliver_now", { params: @params, args: @args }]
-                 else
-                   [@mailer_class.name, @action.to_s, "deliver_now", @params, *@args]
-                 end
-
-      attributes[:job_args] = job.new(job_args).serialize
-
-      AcidicJob::Staged.create!(attributes)
-    end
-    # rubocop:enable Metrics/MethodLength
-  end
-end

data/lib/acidic_job/key.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "active_record"
-
-module AcidicJob
-  class Key < ActiveRecord::Base
-    RECOVERY_POINT_FINISHED = "FINISHED"
-
-    self.table_name = "acidic_job_keys"
-
-    serialize :error_object
-    serialize :job_args
-    serialize :workflow
-    store :attr_accessors
-
-    validates :idempotency_key, presence: true, uniqueness: { scope: %i[job_name job_args] }
-    validates :job_name, presence: true
-    validates :last_run_at, presence: true
-    validates :recovery_point, presence: true
-
-    def finished?
-      recovery_point == RECOVERY_POINT_FINISHED
-    end
-
-    def succeeded?
-      finished? && !failed?
-    end
-
-    def failed?
-      error_object.present?
-    end
-  end
-end

data/lib/acidic_job/no_op.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# Represents an action to perform a no-op. One possible option for a return
-# from an #atomic_phase block.
-module AcidicJob
-  class NoOp
-    def call(_key)
-      # no-op
-    end
-  end
-end

data/lib/acidic_job/perform_transactionally_extension.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module AcidicJob
-  module PerformTransactionallyExtension
-    extend ActiveSupport::Concern
-
-    class_methods do
-      # rubocop:disable Metrics/MethodLength
-      def perform_transactionally(*args)
-        attributes = if defined?(ActiveJob) && self < ActiveJob::Base
-                       {
-                         adapter: "activejob",
-                         job_name: name,
-                         job_args: job_or_instantiate(*args).serialize
-                       }
-                     elsif defined?(Sidekiq) && include?(Sidekiq::Worker)
-                       {
-                         adapter: "sidekiq",
-                         job_name: name,
-                         job_args: args
-                       }
-                     else
-                       raise UnknownJobAdapter
-                     end
-
-        AcidicJob::Staged.create!(attributes)
-      end
-      # rubocop:enable Metrics/MethodLength
-    end
-  end
-end

data/lib/acidic_job/sidekiq_callbacks.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/callbacks"
-
-# Following approach used by ActiveJob
-# https://github.com/rails/rails/blob/93c9534c9871d4adad4bc33b5edc355672b59c61/activejob/lib/active_job/callbacks.rb
-module SidekiqCallbacks
-  extend ActiveSupport::Concern
-
-  def self.prepended(base)
-    base.include(ActiveSupport::Callbacks)
-
-    # Check to see if we already have any callbacks for :perform
-    # Prevents overwriting callbacks if we already included this module (and defined callbacks)
-    base.define_callbacks :perform unless base.respond_to?(:_perform_callbacks) && base._perform_callbacks.present?
-
-    class << base
-      prepend ClassMethods
-    end
-  end
-
-  def perform(*args)
-    if respond_to?(:run_callbacks)
-      run_callbacks :perform do
-        super(*args)
-      end
-    else
-      super(*args)
-    end
-  end
-
-  module ClassMethods
-    def around_perform(*filters, &blk)
-      set_callback(:perform, :around, *filters, &blk)
-    end
-
-    def before_perform(*filters, &blk)
-      set_callback(:perform, :before, *filters, &blk)
-    end
-
-    def after_perform(*filters, &blk)
-      set_callback(:perform, :after, *filters, &blk)
-    end
-  end
-end

data/lib/acidic_job/staged.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "active_record"
-require "global_id"
-
-module AcidicJob
-  class Staged < ActiveRecord::Base
-    self.table_name = "staged_acidic_jobs"
-
-    include GlobalID::Identification
-
-    validates :adapter, presence: true
-    validates :job_name, presence: true
-    validates :job_args, presence: true
-
-    serialize :job_args
-
-    after_create_commit :enqueue_job
-
-    private
-
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def enqueue_job
-      gid = { "staged_job_gid" => to_global_id.to_s }
-
-      if job_args.is_a?(Hash) && job_args.key?("arguments")
-        job_args["arguments"].concat([gid])
-      else
-        job_args.concat([gid])
-      end
-
-      case adapter
-      when "activejob"
-        job = ActiveJob::Base.deserialize(job_args)
-        job.enqueue
-      when "sidekiq"
-        Sidekiq::Client.push(
-          "class" => job_name,
-          "args" => job_args
-        )
-      else
-        raise UnknownJobAdapter.new(adapter: adapter)
-      end
-
-      # NOTE: record will be deleted after the job has successfully been performed
-      true
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-  end
-end

data/lib/generators/acidic_job_generator.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-require "rails/generators/active_record"
-
-class AcidicJobGenerator < ActiveRecord::Generators::Base
-  # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase
-  # which requires a NAME parameter for the new table name.
-  # Our generator always uses "acidic_job_keys", so we just set a random name here.
-  argument :name, type: :string, default: "random_name"
-
-  source_root File.expand_path("templates", __dir__)
-
-  def self.next_migration_number(_path)
-    if instance_variable_defined?("@prev_migration_nr")
-      @prev_migration_nr += 1
-    else
-      @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-    end
-
-    @prev_migration_nr.to_s
-  end
-
-  # Copies the migration template to db/migrate.
-  def copy_acidic_job_keys_migration_files
-    migration_template "create_acidic_job_keys_migration.rb.erb",
-                       "db/migrate/create_acidic_job_keys.rb"
-  end
-
-  def copy_staged_acidic_jobs_migration_files
-    migration_template "create_staged_acidic_jobs_migration.rb.erb",
-                       "db/migrate/create_staged_acidic_jobs.rb"
-  end
-
-  protected
-
-  def migration_class
-    if ActiveRecord::VERSION::MAJOR >= 5
-      ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
-    else
-      ActiveRecord::Migration
-    end
-  end
-end

data/lib/generators/templates/create_staged_acidic_jobs_migration.rb.erb

@@ -1,10 +0,0 @@
-class CreateStagedAcidicJobs < <%= migration_class %>
-  def change
-    create_table :staged_acidic_jobs do |t|
-      t.string :adapter, null: false
-      t.string :job_name, null: false
-      t.text :job_args, null: true
-      t.timestamps
-    end
-  end
-end