sqa 0.0.32 → 0.0.37

data/docs/api-reference/sqa_strategy.md

@@ -0,0 +1,178 @@
+# 📦 SQA::Strategy
+
+!!! note "Description"
+    This module needs to be extend'ed within
+    a strategy class so that these common class
+    methods are available in every trading strategy.
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy.rb:16`
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#strategies()`
+
+
+!!! success "Returns"
+
+    **Type:** `Array<Method>`
+
+    
+
+    Collection of strategy trade methods
+
+??? info "Source Location"
+    `lib/sqa/strategy.rb:19`
+
+---
+
+### `#strategies=(value)`
+
+Sets the attribute strategies
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute strategies to. |
+
+
+??? info "Source Location"
+    `lib/sqa/strategy.rb:19`
+
+---
+
+### `#initialize()`
+
+Creates a new Strategy instance with an empty strategies collection.
+
+
+!!! success "Returns"
+
+    **Type:** `Strategy`
+
+    
+
+    a new instance of Strategy
+
+??? info "Source Location"
+    `lib/sqa/strategy.rb:22`
+
+---
+
+### `#add(a_strategy)`
+
+Adds a trading strategy to the collection.
+Strategies must be either a Class with a .trade method or a Method object.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `a_strategy` | `Class, Method` | Strategy to add |
+!!! success "Returns"
+
+    **Type:** `Array<Method>`
+
+    
+
+    Updated strategies collection
+!!! example "Usage Examples"
+
+    ```ruby
+    strategy.add(SQA::Strategy::RSI)
+    ```
+    
+    ```ruby
+    strategy.add(MyModule.method(:custom_trade))
+    ```
+??? info "Source Location"
+    `lib/sqa/strategy.rb:39`
+
+---
+
+### `#execute(v)`
+
+Executes all registered strategies with the given data vector.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `v` | `OpenStruct` | Data vector containing indicator values and prices |
+!!! success "Returns"
+
+    **Type:** `Array<Symbol>`
+
+    
+
+    Array of signals (:buy, :sell, or :hold) from each strategy
+!!! example "Usage Examples"
+
+    ```ruby
+    vector = OpenStruct.new(rsi: 25, prices: prices_array)
+    signals = strategy.execute(vector)  # => [:buy, :hold, :sell]
+    ```
+??? info "Source Location"
+    `lib/sqa/strategy.rb:60`
+
+---
+
+### `#auto_load(except: = [:common], only: = [])`
+
+Auto-loads strategy files from the strategy directory.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `except` | `Array<Symbol>` | Strategy names to exclude (default: [:common]) |
+    | `only` | `Array<Symbol>` | If provided, only load these strategies |
+!!! success "Returns"
+
+    **Type:** `nil`
+
+    
+!!! example "Usage Examples"
+
+    ```ruby
+    strategy.auto_load(except: [:common, :random])
+    ```
+    
+    ```ruby
+    strategy.auto_load(only: [:rsi, :macd])
+    ```
+??? info "Source Location"
+    `lib/sqa/strategy.rb:79`
+
+---
+
+### `#available()`
+
+Returns all available strategy classes in the SQA::Strategy namespace.
+
+
+!!! success "Returns"
+
+    **Type:** `Array<Class>`
+
+    
+
+    Array of strategy classes
+!!! example "Usage Examples"
+
+    ```ruby
+    SQA::Strategy.new.available
+    # => [SQA::Strategy::RSI, SQA::Strategy::MACD, ...]
+    ```
+??? info "Source Location"
+    `lib/sqa/strategy.rb:108`
+
+---
+
+## 📝 Attributes
+
+### 🔄 `strategies` <small>read/write</small>
+

data/docs/api-reference/sqa_strategy_bollingerbands.md

@@ -0,0 +1,26 @@
+# 📦 SQA::Strategy::BollingerBands
+
+!!! note "Description"
+    Bollinger Bands trading strategy
+    Buy when price touches lower band (oversold)
+    Sell when price touches upper band (overbought)
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/bollinger_bands.rb:8`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/bollinger_bands.rb:9`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_common.md

@@ -0,0 +1,29 @@
+# 🔧 SQA::Strategy::Common
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/common.rb:8`
+
+## 🔨 Instance Methods
+
+### `#trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `#desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_consensus.md

@@ -0,0 +1,129 @@
+# 📦 SQA::Strategy::Consensus
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/consensus.rb:5`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:8`
+
+---
+
+### `.trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `.desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 🔨 Instance Methods
+
+### `#initialize(vector)`
+
+
+!!! success "Returns"
+
+    **Type:** `Consensus`
+
+    
+
+    a new instance of Consensus
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:12`
+
+---
+
+### `#my_fancy_trader()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:17`
+
+---
+
+### `#consensus()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:26`
+
+---
+
+### `#strat_one()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:41`
+
+---
+
+### `#strat_two()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:42`
+
+---
+
+### `#strat_three()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:43`
+
+---
+
+### `#strat_four()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:44`
+
+---
+
+### `#strat_five()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/consensus.rb:45`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_ema.md

@@ -0,0 +1,41 @@
+# 📦 SQA::Strategy::EMA
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/ema.rb:5`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/ema.rb:8`
+
+---
+
+### `.trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `.desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_kbs.md

@@ -0,0 +1,154 @@
+# 📦 SQA::Strategy::KBS
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/kbs_strategy.rb:50`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+Main strategy interface - compatible with SQA::Strategy framework
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:62`
+
+---
+
+## 🔨 Instance Methods
+
+### `#kb()`
+
+Returns the value of attribute kb.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:51`
+
+---
+
+### `#default_rules_loaded()`
+
+Returns the value of attribute default_rules_loaded.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:51`
+
+---
+
+### `#initialize(load_defaults: = true)`
+
+
+!!! success "Returns"
+
+    **Type:** `KBS`
+
+    
+
+    a new instance of KBS
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:53`
+
+---
+
+### `#execute(vector)`
+
+Execute strategy with given market data
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:68`
+
+---
+
+### `#add_rule(name, &block)`
+
+Add a custom trading rule
+
+Example:
+  add_rule :buy_dip do
+    on :rsi, { value: ->(v) { v < 30 } }
+    on :macd, { signal: :bullish }
+    perform { kb.assert(:signal, { action: :buy, confidence: :high }) }
+  end
+
+Note: Use `kb.assert` in perform blocks, not just `assert`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:92`
+
+---
+
+### `#assert_fact(type, attributes = {})`
+
+Assert a fact into working memory
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:105`
+
+---
+
+### `#query_facts(type, pattern = {})`
+
+Query facts from working memory
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:110`
+
+---
+
+### `#print_facts()`
+
+Print current working memory (for debugging)
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:115`
+
+---
+
+### `#print_rules()`
+
+Print all rules (for debugging)
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/kbs_strategy.rb:120`
+
+---
+
+## 📝 Attributes
+
+### 👁️ `kb` <small>read-only</small>
+
+Returns the value of attribute kb.
+
+### 👁️ `default_rules_loaded` <small>read-only</small>
+
+Returns the value of attribute default_rules_loaded.
+

data/docs/api-reference/sqa_strategy_macd.md

@@ -0,0 +1,26 @@
+# 📦 SQA::Strategy::MACD
+
+!!! note "Description"
+    MACD (Moving Average Convergence Divergence) crossover strategy
+    Buy when MACD line crosses above signal line (bullish)
+    Sell when MACD line crosses below signal line (bearish)
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/macd.rb:8`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/macd.rb:9`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_mp.md

@@ -0,0 +1,41 @@
+# 📦 SQA::Strategy::MP
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/mp.rb:5`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/mp.rb:8`
+
+---
+
+### `.trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `.desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_mr.md

@@ -0,0 +1,41 @@
+# 📦 SQA::Strategy::MR
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/mr.rb:5`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/mr.rb:8`
+
+---
+
+### `.trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `.desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa_strategy_random.md

@@ -0,0 +1,41 @@
+# 📦 SQA::Strategy::Random
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/strategy/random.rb:5`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.trade(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/random.rb:8`
+
+---
+
+### `.trade_against(vector)`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:9`
+
+---
+
+### `.desc()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/strategy/common.rb:23`
+
+---
+
+## 📝 Attributes
+