kbs 0.0.1 → 0.1.0

data/examples/working_demo_dsl.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/kbs/dsl'
+include KBS::DSL::ConditionHelpers
+
+# Define the knowledge base with rules
+kb = KBS.knowledge_base do
+  # Rule 1: Simple stock momentum
+  rule "momentum_buy" do
+    on :stock, symbol: "AAPL"
+
+    perform do |facts, bindings|
+      stock = facts.find { |f| f.type == :stock }
+      puts "🚀 MOMENTUM SIGNAL: #{stock[:symbol]}"
+      puts "   Price: $#{stock[:price]}"
+      puts "   Volume: #{stock[:volume].to_s.reverse.scan(/\d{1,3}/).join(',').reverse}"
+      puts "   Recommendation: BUY"
+    end
+  end
+
+  # Rule 2: High volume alert
+  rule "high_volume" do
+    on :stock do
+      volume greater_than(1000000)
+    end
+
+    perform do |facts, bindings|
+      stock = facts.find { |f| f.type == :stock }
+      puts "📊 HIGH VOLUME ALERT: #{stock[:symbol]}"
+      puts "   Volume: #{stock[:volume].to_s.reverse.scan(/\d{1,3}/).join(',').reverse}"
+      puts "   Above 1M shares traded"
+    end
+  end
+
+  # Rule 3: Price movement
+  rule "price_movement" do
+    on :stock do
+      price_change satisfies { |p| p && p.abs > 2 }
+    end
+
+    perform do |facts, bindings|
+      stock = facts.find { |f| f.type == :stock }
+      direction = stock[:price_change] > 0 ? "UP" : "DOWN"
+      puts "📈 SIGNIFICANT MOVE: #{stock[:symbol]} #{direction}"
+      puts "   Change: #{stock[:price_change] > 0 ? '+' : ''}#{stock[:price_change]}%"
+    end
+  end
+
+  # Rule 4: RSI signals
+  rule "rsi_signal" do
+    on :stock do
+      rsi satisfies { |r| r && (r < 30 || r > 70) }
+    end
+
+    perform do |facts, bindings|
+      stock = facts.find { |f| f.type == :stock }
+      condition = stock[:rsi] < 30 ? "OVERSOLD" : "OVERBOUGHT"
+      action = stock[:rsi] < 30 ? "BUY" : "SELL"
+      puts "⚡ RSI SIGNAL: #{stock[:symbol]} #{condition}"
+      puts "   RSI: #{stock[:rsi].round(1)}"
+      puts "   Recommendation: #{action}"
+    end
+  end
+
+  # Rule 5: Multi-condition golden cross
+  rule "golden_cross_complete" do
+    on :stock, symbol: "AAPL"
+    on :ma_signal, type: "golden_cross"
+
+    perform do |facts, bindings|
+      stock = facts.find { |f| f.type == :stock }
+      signal = facts.find { |f| f.type == :ma_signal }
+      puts "🌟 GOLDEN CROSS CONFIRMED: #{stock[:symbol]}"
+      puts "   50-day MA crossed above 200-day MA"
+      puts "   Price: $#{stock[:price]}"
+      puts "   Recommendation: STRONG BUY"
+    end
+  end
+end
+
+def run_scenarios(kb)
+  puts "🏦 STOCK TRADING EXPERT SYSTEM"
+  puts "=" * 50
+
+  # Scenario 1: Apple momentum
+  puts "\n📊 SCENARIO 1: Apple with High Volume"
+  puts "-" * 30
+  kb.reset
+  kb.fact :stock, {
+    symbol: "AAPL",
+    price: 185.50,
+    volume: 1_500_000,
+    price_change: 3.2,
+    rsi: 68
+  }
+  kb.run
+
+  # Scenario 2: Google big move
+  puts "\n📊 SCENARIO 2: Google Big Price Move"
+  puts "-" * 30
+  kb.reset
+  kb.fact :stock, {
+    symbol: "GOOGL",
+    price: 142.80,
+    volume: 800_000,
+    price_change: -4.1,
+    rsi: 75
+  }
+  kb.run
+
+  # Scenario 3: Tesla oversold
+  puts "\n📊 SCENARIO 3: Tesla Oversold"
+  puts "-" * 30
+  kb.reset
+  kb.fact :stock, {
+    symbol: "TSLA",
+    price: 195.40,
+    volume: 2_200_000,
+    price_change: -1.8,
+    rsi: 25
+  }
+  kb.run
+
+  # Scenario 4: Apple Golden Cross
+  puts "\n📊 SCENARIO 4: Apple Golden Cross"
+  puts "-" * 30
+  kb.reset
+  kb.fact :stock, {
+    symbol: "AAPL",
+    price: 190.25,
+    volume: 1_100_000,
+    price_change: 2.1,
+    rsi: 55
+  }
+  kb.fact :ma_signal, {
+    symbol: "AAPL",
+    type: "golden_cross"
+  }
+  kb.run
+
+  # Scenario 5: Multiple signals
+  puts "\n📊 SCENARIO 5: NVIDIA Multiple Signals"
+  puts "-" * 30
+  kb.reset
+  kb.fact :stock, {
+    symbol: "NVDA",
+    price: 425.80,
+    volume: 3_500_000,
+    price_change: 8.7,
+    rsi: 78
+  }
+  kb.run
+
+  puts "\n" + "=" * 50
+  puts "DEMONSTRATION COMPLETE"
+end
+
+if __FILE__ == $0
+  run_scenarios(kb)
+end

data/lib/kbs/blackboard/engine.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../rete_engine'
+require_relative '../engine'
 require_relative 'memory'
 
 module KBS
   module Blackboard
-    # RETE engine integrated with Blackboard memory
-    class Engine < ReteEngine
+    # KBS engine integrated with Blackboard memory
+    class Engine < KBS::Engine
       attr_reader :blackboard
 
       def initialize(db_path: ':memory:', store: nil)

data/lib/kbs/blackboard/fact.rb

@@ -39,7 +39,7 @@ module KBS
 
           if value.is_a?(Proc)
             return false unless @attributes[key] && value.call(@attributes[key])
-          elsif value.is_a?(Symbol) && value.to_s.start_with?('?')
+          elsif value.is_a?(Symbol) && value.to_s.end_with?('?')
             next
           else
             return false unless @attributes[key] == value

data/lib/kbs/condition.rb

@@ -16,7 +16,7 @@ module KBS
     def extract_variables(pattern)
       vars = {}
       pattern.each do |key, value|
-        if value.is_a?(Symbol) && value.to_s.start_with?('?')
+        if value.is_a?(Symbol) && value.to_s.end_with?('?')
           vars[value] = key
         end
       end

data/lib/kbs/dsl/knowledge_base.rb

@@ -6,7 +6,7 @@ module KBS
       attr_reader :engine, :rules
 
       def initialize
-        @engine = ReteEngine.new
+        @engine = Engine.new
         @rules = {}
         @rule_builders = {}
       end

data/lib/kbs/dsl/variable.rb

@@ -7,7 +7,7 @@ module KBS
 
       def initialize(name)
         name_str = name.to_s
-        @name = name_str.start_with?('?') ? name_str.to_sym : "?#{name_str}".to_sym
+        @name = name_str.end_with?('?') ? name_str.to_sym : "#{name_str}?".to_sym
       end
 
       def to_sym

data/lib/kbs/{rete_engine.rb → engine.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module KBS
-  class ReteEngine
+  class Engine
     attr_reader :working_memory, :rules, :alpha_memories, :production_nodes
 
     def initialize

data/lib/kbs/fact.rb

@@ -26,7 +26,7 @@ module KBS
 
         if value.is_a?(Proc)
           return false unless @attributes[key] && value.call(@attributes[key])
-        elsif value.is_a?(Symbol) && value.to_s.start_with?('?')
+        elsif value.is_a?(Symbol) && value.to_s.end_with?('?')
           next
         else
           return false unless @attributes[key] == value

data/lib/kbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KBS
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/kbs.rb

@@ -2,7 +2,7 @@
 
 require_relative "kbs/version"
 
-# Core RETE II classes
+# Core RETE classes
 require_relative "kbs/fact"
 require_relative "kbs/working_memory"
 require_relative "kbs/token"
@@ -13,7 +13,7 @@ require_relative "kbs/negation_node"
 require_relative "kbs/production_node"
 require_relative "kbs/condition"
 require_relative "kbs/rule"
-require_relative "kbs/rete_engine"
+require_relative "kbs/engine"
 
 module KBS
   class Error < StandardError; end

data/mkdocs.yml

@@ -0,0 +1,181 @@
+# MkDocs Configuration for KBS Documentation
+site_name: KBS - Knowledge-Based Systems for Ruby
+site_description: A Ruby implementation of the RETE algorithm for production rule systems with persistent blackboard memory
+site_author: Dewayne VanHoozer
+site_url: https://madbomber.github.io/kbs
+copyright: Copyright © 2024 Dewayne VanHoozer
+
+# Repository information
+repo_name: madbomber/kbs
+repo_url: https://github.com/madbomber/kbs
+edit_uri: edit/main/docs/
+
+# Configuration
+theme:
+  name: material
+
+  # Color scheme - Default to light mode
+  palette:
+    # Palette toggle for light mode (default)
+    - scheme: default
+      primary: deep purple
+      accent: purple
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: deep purple
+      accent: purple
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  # Typography
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Theme features
+  features:
+    # Navigation
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.path
+    - navigation.indexes
+    - navigation.top
+
+    # Table of contents
+    - toc.follow
+
+    # Search
+    - search.suggest
+    - search.highlight
+    - search.share
+
+    # Header
+    - header.autohide
+
+    # Content
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+    - content.tooltips
+    - content.action.edit
+    - content.action.view
+
+# Plugins
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+
+# Extensions
+markdown_extensions:
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+      title: On this page
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+  - 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: kbs
+  - 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 CSS and JavaScript
+extra_css:
+  - assets/css/custom.css
+
+extra_javascript:
+  - assets/js/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+# Social media and extra configuration
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/madbomber/kbs
+      name: KBS on GitHub
+    - icon: fontawesome/solid/gem
+      link: https://rubygems.org/gems/kbs
+      name: KBS on RubyGems
+
+  version:
+    provider: mike
+
+# Navigation
+nav:
+  - Home: index.md
+  - Installation: installation.md
+  - Quick Start: quick-start.md
+  - Architecture:
+    - architecture/index.md
+    - RETE Algorithm: architecture/rete-algorithm.md
+    - Blackboard System: architecture/blackboard.md
+    - Network Structure: architecture/network-structure.md
+  - Guides:
+    - guides/index.md
+    - Getting Started: guides/getting-started.md
+    - Writing Rules: guides/writing-rules.md
+    - DSL Reference: guides/dsl.md
+    - Working with Facts: guides/facts.md
+    - Pattern Matching: guides/pattern-matching.md
+    - Variable Binding: guides/variable-binding.md
+    - Negation: guides/negation.md
+    - Blackboard Memory: guides/blackboard-memory.md
+    - Persistence Options: guides/persistence.md
+  - Examples:
+    - examples/index.md
+    - Stock Trading: examples/stock-trading.md
+    - Expert Systems: examples/expert-systems.md
+    - Multi-Agent Systems: examples/multi-agent.md
+  - Advanced:
+    - advanced/index.md
+    - Performance Tuning: advanced/performance.md
+    - Custom Persistence: advanced/custom-persistence.md
+    - Debugging: advanced/debugging.md
+    - Testing Rules: advanced/testing.md
+  - API Reference:
+    - api/index.md
+    - ReteEngine: api/engine.md
+    - Facts: api/facts.md
+    - Rules: api/rules.md
+    - Blackboard: api/blackboard.md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kbs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -68,7 +68,7 @@ dependencies:
 description: |
   A comprehensive Ruby implementation of a Knowledge-Based System featuring:
 
-  • RETE II Algorithm: Optimized forward-chaining inference engine with unlinking optimization for high-performance pattern matching
+  • RETE Algorithm: Optimized forward-chaining inference engine with unlinking optimization for high-performance pattern matching
   • Declarative DSL: Readable, expressive syntax for rule definition with built-in condition helpers
   • Blackboard Architecture: Multi-agent coordination with message passing and knowledge source registration
   • Flexible Persistence: SQLite (durable), Redis (fast), and hybrid storage backends with audit trails
@@ -84,27 +84,86 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".envrc"
+- ".github/workflows/deploy-github-pages.yml"
 - CHANGELOG.md
 - COMMITS.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/DOCUMENTATION_STATUS.md
+- docs/advanced/custom-persistence.md
+- docs/advanced/debugging.md
+- docs/advanced/index.md
+- docs/advanced/performance.md
+- docs/advanced/testing.md
+- docs/api/blackboard.md
+- docs/api/engine.md
+- docs/api/facts.md
+- docs/api/index.md
+- docs/api/rules.md
+- docs/architecture/blackboard.md
+- docs/architecture/index.md
+- docs/architecture/network-structure.md
+- docs/architecture/rete-algorithm.md
+- docs/assets/css/custom.css
+- docs/assets/images/blackboard-architecture.svg
+- docs/assets/images/compiled-network.svg
+- docs/assets/images/fact-assertion-flow.svg
+- docs/assets/images/kbs.jpg
+- docs/assets/images/pattern-matching-trace.svg
+- docs/assets/images/rete-network-layers.svg
+- docs/assets/images/system-layers.svg
+- docs/assets/images/trading-signal-network.svg
+- docs/assets/js/mathjax.js
+- docs/examples/expert-systems.md
+- docs/examples/index.md
+- docs/examples/multi-agent.md
+- docs/examples/stock-trading.md
+- docs/guides/blackboard-memory.md
+- docs/guides/dsl.md
+- docs/guides/facts.md
+- docs/guides/getting-started.md
+- docs/guides/index.md
+- docs/guides/negation.md
+- docs/guides/pattern-matching.md
+- docs/guides/persistence.md
+- docs/guides/variable-binding.md
+- docs/guides/writing-rules.md
+- docs/index.md
+- docs/installation.md
+- docs/quick-start.md
 - examples/README.md
 - examples/advanced_example.rb
+- examples/advanced_example_dsl.rb
 - examples/ai_enhanced_kbs.rb
+- examples/ai_enhanced_kbs_dsl.rb
 - examples/blackboard_demo.rb
+- examples/blackboard_demo_dsl.rb
 - examples/car_diagnostic.rb
+- examples/car_diagnostic_dsl.rb
 - examples/concurrent_inference_demo.rb
+- examples/concurrent_inference_demo_dsl.rb
 - examples/csv_trading_system.rb
+- examples/csv_trading_system_dsl.rb
 - examples/iot_demo_using_dsl.rb
+- examples/knowledge_base.db
 - examples/portfolio_rebalancing_system.rb
+- examples/portfolio_rebalancing_system_dsl.rb
 - examples/redis_trading_demo.rb
+- examples/redis_trading_demo_dsl.rb
+- examples/run_all.rb
+- examples/run_all_dsl.rb
 - examples/sample_stock_data.csv
 - examples/stock_trading_advanced.rb
-- examples/stock_trading_system.rb.bak
+- examples/stock_trading_advanced_dsl.rb
+- examples/temp.txt
+- examples/temp_dsl.txt
 - examples/timestamped_trading.rb
+- examples/timestamped_trading_dsl.rb
 - examples/trading_demo.rb
+- examples/trading_demo_dsl.rb
 - examples/working_demo.rb
+- examples/working_demo_dsl.rb
 - lib/kbs.rb
 - lib/kbs/alpha_memory.rb
 - lib/kbs/beta_memory.rb
@@ -127,15 +186,16 @@ files:
 - lib/kbs/dsl/pattern_evaluator.rb
 - lib/kbs/dsl/rule_builder.rb
 - lib/kbs/dsl/variable.rb
+- lib/kbs/engine.rb
 - lib/kbs/fact.rb
 - lib/kbs/join_node.rb
 - lib/kbs/negation_node.rb
 - lib/kbs/production_node.rb
-- lib/kbs/rete_engine.rb
 - lib/kbs/rule.rb
 - lib/kbs/token.rb
 - lib/kbs/version.rb
 - lib/kbs/working_memory.rb
+- mkdocs.yml
 homepage: https://github.com/madbomber/kbs
 licenses:
 - MIT
@@ -159,6 +219,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
-summary: Production-ready Knowledge-Based System with RETE II inference, Blackboard
-  architecture, and AI integration
+summary: Knowledge-Based System with RETE inference, Blackboard architecture, and
+  AI integration
 test_files: []