tulirb 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71894a41382e1a2d581cd40f46e5cae0fa5b3d16f496f86b38ced085d94532bc
-  data.tar.gz: b59d5863188a36eb43bc184289778bb207d1982ea03eacf3a591d09b8319aeb8
+  metadata.gz: 439ab7a08e2ecbe74674156913a01255c008e7e4768821dae21f4ccef2db95a5
+  data.tar.gz: 20df5ea27a9ef2c6a16aae50688b2fab30b3f4c6327ef0213b188642483b1249
 SHA512:
-  metadata.gz: ff097d9c769fd60037af18e055e523f8f1e703f3649a43589390ccc178dd7934e699515baeefb7920b6b10299a025c115677786260540e67ccca2dc5b39aeb8e
-  data.tar.gz: df0d53ecd8603a89cf0b355ab5ab39bae71ebfd79c9ab4e395ac7ad23f2bbe16debac1f46c20a8ad219224bf1871d5b596cb6a0e1fe446f5d9c0779a31404dad
+  metadata.gz: '059b4963c53683830ac7c169596ee001e11bab1c8ebf4ec6cd95d95d92bfdc22c7b5f5647b4698d9b2528c381d5089c52ede0084a97e53d7370508416c620284'
+  data.tar.gz: 0edb7138cc91a916ed717aed369115140041491b53a22fc2f2967439cace19bc58771a55b6a91b252c0a8f888d6ba1063b0a7c7145d5ee3e866b8f94c3aaa399

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   Exclude:
     - ext/tulirb/extconf.rb
     - Gemfile.lock
@@ -16,6 +16,13 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 Style/Documentation:
   Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 30
   
 
 Layout/LineLength:

data/CHANGELOG.md

@@ -1,5 +1,19 @@
-## [Unreleased]
+# Tulirb Changelog
+
+## [1.0.0] - 2025-02-24
+
+- Fix all compiler warnings in C extension and ensure there are no memory leaks.
+- [internal] Added AddressSanitizer to detect memory leaks in the C extension.
+- [internal] Added Dockerfile and docker-compose.yml to run tests in a Linux environment.
+
+## [0.1.1] - 2024-01-22
+
+- Fixed ArgumentError messages in C extension.
+- [interna] Replace metaprogrammed Ruby wrapper methods with explicitly defined methods.
+- [internal] Added tests for wrapper methods.
 
 ## [0.1.0] - 2023-12-31
 
 - Initial release
+
+## [Unreleased]

data/Dockerfile

@@ -0,0 +1,10 @@
+ARG RUBY_VERSION=3.4
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim AS base
+WORKDIR /tulirb
+COPY . /tulirb
+RUN apt-get update -qq && \
+  apt-get install -y build-essential \
+  git
+RUN bundle install
+CMD [ "/bin/bash" ]
+ENTRYPOINT [ "/bin/bash", "-c" ]

data/README.md

@@ -1,5 +1,5 @@
 # Tulirb
-Ruby bindings for the Tulip indicators technical analysis indicator library (https://tulipindicators.org/). This can be used to build tools for financial trading and data analytics in Ruby.
+Ruby bindings for the Tulip indicators technical analysis indicator library (https://tulipindicators.org/). This can be used to build tools for financial markets trading and analytics in Ruby.
 
 ## Installation
 
@@ -18,6 +18,8 @@ This library consists of a single module: `Tulirb`. All indicator functions are
 Example:
 
 ```ruby
+    require("tulirb")
+
     # Exponential Moving Average
     Tulirb.ema([[1.2, 1.5, 1, 1.8]], period: 5) # => [[1.2, 1.35, 1.175, 1.4875]]
 
@@ -34,15 +36,22 @@ Example:
     ) # => [[650, 720.2020202020201, 120.20202020202017], [480.80808080808083, 690.0673400673401, 496.80134680134677]]
 ```
 
+## Documentation
+Find documentation for all indicator functions [here](https://www.rubydoc.info/github/ozone4real/tulirb/main/Tulirb). Information about the input and option parameters for each indicator method are also available in the `Tulirb::INDICATORS_INFO` hash.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to compile the C extension, detect memory leaks in the C extension and run tests. [AddressSanitizer](https://github.com/google/sanitizers/wiki/addresssanitizer) is used to detect memory leaks in the C extension but it is only available on Linux. I'll recommend running the `rake` command with Docker to run in a Linux environment. There is a Dockerfile and docker-compose.yml file in the root directory to help with this. You can run `rake` with Docker by executing:
+
+    $ docker compose run tulirb rake
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tulirb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tulirb/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ozone4real/tulirb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ozone4real/tulirb/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -50,4 +59,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Tulirb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tulirb/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Tulirb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ozone4real/tulirb/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,45 @@
 # frozen_string_literal: true
 
+def windows?
+  RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
+end
+
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen(File::NULL)
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+end
+
+def reenable_task_with_prereqs(task_name)
+  task = Rake::Task[task_name]
+  return unless task.already_invoked # Skip if task hasn't run before
+
+  task.prerequisite_tasks.each { |prereq| reenable_task_with_prereqs(prereq) } # Recursively reset prerequisites
+  task.reenable # Reset the main task itself
+end
+
+def detect_memory_leaks!
+  asan_path = `gcc -print-file-name=libasan.so`.strip
+  env = { "LD_PRELOAD" => asan_path }
+  Open3.capture3(env,
+                 "ruby -Ilib:ext -r tulirb -e \"puts Tulirb.ema([[2, 4, 6]], period: 5)\"").tap do |_, error, status|
+    puts("Running memory leak detection with AddressSanitizer")
+    unless status.success?
+      errors = error.split("\n\n").grep(%r{ext/tulirb})
+      if errors.any?
+        elog = "Memory leaks detected in C extension:\n\n"
+        elog += errors.join("\n\n")
+        raise(elog)
+      end
+    end
+
+    puts("No memory leaks detected in C extension")
+  end
+end
+
 require("bundler/gem_tasks")
 require("rake/testtask")
 
@@ -10,15 +50,30 @@ Rake::TestTask.new(:test) do |t|
 end
 
 require("rubocop/rake_task")
-
 RuboCop::RakeTask.new
 
 require("rake/extensiontask")
-
 task(build: :compile)
-
 Rake::ExtensionTask.new("tulirb") do |ext|
   ext.lib_dir = "lib/tulirb"
 end
 
-task(default: %i[clobber compile test rubocop])
+task(detect_memory_leaks: :clobber) do
+  next if windows?
+
+  require("open3")
+  ENV["SANITIZE"] = "true"
+  silence_stream($stderr) { Rake::Task["compile"].invoke }
+
+  begin
+    detect_memory_leaks!
+  ensure
+    reenable_task_with_prereqs("clobber")
+    Rake::Task["clobber"].invoke
+    ENV["SANITIZE"] = "false"
+    reenable_task_with_prereqs("clobber")
+    reenable_task_with_prereqs("compile")
+  end
+end
+
+task(default: %i[detect_memory_leaks compile test rubocop clobber])

data/code_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require("tulirb")
+require("active_support/core_ext/string")
+
+file = File.open("code_output.rb", "a+")
+
+file.write("class << self\n")
+
+Tulirb::INDICATORS_INFO.each do |k, v|
+  kwargs = v[:options].map { |o| "#{o}:" }.join(", ")
+  kwargs = kwargs.empty? ? "" : ", #{kwargs}"
+  options_doc = v[:options].map { |o| "# @param #{o} [Numeric] #{o.titleize}" }
+  options_doc = options_doc.empty? ? "" : "\n#{options_doc.join(".\n")}."
+  func = <<~RUBY
+    # #{v[:full_name]}.
+    # @param inputs [Array<Array<Numeric>>] 2d array of inputs. #{options_doc}
+    # @return [Array<Array<Numeric>>] 2d array of results.
+    # @see Official TulipIndicators docs for detailed explanation and formular for this indicator function: (https://tulipindicators.org/#{k})
+    def #{k}(inputs#{kwargs})
+      super(inputs, [#{v[:options].join(", ")}])
+    end
+
+  RUBY
+  file.write(func)
+end
+
+file.write("end")
+file.close

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3.4'
+
+services:
+  tulirb:
+    platform: linux/amd64
+    build: .
+    volumes:
+      - .:/tulirb

data/ext/tulirb/extconf.rb

@@ -2,8 +2,12 @@
 
 require "mkmf"
 
-# $LDFLAGS << " -fsanitize=address,undefined"
-# $CFLAGS << " -fsanitize=address,undefined"
+if ENV["SANITIZE"] == "true"
+  CONFIG["optflags"] = "-O0"
+  CONFIG["debugflags"] = "-ggdb3"
+  $CFLAGS << " -fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls -DTULIRB_SANITIZE=1"
+  $LDFLAGS << " -fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls"
+end
 
 $srcs = %w[tiamalgamation.c tulirb.c]
 create_makefile("tulirb/tulirb")