Merge pull request #7 from TA-Lib/dev

feat: add YARD documentation generation and insert

Author: Youngv

.github/workflows/main.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        ruby: ['3.2.3']
+        ruby: ['3.1', '3.2']
 
     runs-on: ${{ matrix.os }}
     name: Ruby ${{ matrix.ruby }} on ${{ matrix.os }}

.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1.0
 
 Style/StringLiterals:
   Enabled: true

CHANGELOG.md

@@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Renamed main file from `lib/ta_lib.rb` to `lib/ta_lib_ffi.rb`
 - Updated require statements in specs and gemspec
 
-## [0.1.0] - 2024-01-21
+## [0.1.0] - 2025-01-21
 
 ### Added
 - Initial release of ta_lib_ffi

Gemfile.lock

@@ -63,6 +63,8 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    webrick (1.9.1)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
@@ -74,6 +76,8 @@ DEPENDENCIES
   rubocop-rspec (~> 3.3)
   ruby-lsp-rspec (~> 0.1.20)
   ta_lib_ffi!
+  webrick (~> 1.9)
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.5.6

README.md

@@ -1,14 +1,15 @@
 # TALibFFI
 
 ![Tests](https://github.com/TA-Lib/ta-lib-ruby/actions/workflows/main.yml/badge.svg)
+![Gem Version](https://img.shields.io/gem/v/ta_lib_ffi.svg)
 
 ## Introduction
 
 TALibFFI is a Ruby binding for [TA-Lib](https://ta-lib.org/) (Technical Analysis Library) using FFI (Foreign Function Interface). It provides a comprehensive set of functions for technical analysis of financial market data.
 
 ## Requirements
 
-- Ruby >= 3.0.0
+- Ruby >= 3.1.0
 - TA-Lib >= 0.6.4
 
 ## Installation

Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -10,3 +11,14 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+YARD::Rake::YardocTask.new do |t|
+  require_relative "lib/ta_lib_ffi"
+  require_relative "lib/ta_lib_ffi/doc"
+  TALibFFI::Doc.insert
+
+  t.files = ["lib/**/*.rb"]
+  t.options = ["--exclude", "lib/ta_lib_ffi/doc.rb"]
+  t.stats_options = ["--list-undoc"]
+  t.after = -> { TALibFFI::Doc.remove }
+end