ruby_dsp 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2302dab136b64de0880e5d512095d28e7730803a76bee8dc4f97b284be76fffb
-  data.tar.gz: b3831519ba0a0997c09bfe285c5ec70a683172a6da645faf9df61e3ff79c3d71
+  metadata.gz: d8e97fbe60fdad6b1c32094042d18d5e8ef350fee5eb3c3806fd1acefdf30d20
+  data.tar.gz: d5b9fa0d531f9c82d448513aeebaf23f1bdd598487371f2224d17c2557b7c10a
 SHA512:
-  metadata.gz: 1210548618a8e94e1f80cc014802bfd257595c677301bd8980d6db0e3e1751a2a0dc5a58dd5b16426515f5054e00cdb95ebce10e647a86891d17fcb6e99b3364
-  data.tar.gz: 6edb77f271deed7670a19afda00bf0f8aa1d255dddbde4a269d5a483dff101bcac17f000f7e6ace1ab19a06f8327101f1a0160ec9b529606f0896ab3e6a021c8
+  metadata.gz: 4bf040c46e365162b7b5d1d0bae39c53fc4d1ba62c5b449127005d33569a9fc940d85ab5fced54ca550fc68a862429b6e552cafdfb4bbc1ef86e220350b67109
+  data.tar.gz: 388d2bcf61a705ac2167cc483f141e726ba702fbc60ab45899ba1048779496ac60cab21d240feba9a6e0fb8a3fc9ed66103db14919fe69431aca3fb79285bf58

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ "main", "dev_pipelines" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true 
+
+    - name: Run tests
+      run: bundle exec rake test

data/README.md

@@ -1,7 +1,13 @@
-# RubyDSP
+# RubyDSP | [Documentation](https://www.rubydoc.info/gems/ruby_dsp/0.0.4)
+
+[![Ruby CI](https://github.com/cichrrad/rubyDSP/actions/workflows/test.yml/badge.svg)](https://github.com/cichrrad/rubyDSP/actions/workflows/test.yml)
+
+---
 
 > 🚧 **Status:** This project is currently in early development. It is hopefully functional, but API changes are expected. There is no warranty.
 
+---
+
 **RubyDSP** is an audio processing and DSP Ruby gem. Ultimately, it aims to be `librosa`-wannabe for Ruby. It uses C++ under the hood, utilizing [miniaudio](https://miniaud.io/) and [Rice](https://github.com/jasonroelofs/rice)
 
 ## Features
@@ -13,12 +19,10 @@
 
 ## Installation
 
-Since the gem is currently in pre-release, you can install it directly from GitHub by adding this line to your application's `Gemfile`:
+Add this line to your application's `Gemfile`:
 
 ```ruby
-source "https://rubygems.org"
-
-gem 'ruby_dsp', github: 'cichrrad/rubyDSP'
+gem 'ruby_dsp'
 ```
 
 And then execute:
@@ -27,13 +31,12 @@ And then execute:
 $ bundle install
 ```
 
-*(Note: Installing this gem requires a modern C++ compiler, as it builds the native extensions directly on your machine upon installation. It requires Ruby 3.0+).*
-
-After this, you can run your scripts with
+Or install it yourself directly via:
 
 ```bash
-$ bundle exec ruby script.rb
+$ gem install ruby_dsp
 ```
+*(Note: Installing this gem requires a modern C++ compiler, as it builds the native extensions directly on your machine upon installation. It requires Ruby 3.0+).*
 
 ## Quick Start
 
@@ -69,7 +72,7 @@ track.save_track("processed_vocals.wav")
 
 ## Development
 
-If you want to clone the repo and hack on the C++ guts, we have fully automated the compilation and testing steps.
+If you want to clone the repo and work on C++ guts, start with:
 
 1. Clone the repo and run `bundle install` to grab the development dependencies.
 2. Run `rake test` — this will automatically compile the C++ `extconf.rb` and run the Minitest suite.

data/lib/ruby_dsp/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RubyDSP
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/ruby_dsp.gemspec

@@ -21,8 +21,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rice', '~> 4.11.2'
 
+  s.add_development_dependency 'minitest', '~> 6.0'
   s.add_development_dependency 'rack', '~> 3.2'
   s.add_development_dependency 'rackup', '~> 2.3'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rake-compiler', '~> 1.3'
   s.add_development_dependency 'webrick', '~> 1.9'
   s.add_development_dependency 'yard', '~> 0.9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_dsp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Radek C.
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.11.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +129,7 @@ extensions:
 - ext/ruby_dsp/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".yardopts"
 - Gemfile