roast-ai 0.1.0

data/lib/roast/workflow/workflow_executor.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Roast
+  module Workflow
+    # Handles the execution of workflow steps, including orchestration and threading
+    class WorkflowExecutor
+      DEFAULT_MODEL = "anthropic:claude-3-7-sonnet"
+
+      attr_reader :workflow, :config_hash, :context_path
+
+      def initialize(workflow, config_hash, context_path)
+        @workflow = workflow
+        @config_hash = config_hash
+        @context_path = context_path
+      end
+
+      def execute_steps(steps)
+        steps.each do |step|
+          case step
+          when Hash
+            execute_hash_step(step)
+          when Array
+            execute_parallel_steps(step)
+          when String
+            execute_string_step(step)
+          else
+            raise "Unknown step type: #{step.inspect}"
+          end
+        end
+      end
+
+      def execute_step(name)
+        $stderr.puts "Executing: #{name}"
+        return strip_and_execute(name) if name.starts_with?("%") || name.starts_with?("$(")
+
+        return glob(name) if name.include?("*")
+
+        step_object = find_and_load_step(name)
+        result = step_object.call
+
+        workflow.output[name] = result
+        result
+      end
+
+      private
+
+      def execute_hash_step(step)
+        # execute a command and store the output in a variable
+        name, command = step.to_a.flatten
+        if command.is_a?(Hash)
+          execute_steps([command])
+        else
+          workflow.output[name] = execute_step(command)
+        end
+      end
+
+      def execute_parallel_steps(steps)
+        # run steps in parallel, don't proceed until all are done
+        steps.map do |sub_step|
+          Thread.new { execute_steps([sub_step]) }
+        end.each(&:join)
+      end
+
+      def execute_string_step(step)
+        execute_step(step)
+      end
+
+      def find_and_load_step(step_name)
+        # First check for a ruby file with the step name
+        rb_file_path = File.join(context_path, "#{step_name}.rb")
+        if File.file?(rb_file_path)
+          return load_ruby_step(rb_file_path, step_name)
+        end
+
+        # Check in shared directory for ruby file
+        shared_rb_path = File.expand_path(File.join(context_path, "..", "shared", "#{step_name}.rb"))
+        if File.file?(shared_rb_path)
+          return load_ruby_step(shared_rb_path, step_name, File.dirname(shared_rb_path))
+        end
+
+        # Continue with existing directory check logic
+        step_path = File.join(context_path, step_name)
+        step_path = File.expand_path(File.join(context_path, "..", "shared", step_name)) unless File.directory?(step_path)
+        raise "Step directory or file not found: #{step_path}" unless File.directory?(step_path)
+
+        setup_step(Roast::Workflow::BaseStep, step_name, step_path)
+      end
+
+      def glob(name)
+        Dir.glob(name).join("\n")
+      end
+
+      def load_ruby_step(file_path, step_name, context_path = File.dirname(file_path))
+        $stderr.puts "Requiring step file: #{file_path}"
+        require file_path
+        step_class = step_name.classify.constantize
+        setup_step(step_class, step_name, context_path)
+      end
+
+      def setup_step(step_class, step_name, context_path)
+        step_class.new(workflow, name: step_name, context_path: context_path).tap do |step|
+          step_config = config_hash[step_name]
+          if step_config.present?
+            step.model = step_config["model"] || DEFAULT_MODEL
+            step.print_response = step_config["print_response"] if step_config["print_response"].present?
+            step.loop = step_config["loop"] if step_config["loop"].present?
+            step.json = step_config["json"] if step_config["json"].present?
+            step.params = step_config["params"] if step_config["params"].present?
+          end
+        end
+      end
+
+      def strip_and_execute(step)
+        command = step.gsub("%", "")
+        %x(#{command})
+      end
+    end
+  end
+end

data/lib/roast/workflow.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "roast/workflow/base_step"
+require "roast/workflow/base_workflow"
+require "roast/workflow/configuration"
+require "roast/workflow/workflow_executor"
+require "roast/workflow/configuration_parser"
+require "roast/workflow/validator"
+
+module Roast
+  module Workflow
+  end
+end

data/lib/roast.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "raix"
+require "thor"
+require "roast/version"
+require "roast/tools"
+require "roast/helpers"
+require "roast/workflow"
+
+module Roast
+  ROOT = File.expand_path("../..", __FILE__)
+
+  class CLI < Thor
+    desc "execute [WORKFLOW_CONFIGURATION_FILE] [FILES...]", "Run a configured workflow"
+    option :concise, type: :boolean, aliases: "-c", desc: "Optional flag for use in output templates"
+    option :output, type: :string, aliases: "-o", desc: "Save results to a file"
+    option :verbose, type: :boolean, aliases: "-v", desc: "Show output from all steps as they are executed"
+    option :target, type: :string, aliases: "-t", desc: "Override target files. Can be file path, glob pattern, or $(shell command)"
+    option :subject, type: :string, aliases: "-s", desc: "Subject file to analyze"
+    def execute(*paths)
+      raise Thor::Error, "Workflow configuration file is required" if paths.empty?
+
+      workflow_path, *files = paths
+      expanded_workflow_path = File.expand_path(workflow_path)
+      raise Thor::Error, "Expected a Roast workflow configuration file, got directory: #{expanded_workflow_path}" if File.directory?(expanded_workflow_path)
+
+      if options[:subject] && !File.exist?(options[:subject])
+        raise Thor::Error, "Subject file does not exist: #{options[:subject]}"
+      end
+
+      Roast::Workflow::ConfigurationParser.new(expanded_workflow_path, files, options.transform_keys(&:to_sym)).begin!
+    end
+
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/roast.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "roast/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "roast-ai"
+  spec.version       = Roast::VERSION
+  spec.authors       = ["Shopify"]
+  spec.email         = ["opensource@shopify.com"]
+
+  spec.summary       = "A framework for executing structured AI workflows in Ruby"
+  spec.description   = "Roast is a Ruby library for running structured AI workflows along with many building blocks for creating and executing them"
+  spec.homepage      = "https://github.com/Shopify/roast"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Shopify/roast"
+    spec.metadata["changelog_uri"] = "https://github.com/Shopify/roast/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activesupport", "~> 8.0")
+  spec.add_dependency("faraday-retry")
+  spec.add_dependency("json-schema")
+  spec.add_dependency("raix", "0.8.3")
+  spec.add_dependency("thor", "~> 1.3")
+end

data/schema/workflow.json

@@ -0,0 +1,92 @@
+{
+    "type": "object",
+    "required": ["name", "tools", "steps"],
+    "properties": {
+      "name": {
+        "type": "string"
+      },
+      "tools": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "inputs": {
+        "type": "array",
+        "items": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "minProperties": 1,
+              "maxProperties": 1
+            }
+          ]
+        }
+      },
+      "steps": {
+        "type": "array",
+        "items": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "steps": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "required": ["steps"]
+                  }
+                ]
+              }
+            },
+            {
+              "type": "object",
+              "properties": {
+                "proceed?": {
+                  "type": "object",
+                  "properties": {
+                    "true": {
+                      "$ref": "#/properties/steps"
+                    },
+                    "false": {
+                      "$ref": "#/properties/steps"
+                    }
+                  },
+                  "required": ["true", "false"]
+                }
+              },
+              "required": ["proceed?"]
+            }
+          ]
+        }
+      },
+      "proceed?": {
+        "type": "object",
+        "properties": {
+          "label": {
+            "type": "string"
+          }
+        },
+        "required": ["label"]
+      }
+    }
+  }

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: roast-ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shopify
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  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: json-schema
+  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: raix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Roast is a Ruby library for running structured AI workflows along with
+  many building blocks for creating and executing them
+email:
+- opensource@shopify.com
+executables:
+- roast
+extensions: []
+extra_rdoc_files: []
+files:
+- ".claude/settings.json"
+- ".github/workflows/ci.yaml"
+- ".github/workflows/cla.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CLAUDE.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- examples/grading/analyze_coverage/prompt.md
+- examples/grading/calculate_final_grade.rb
+- examples/grading/format_result.rb
+- examples/grading/generate_grades/prompt.md
+- examples/grading/generate_recommendations/output.txt
+- examples/grading/generate_recommendations/prompt.md
+- examples/grading/run_coverage.rb
+- examples/grading/verify_mocks_and_stubs/prompt.md
+- examples/grading/verify_test_helpers/prompt.md
+- examples/grading/workflow.md
+- examples/grading/workflow.rb.md
+- examples/grading/workflow.ts+tsx.md
+- examples/grading/workflow.yml
+- exe/roast
+- lib/roast.rb
+- lib/roast/helpers.rb
+- lib/roast/helpers/function_caching_interceptor.rb
+- lib/roast/helpers/logger.rb
+- lib/roast/helpers/minitest_coverage_runner.rb
+- lib/roast/helpers/path_resolver.rb
+- lib/roast/helpers/prompt_loader.rb
+- lib/roast/tools.rb
+- lib/roast/tools/cmd.rb
+- lib/roast/tools/grep.rb
+- lib/roast/tools/read_file.rb
+- lib/roast/tools/search_file.rb
+- lib/roast/tools/write_file.rb
+- lib/roast/version.rb
+- lib/roast/workflow.rb
+- lib/roast/workflow/base_step.rb
+- lib/roast/workflow/base_workflow.rb
+- lib/roast/workflow/configuration.rb
+- lib/roast/workflow/configuration_parser.rb
+- lib/roast/workflow/validator.rb
+- lib/roast/workflow/workflow_executor.rb
+- roast.gemspec
+- schema/workflow.json
+- shipit.rubygems.yml
+homepage: https://github.com/Shopify/roast
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/roast
+  source_code_uri: https://github.com/Shopify/roast
+  changelog_uri: https://github.com/Shopify/roast/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: A framework for executing structured AI workflows in Ruby
+test_files: []