durable_workflow 0.1.0

data/Gemfile.lock

@@ -0,0 +1,192 @@
+PATH
+  remote: .
+  specs:
+    durable_workflow (0.1.0)
+      async (~> 2.21)
+      dry-struct (~> 1.6)
+      dry-types (~> 1.7)
+      faraday (>= 2.0)
+      json_schemer (~> 2.0)
+      mcp (~> 0.1)
+      rack (>= 2.0)
+      ruby_llm (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.2.3)
+      activesupport (= 7.2.3)
+    activerecord (7.2.3)
+      activemodel (= 7.2.3)
+      activesupport (= 7.2.3)
+      timeout (>= 0.4.0)
+    activesupport (7.2.3)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    async (2.34.0)
+      console (~> 1.29)
+      fiber-annotation
+      io-event (~> 1.11)
+      metrics (~> 0.12)
+      traces (~> 0.18)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.5)
+    console (1.34.2)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
+    dotenv (3.1.8)
+    drb (2.2.3)
+    dry-core (1.1.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    event_stream_parser (1.0.0)
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.1)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    faraday-retry (2.3.2)
+      faraday (~> 2.0)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.1)
+    hana (1.3.7)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    io-event (1.11.2)
+    json (2.16.0)
+    json-schema (6.0.0)
+      addressable (~> 2.8)
+      bigdecimal (~> 3.1)
+    json_rpc_handler (0.1.1)
+    json_schemer (2.4.0)
+      bigdecimal
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    marcel (1.1.0)
+    mcp (0.4.0)
+      json-schema (>= 4.1)
+      json_rpc_handler (~> 0.1)
+    metrics (0.15.0)
+    minitest (5.26.2)
+    multipart-post (2.4.1)
+    net-http (0.8.0)
+      uri (>= 0.11.1)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    public_suffix (7.0.0)
+    racc (1.8.1)
+    rack (3.2.4)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    redis (5.4.1)
+      redis-client (>= 0.22.0)
+    redis-client (0.26.1)
+      connection_pool
+    regexp_parser (2.11.3)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    ruby_llm (1.9.1)
+      base64
+      event_stream_parser (~> 1)
+      faraday (>= 1.10.0)
+      faraday-multipart (>= 1)
+      faraday-net_http (>= 1)
+      faraday-retry (>= 1)
+      marcel (~> 1.0)
+      ruby_llm-schema (~> 0.2.1)
+      zeitwerk (~> 2)
+    ruby_llm-schema (0.2.5)
+    securerandom (0.4.1)
+    sequel (5.98.0)
+      bigdecimal
+    simpleidn (0.2.3)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    timeout (0.4.4)
+    traces (0.18.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  arm64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7.0)
+  dotenv (~> 3.0)
+  durable_workflow!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  redis (~> 5.0)
+  rubocop (~> 1.21)
+  sequel (~> 5.0)
+  sqlite3 (~> 1.6)
+
+BUNDLED WITH
+   2.4.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ben
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# DurableWorkflow
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/durable_workflow`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/durable_workflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/durable_workflow/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DurableWorkflow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/durable_workflow/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/durable_workflow.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/durable_workflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'durable_workflow'
+  spec.version = DurableWorkflow::VERSION
+  spec.authors = ['Ben']
+  spec.email = ['ben@dee.mx']
+
+  spec.summary = 'Durable workflow engine with YAML-defined steps and pluggable executors'
+  spec.description = 'A workflow engine supporting loops, parallel execution, approvals, halts, and extensible step types. Designed for durable, resumable execution with optional AI capabilities.'
+  spec.homepage = 'https://github.com/your-org/durable_workflow'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Core dependencies
+  spec.add_dependency 'dry-types', '~> 1.7'
+  spec.add_dependency 'dry-struct', '~> 1.6'
+  spec.add_dependency 'json_schemer', '~> 2.0'
+  spec.add_dependency 'async', '~> 2.21'
+
+  # AI extension dependencies
+  spec.add_dependency 'ruby_llm', '~> 1.0'
+  spec.add_dependency 'mcp', '~> 0.1'
+  spec.add_dependency 'faraday', '>= 2.0'
+  spec.add_dependency 'rack', '>= 2.0'
+end

data/examples/approval_request.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Approval Request - Workflow that halts for human input
+#
+# Demonstrates: Halt step, resume, human-in-the-loop
+#
+# Run: ruby examples/approval_request.rb
+# Requires: Redis running on localhost:6379
+
+require "bundler/setup"
+require "durable_workflow"
+require "durable_workflow/storage/redis"
+
+DurableWorkflow.configure do |c|
+  c.store = DurableWorkflow::Storage::Redis.new(url: "redis://localhost:6379")
+end
+
+workflow = DurableWorkflow::Core::Parser.parse(<<~YAML)
+  id: expense_approval
+  name: Expense Approval
+  version: "1.0"
+
+  inputs:
+    requester:
+      type: string
+      required: true
+    amount:
+      type: number
+      required: true
+    description:
+      type: string
+      required: true
+
+  steps:
+    - id: start
+      type: start
+      next: check_amount
+
+    - id: check_amount
+      type: router
+      routes:
+        - when:
+            field: input.amount
+            op: gt
+            value: 100
+          then: require_approval
+      default: auto_approve
+
+    - id: auto_approve
+      type: assign
+      set:
+        approved: true
+        approved_by: system
+        reason: "Amount under threshold"
+      next: end
+
+    - id: require_approval
+      type: approval
+      prompt: "Please approve expense request"
+      context:
+        requester: "$input.requester"
+        amount: "$input.amount"
+        description: "$input.description"
+      on_reject: rejected
+      next: approved
+
+    - id: approved
+      type: assign
+      set:
+        approved: true
+        approved_by: manager
+      next: end
+
+    - id: rejected
+      type: assign
+      set:
+        approved: false
+        approved_by: manager
+        reason: "Request rejected"
+      next: end
+
+    - id: end
+      type: end
+      result:
+        approved: "$approved"
+        approved_by: "$approved_by"
+        reason: "$reason"
+YAML
+
+runner = DurableWorkflow::Runners::Sync.new(workflow)
+
+# Small expense - auto-approved
+result = runner.run(input: { requester: "Alice", amount: 50, description: "Office supplies" })
+puts "Small expense: #{result.output}"
+# => Small expense: {:approved=>true, :approved_by=>"system", :reason=>"Amount under threshold"}
+
+# Large expense - requires approval
+result = runner.run(input: { requester: "Bob", amount: 500, description: "Conference ticket" })
+puts "\nLarge expense halted: #{result.status}"
+puts "Halt data: #{result.halt&.data}"
+
+# Simulate manager approval
+if result.status == :halted
+  puts "Workflow halted for approval - would resume with approved: true/false"
+end

data/examples/calculator.rb

@@ -0,0 +1,154 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Calculator Workflow - Routing based on input
+#
+# Demonstrates: Router step, conditional branching, service calls
+#
+# Run: ruby examples/calculator.rb
+# Requires: Redis running on localhost:6379
+
+require "bundler/setup"
+require "durable_workflow"
+require "durable_workflow/storage/redis"
+
+# Calculator service for arithmetic operations (must be globally accessible)
+module Calculator
+  def self.add(a:, b:)
+    { result: a + b, operation: "addition" }
+  end
+
+  def self.subtract(a:, b:)
+    { result: a - b, operation: "subtraction" }
+  end
+
+  def self.multiply(a:, b:)
+    { result: a * b, operation: "multiplication" }
+  end
+
+  def self.divide(a:, b:)
+    { result: a.to_f / b, operation: "division" }
+  end
+end
+
+DurableWorkflow.configure do |c|
+  c.store = DurableWorkflow::Storage::Redis.new(url: "redis://localhost:6379")
+end
+
+workflow = DurableWorkflow::Core::Parser.parse(<<~YAML)
+  id: calculator
+  name: Calculator
+  version: "1.0"
+
+  inputs:
+    operation:
+      type: string
+      required: true
+    a:
+      type: number
+      required: true
+    b:
+      type: number
+      required: true
+
+  steps:
+    - id: start
+      type: start
+      next: route
+
+    - id: route
+      type: router
+      routes:
+        - when:
+            field: input.operation
+            op: eq
+            value: "add"
+          then: add
+        - when:
+            field: input.operation
+            op: eq
+            value: "subtract"
+          then: subtract
+        - when:
+            field: input.operation
+            op: eq
+            value: "multiply"
+          then: multiply
+        - when:
+            field: input.operation
+            op: eq
+            value: "divide"
+          then: divide
+      default: error
+
+    - id: add
+      type: call
+      service: Calculator
+      method: add
+      input:
+        a: "$input.a"
+        b: "$input.b"
+      output: calc_result
+      next: end
+
+    - id: subtract
+      type: call
+      service: Calculator
+      method: subtract
+      input:
+        a: "$input.a"
+        b: "$input.b"
+      output: calc_result
+      next: end
+
+    - id: multiply
+      type: call
+      service: Calculator
+      method: multiply
+      input:
+        a: "$input.a"
+        b: "$input.b"
+      output: calc_result
+      next: end
+
+    - id: divide
+      type: call
+      service: Calculator
+      method: divide
+      input:
+        a: "$input.a"
+        b: "$input.b"
+      output: calc_result
+      next: end
+
+    - id: error
+      type: assign
+      set:
+        calc_result:
+          error: "Unknown operation"
+      next: end
+
+    - id: end
+      type: end
+      result:
+        result: "$calc_result.result"
+        operation: "$calc_result.operation"
+        error: "$calc_result.error"
+YAML
+
+runner = DurableWorkflow::Runners::Sync.new(workflow)
+
+# Test all operations
+[
+  { operation: "add", a: 10, b: 5 },
+  { operation: "subtract", a: 10, b: 5 },
+  { operation: "multiply", a: 10, b: 5 },
+  { operation: "divide", a: 10, b: 5 }
+].each do |calc_input|
+  result = runner.run(input: calc_input)
+  puts "#{calc_input[:a]} #{calc_input[:operation]} #{calc_input[:b]} = #{result.output[:result]}"
+end
+# => 10 add 5 = 15
+# => 10 subtract 5 = 5
+# => 10 multiply 5 = 50
+# => 10 divide 5 = 2.0

data/examples/file_search_demo.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# File Search Demo
+# Demonstrates the file_search step type with dummy results
+
+require "bundler/setup"
+require "durable_workflow"
+require "durable_workflow/extensions/ai"
+require "durable_workflow/storage/redis"
+
+DurableWorkflow.configure do |c|
+  c.store = DurableWorkflow::Storage::Redis.new(url: "redis://localhost:6379")
+  c.logger = Logger.new($stdout, level: Logger::INFO)
+end
+
+# Define workflow inline using YAML
+workflow_yaml = <<~YAML
+  id: file_search_demo
+  name: File Search Demo
+  version: "1.0"
+  description: Search documentation files
+
+  inputs:
+    query:
+      type: string
+      required: true
+      description: Search query
+
+  steps:
+    - id: start
+      type: start
+      next: search_docs
+
+    - id: search_docs
+      type: file_search
+      query: "$input.query"
+      files:
+        - docs/getting_started.md
+        - docs/configuration.md
+        - docs/api_reference.md
+        - docs/troubleshooting.md
+      max_results: 3
+      output: search_results
+      next: format_results
+
+    - id: format_results
+      type: assign
+      set:
+        summary: "Found results for query"
+      next: end
+
+    - id: end
+      type: end
+      result:
+        query: "$input.query"
+        results: "$search_results.results"
+        total: "$search_results.total"
+        summary: "$summary"
+YAML
+
+workflow = DurableWorkflow.load(workflow_yaml)
+runner = DurableWorkflow::Runners::Sync.new(workflow)
+
+puts "=" * 60
+puts "File Search Demo"
+puts "=" * 60
+
+result = runner.run(input: { query: "how to configure logging" })
+
+puts "\nSearch Query: #{result.output[:query]}"
+puts "Total Results: #{result.output[:total]}"
+puts "\nResults:"
+result.output[:results].each_with_index do |r, idx|
+  puts "  #{idx + 1}. #{r[:file]} (score: #{r[:score]})"
+  puts "     #{r[:snippet]}"
+end

data/examples/hello_workflow.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Hello Workflow - Simplest possible durable workflow
+#
+# Demonstrates: Basic workflow structure, assign step, input/output
+#
+# Run: ruby examples/hello_workflow.rb
+# Requires: Redis running on localhost:6379
+
+require "bundler/setup"
+require "durable_workflow"
+require "durable_workflow/storage/redis"
+
+# Configure storage
+DurableWorkflow.configure do |c|
+  c.store = DurableWorkflow::Storage::Redis.new(url: "redis://localhost:6379")
+end
+
+# Define workflow inline
+workflow = DurableWorkflow::Core::Parser.parse(<<~YAML)
+  id: hello_world
+  name: Hello World
+  version: "1.0"
+
+  inputs:
+    name:
+      type: string
+      required: true
+
+  steps:
+    - id: start
+      type: start
+      next: greet
+
+    - id: greet
+      type: assign
+      set:
+        greeting: "Hello, $input.name!"
+        timestamp: "$now"
+      next: end
+
+    - id: end
+      type: end
+      result:
+        message: "$greeting"
+        generated_at: "$timestamp"
+YAML
+
+# Run it
+runner = DurableWorkflow::Runners::Sync.new(workflow)
+result = runner.run(input: { name: "World" })
+
+puts "Status: #{result.status}"
+puts "Output: #{result.output}"
+# => Status: completed
+# => Output: {:message=>"Hello, World!", :generated_at=>"2024-..."}