Ruby wrapper

.github/workflows/ruby_tests.yml

@@ -0,0 +1,30 @@
+name: Ruby wrapper building and tests run
+
+on:
+  push:
+    branches: ['main', 'dev']
+
+jobs:
+  test_api:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repo'
+        uses: actions/checkout@v4
+      - name: 'Set up Ruby 3.3'
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+      - name: 'Install CMake'
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y cmake
+      - name: 'Build native gem'
+        run: |
+          gem build vmaware-rb.gemspec
+          gem install vmaware-rb-1.0.0.gem
+      - name: Install test deps
+        run: |
+          gem install minitest -v 6.0.0
+      - name: Run ruby wrapper tests
+        run: |
+          ruby gem/test/unit/api.rb

.gitignore

@@ -1,72 +1,78 @@
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.li
-
-# Executables
-*.out
-*.app
-main
-
-#Custom 
-vm
-cli
-vmaware
-tmp
-test
-tmp.cpp
-src/vmtest.cpp
-archive/
-.vscode/
-build/
-milestones.md
-bin/
-notes.md
-private/
-resources/
-releases/
-release_notes.txt
-*.bk
-cmake-build-*/
-.idea/*
-*.bkp
-*copy.hpp
-personal_todo.md
-notes.txt
-auxiliary/test_template.cpp
-release_notes.md
-src/gui/lib/*
-pafish/
-list.txt
-/.vs
-/.vs/CMake Overview
-/.vs/ProjectSettings.json
-/.vs/slnx.sqlite
-/.vs/VSWorkspaceState.json
-TODO.md
-auxiliary/path*
-packages/
-auxiliary/test.cpp
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.li
+
+# Executables
+*.out
+*.app
+main
+
+# Ruby artifacts
+*.gem
+
+#Custom 
+vm
+cli
+vmaware
+tmp
+test
+tmp.cpp
+src/vmtest.cpp
+archive/
+.vscode/
+build/
+milestones.md
+bin/
+notes.md
+private/
+resources/
+releases/
+release_notes.txt
+*.bk
+cmake-build-*/
+.idea/*
+*.bkp
+*copy.hpp
+personal_todo.md
+notes.txt
+auxiliary/test_template.cpp
+release_notes.md
+src/gui/lib/*
+pafish/
+list.txt
+/.vs
+/.vs/CMake Overview
+/.vs/ProjectSettings.json
+/.vs/slnx.sqlite
+/.vs/VSWorkspaceState.json
+TODO.md
+auxiliary/path*
+packages/
+auxiliary/test.cpp
+.devcontainer/
+
+!gem/test/

gem/Readme.md

@@ -0,0 +1,10 @@
+# VMAware-rb
+
+_A `ruby` wrapper for VMAware._
+
+## Notes
+- The gem is not supported on windows.
+- Builds a native gem.
+- Only exports two functions: `vm?` (`VM::detect`) and `confidence`(`VM::percentage`) in their default invocation.
+
+> If building under `gem install vmaware-rb` starts complaining about a missing `make install` step, update your rubygems (`gem update --system`).