simple_flow 0.1.0 → 0.2.0

data/mkdocs.yml

@@ -1,146 +0,0 @@
-site_name: SimpleFlow Documentation
-site_description: "A lightweight, modular Ruby framework for building composable data processing pipelines with concurrent execution"
-site_author: "Dewayne VanHoozer"
-site_url: "https://madbomber.github.io/simple_flow/"
-
-repo_name: "MadBomber/simple_flow"
-repo_url: "https://github.com/MadBomber/simple_flow"
-edit_uri: "edit/main/docs/"
-
-theme:
-  name: material
-  language: en
-  favicon: assets/logo.png
-
-  palette:
-    - media: "(prefers-color-scheme: light)"
-      scheme: default
-      primary: indigo
-      accent: deep-purple
-      toggle:
-        icon: material/brightness-7
-        name: Switch to dark mode
-
-    - media: "(prefers-color-scheme: dark)"
-      scheme: slate
-      primary: indigo
-      accent: deep-purple
-      toggle:
-        icon: material/brightness-4
-        name: Switch to light mode
-
-  font:
-    text: Roboto
-    code: Roboto Mono
-
-  features:
-    - navigation.instant
-    - navigation.tracking
-    - navigation.tabs
-    - navigation.tabs.sticky
-    - navigation.sections
-    - navigation.path
-    - navigation.indexes
-    - navigation.top
-    - toc.follow
-    - search.suggest
-    - search.highlight
-    - search.share
-    - header.autohide
-    - content.code.copy
-    - content.code.annotate
-    - content.tabs.link
-    - content.tooltips
-    - content.action.edit
-    - content.action.view
-
-plugins:
-  - search:
-      separator: '[\s\-,:!=\[\]()"\`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
-
-markdown_extensions:
-  - abbr
-  - admonition
-  - attr_list
-  - def_list
-  - footnotes
-  - md_in_html
-  - toc:
-      permalink: true
-      title: On this page
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.details
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
-  - pymdownx.highlight:
-      anchor_linenums: true
-      line_spans: __span
-      pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.keys
-  - pymdownx.magiclink:
-      repo_url_shorthand: true
-      user: MadBomber
-      repo: simple_flow
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
-
-extra:
-  version: 0.0.1
-  social:
-    - icon: fontawesome/brands/github
-      link: https://github.com/MadBomber/simple_flow
-      name: GitHub Repository
-  generator: false
-
-nav:
-  - Home: index.md
-  - 🚀 Getting Started:
-    - Installation: getting-started/installation.md
-    - Quick Start: getting-started/quick-start.md
-    - Examples: getting-started/examples.md
-  - 📖 Core Concepts:
-    - Overview: core-concepts/overview.md
-    - Result: core-concepts/result.md
-    - Pipeline: core-concepts/pipeline.md
-    - Steps: core-concepts/steps.md
-    - Middleware: core-concepts/middleware.md
-    - Flow Control: core-concepts/flow-control.md
-  - ⚡ Concurrent Execution:
-    - Introduction: concurrent/introduction.md
-    - Parallel Steps: concurrent/parallel-steps.md
-    - Performance: concurrent/performance.md
-    - Best Practices: concurrent/best-practices.md
-  - 📚 Guides:
-    - Error Handling: guides/error-handling.md
-    - Validation Patterns: guides/validation-patterns.md
-    - Choosing Concurrency Model: guides/choosing-concurrency-model.md
-    - Data Fetching: guides/data-fetching.md
-    - File Processing: guides/file-processing.md
-    - Complex Workflows: guides/complex-workflows.md
-  - 🔌 API Reference:
-    - Result API: api/result.md
-    - Pipeline API: api/pipeline.md
-    - ParallelStep API: api/parallel-step.md
-    - Middleware API: api/middleware.md
-  - ⚙️ Development:
-    - Contributing: development/contributing.md
-    - Testing: development/testing.md
-    - Benchmarking: development/benchmarking.md
-
-copyright: Copyright © 2025 Dewayne VanHoozer

data/pipeline_graph.dot

@@ -1,51 +0,0 @@
-digraph DependencyGraph {
-  rankdir=TB;
-  node [shape=box, style=rounded];
-
-  // Group 1
-  validate_order [fillcolor=lightblue, style="rounded,filled"];
-  // Group 2
-  calculate_shipping [fillcolor=lightgreen, style="rounded,filled"];
-  check_inventory [fillcolor=lightgreen, style="rounded,filled"];
-  // Group 3
-  calculate_totals [fillcolor=lightyellow, style="rounded,filled"];
-  // Group 4
-  process_payment [fillcolor=lightpink, style="rounded,filled"];
-  // Group 5
-  reserve_inventory [fillcolor=lightgray, style="rounded,filled"];
-  // Group 6
-  create_shipment [fillcolor=lightblue, style="rounded,filled"];
-  // Group 7
-  send_email [fillcolor=lightgreen, style="rounded,filled"];
-  send_sms [fillcolor=lightgreen, style="rounded,filled"];
-  // Group 8
-  finalize_order [fillcolor=lightyellow, style="rounded,filled"];
-
-  // Dependencies
-  validate_order;
-  validate_order -> check_inventory;
-  validate_order -> calculate_shipping;
-  calculate_shipping -> calculate_totals;
-  check_inventory -> calculate_totals;
-  calculate_totals -> process_payment;
-  process_payment -> reserve_inventory;
-  reserve_inventory -> create_shipment;
-  create_shipment -> send_email;
-  create_shipment -> send_sms;
-  send_email -> finalize_order;
-  send_sms -> finalize_order;
-
-  // Legend
-  subgraph cluster_legend {
-    label="Parallel Groups";
-    style=dashed;
-    legend_0 [label="Group 1 (1 step)", fillcolor=lightblue, style="rounded,filled"];
-    legend_1 [label="Group 2 (2 steps)", fillcolor=lightgreen, style="rounded,filled"];
-    legend_2 [label="Group 3 (1 step)", fillcolor=lightyellow, style="rounded,filled"];
-    legend_3 [label="Group 4 (1 step)", fillcolor=lightpink, style="rounded,filled"];
-    legend_4 [label="Group 5 (1 step)", fillcolor=lightgray, style="rounded,filled"];
-    legend_5 [label="Group 6 (1 step)", fillcolor=lightblue, style="rounded,filled"];
-    legend_6 [label="Group 7 (2 steps)", fillcolor=lightgreen, style="rounded,filled"];
-    legend_7 [label="Group 8 (1 step)", fillcolor=lightyellow, style="rounded,filled"];
-  }
-}

data/pipeline_graph.html

@@ -1,60 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>E-commerce Pipeline</title>
-  <script type="text/javascript" src="https://unpkg.com/vis-network/standalone/umd/vis-network.min.js"></script>
-  <style>
-    body { font-family: Arial, sans-serif; margin: 20px; }
-    #graph { width: 100%; height: 600px; border: 1px solid #ddd; }
-    .info { margin-top: 20px; padding: 15px; background: #f5f5f5; border-radius: 5px; }
-    .legend { display: flex; gap: 20px; margin-top: 10px; }
-    .legend-item { display: flex; align-items: center; gap: 5px; }
-    .legend-color { width: 20px; height: 20px; border-radius: 3px; }
-  </style>
-</head>
-<body>
-  <h1>E-commerce Pipeline</h1>
-  <div id="graph"></div>
-  <div class="info">
-    <h3>Execution Groups (Parallel)</h3>
-    <div class="legend">
-      <div class='legend-item'><div class='legend-color' style='background: #A8D5FF'></div><span>Group 1: validate_order</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #A8FFA8'></div><span>Group 2: calculate_shipping, check_inventory</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #FFFFA8'></div><span>Group 3: calculate_totals</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #FFA8FF'></div><span>Group 4: process_payment</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #D3D3D3'></div><span>Group 5: reserve_inventory</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #A8D5FF'></div><span>Group 6: create_shipment</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #A8FFA8'></div><span>Group 7: send_email, send_sms</span></div>
-              <div class='legend-item'><div class='legend-color' style='background: #FFFFA8'></div><span>Group 8: finalize_order</span></div>
-    </div>
-  </div>
-  <script>
-    var nodes = new vis.DataSet([{"id":"validate_order","label":"validate_order","color":"#A8D5FF","level":0},{"id":"check_inventory","label":"check_inventory","color":"#A8FFA8","level":1},{"id":"calculate_shipping","label":"calculate_shipping","color":"#A8FFA8","level":1},{"id":"calculate_totals","label":"calculate_totals","color":"#FFFFA8","level":2},{"id":"process_payment","label":"process_payment","color":"#FFA8FF","level":3},{"id":"reserve_inventory","label":"reserve_inventory","color":"#D3D3D3","level":4},{"id":"create_shipment","label":"create_shipment","color":"#A8D5FF","level":5},{"id":"send_email","label":"send_email","color":"#A8FFA8","level":6},{"id":"send_sms","label":"send_sms","color":"#A8FFA8","level":6},{"id":"finalize_order","label":"finalize_order","color":"#FFFFA8","level":7}]);
-    var edges = new vis.DataSet([{"from":"validate_order","to":"check_inventory"},{"from":"validate_order","to":"calculate_shipping"},{"from":"calculate_shipping","to":"calculate_totals"},{"from":"check_inventory","to":"calculate_totals"},{"from":"calculate_totals","to":"process_payment"},{"from":"process_payment","to":"reserve_inventory"},{"from":"reserve_inventory","to":"create_shipment"},{"from":"create_shipment","to":"send_email"},{"from":"create_shipment","to":"send_sms"},{"from":"send_email","to":"finalize_order"},{"from":"send_sms","to":"finalize_order"}]);
-    var container = document.getElementById('graph');
-    var data = { nodes: nodes, edges: edges };
-    var options = {
-      layout: {
-        hierarchical: {
-          direction: 'UD',
-          sortMethod: 'directed',
-          levelSeparation: 150
-        }
-      },
-      edges: {
-        arrows: 'to',
-        smooth: { type: 'cubicBezier' }
-      },
-      nodes: {
-        shape: 'box',
-        margin: 10,
-        widthConstraint: { minimum: 100, maximum: 200 }
-      },
-      physics: {
-        enabled: false
-      }
-    };
-    var network = new vis.Network(container, data, options);
-  </script>
-</body>
-</html>

data/pipeline_graph.mmd

@@ -1,19 +0,0 @@
-graph TD
-  validate_order[validate_order]
-  validate_order[validate_order] --> check_inventory[check_inventory]
-  validate_order[validate_order] --> calculate_shipping[calculate_shipping]
-  calculate_shipping[calculate_shipping] --> calculate_totals[calculate_totals]
-  check_inventory[check_inventory] --> calculate_totals[calculate_totals]
-  calculate_totals[calculate_totals] --> process_payment[process_payment]
-  process_payment[process_payment] --> reserve_inventory[reserve_inventory]
-  reserve_inventory[reserve_inventory] --> create_shipment[create_shipment]
-  create_shipment[create_shipment] --> send_email[send_email]
-  create_shipment[create_shipment] --> send_sms[send_sms]
-  send_email[send_email] --> finalize_order[finalize_order]
-  send_sms[send_sms] --> finalize_order[finalize_order]
-  classDef group1 fill:#9f9
-  class calculate_shipping group1
-  class check_inventory group1
-  classDef group6 fill:#9f9
-  class send_email group6
-  class send_sms group6