roast-ai 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d715c7be58b0ec9d6325f0eafd0b234d8bcf51fa3151c5830717dac034fdb5
-  data.tar.gz: d52615bc873667aaf3dc22a29c59b4ae0f6f1dd25af3addaaa4c8ad23eaa7cb4
+  metadata.gz: 70a8b9b5eb5427205d65f9e2d3eb989c53a0cd449aa83d2e8df712f3b06ae203
+  data.tar.gz: 29d8236ed59630399b69ddc7286d9f80428620158117a68bc14048c8ac0a1e78
 SHA512:
-  metadata.gz: 80796feab187127b4815af1d6120f5370724e817c55ecc240b2f5c58c39faf63c2e7ccb65ebc58c427a09debea7c26fc2ba26a044450e8696901a5da9aaba4b9
-  data.tar.gz: fa9791f7148cad5177f756705eab8778f3925183f734537b5732d712513be494c7124a530e065b5ed40765c967361fd6d4a1ee62897b0ab34db334588f2dfb78
+  metadata.gz: 48fcaf3988124ce0d627ff22f11fc563a990b96eb92afa27b75294f4c21ed2341c240f5ecf1fcf2b618f87078b19876adaa5cc493419a6be3b05c6b2137abd58
+  data.tar.gz: 4df2dfb16ff49b3bfe53102d878de8c356330621e4267a07fbfd35642251b512eab974cbe4c3377fbdaf29933b4a36c91010abc741ccb6b11321fcc4decf191a

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @nfgrep @dersam @obie @juniper-shopify
+

data/.github/workflows/ci.yaml

@@ -30,4 +30,5 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: bundle exec rake ci
+      - run: bin/srb tc
 

data/.gitignore

@@ -13,32 +13,6 @@
 **/CLAUDE.local.md
 .roast/
 
-bin/_guard-core
-bin/bundle
-bin/coderay
-bin/dotenv
-bin/erb
-bin/guard
-bin/htmldiff
-bin/irb
-bin/ldiff
-bin/listen
-bin/pry
-bin/racc
-bin/rake
-bin/rbs
-bin/rdbg
-bin/rdoc
-bin/ri
-bin/rubocop
-bin/ruby-lsp
-bin/ruby-lsp-check
-bin/ruby-lsp-launcher
-bin/ruby-lsp-test-exec
-bin/ruby-parse
-bin/ruby-rewrite
-bin/thor
-
 gemfiles/*.lock
 bin/claude-swarm
 *.gem

data/.rubocop.yml

@@ -1,3 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-sorbet
+
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
@@ -10,3 +15,11 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 3.4
   UseCache: true
+
+Sorbet/FalseSigil:
+  Enabled: true
+  Include:
+    - "lib/**/*.rb"
+  Exclude:
+    - "test/**/*"
+    - "examples/**/*"

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-08-17 17:40:01 UTC using RuboCop version 1.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Sorbet/ConstantsFromStrings:
+  Exclude:
+    - 'lib/roast/helpers/logger.rb'
+    - 'lib/roast/workflow/step_loader.rb'
+    - 'lib/roast/workflow/validators/dependency_validator.rb'
+    - 'lib/roast/workflow/workflow_initializer.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Sorbet/SelectByIsA:
+  Exclude:
+    - 'lib/roast/workflow/configuration_loader.rb'

data/CHANGELOG.md

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.5]
+
+### Added
+- **Sorbet static type checking** (#359, #360, #362)
+  - Initial setup of Sorbet for static type analysis
+  - Added `bin/srb tc` command for type checking
+  - Gradually adding type signatures to improve code safety and navigation
+  - Fixed invalid constants that were undefined and never reached
+  - Added to CI pipeline for continuous type checking
+- **Workflow name in step event payloads** (#333, #351)
+  - Added `workflow_name` field to all step-related ActiveSupport::Notification events
+  - Enables better tracking of which workflow a step belongs to in monitoring systems
+  - Updated events: `roast.step.start`, `roast.step.complete`, `roast.step.error`
+
+### Changed
+- **Improved error output formatting** (#358)
+  - Error messages now show concise output by default (just the error message)
+  - Full exception details and stack traces only shown in verbose mode (`-v`)
+  - Makes error output cleaner and more user-friendly
+- **Consolidated workflow runner architecture** (#355)
+  - Merged ConfigurationParser functionality into WorkflowRunner for better cohesion
+  - Simplified the codebase by removing redundant abstraction layers
+
+### Fixed
+- **Removed duplicated pre/post processing code** (#357)
+  - Extracted common pre/post processing logic from individual step executors
+  - Eliminated code duplication across different step types
+  - Improved maintainability and consistency
+
 ## [0.4.3] - 2025-07-10
 
 ### Changed

data/Gemfile

@@ -15,8 +15,12 @@ gem "guard-minitest"
 gem "mocha"
 gem "rake", require: false
 gem "rubocop-shopify", require: false
+gem "rubocop-sorbet", require: false
 gem "vcr", require: false
 gem "webmock", require: false
 gem "minitest-rg"
 
+gem "sorbet", require: false
+gem "tapioca", require: false
+
 gem "claude_swarm"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roast-ai (0.4.4)
+    roast-ai (0.4.5)
       activesupport (>= 7.0)
       cli-kit (~> 5.0)
       cli-ui (= 2.3.0)
@@ -81,6 +81,7 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
+    erubi (1.13.1)
     event_stream_parser (1.0.0)
     faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
@@ -145,6 +146,7 @@ GEM
     nenv (0.3.0)
     net-http (0.6.0)
       uri
+    netrc (0.11.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -176,6 +178,11 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
+    rbi (0.3.6)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+    rbs (3.9.4)
+      logger
     regexp_parser (2.10.0)
     rexml (3.4.1)
     rubocop (1.77.0)
@@ -194,6 +201,9 @@ GEM
       prism (~> 1.4)
     rubocop-shopify (2.17.1)
       rubocop (~> 1.62)
+    rubocop-sorbet (0.10.5)
+      lint_roller
+      rubocop (>= 1.75.2)
     ruby-graphviz (1.2.5)
       rexml
     ruby-openai (8.1.0)
@@ -204,8 +214,33 @@ GEM
     ruby2_keywords (0.0.5)
     securerandom (0.4.1)
     shellany (0.0.1)
+    sorbet (0.5.12414)
+      sorbet-static (= 0.5.12414)
+    sorbet-runtime (0.5.12414)
+    sorbet-static (0.5.12414-universal-darwin)
+    sorbet-static (0.5.12414-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12414)
+      sorbet (= 0.5.12414)
+      sorbet-runtime (= 0.5.12414)
+    spoom (1.6.3)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.3.3)
+      rexml (>= 3.2.6)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
     sqlite3 (2.7.0-arm64-darwin)
     sqlite3 (2.7.0-x86_64-linux-gnu)
+    tapioca (0.16.11)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     thor (1.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -219,6 +254,10 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
     zeitwerk (2.7.3)
 
 PLATFORMS
@@ -237,6 +276,9 @@ DEPENDENCIES
   rake
   roast-ai!
   rubocop-shopify
+  rubocop-sorbet
+  sorbet
+  tapioca
   vcr
   webmock
 

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/spoom

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'spoom' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("spoom", "spoom")

data/bin/srb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'srb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sorbet", "srb")

data/bin/srb-rbi

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'srb-rbi' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sorbet", "srb-rbi")

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/docs/INSTRUMENTATION.md

@@ -39,13 +39,13 @@ your-project/
 ### Step Events
 
 - `roast.step.start` - Emitted when a step begins execution
-  - Payload: `{ step_name: }`
+  - Payload: `{ step_name:, resource_type:, workflow_name: }`
   
 - `roast.step.complete` - Emitted when a step completes successfully
-  - Payload: `{ step_name:, success: true, execution_time:, result_size: }`
+  - Payload: `{ step_name:, resource_type:, workflow_name:, success: true, execution_time:, result_size: }`
   
 - `roast.step.error` - Emitted when a step encounters an error
-  - Payload: `{ step_name:, error:, message:, execution_time: }`
+  - Payload: `{ step_name:, resource_type:, workflow_name:, error:, message:, execution_time: }`
 
 ### AI/Chat Completion Events
 

data/dsl/simple.rb

@@ -0,0 +1,10 @@
+# typed: true
+# frozen_string_literal: true
+
+#: self as Roast::DSL::Executor
+
+# This is a dead simple workflow that calls two shell scripts
+shell <<~SHELLSTEP
+  echo "I have no idea what's going on"
+SHELLSTEP
+shell "pwd"

data/lib/roast/dsl/executor.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module Roast
+  module DSL
+    class Executor
+      class << self
+        def from_file(workflow_path)
+          execute(File.read(workflow_path))
+        end
+
+        private
+
+        def execute(input)
+          new.instance_eval(input)
+        end
+      end
+
+      # Define methods to be used in workflows below.
+
+      def shell(command_string)
+        puts %x(#{command_string})
+      end
+    end
+  end
+end

data/lib/roast/dsl.rb

@@ -0,0 +1,7 @@
+# typed: true
+# frozen_string_literal: true
+
+module Roast
+  module DSL
+  end
+end

data/lib/roast/errors.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast

data/lib/roast/factories/api_provider_factory.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast

data/lib/roast/helpers/function_caching_interceptor.rb

@@ -1,9 +1,12 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast
   module Helpers
     # Intercepts function dispatching to add caching capabilities
     # This module wraps around Raix::FunctionDispatch to provide caching for tool functions
+    # @requires_ancestor: Kernel
+    # @requires_ancestor: Raix::ChatCompletion
     module FunctionCachingInterceptor
       def dispatch_tool_function(function_name, params)
         start_time = Time.now

data/lib/roast/helpers/logger.rb

@@ -1,28 +1,25 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast
   module Helpers
     # Central logger for the Roast application
     class Logger
-      VALID_LOG_LEVELS = ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"].freeze
+      VALID_LOG_LEVELS = ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"].freeze #: Array[String]
 
-      delegate_missing_to :@logger
+      delegate :debug, :info, :warn, :error, :fatal, to: :@logger
 
       attr_reader :logger
 
       class << self
-        delegate_missing_to :instance
+        delegate :debug, :info, :warn, :error, :fatal, to: :instance
 
+        #: -> Roast::Helpers::Logger
         def instance
           @instance ||= new
         end
 
-        # Override Kernel#warn to ensure proper delegation
-        def warn(*args)
-          instance.warn(*args)
-        end
-
-        # For testing purposes
+        #: -> void
         def reset
           @instance = nil
         end

data/lib/roast/helpers/metadata_access.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast

data/lib/roast/helpers/minitest_coverage_runner.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require "coverage"

data/lib/roast/helpers/path_resolver.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast
@@ -38,17 +39,14 @@ module Roast
             next if i == 0 # Skip the first segment
 
             # Check if this segment appears earlier in the path
-            next unless path_parts[0...i].include?(part)
+            next unless path_parts[0...i]&.include?(part)
 
             # Create a new path without this segment
             test_parts = path_parts.dup
             test_parts.delete_at(i)
+            test_parts.prepend("/") if original_path.start_with?("/")
 
-            test_path = if original_path.start_with?("/")
-              File.join("/", *test_parts)
-            else
-              File.join(test_parts)
-            end
+            test_path = File.join(test_parts)
 
             # If this path exists, return it
             return test_path if File.exist?(test_path)
@@ -66,12 +64,8 @@ module Roast
             filtered_parts = path_parts.dup
             # Remove from end to beginning to keep indices valid
             duplicate_indices.reverse_each { |idx| filtered_parts.delete_at(idx) }
-
-            test_path = if original_path.start_with?("/")
-              File.join("/", *filtered_parts)
-            else
-              File.join(filtered_parts)
-            end
+            filtered_parts.prepend("/") if original_path.start_with?("/")
+            test_path = File.join(filtered_parts)
 
             return test_path if File.exist?(test_path)
           end
@@ -93,12 +87,8 @@ module Roast
             unique_parts = path_parts.dup
             # Remove from end to beginning to keep indices valid
             duplicate_indices.reverse_each { |i| unique_parts.delete_at(i) }
-
-            test_path = if original_path.start_with?("/")
-              File.join("/", *unique_parts)
-            else
-              File.join(unique_parts)
-            end
+            unique_parts.prepend("/") if original_path.start_with?("/")
+            test_path = File.join(unique_parts)
 
             return test_path if File.exist?(test_path)
           end

data/lib/roast/helpers/prompt_loader.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast
@@ -58,7 +59,7 @@ module Roast
         glob_pattern = File.join(context_dir, "{#{base_name},prompt}.*+*.md")
         Dir.glob(glob_pattern).each do |combined_path|
           basename = File.basename(combined_path, ".md")
-          combined_exts = basename.split(".", 2)[1].split("+")
+          combined_exts = basename.split(".", 2)[1]&.split("+")
 
           # Return the first matching combined format
           return combined_path if extensions.intersect?(combined_exts)
@@ -77,7 +78,7 @@ module Roast
 
         if file_basename.end_with?(".md") && file_basename.count(".") > 1
           without_md = file_basename[0...-3] # Remove .md
-          without_md.split(".", 2)[1]&.split("+") || []
+          without_md&.split(".", 2)&.[](1)&.split("+") || []
         else
           ext = File.extname(target_file)[1..]
           ext&.empty? ? [] : [ext]

data/lib/roast/helpers/timeout_handler.rb

@@ -1,8 +1,6 @@
+# typed: true
 # frozen_string_literal: true
 
-require "timeout"
-require "open3"
-
 module Roast
   module Helpers
     # Shared timeout handling logic for command-based tools
@@ -29,8 +27,8 @@ module Roast
         def call(command, timeout: DEFAULT_TIMEOUT, working_directory: Dir.pwd)
           timeout = validate_timeout(timeout)
           output = ""
-          exit_status = nil
-          wait_thr = nil
+          exit_status = nil #: Integer?
+          wait_thr = nil #: Process::Waiter?
 
           begin
             Timeout.timeout(timeout) do

data/lib/roast/initializers.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast

data/lib/roast/resources/api_resource.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast
@@ -57,7 +58,7 @@ module Roast
         http.use_ssl = (uri.scheme == "https")
 
         # Use HEAD request to check existence
-        request = Net::HTTP::Head.new(uri.path.empty? ? "/" : uri.path)
+        request = Net::HTTP::Head.new(uri.path&.empty? ? "/" : uri.path)
 
         # Add headers if present in options
         if options["headers"].is_a?(Hash)
@@ -124,8 +125,8 @@ module Roast
       # Replace environment variables in the format ${VAR_NAME}
       def process_env_vars(text)
         text.gsub(/\${([^}]+)}/) do |_match|
-          var_name = ::Regexp.last_match(1).strip
-          ENV.fetch(var_name, "${#{var_name}}")
+          var_name = ::Regexp.last_match(1)&.strip
+          ENV.fetch(var_name, "${#{var_name}}") unless var_name.nil?
         end
       end
     end

data/lib/roast/resources/base_resource.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast

data/lib/roast/resources/directory_resource.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Roast