stepped 0.1.0 → 1.0.0

data/db/migrate/20251214104829_create_stepped_tables_if_missing.rb

@@ -0,0 +1,77 @@
+class CreateSteppedTablesIfMissing < ActiveRecord::Migration[8.0]
+  def change
+    create_table :stepped_achievements, if_not_exists: true do |t|
+      t.string :checksum, null: false
+      t.string :checksum_key, null: false
+      t.timestamps null: false
+    end
+    add_index :stepped_achievements, :checksum_key, unique: true, if_not_exists: true
+
+    create_table :stepped_actions, if_not_exists: true do |t|
+      t.bigint :actor_id, null: false
+      t.string :actor_type, null: false
+      t.integer :after_callbacks_failed_count
+      t.integer :after_callbacks_succeeded_count
+      t.json :arguments
+      t.string :checksum
+      t.string :checksum_key, null: false
+      t.datetime :completed_at
+      t.string :concurrency_key, null: false
+      t.integer :current_step_index, null: false, default: 0
+      t.string :job
+      t.string :name, null: false
+      t.boolean :outbound, null: false, default: false
+      t.bigint :performance_id
+      t.boolean :root, default: false
+      t.datetime :started_at
+      t.string :status, null: false, default: "pending"
+      t.integer :timeout_seconds
+      t.timestamps null: false
+    end
+
+    add_index :stepped_actions, %i[actor_type actor_id], name: "index_stepped_actions_on_actor", if_not_exists: true
+    add_index :stepped_actions, %i[performance_id outbound], name: "index_stepped_actions_on_performance_id_and_outbound", if_not_exists: true
+    add_index :stepped_actions, :performance_id, if_not_exists: true
+    add_index :stepped_actions, :root, if_not_exists: true
+
+    create_table :stepped_actions_steps, id: false, if_not_exists: true do |t|
+      t.bigint :action_id, null: false
+      t.bigint :step_id, null: false
+    end
+
+    add_index :stepped_actions_steps, %i[action_id step_id], unique: true, name: "index_stepped_actions_steps_on_action_id_and_step_id", if_not_exists: true
+    add_index :stepped_actions_steps, %i[step_id action_id], name: "index_stepped_actions_steps_on_step_id_and_action_id", if_not_exists: true
+
+    create_table :stepped_performances, if_not_exists: true do |t|
+      t.bigint :action_id, null: false
+      t.string :concurrency_key
+      t.string :outbound_complete_key
+      t.timestamps null: false
+    end
+
+    add_index :stepped_performances, :action_id, unique: true, name: "index_stepped_performances_on_action_id", if_not_exists: true
+    add_index :stepped_performances, :concurrency_key, unique: true, name: "index_stepped_performances_on_concurrency_key", if_not_exists: true
+    add_index :stepped_performances, :outbound_complete_key,
+              name: "index_stepped_performances_on_outbound_complete_key",
+              where: "(outbound_complete_key IS NOT NULL)",
+              if_not_exists: true
+
+    create_table :stepped_steps, if_not_exists: true do |t|
+      t.bigint :action_id, null: false
+      t.datetime :completed_at
+      t.integer :definition_index, null: false
+      t.integer :pending_actions_count, null: false, default: 0
+      t.datetime :started_at
+      t.string :status, null: false, default: "pending"
+      t.integer :unsuccessful_actions_count, default: 0
+      t.timestamps null: false
+    end
+
+    add_index :stepped_steps, %i[action_id definition_index], unique: true, name: "index_stepped_steps_on_action_id_and_definition_index", if_not_exists: true
+    add_index :stepped_steps, :action_id, name: "index_stepped_steps_on_action_id", if_not_exists: true
+
+    add_foreign_key :stepped_actions, :stepped_performances, column: :performance_id, if_not_exists: true
+    add_foreign_key :stepped_performances, :stepped_actions, column: :action_id, if_not_exists: true
+    add_foreign_key :stepped_steps, :stepped_actions, column: :action_id, if_not_exists: true
+  end
+end

data/lib/stepped/engine.rb

@@ -1,10 +1,12 @@
-# frozen_string_literal: true
-
-require "rails/engine"
-require "action_dispatch"
-
 module Stepped
   class Engine < ::Rails::Engine
-    isolate_namespace Stepped
+    config.stepped_actions = ActiveSupport::OrderedOptions.new
+    config.stepped_actions.handle_exceptions = Rails.env.test? ? [] : [ StandardError ]
+
+    initializer "stepped.active_record.extensions" do
+      ActiveSupport.on_load :active_record do
+        include Stepped::Actionable
+      end
+    end
   end
 end

data/lib/stepped/test_helper.rb

@@ -0,0 +1,76 @@
+module Stepped::TestHelper
+  def perform_stepped_actions(only: stepped_job_classes)
+    perform_enqueued_jobs_recursively(only:)
+    complete_stepped_outbound_performances
+
+    perform_stepped_actions(only:) if Stepped::Performance.any? || enqueued_jobs_with(only:).count > 0
+  end
+
+  def assert_stepped_action_job(name, actor = nil)
+    jobs_before = enqueued_jobs + performed_jobs
+    yield
+    jobs = (enqueued_jobs + performed_jobs) - jobs_before
+    found = false
+    all_actions = []
+    jobs.each do |job|
+      next unless job["job_class"] == "Stepped::ActionJob"
+
+      job_actor, job_action_name = ActiveJob::Arguments.deserialize job["arguments"]
+      all_actions << [ job_actor.to_global_id, job_action_name ].join("#")
+      next if found
+
+      found = job_action_name == name
+      if found && actor.present?
+        actor = eval(actor) if actor.is_a?(String)
+        found = job_actor == actor
+      end
+    end
+    assert found, <<~MESSAGE
+      Stepped action job for '#{name}' was not enqueued or performed#{actor.respond_to?(:to_debug_id) ? " on #{actor.to_debug_id}" : nil}.
+      Actions that were: #{all_actions.join(", ")}
+    MESSAGE
+  end
+
+  def assert_no_stepped_actions
+    jobs_before = enqueued_jobs + performed_jobs
+    yield
+    jobs = (enqueued_jobs + performed_jobs) - jobs_before
+    found = false
+    all_actions = []
+    jobs.each do |job|
+      next unless job["job_class"] == "Stepped::ActionJob"
+      found = true
+      job_actor, job_action_name = ActiveJob::Arguments.deserialize job["arguments"]
+      all_actions << [ job_actor.class.name, job_action_name ].join("#")
+    end
+    assert_not found, <<~MESSAGE
+      Stepped action jobs enqueued or performed: #{all_actions.join(", ")}
+    MESSAGE
+  end
+
+  def handle_stepped_action_exceptions(only: [ StandardError ])
+    was = Stepped::Engine.config.stepped_actions.handle_exceptions
+    Stepped::Engine.config.stepped_actions.handle_exceptions = Array(only)
+    yield
+  ensure
+    Stepped::Engine.config.stepped_actions.handle_exceptions = was
+  end
+
+  def perform_enqueued_jobs_recursively(only: nil)
+    total = 0
+    loop do
+      batch = perform_enqueued_jobs(only:)
+      break if batch == 0
+      total += batch
+    end
+    total
+  end
+
+  def stepped_job_classes
+    [ Stepped::ActionJob, Stepped::TimeoutJob, Stepped::WaitJob ] + Stepped::Registry.job_classes
+  end
+
+  def complete_stepped_outbound_performances
+    # Consuming app can redefine
+  end
+end

data/lib/stepped/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Stepped
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/stepped.rb

@@ -1,13 +1,26 @@
-# frozen_string_literal: true
-
-require "active_support/lazy_load_hooks"
-require_relative "stepped/version"
-require_relative "stepped/active_record_extension"
-require_relative "stepped/engine"
+require "stepped/version"
+require "stepped/engine"
 
 module Stepped
-end
+  def self.table_name_prefix
+    "stepped_"
+  end
+
+  def self.handled_exception_classes
+    Array(Stepped::Engine.config.stepped_actions.handle_exceptions)
+  end
+
+  def self.handle_exception(context: {})
+    yield
+    true
+  rescue StandardError => e
+    raise unless handled_exception_classes.any? { e.class <= _1 }
+    Rails.error.report(e, handled: false, context:)
+    false
+  end
 
-ActiveSupport.on_load(:active_record) do
-  include Stepped::ActiveRecordExtension
+  def self.checksum(value)
+    return if value.nil?
+    Digest::SHA256.hexdigest JSON.dump(value)
+  end
 end

data/lib/tasks/stepped_tasks.rake

@@ -0,0 +1,12 @@
+namespace :stepped do
+  desc "Install Stepped Actions"
+  task install: "stepped:install:migrations"
+
+  namespace :install do
+    desc "Copy Stepped migrations to the host app"
+    task migrations: :environment do
+      ENV["FROM"] = Stepped::Engine.railtie_name
+      Rake::Task["railties:install:migrations"].invoke
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stepped
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Starsi
@@ -15,72 +15,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: 8.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: 8.1.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: temping
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 email:
 - klevo@klevo.sk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- MIT-LICENSE
 - README.md
+- Rakefile
+- app/jobs/stepped/action_job.rb
+- app/jobs/stepped/complete_action_job.rb
+- app/jobs/stepped/timeout_job.rb
+- app/jobs/stepped/wait_job.rb
+- app/models/concerns/stepped/actionable.rb
+- app/models/stepped/achievement.rb
+- app/models/stepped/action.rb
+- app/models/stepped/arguments.rb
+- app/models/stepped/definition.rb
+- app/models/stepped/performance.rb
+- app/models/stepped/registry.rb
+- app/models/stepped/step.rb
+- config/routes.rb
+- db/migrate/20251214104829_create_stepped_tables_if_missing.rb
 - lib/stepped.rb
-- lib/stepped/active_record_extension.rb
 - lib/stepped/engine.rb
+- lib/stepped/test_helper.rb
 - lib/stepped/version.rb
+- lib/tasks/stepped_tasks.rake
 homepage: https://github.com/envirobly/stepped
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/envirobly/stepped
+  source_code_uri: https://github.com/envirobly/stepped
 rdoc_options: []
 require_paths:
 - lib
@@ -88,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.1
 specification_version: 4
-summary: Stepped Actions orchestrate checksumable and reusable tasks.
+summary: Rails engine for orchestrating complex action trees.
 test_files: []

data/lib/stepped/active_record_extension.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Stepped
-  module ActiveRecordExtension
-    def stepped_test
-      "stepped here"
-    end
-  end
-end