bytebuffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20a3822e4f7dd0a4162f60b834648acc30a1b33a3c7839c0434a084bf4a88ec8
+  data.tar.gz: c685d79e7d93d6c0df12c7ab55f55a37a98251ae4d416e6cc76b015ab8fc0a05
+SHA512:
+  metadata.gz: e7f1a3cba5fcaba77cb5b975cd7a14cd690e73c5c719a9d59c3ef7d03278cb5d4880a1050240a513fe8b4e199d4c8995228a6645bd87a350ebe49bd0c5c39127
+  data.tar.gz: d9c2033f9009139988b7e3131afe37e393f0b48fddf7f132c24bb6aeac5fc3bb3ea74cb89c58da5e4774e5a73fe288261391be84ef5ef357afc9666485536cd4

data/.github/workflows/pages.yml

@@ -0,0 +1,40 @@
+---
+name: YARD to GitHub Pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [released]
+
+permissions:
+  id-token: write
+  contents: read
+  pages: write
+
+jobs:
+  BuildAndPublish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Build YARD Docs
+        run: bundler exec rake docs:generate
+
+      - name: Upload pages artifact
+        id: upload-artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: "yard-docs"
+          path: ./doc/
+          retention-days: "7"
+
+      - name: Deploy pages artifact
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: "yard-docs"

data/.github/workflows/publish.yml

@@ -0,0 +1,88 @@
+---
+name: Publish Gem
+
+on:
+  workflow_dispatch:
+  release:
+    types: [released]
+
+jobs:
+  Build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: windows-latest
+            name: windows
+            path: "ext/libext.dll"
+          - os: ubuntu-latest
+            name: linux
+            path: "ext/libext.so"
+          - os: macos-latest
+            name: macos
+            path: "ext/libext.dylib"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Setup Rust
+        uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: stable
+
+      - name: Build extension
+        run: bundle exec rake gem:build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: extension-${{ matrix.name }}
+          path: ${{ matrix.path }}
+
+  Publish:
+    runs-on: ubuntu-latest
+    needs: [Build]
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Setup Rust
+        uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: stable
+
+      - name: Download build linux artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: extension-linux
+          path: ext/libext.so
+
+      - name: Download build windows artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: extension-windows
+          path: ext/libext.dll
+
+      - name: Download build macos artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: extension-macos
+          path: ext/libext.dylib
+
+      - name: Publish Gem
+        uses: rubygems/release-gem@v1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://www.rubygems.org'
+
+gem 'simplecov', require: false
+gem 'webrick', '~> 1.7', require: false
+gem 'yard', '~> 0.9', require: false
+gem 'gem-release'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    bytebuffer (0.1.0)
+      ffi (~> 1.17)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    ffi (1.17.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
+    gem-release (2.2.2)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    webrick (1.8.1)
+    yard (0.9.36)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bytebuffer!
+  gem-release
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  simplecov
+  webrick (~> 1.7)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.5.3

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Patrick Worlds
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,26 @@
+# ByteBuffer
+The `ByteBuffer` Ruby gem provides a powerful and flexible interface for buffered IO data, wrapping the [bytebuffer](https://crates.io/crates/bytebuffer) crate using FFI.
+
+## Overview
+ByteBuffer offers an interface to the compiled rust library for manipulating buffered IO, e.g. reading and writing bits, bytes, integers of various sizes, and floats.
+## Getting Started
+#### Dependencies
+The following packages are required to build and use the gem:
+* `ruby` >= 3.0
+* `rustc`
+* `cargo`
+
+Ensure the following toolchains are installed via rustup:
+* `x86_64-unknown-linux-gnu`
+* 
+
+#### Usage
+A basic example of the ByteBuffer in action can be found below:
+```ruby
+require 'bytebuffer'
+
+bb = ByteBuffer.new
+bb.write_i32(-128)
+puts bb.read_i32 # Output: -128
+bb.free
+```

data/Rakefile

@@ -0,0 +1,90 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'ffi'
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubygems'
+require 'rubygems/package_task'
+
+namespace :gem do
+  desc 'Build the Gem extensions'
+  task :build do
+    raise "Install rustc along with Cargo before running this rake task." if !system('cargo --version') || !system('rustc --version')
+
+    FileUtils.chdir("ext/") do
+      target = case RUBY_PLATFORM
+               when /darwin/ then 'aarch64-apple-darwin'
+               when /linux/ then 'x86_64-unknown-linux-gnu'
+               when /mswin|mingw/ then 'x86_64-pc-windows-msvc'
+               else 'x86_64-unknown-linux-gnu'
+               end
+
+      target_path = "./build/#{target}/release/#{RUBY_PLATFORM.match?(/mswin|mingw/) ? 'ext' : 'libext'}.#{FFI::Platform::LIBSUFFIX}"
+
+      FileUtils.mkdir("build")
+
+      system("cargo build --release --target=#{target} --target-dir=#{FileUtils.pwd}/build")
+
+      FileUtils.cp(target_path, "./libext.#{FFI::Platform::LIBSUFFIX}")
+    end
+  end
+
+  desc 'Clean up the Gem build environment.'
+  task :clean do
+    FileUtils.rm_rf('pkg/')
+    FileUtils.rm_rf('ext/build/')
+  end
+
+  desc 'Package the Gem package'
+  task :package do
+    load('bytebuffer.gemspec')
+
+    Gem::PackageTask.new(GEM_SPEC) do |pkg|
+      pkg.need_tar_bz2 = true
+    end
+
+    Rake::Task['package'].invoke
+  end
+end
+
+namespace :docs do
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.name = 'generate'
+    t.files = ['lib/**/*.rb']
+  end
+
+  task serve: %i[docs:generate] do
+    Kernel.system('yard server')
+  end
+
+  task :clean do
+    require 'fileutils'
+
+    FileUtils.rm_rf('doc')
+    FileUtils.rm_rf('.yardoc')
+  end
+end
+
+
+namespace :test do
+  desc 'Runs all specs in the "spec/" folder using RSpec.'
+  RSpec::Core::RakeTask.new(:rspec)
+
+  task :clean do
+    require 'fileutils'
+
+    FileUtils.rm_rf('coverage')
+  end
+
+  desc 'Runs extension tests using cargo test.'
+  task :ext do
+    raise "Install rustc along with Cargo before running this rake task." if !system('cargo --version') || !system('rustc --version')
+
+    FileUtils.chdir("ext/") do
+      system("cargo test")
+    end
+  end
+end

data/bytebuffer.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/bytebuffer/version'
+
+GEM_SPEC = Gem::Specification.new do |spec|
+  spec.name = 'bytebuffer'
+  spec.version = ByteBuffer::VERSION
+  spec.summary = 'A gem wrapping the bytebuffer crate using FFI.'
+  spec.description = 'A gem that provides a ByteBuffer class based on the bytebuffer rust crate.'
+  spec.license = 'BSD-3-Clause'
+  spec.author = 'Patrick W.'
+  spec.email = 'Sickday@pm.me'
+
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.add_runtime_dependency 'ffi', '~> 1.17'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+
+  spec.extensions = "ext/extconf.rb"
+  spec.require_paths = ['lib']
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+end

data/ext/Cargo.lock

@@ -0,0 +1,25 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "bytebuffer"
+version = "2.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fa7bfaf7cd08cacd74cdc6b521c37ac39cbc92692e5ab5c21ed5657a749b577c"
+dependencies = [
+ "byteorder",
+]
+
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
+[[package]]
+name = "ext"
+version = "0.1.0"
+dependencies = [
+ "bytebuffer",
+]

data/ext/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "ext"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+bytebuffer = "2.2.0"

data/ext/Makefile

@@ -0,0 +1,57 @@
+ifeq '$(findstring ;,$(PATH))' ';'
+    OS := Windows
+else
+    OS := $(shell uname 2>/dev/null || echo Unknown)
+    OS := $(patsubst CYGWIN%,Cygwin,$(OS))
+    OS := $(patsubst MSYS%,MSYS,$(OS))
+    OS := $(patsubst MINGW%,MSYS,$(OS))
+endif
+
+
+ifeq ($(OS),Windows)
+    SUFFIX := dll
+    TARGET := x86_64-pc-windows-msvc
+endif
+ifeq ($(OS),Darwin)
+    SUFFIX := dylib
+    TARGET := aarch64-apple-darwin
+endif
+ifeq ($(OS),Linux)
+    SUFFIX := so
+    TARGET := x86_64-unknown-linux-gnu
+endif
+ifeq ($(OS),GNU)
+    SUFFIX := so
+    TARGET := x86_64-unknown-linux-gnu
+endif
+
+
+all:
+	mkdir build
+	echo "Outputting to $PWD /build/$(TARGET)"
+	cargo build --release --target=$(TARGET) --target-dir=./build
+
+clean:
+	rm -rf target
+
+install:
+	cp target/$(TARGET)/release/libext.$(SUFFIX) ./
+
+test:
+	cargo test
+
+build-macos-amd64:
+	cargo build --release --target=x86_64-apple-darwin
+	cp target/x86_64-apple-darwin/release/libext.dylib ./
+
+build-macos-aarch:
+	cargo build --release --target=aarch64-apple-darwin
+	cp target/aarch64-apple-darwin/release/libext.dylib  ./
+
+build-linux:
+	cargo build --release --target=x86_64-unknown-linux-gnu
+	cp target/x86_64-unknown-linux-gnu/release/libext.so ./
+
+build-windows:
+	cargo build --release --target=x86_64-pc-windows-msvc
+	cp target/x86_64-pc-windows-msvc/release/libext.dll  ./

data/ext/extconf.rb

@@ -0,0 +1 @@
+raise 'Install Rust with Cargo from https://www.rust-lang.org/ before installing this gem.' if !system('cargo --version') || !system('rustc --version')