sqa-tai 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df8b9f48bc99341d38af4690c0a82a3a6f648890bfeaf8d45e92aec5d591e25
-  data.tar.gz: 60e3356d7f7911700dd05efb166817caf9a42ceb718b261088bc3659cc3e5b87
+  metadata.gz: fb0c8beef02e005aa23c29fd805d7d68067f816286ccf41f747f9cdcf3dc7918
+  data.tar.gz: 485f49c5d3636dd5d4814f6c011fcd2b50848697ba1193faa3d0958ed155208f
 SHA512:
-  metadata.gz: 13e78aa5c9e871041502c71860f827896de687363a06797fb43d2a9522fb9664e1ecd8efd0fd2aecbedad6c23a58af4f6e648182b7509deea90377ff497b7ace
-  data.tar.gz: 4045b21ddbbe25fe6d73aa52c3b9a695ce6f5fcbdc520057aef403f3474091b4f6feb1d200e0bdd510d8cfed6c2aeede44591de5888a8072ce223119dec2f517
+  metadata.gz: f833ff859431d01643f78e7748ae6ff865886bc05f1ba29dedd498285698a191bf5101bc4abc20894adcfdd5cb245157bd5b9ca3a224bbca52be58470565d6f8
+  data.tar.gz: f3103d7e14e368cfbc134c93873bcae59144229a484459858460d89cec2cd058e5deaa127a7bb73fecfee2fcd73001383cffd070cde8386b367117ea1057378a

data/CHANGELOG.md

@@ -7,6 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Help system for accessing indicator documentation (`SQA::TAI.help`)
+  - Returns URLs to online documentation for any indicator
+  - Supports searching by name, filtering by category, and listing all indicators
+  - Auto-generated from mkdocs documentation files via `rake help:generate`
+  - Flexible API returns HelpResource objects with URL, name, and category
+  - Optional browser integration to open documentation directly
+  - Zeitwerk-compatible file structure with `help.rb` and `help_resource.rb`
+
+## [0.1.1] 2025-11-13
+### Added
+- Intraday Momentum Index (IMI) indicator
+- GitHub Actions workflow to automatically deploy documentation to GitHub Pages
+- Indicator template markdown file for documentation
+- Chronological ordering note to indicator documentation
+
+### Fixed
+- Hash return format handling from newer ta_lib_ffi versions
+- Image alignment and naming in README
+- API reference documentation formatting and index links
+
+### Changed
+- Refactored library code into modular structure with 8 focused modules organized by indicator category
+  - `lib/sqa/tai/overlap_studies.rb` - Moving averages and bands
+  - `lib/sqa/tai/momentum_indicators.rb` - Momentum and oscillator indicators
+  - `lib/sqa/tai/volatility_indicators.rb` - Volatility and range indicators
+  - `lib/sqa/tai/volume_indicators.rb` - Volume-based indicators
+  - `lib/sqa/tai/price_transform.rb` - Price transformation functions
+  - `lib/sqa/tai/cycle_indicators.rb` - Hilbert Transform cycle indicators
+  - `lib/sqa/tai/statistical_functions.rb` - Statistical analysis functions
+  - `lib/sqa/tai/pattern_recognition.rb` - Candlestick pattern recognition
+- Refactored test suite to mirror lib directory organization with 8 modular test files
+- Reduced main `lib/sqa/tai.rb` from 1,851 lines to 67 lines (96% reduction)
+- Reduced main `test/sqa/tai_test.rb` to core tests only, extracted 72 tests into category-specific files
+- Updated indicator count to 132
+- Reorganized README sections
+- Improved SQA name from "Stock Qualitative Analysis" to "Simple Qualitative Analysis"
+- Updated gemspec description
+
 ## [0.1.0] - 2025-11-06
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sqa-tai (0.1.0)
+    sqa-tai (0.1.2)
       ta_lib_ffi (~> 0.3)
 
 GEM

data/README.md

@@ -7,8 +7,8 @@
 
 <table>
 <tr>
-<td width="30%" valign="top" align="center">
-  <img src="docs/assets/images/sqa-tai.jpg" alt="Ruby Turns Information into Knowledge" width="60%">
+<td width="30%" valign="middle" align="center">
+  <img src="docs/assets/images/sqa.jpg" alt="Ruby Turns Information into Knowledge" width="80%">
   <br/>
 </td>
 <td width="70%" valign="top">
@@ -86,6 +86,34 @@ if SQA::TAI.available?
 end
 ```
 
+## Getting Help on Indicators
+
+Access comprehensive documentation for any indicator directly from your code:
+
+```ruby
+# Get documentation URL for an indicator
+help = SQA::TAI.help(:sma)
+puts help.url
+# => https://madbomber.github.io/sqa-tai/indicators/overlap/sma/
+
+# Open documentation in browser
+SQA::TAI.help(:rsi, open: true)
+
+# Search for indicators
+SQA::TAI.help(search: "momentum")
+# => {mom: "https://...", cmo: "https://...", ...}
+
+# List all indicators in a category
+SQA::TAI.help(category: :momentum_indicators)
+# => {rsi: "https://...", macd: "https://...", ...}
+
+# Get all available indicators
+SQA::TAI.help(:all)
+# => {sma: "https://...", ema: "https://...", ...}
+```
+
+See the [Help System Guide](https://madbomber.github.io/sqa-tai/getting-started/help/) for more details.
+
 ## Available Indicators (136 Total)
 
 ### Overlap Studies (15)

data/Rakefile

@@ -11,3 +11,72 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+namespace :help do
+  desc "Generate help mappings from documentation files"
+  task :generate do
+    require "fileutils"
+
+    indicators = {}
+    category_mapping = {
+      "overlap" => :overlap_studies,
+      "momentum" => :momentum_indicators,
+      "volatility" => :volatility_indicators,
+      "volume" => :volume_indicators,
+      "price_transform" => :price_transform,
+      "statistical" => :statistical_functions,
+      "cycle" => :cycle_indicators,
+      "patterns" => :pattern_recognition
+    }
+
+    # Scan docs directory
+    Dir.glob("docs/indicators/**/*.md").sort.each do |file|
+      next if file.include?("index.md")
+
+      # Extract indicator name from filename
+      indicator = File.basename(file, ".md").to_sym
+
+      # Extract category from path
+      path_category = File.dirname(file).split("/").last
+      category = category_mapping[path_category] || path_category.to_sym
+
+      # Read first heading for name
+      name = nil
+      File.open(file, "r") do |f|
+        f.each_line do |line|
+          if line.start_with?("# ")
+            name = line.gsub(/^#\s*/, "").strip
+            # Remove content after parentheses if present
+            name = name.split("(").first.strip if name.include?("(")
+            break
+          end
+        end
+      end
+
+      # Build path relative to docs/
+      path = file.gsub("docs/", "").gsub(".md", "")
+
+      indicators[indicator] = {
+        name: name || indicator.to_s.upcase,
+        category: category,
+        path: path
+      }
+    end
+
+    # Convert to JSON-friendly format (strings instead of symbols)
+    json_data = indicators.transform_keys(&:to_s).transform_values do |meta|
+      {
+        "name" => meta[:name],
+        "category" => meta[:category].to_s,
+        "path" => meta[:path]
+      }
+    end
+
+    # Write to JSON file
+    require "json"
+    json_output = JSON.pretty_generate(json_data)
+    File.write("lib/sqa/tai/help/data.json", json_output)
+    puts "✓ Generated help data for #{indicators.size} indicators"
+    puts "  File: lib/sqa/tai/help/data.json"
+  end
+end

data/lib/sqa/tai/cycle_indicators.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SQA
+  module TAI
+    # Cycle Indicators
+    module CycleIndicators
+      # Hilbert Transform - Dominant Cycle Period
+      # @param prices [Array<Float>] Array of prices
+      # @return [Array<Float>] Dominant cycle period values
+      def ht_dcperiod(prices)
+        check_available!
+        validate_prices!(prices)
+
+        TALibFFI.ht_dcperiod(prices)
+      end
+
+      # Hilbert Transform - Trend vs Cycle Mode
+      # @param prices [Array<Float>] Array of prices
+      # @return [Array<Integer>] Trend mode (1) or cycle mode (0)
+      def ht_trendmode(prices)
+        check_available!
+        validate_prices!(prices)
+
+        TALibFFI.ht_trendmode(prices)
+      end
+
+      # Hilbert Transform - Dominant Cycle Phase
+      # @param prices [Array<Float>] Array of prices
+      # @return [Array<Float>] Dominant cycle phase values
+      def ht_dcphase(prices)
+        check_available!
+        validate_prices!(prices)
+
+        TALibFFI.ht_dcphase(prices)
+      end
+
+      # Hilbert Transform - Phasor Components
+      # @param prices [Array<Float>] Array of prices
+      # @return [Array<Array<Float>>] [inphase, quadrature]
+      def ht_phasor(prices)
+        check_available!
+        validate_prices!(prices)
+
+        result = TALibFFI.ht_phasor(prices)
+
+        # Handle hash return format from newer ta_lib_ffi versions
+        if result.is_a?(Hash)
+          [result[:in_phase], result[:quadrature]]
+        else
+          result
+        end
+      end
+
+      # Hilbert Transform - SineWave
+      # @param prices [Array<Float>] Array of prices
+      # @return [Array<Array<Float>>] [sine, lead_sine]
+      def ht_sine(prices)
+        check_available!
+        validate_prices!(prices)
+
+        result = TALibFFI.ht_sine(prices)
+
+        # Handle hash return format from newer ta_lib_ffi versions
+        if result.is_a?(Hash)
+          [result[:sine], result[:lead_sine]]
+        else
+          result
+        end
+      end
+    end
+  end
+end