roast-ai 0.3.0 → 0.4.0

data/examples/available_tools_demo/workflow.yml

@@ -0,0 +1,32 @@
+model: anthropic:claude-opus-4
+
+tools:
+  - Roast::Tools::Grep
+  - Roast::Tools::ReadFile
+  - Roast::Tools::WriteFile
+  - Roast::Tools::Cmd:
+      allowed_commands:
+        - pwd
+        - ls
+        - echo
+
+steps:
+  - explore_directory
+  - analyze_files
+  - write_summary
+
+# Step-level tool configuration
+explore_directory:
+  available_tools:
+    - pwd
+    - ls
+
+analyze_files:
+  available_tools:
+    - grep
+    - read_file
+
+write_summary:
+  available_tools:
+    - write_file
+    - echo

data/examples/available_tools_demo/write_summary/prompt.md

@@ -0,0 +1,6 @@
+Based on your exploration and analysis, create a summary:
+
+1. Write a brief summary of what you found to a file called `summary.txt`
+2. Echo a completion message
+
+Note: You only have access to the `write_file` and `echo` tools for this step. You cannot read files or use other commands.

data/examples/case_when/detect_language/prompt.md

@@ -9,8 +9,8 @@ Based on the file extension and content, determine the primary programming langu
 
 Return ONLY the language name in lowercase, nothing else.
 
-File: {{ context.resource_uri }}
+File: <%= context.resource_uri %>
 Content:
 ```
-{{ context.resource }}
+<%= context.resource %>
 ```

data/examples/grading/README.md

@@ -0,0 +1,71 @@
+# Test Grading Workflow
+
+This workflow acts as a senior software engineer and testing expert to evaluate the quality of test files based on best practices and guidelines.
+
+## Prerequisites
+
+This example uses `shadowenv` for environment management, which is specific to Shopify's development environment. If you're not using shadowenv, you'll need to adapt the commands to your own setup.
+
+### If you're using shadowenv:
+```bash
+brew install shadowenv
+```
+
+### If you're NOT using shadowenv:
+You'll need to modify the `run_coverage.rb` file to remove the shadowenv commands. Look for lines like:
+```ruby
+command = "shadowenv exec -- bundle exec ruby ..."
+```
+
+And change them to match your environment:
+```ruby
+# For standard Ruby/Bundler setup:
+command = "bundle exec ruby ..."
+
+# Or if you're using rbenv/rvm:
+command = "ruby ..."
+```
+
+## Usage
+
+```bash
+# Run the grading workflow on a test file
+roast execute examples/grading/workflow.yml path/to/your_test.rb
+```
+
+## How it Works
+
+1. **read_dependencies**: Analyzes the test file and its dependencies
+2. **run_coverage**: Executes the test with coverage tracking
+3. **generate_grades**: Evaluates test quality across multiple dimensions
+4. **verify_test_helpers**: Checks for proper test helper usage
+5. **verify_mocks_and_stubs**: Ensures appropriate use of test doubles
+6. **analyze_coverage**: Reviews code coverage metrics
+7. **generate_recommendations**: Provides improvement suggestions
+8. **calculate_final_grade**: Computes an overall grade (A-F scale)
+9. **format_result**: Formats the final output
+
+## Customization
+
+Feel free to adapt this workflow to your testing environment:
+
+- **Different test frameworks**: Modify `run_coverage.rb` to work with RSpec, Jest, pytest, etc.
+- **Coverage tools**: Replace the coverage command with your preferred tool (SimpleCov, Istanbul, Coverage.py)
+- **Grading criteria**: Adjust the prompts in each step to match your team's standards
+- **Environment setup**: Remove or replace shadowenv with your environment management tool
+
+## Example Output
+
+```
+========== TEST GRADE REPORT ==========
+Test file: test/example_test.rb
+
+FINAL GRADE:
+  Score: 85/100
+  Letter Grade: B
+
+RECOMMENDATIONS:
+- Add edge case testing for error conditions
+- Improve test descriptions for clarity
+- Consider extracting common setup to helper methods
+```

data/examples/grading/run_coverage.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "open3"
-
 class RunCoverage < Roast::Workflow::BaseStep
   def call
     # Run the test with coverage analysis

data/examples/iteration/analyze_complexity/prompt.md

@@ -1,4 +1,4 @@
-I'll analyze the code complexity of the file {{current_file}}, which I've read in the previous step.
+I'll analyze the code complexity of the file <%= current_file %>, which I've read in the previous step.
 
 I'll examine the following aspects:
 1. Cyclomatic complexity (number of decision paths)
@@ -9,7 +9,7 @@ I'll examine the following aspects:
 6. Opportunities for refactoring
 
 ```ruby
-{{output.read_file}}
+<%= output.read_file %>
 ```
 
 Based on this analysis, I'll provide a structured assessment of the code quality issues found.

data/examples/iteration/generate_recommendations/prompt.md

@@ -1,8 +1,8 @@
-Based on the analysis of complexity for file {{current_file}}, I'll generate specific recommendations for improving code quality.
+Based on the analysis of complexity for file <%= current_file %>, I'll generate specific recommendations for improving code quality.
 
 I'll use the complexity analysis from the previous step:
 ```json
-{{output.analyze_complexity}}
+<%= output.analyze_complexity %>
 ```
 
 For each identified issue, I'll provide detailed, actionable recommendations including:

data/examples/iteration/implement_fix/prompt.md

@@ -2,13 +2,13 @@ I'll implement the fix for the issue selected in the previous step.
 
 Here is the issue to fix:
 ```json
-{{output.select_next_issue}}
+<%= output.select_next_issue %>
 ```
 
 First, I'll read the current file content to understand the context:
 
 ```ruby
-{{read_file(output.select_next_issue.file_path)}}
+<%= read_file(output.select_next_issue.file_path) %>
 ```
 
 Based on the issue description and the recommended changes, I'll implement a fix that:

data/examples/iteration/prioritize_issues/prompt.md

@@ -8,7 +8,7 @@ I'll analyze all the recommendations I've generated across multiple files and pr
 Let me review all the recommendations collected so far:
 
 ```json
-{{outputs_of.generate_recommendations}}
+<%= outputs_of.generate_recommendations %>
 ```
 
 I'll create a comprehensive prioritized list of all issues across files, combining similar issues where appropriate. The prioritized list will include:

data/examples/iteration/prompts/analyze_file.md

@@ -3,10 +3,10 @@
 You are a code analyzer focusing on analyzing Ruby files to count the number of methods defined.
 
 ## Input
-- File path: {{ file_path }}
+- File path: <%= file_path %>
 - File content:
 ```ruby
-{{ tools.read_file.content(file_path) }}
+<%= read_file(file_path) %>
 ```
 
 ## Task

data/examples/iteration/prompts/generate_summary.md

@@ -3,7 +3,7 @@
 You are a report generator responsible for summarizing the method analysis results.
 
 ## Input
-- Report data: {{ report_data }}
+- Report data: <%= report_data %>
 
 ## Task
 1. Parse the report data as JSON

data/examples/iteration/prompts/update_report.md

@@ -3,9 +3,9 @@
 You are a data updater responsible for adding analysis results to a report.
 
 ## Input
-- File path: {{ file_path }}
-- Method count: {{ method_count }}
-- Current report data: {{ current_report }}
+- File path: <%= file_path %>
+- Method count: <%= method_count %>
+- Current report data: <%= current_report %>
 
 ## Task
 1. Parse the current report data as JSON

data/examples/iteration/prompts/write_report.md

@@ -3,8 +3,8 @@
 You are responsible for creating a formatted report file based on the analysis results.
 
 ## Input
-- Report data: {{ report_data }}
-- Summary: {{ summary }}
+- Report data: <%= report_data %>
+- Summary: <%= summary %>
 
 ## Task
 1. Generate a Markdown report that includes:
@@ -16,7 +16,7 @@ You are responsible for creating a formatted report file based on the analysis r
 Return a JSON object with the following structure:
 ```json
 {
-  "report_content": "# Ruby Method Analysis Report\n\n{{ summary }}\n\n## Detailed Results\n\n| File | Method Count | Methods |\n|------|--------------|--------|\n| file1.rb | 5 | method1, method2, ... |\n| file2.rb | 3 | methodA, methodB, ... |\n...",
+  "report_content": "# Ruby Method Analysis Report\n\n<%= summary %>\n\n## Detailed Results\n\n| File | Method Count | Methods |\n|------|--------------|--------|\n| file1.rb | 5 | method1, method2, ... |\n| file2.rb | 3 | methodA, methodB, ... |\n...",
   "report_file_path": "method_analysis_report.md"
 }
 ```

data/examples/iteration/read_file/prompt.md

@@ -1,9 +1,9 @@
-I'll analyze the Ruby file at: {{current_file}}
+I'll analyze the Ruby file at: <%= current_file %>
 
 First, let me read the content of this file.
 
 ```ruby
-{{read_file current_file}}
+<%= read_file(current_file) %>
 ```
 
 I'll store this content for further analysis in the next steps.

data/examples/iteration/select_next_issue/prompt.md

@@ -2,12 +2,12 @@ I'll select the next highest priority issue to fix from our prioritized list.
 
 Here is the current prioritized list of issues:
 ```json
-{{output.prioritize_issues}}
+<%= output.prioritize_issues %>
 ```
 
 And here is the count of fixes we've already applied:
 ```
-{{output.update_fix_count || '0'}}
+<%= output.update_fix_count || '0' %>
 ```
 
 I'll select the highest priority issue that hasn't yet been addressed. I'll consider:

data/examples/iteration/update_fix_count/prompt.md

@@ -2,19 +2,19 @@ I'll update the count of fixes that have been successfully applied.
 
 Current fix count: 
 ```
-{{output.update_fix_count || 0}}
+<%= output.update_fix_count || 0 %>
 ```
 
 Verification result from the previous step:
 ```json
-{{output.verify_fix}}
+<%= output.verify_fix %>
 ```
 
 I'll increment the fix count if the verification was successful or partial, but not if it failed.
 
 ```javascript
-let currentCount = parseInt({{output.update_fix_count || 0}});
-let verificationStatus = "{{output.verify_fix.status}}";
+let currentCount = parseInt(<%= output.update_fix_count || 0 %>);
+let verificationStatus = "<%= output.verify_fix.status %>";
 
 if (verificationStatus === "success" || verificationStatus === "partial") {
   currentCount += 1;

data/examples/iteration/verify_fix/prompt.md

@@ -2,17 +2,17 @@ I'll verify that the fix implemented in the previous step correctly addresses th
 
 Here are the details of the issue that was fixed:
 ```json
-{{output.select_next_issue}}
+<%= output.select_next_issue %>
 ```
 
 And here is the implementation of the fix:
 ```json
-{{output.implement_fix}}
+<%= output.implement_fix %>
 ```
 
 Now I'll read the updated file to verify the changes:
 ```ruby
-{{read_file(output.select_next_issue.file_path)}}
+<%= read_file(output.select_next_issue.file_path) %>
 ```
 
 I'll evaluate the fix based on these criteria:

data/examples/mcp/README.md

@@ -44,7 +44,7 @@ tools:
         - --rm
         - ghcr.io/example/mcp-server
       env:
-        API_KEY: "{{env.API_KEY}}"
+        API_KEY: "{{ENV['API_KEY']}}"
       except:
         - dangerous_function
 ```
@@ -116,7 +116,7 @@ tools:
       command: npx
       args: ["-y", "@modelcontextprotocol/server-github"]
       env:
-        GITHUB_PERSONAL_ACCESS_TOKEN: "{{env.GITHUB_TOKEN}}"
+        GITHUB_PERSONAL_ACCESS_TOKEN: "{{ENV['GITHUB_TOKEN']}}"
       only:
         - search_repositories
         - get_issue
@@ -131,7 +131,7 @@ tools:
       command: npx
       args: ["-y", "@modelcontextprotocol/server-postgres"]
       env:
-        DATABASE_URL: "{{env.DATABASE_URL}}"
+        DATABASE_URL: "{{ENV['DATABASE_URL']}}"
       only:
         - query
         - list_tables

data/examples/mcp/analyze_changes/prompt.md

@@ -1,4 +1,4 @@
-For the file {{resource.target}}:
+For the file <%= resource.target %>:
 1. Read the file contents using read_file
 2. Use the Linter tool to analyze code quality
 3. Check for common issues:

data/examples/mcp/database_workflow.yml

@@ -12,7 +12,7 @@ tools:
         - "-y"
         - "@modelcontextprotocol/server-postgres"
       env:
-        DATABASE_URL: "{{env.DATABASE_URL}}"
+        DATABASE_URL: "{{ENV['DATABASE_URL']}}"
       only:
         - query
         - list_tables

data/examples/mcp/fetch_pr_context/prompt.md

@@ -1,4 +1,4 @@
-Using the GitHub tool, fetch details about PR #{{env.PR_NUMBER}}:
+Using the GitHub tool, fetch details about PR #<%= ENV['PR_NUMBER'] %>:
 1. Get the PR description and title
 2. List all changed files
 3. Identify the type of changes (feature, bugfix, refactor)

data/examples/mcp/github_workflow.yml

@@ -15,7 +15,7 @@ tools:
         - "-y"
         - "@modelcontextprotocol/server-github"
       env:
-        GITHUB_PERSONAL_ACCESS_TOKEN: "{{env.GITHUB_TOKEN}}"
+        GITHUB_PERSONAL_ACCESS_TOKEN: "{{ENV['GITHUB_TOKEN']}}"
       only:
         - search_repositories
         - get_repository

data/examples/mcp/post_review/prompt.md

@@ -1,3 +1,3 @@
-Using the GitHub tool, post the code review as a comment on PR #{{env.PR_NUMBER}}.
+Using the GitHub tool, post the code review as a comment on PR #<%= ENV['PR_NUMBER'] %>.
 Format the review in a friendly, constructive manner.
 Include specific line-by-line suggestions where appropriate.

data/examples/pre_post_processing/analyze_test_file/prompt.md

@@ -1,6 +1,6 @@
 # Analyze Test File
 
-Current test file: {{file}}
+Current test file: <%= file %>
 
 Please analyze this test file and identify:
 

data/examples/pre_post_processing/improve_test_coverage/prompt.md

@@ -1,6 +1,6 @@
 # Improve Test Coverage
 
-Based on the analysis of {{file}}, implement the following improvements:
+Based on the analysis of <%= file %>, implement the following improvements:
 
 1. **Add Missing Test Cases**: Write tests for uncovered code paths, edge cases, and error conditions
 2. **Improve Test Descriptions**: Make test names more descriptive and follow consistent naming conventions

data/examples/pre_post_processing/optimize_test_performance/prompt.md

@@ -1,6 +1,6 @@
 # Optimize Test Performance
 
-Optimize the performance of {{file}} by:
+Optimize the performance of <%= file %> by:
 
 1. **Reduce Setup Overhead**:
    - Move expensive operations out of individual test setup

data/examples/pre_post_processing/post_processing/aggregate_metrics/prompt.md

@@ -3,8 +3,8 @@
 Aggregate all the metrics collected during the workflow execution:
 
 Available data:
-- Pre-processing baseline metrics: {{pre_processing.gather_baseline_metrics}}
-- Results from all processed test files: {{output.targets}}
+- Pre-processing baseline metrics: <%= pre_processing.gather_baseline_metrics %>
+- Results from all processed test files: <%= output.targets %>
 
 Please calculate and provide:
 

data/examples/pre_post_processing/post_processing/generate_summary_report/prompt.md

@@ -9,7 +9,7 @@ Provide a high-level overview of the optimization results, key achievements, and
 
 ### Metrics Summary
 Include the aggregated metrics from the previous step:
-{{aggregate_metrics}}
+<%= aggregate_metrics %>
 
 ### Detailed Results by File
 For each processed test file, include:

data/examples/pre_post_processing/pre_processing/setup_test_environment/prompt.md

@@ -3,7 +3,7 @@
 Prepare the test environment for optimization. Please:
 
 1. Ensure all test dependencies are installed
-2. Create a backup branch for safety: `test-optimization-backup-{{timestamp}}`
+2. Create a backup branch for safety: `test-optimization-backup-<%= timestamp %>`
 3. Set up any necessary test databases or fixtures
 4. Configure test parallelization settings if available
 5. Clear any test caches that might affect benchmarking

data/examples/pre_post_processing/validate_changes/prompt.md

@@ -1,6 +1,6 @@
 # Validate Changes
 
-Validate the changes made to {{file}}:
+Validate the changes made to <%= file %>:
 
 1. **Run the updated tests** and ensure they all pass
 2. **Check coverage metrics** to verify improvements
@@ -11,7 +11,7 @@ Validate the changes made to {{file}}:
 Store the validation results in the workflow state:
 ```json
 {
-  "file": "{{file}}",
+  "file": "<%= file %>",
   "tests_passed": true,
   "coverage_before": 0.0,
   "coverage_after": 0.0,

data/examples/user_input/README.md

@@ -0,0 +1,90 @@
+# User Input Example
+
+This example demonstrates how to use the `input` step type in Roast workflows to collect information from users during workflow execution.
+
+## Overview
+
+The `input` step type allows workflows to:
+- Collect text input from users
+- Ask yes/no questions (boolean)
+- Present multiple choice options
+- Securely collect passwords (hidden input)
+- Store collected values in workflow state for later use
+
+## Running the Example
+
+```bash
+# Run the interactive deployment workflow
+roast execute examples/user_input/workflow.yml
+
+# Run a simple survey workflow
+roast execute examples/user_input/survey_workflow.yml
+```
+
+## Input Step Configuration
+
+### Basic Text Input
+```yaml
+- input:
+    prompt: "Enter your name:"
+    name: user_name
+```
+
+### Boolean (Yes/No) Input
+```yaml
+- input:
+    prompt: "Do you want to continue?"
+    type: boolean
+    default: true
+    name: should_continue
+```
+
+### Choice Selection
+```yaml
+- input:
+    prompt: "Select environment:"
+    type: choice
+    options:
+      - development
+      - staging
+      - production
+    name: environment
+```
+
+### Password Input
+```yaml
+- input:
+    prompt: "Enter password:"
+    type: password
+    required: true
+    name: user_password
+```
+
+## Configuration Options
+
+- `prompt` (required): The question or message to display to the user
+- `name` (optional): Variable name to store the input value in workflow state
+- `type` (optional): Type of input - `text` (default), `boolean`, `choice`, or `password`
+- `required` (optional): Whether the input is required (default: false)
+- `default` (optional): Default value if user presses enter without input
+- `timeout` (optional): Timeout in seconds for user input
+- `options` (required for choice type): Array of options for choice selection
+
+## Accessing Input Values
+
+Input values stored with a `name` can be accessed in subsequent steps using interpolation:
+
+```yaml
+- input:
+    prompt: "Enter project name:"
+    name: project_name
+
+- prompt: "Creating project: #{state.project_name}"
+```
+
+## Non-TTY Environments
+
+When running in non-TTY environments (e.g., CI/CD pipelines), input steps will:
+- Use default values if provided
+- Fail if required inputs have no default
+- Skip optional inputs without defaults

data/examples/user_input/funny_name/create_backstory/prompt.md

@@ -0,0 +1,10 @@
+Create a hilarious and absurd backstory for someone named <%= workflow.output.user_name %> as a <%= workflow.output.genre %>.
+
+Make it funny, creative, and include:
+- A ridiculous origin story
+- An absurd special ability or talent related to their name
+- A nemesis with an equally silly name
+- Their greatest achievement (make it hilariously mundane yet epic)
+- A catchphrase that makes no sense
+
+Keep it fun and family-friendly! Format it as an entertaining narrative.

data/examples/user_input/funny_name/workflow.yml

@@ -0,0 +1,26 @@
+name: funny_name_backstory
+description: Create a humorous backstory based on your name
+model: anthropic:claude-3-5-sonnet
+
+steps:
+  # Collect user's name
+  - input:
+      prompt: "What's your name?"
+      name: user_name
+      required: true
+  
+  # Ask for preferences
+  - input:
+      prompt: "Pick a genre for your backstory:"
+      type: choice
+      options:
+        - "Epic Fantasy Adventure"
+        - "Cyberpunk Hacker"
+        - "Time-Traveling Detective"
+        - "Intergalactic Pizza Delivery"
+        - "Victorian-Era Vampire Hunter"
+        - "Professional Cat Whisperer"
+      name: genre
+  
+  # Generate the backstory
+  - create_backstory

data/examples/user_input/generate_summary/prompt.md

@@ -0,0 +1,11 @@
+Please generate a nicely formatted survey summary based on the following information:
+
+Survey Participant: <%= workflow.output.developer_name %>
+Usage Duration: <%= workflow.output.usage_duration %>
+Experience Rating: <%= workflow.output.experience_rating %>
+Primary Feature Used: <%= workflow.output.primary_feature %>
+Additional Feedback Provided: <%= workflow.output.user_feedback %>
+Contact Permission: <%= workflow.output.allow_contact %>
+Email (if provided): <%= workflow.output.user_email %>
+
+Format this as a professional survey summary report with proper headings and thank the participant for their time.

data/examples/user_input/simple_input_demo/workflow.yml

@@ -0,0 +1,35 @@
+name: simple_input_demo
+description: Simple demonstration of input step functionality
+model: gpt-4o
+
+steps:
+  # Text input
+  - input:
+      prompt: "What's your name?"
+      name: user_name
+      required: true
+  
+  - input:
+      prompt: "Are you enjoying Roast?"
+      type: boolean
+      default: true
+      name: enjoying_roast
+  
+  - input:
+      prompt: "What's your favorite programming language?"
+      type: choice
+      options:
+        - Ruby
+        - Python
+        - JavaScript
+        - Go
+        - Other
+      name: favorite_language
+  
+  - input:
+      prompt: "Create a secret password (won't be displayed):"
+      type: password
+      required: true
+      name: secret_password
+  
+  - "Summarize the following inputs: {{workflow.output}}"