fractor 0.1.4 → 0.1.7

data/docs/assets/images/favicon.svg

@@ -0,0 +1,45 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48" width="48" height="48">
+  <!-- Simplified icon for favicon -->
+  <rect width="48" height="48" fill="white"/>
+
+  <!-- Define gradients -->
+  <defs>
+    <linearGradient id="g1" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#CC342D;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="g2" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#E67E22;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#F39C12;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="g3" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#C0392B;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+
+  <!-- Simplified parallel paths -->
+  <path d="M 8 12 L 16 12 L 18 14 L 28 14 L 30 12 L 40 12"
+        stroke="url(#g1)" stroke-width="2.5" fill="none" stroke-linecap="round"/>
+  <circle cx="8" cy="12" r="2" fill="#CC342D"/>
+  <circle cx="40" cy="12" r="2" fill="#E74C3C"/>
+
+  <path d="M 8 24 L 15 24 L 17 22 L 29 22 L 31 24 L 40 24"
+        stroke="url(#g2)" stroke-width="2.5" fill="none" stroke-linecap="round"/>
+  <circle cx="8" cy="24" r="2" fill="#E67E22"/>
+  <circle cx="40" cy="24" r="2" fill="#F39C12"/>
+
+  <path d="M 8 36 L 16 36 L 18 34 L 28 34 L 30 36 L 40 36"
+        stroke="url(#g3)" stroke-width="2.5" fill="none" stroke-linecap="round"/>
+  <circle cx="8" cy="36" r="2" fill="#C0392B"/>
+  <circle cx="40" cy="36" r="2" fill="#E74C3C"/>
+
+  <!-- Connection points -->
+  <line x1="24" y1="14" x2="24" y2="22" stroke="#CC342D" stroke-width="1.5" opacity="0.5"/>
+  <line x1="24" y1="24" x2="24" y2="34" stroke="#E67E22" stroke-width="1.5" opacity="0.5"/>
+
+  <!-- Arrows -->
+  <polygon points="38,11 40,12 38,13" fill="#E74C3C"/>
+  <polygon points="38,23 40,24 38,25" fill="#F39C12"/>
+  <polygon points="38,35 40,36 38,37" fill="#E74C3C"/>
+</svg>

data/docs/assets/images/fractor-icon.svg

@@ -0,0 +1,49 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 80 80" width="80" height="80">
+  <!-- Define gradients -->
+  <defs>
+    <linearGradient id="gradient1" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#CC342D;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="gradient2" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#E67E22;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#F39C12;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="gradient3" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#C0392B;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+
+  <!-- Icon - Parallel flow paths representing Ractors -->
+  <g id="icon">
+    <!-- Top path -->
+    <path d="M 10 15 L 30 15 L 35 20 L 50 20 L 55 15 L 70 15"
+          stroke="url(#gradient1)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="15" r="3" fill="#CC342D"/>
+    <circle cx="70" cy="15" r="3" fill="#E74C3C"/>
+
+    <!-- Middle path -->
+    <path d="M 10 40 L 25 40 L 30 35 L 45 35 L 50 40 L 70 40"
+          stroke="url(#gradient2)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="40" r="3" fill="#E67E22"/>
+    <circle cx="70" cy="40" r="3" fill="#F39C12"/>
+
+    <!-- Bottom path -->
+    <path d="M 10 65 L 30 65 L 35 60 L 50 60 L 55 65 L 70 65"
+          stroke="url(#gradient3)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="65" r="3" fill="#C0392B"/>
+    <circle cx="70" cy="65" r="3" fill="#E74C3C"/>
+
+    <!-- Connection points (representing Ractor communication) -->
+    <line x1="40" y1="20" x2="40" y2="35" stroke="#CC342D" stroke-width="1.5" opacity="0.6"/>
+    <line x1="40" y1="40" x2="40" y2="60" stroke="#E67E22" stroke-width="1.5" opacity="0.6"/>
+    <circle cx="40" cy="27.5" r="2" fill="#CC342D" opacity="0.7"/>
+    <circle cx="40" cy="50" r="2" fill="#E67E22" opacity="0.7"/>
+
+    <!-- Arrow indicators -->
+    <polygon points="67,13 70,15 67,17" fill="#E74C3C"/>
+    <polygon points="67,38 70,40 67,42" fill="#F39C12"/>
+    <polygon points="67,63 70,65 67,67" fill="#E74C3C"/>
+  </g>
+</svg>

data/docs/assets/images/fractor-logo.svg

@@ -0,0 +1,61 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 300 80" width="300" height="80">
+  <!-- Background (optional, can be removed for transparency) -->
+
+  <!-- Define gradients -->
+  <defs>
+    <linearGradient id="gradient1" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#CC342D;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="gradient2" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#E67E22;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#F39C12;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="gradient3" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#C0392B;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#E74C3C;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+
+  <!-- Icon part (left side) - Parallel flow paths representing Ractors -->
+  <g id="icon">
+    <!-- Top path -->
+    <path d="M 10 15 L 30 15 L 35 20 L 50 20 L 55 15 L 70 15"
+          stroke="url(#gradient1)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="15" r="3" fill="#CC342D"/>
+    <circle cx="70" cy="15" r="3" fill="#E74C3C"/>
+
+    <!-- Middle path -->
+    <path d="M 10 40 L 25 40 L 30 35 L 45 35 L 50 40 L 70 40"
+          stroke="url(#gradient2)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="40" r="3" fill="#E67E22"/>
+    <circle cx="70" cy="40" r="3" fill="#F39C12"/>
+
+    <!-- Bottom path -->
+    <path d="M 10 65 L 30 65 L 35 60 L 50 60 L 55 65 L 70 65"
+          stroke="url(#gradient3)" stroke-width="3" fill="none" stroke-linecap="round"/>
+    <circle cx="10" cy="65" r="3" fill="#C0392B"/>
+    <circle cx="70" cy="65" r="3" fill="#E74C3C"/>
+
+    <!-- Connection points (representing Ractor communication) -->
+    <line x1="40" y1="20" x2="40" y2="35" stroke="#CC342D" stroke-width="1.5" opacity="0.6"/>
+    <line x1="40" y1="40" x2="40" y2="60" stroke="#E67E22" stroke-width="1.5" opacity="0.6"/>
+    <circle cx="40" cy="27.5" r="2" fill="#CC342D" opacity="0.7"/>
+    <circle cx="40" cy="50" r="2" fill="#E67E22" opacity="0.7"/>
+
+    <!-- Arrow indicators -->
+    <polygon points="67,13 70,15 67,17" fill="#E74C3C"/>
+    <polygon points="67,38 70,40 67,42" fill="#F39C12"/>
+    <polygon points="67,63 70,65 67,67" fill="#E74C3C"/>
+  </g>
+
+  <!-- Text part (right side) -->
+  <g id="text">
+    <text x="85" y="48" font-family="Arial, Helvetica, sans-serif" font-size="32" font-weight="bold" fill="#2C3E50">
+      Fractor
+    </text>
+    <text x="85" y="63" font-family="Arial, Helvetica, sans-serif" font-size="9" fill="#7F8C8D" letter-spacing="1">
+      PARALLEL WORKFLOW ENGINE
+    </text>
+  </g>
+</svg>

data/docs/index.adoc

@@ -0,0 +1,131 @@
+---
+layout: home
+title: Home
+nav_order: 1
+description: "Fractor - Parallel processing framework for Ruby using Ractors"
+permalink: /
+---
+
+++++
+<div style="text-align: center; margin: 2em 0;">
+  <img src="/fractor/assets/images/fractor-logo.svg" alt="Fractor Logo" style="max-width: 400px; width: 100%;">
+</div>
+++++
+
+== Fractor Documentation
+
+Fractor is a powerful parallel processing framework for Ruby that leverages Ractors to provide true concurrent execution without the Global Interpreter Lock (GIL) limitations.
+
+---
+
+== What's New
+
+=== Recent Updates
+
+* ✨ **Enhanced Workflow System**: Added support for circuit breakers, retry strategies, and dead letter queues
+* 📊 **Performance Monitoring**: New performance monitoring capabilities with Prometheus and JSON export support
+* 🔄 **Improved Error Handling**: Rich error categorization with automatic retry logic for transient failures
+* 📚 **Comprehensive Documentation**: Complete tutorials, guides, and reference documentation with 18+ real-world examples
+* 🛠️ **Production Ready**: Battle-tested patterns for continuous mode, signal handling, and graceful shutdown
+* 🎯 **Workflow Visualizer**: Built-in tools for visualizing complex workflow graphs and execution traces
+
+---
+
+== Quick Start
+
+Get started with Fractor in minutes:
+
+[source,ruby]
+----
+require 'fractor'
+
+class MyWork < Fractor::Work
+  def initialize(value)
+    super({ value: value })
+  end
+end
+
+class MyWorker < Fractor::Worker
+  def process(work)
+    result = work.input[:value] * 2
+    Fractor::WorkResult.new(result: result, work: work)
+  end
+end
+
+supervisor = Fractor::Supervisor.new(
+  worker_pools: [{ worker_class: MyWorker }]
+)
+
+supervisor.add_work_items([MyWork.new(1), MyWork.new(2), MyWork.new(3)])
+supervisor.run
+
+puts supervisor.results.results.map(&:result)
+# => [2, 4, 6]
+----
+
+---
+
+== Learning Path
+
+=== 🎯 Beginner - Get Started
+
+New to Fractor? Start here to learn the fundamentals.
+
+* link:tutorials/installation/[Installation] - Set up Fractor in your environment
+* link:tutorials/first-application/[Your First Application] - Build your first parallel processor
+* link:tutorials/getting-started/[Getting Started Guide] - Understand modes and basic patterns
+
+=== 📚 Intermediate - Core Concepts
+
+Ready to build real applications? Dive into core features.
+
+* link:core-concepts/[Core Concepts] - Components, data flow, and concurrency model
+* link:architecture/[Architecture Guide] - System design and implementation details
+* link:design-principles/[Design Principles] - Philosophy and design decisions
+* link:guides/pipeline-mode/[Pipeline Mode] - Batch processing patterns
+* link:guides/continuous-mode/[Continuous Mode] - Long-running server applications
+* link:features/workflows/[Workflows] - Complex processing graphs
+* link:features/error-handling/[Error Handling] - Robust error management
+* link:features/signal-handling/[Signal Handling] - Graceful shutdown patterns
+
+=== 🚀 Advanced - Deep Dive
+
+Master advanced patterns and optimization techniques.
+
+* link:reference/api/[API Reference] - Complete API documentation
+* link:reference/patterns/[Design Patterns] - Real-world examples and patterns
+* link:reference/performance/[Performance Tuning] - Optimization strategies
+* link:reference/best-practices/[Best Practices] - Production deployment guide
+
+---
+
+== Key Features
+
+* *True Parallelism*: Leverages Ruby 3.0+ Ractors for concurrent execution without GIL
+* *Two Modes*: Pipeline mode for batch jobs, Continuous mode for servers
+* *Worker Pools*: Multiple specialized worker types with automatic scaling
+* *Rich Error Handling*: Categorized errors with retry logic and context
+* *Workflow Engine*: Build complex processing graphs with retry, circuit breakers, and more
+* *Signal Handling*: Graceful shutdown with SIGINT, SIGTERM support
+* *Production Ready*: Performance monitoring, error reporting, and dead letter queues
+
+---
+
+== System Requirements
+
+* Ruby 3.0 or later (Ractor support required)
+* Multi-core CPU (for true parallel execution)
+
+---
+
+== Community
+
+* https://github.com/metanorma/fractor[GitHub Repository]
+* https://github.com/metanorma/fractor/issues[Issue Tracker]
+* https://github.com/metanorma/fractor/discussions[Discussions]
+
+---
+
+== License
+
+Fractor is distributed under the link:../LICENSE[MIT License].

data/docs/lychee.toml

@@ -0,0 +1,39 @@
+# Lychee link checker configuration
+
+# Cache results to avoid re-checking
+cache = true
+
+# Maximum number of concurrent requests
+max_concurrency = 10
+
+# Accept 200-299 status codes
+accept = [200, 201, 202, 203, 204, 205, 206, 207, 208, 226]
+
+# Timeout for requests (seconds)
+timeout = 30
+
+# Retry failed links
+max_retries = 3
+
+# User agent string
+user_agent = "Mozilla/5.0 (compatible; Lychee/0.x; +https://github.com/lycheeverse/lychee)"
+
+# Exclude path patterns (file/directory paths to skip)
+exclude_path = [
+  "vendor",
+  "node_modules",
+  ".jekyll-cache",
+  "_site"
+]
+
+# Check external links
+include_external = true
+
+# Follow redirects
+max_redirects = 10
+
+# Check fragments (anchors)
+check_fragments = true
+
+# Base URL for checking local links
+base_url = "https://metanorma.github.io/fractor"