bytebuffer 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eea8692ed857ea29116f8c6fe67247ccaebd7ae9b74881952715ca566810fed
-  data.tar.gz: 8dd61f4de9f5d424e6af310604386cc4386c9cb0e157eb39a233bf45980530f2
+  metadata.gz: 84a49dc9a366a0926ea0677547554188adae538ddfba8ba42f74e68e621af3f0
+  data.tar.gz: 161a564f57ecb7da7ca3ef9eb8e169b92a1bd81b0ddc9abf7f0ac7e47e7c77f9
 SHA512:
-  metadata.gz: c7641fc331f1eb535320937405685cb43076ee2f90610bb96b813917aa8658d389b111c8d9a59e2b4ace87f9d65ed12eaab98066784f56f721049ba8f73e6355
-  data.tar.gz: 9a16aa790e47b0ccf02eb741b6962453d1d8e4e69a8542d40b665179e2ce30594bdfcbd09d930ae5748449f730a5c105c2cdb864ec1672034f9c6e783c5612b9
+  metadata.gz: 330bf79aaf86a4637321a581ff8574033094980575a8223876f9209c922ff049a82aea5e4ba983d32a454d8ab263f9a5db1273da244e0ae0cde3eaff239bc241
+  data.tar.gz: d2f423bc467494d1193ae7796ac3b40297ed1a880e7c0940539e034c02e1aec48cf9dc34aa1ae134185a3eb4c4283b9d829d5e5e8ef21c1465658e63ddf167bb

data/.github/workflows/publish.yml

@@ -7,47 +7,8 @@ on:
     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'
-      - run: bundle install
-
-      - 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
@@ -66,24 +27,6 @@ jobs:
         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: Build package gem
         run: bundle exec rake gem:package
 

data/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+---
+name: Rspec and Cargo Test
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  BuildAndTest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 3
+      matrix:
+        os: [ ubuntu-latest, macos-latest ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+      - run: bundle install
+
+      - name: Setup Rust
+        uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: stable
+
+      - name: Build extension
+        run: |
+          bundle exec rake gem:compile
+          bundle exec rake gem:patch
+
+      - name: Run Rspec
+        run: bundle exec rake test:rspec
+
+      - name: Run Cargo test
+        run: bundle exec rake test:ext

data/{ext/Cargo.lock → Cargo.lock}

@@ -2,6 +2,13 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "bytebuffer"
+version = "0.1.0"
+dependencies = [
+ "bytebuffer 2.2.0",
+]
+
 [[package]]
 name = "bytebuffer"
 version = "2.2.0"
@@ -16,10 +23,3 @@ 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/Cargo.toml

@@ -0,0 +1,3 @@
+[workspace]
+members = ["./ext/bytebuffer"]
+resolver = "2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bytebuffer (0.1.1)
+    bytebuffer (0.1.3)
       ffi (~> 1.17)
 
 GEM
@@ -21,6 +21,9 @@ GEM
     ffi (1.17.0-x86_64-linux-gnu)
     ffi (1.17.0-x86_64-linux-musl)
     rake (13.2.1)
+    rake-compiler (1.2.7)
+      rake
+    rb_sys (0.9.98)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -59,6 +62,8 @@ PLATFORMS
 DEPENDENCIES
   bytebuffer!
   rake (~> 13.0)
+  rake-compiler (~> 1.2)
+  rb_sys (~> 0.9)
   rspec (~> 3.12)
   simplecov
   webrick (~> 1.7)

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/bytebuffer.svg)](https://badge.fury.io/rb/bytebuffer)
+
 # 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.
 

data/Rakefile

@@ -3,43 +3,84 @@ require 'bundler/gem_tasks'
 require 'ffi'
 require 'rake'
 require 'rake/testtask'
+require 'rb_sys/extensiontask'
 require 'rspec/core/rake_task'
 require 'rubygems'
 require 'rubygems/package_task'
 
+GEM_SPEC = Gem::Specification.load('bytebuffer.gemspec')
+
 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
+  desc 'Clean up the Gem build environment. Note: This command indiscriminately removes all .so, and .bundle files in subdirectories.'
+  task :clean do
+    FileUtils.rm_rf(%w(./tmp ./pkg ./target))
 
-      target_path = "./build/#{target}/release/#{RUBY_PLATFORM.match?(/mswin|mingw/) ? 'ext' : 'libext'}.#{FFI::Platform::LIBSUFFIX}"
+    case FFI::Platform::OS
+    when 'linux' then FileUtils.rm_r(Dir['./**/*.so'])
+    when 'darwin' then FileUtils.rm_r(Dir['./**/*.bundle'])
+    else system("rm -r ./**/*.so")
+    end
+  end
 
-      FileUtils.mkdir("build")
+  desc 'Compile and install the native extension'
+  task compile: %i(clean) do
+    RbSys::ExtensionTask.new('bytebuffer', GEM_SPEC) do |ext|
+      ext.source_pattern = "*.{rs,toml,lock,rb}"
+      ext.ext_dir = "#{File.dirname(__FILE__)}/ext/bytebuffer"
+      ext.cross_platform = %w[
+        aarch64-linux
+        arm64-darwin
+        x86_64-darwin
+        x86_64-linux
+        x86_64-linux-musl
+      ]
+
+      ext.cross_compile = true
+      ext.lib_dir = "lib"
+    end
 
-      system("cargo build --release --target=#{target} --target-dir=#{FileUtils.pwd}/build")
+    Rake::Task["compile"].invoke
+  end
 
-      FileUtils.cp(target_path, "./libext.#{FFI::Platform::LIBSUFFIX}")
+  desc 'Apply platform patches'
+  task :patch do
+    working_dir = File.dirname(__FILE__)
+    target = case RUBY_PLATFORM
+             when /darwin/ then 'darwin'
+             when /linux/ then 'linux'
+             end
+    patch_dir = "#{working_dir}/lib/bytebuffer/patch/#{target}"
+    unless !File.directory?(patch_dir) || Dir.empty?(patch_dir)
+      puts "Applying platform patches for #{target}"
+
+      FileUtils.chdir(patch_dir) do |dir|
+        Dir["#{dir}/*.patch"].sort.each do |patch|
+          puts "Applying patch: #{patch}"
+          system("patch #{working_dir}/lib/bytebuffer.rb #{patch}")
+        end
+      end
     end
   end
 
-  desc 'Clean up the Gem build environment.'
-  task :clean do
-    FileUtils.rm_rf('pkg/')
-    FileUtils.rm_rf('ext/build/')
+  desc 'Revert platform patches'
+  task :revert do
+    working_dir = File.dirname(__FILE__)
+    target = case RUBY_PLATFORM
+             when /darwin/ then 'darwin'
+             when /linux/ then 'linux'
+             end
+
+    FileUtils.chdir("#{working_dir}/lib/bytebuffer/patch/#{target}") do |dir|
+      Dir["#{dir}/*.patch"].sort.each do |patch|
+        puts "Applying patch: #{patch}"
+        system("patch -R #{working_dir}/lib/bytebuffer.rb #{patch}")
+      end
+    end
   end
 
   desc 'Package the Gem package'
-  task :package do
-    load('bytebuffer.gemspec')
-
+  task package: %i(compile gem:patch) do
     Gem::PackageTask.new(GEM_SPEC) do |pkg|
       pkg.need_tar_bz2 = true
     end
@@ -53,7 +94,7 @@ namespace :docs do
 
   YARD::Rake::YardocTask.new do |t|
     t.name = 'generate'
-    t.files = ['lib/**/*.rb']
+    t.files = %w(lib/**/*.rb)
   end
 
   task serve: %i[docs:generate] do
@@ -83,8 +124,6 @@ namespace :test do
   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
+    system("cargo test")
   end
-end
+end

data/bytebuffer.gemspec

@@ -1,23 +1,31 @@
 require_relative 'lib/bytebuffer/version'
 
-GEM_SPEC = Gem::Specification.new do |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.homepage = 'https://github.com/sickday/bytebuffer-rb'
   spec.license = 'BSD-3-Clause'
   spec.author = 'Patrick W.'
   spec.email = 'Sickday@pm.me'
 
+  spec.metadata = {
+    "homepage_uri" => 'https://github.com/sickday/bytebuffer-rb',
+    "documentation_uri" => 'https://sickday.github.io/bytebuffer-rb/'
+  }
+
   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 'rake-compiler', '~> 1.2'
+  spec.add_development_dependency 'rb_sys', '~> 0.9'
   spec.add_development_dependency 'rspec', '~> 3.12'
 
-  spec.extensions = "ext/extconf.rb"
-  spec.require_paths = ['lib']
+  spec.extensions = %w(ext/bytebuffer/extconf.rb)
+  spec.require_paths = %w(lib)
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + Dir["ext/*.so"] + Dir["ext/*.dylib"] + Dir["ext/*.dll"]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|git)/}) }
 end

data/ext/{Cargo.toml → bytebuffer/Cargo.toml}

@@ -1,7 +1,9 @@
 [package]
-name = "ext"
+name = "bytebuffer"
 version = "0.1.0"
 edition = "2021"
+authors = ["Patrick Worlds <sickday@pm.me>"]
+publish = false
 
 [lib]
 crate-type = ["cdylib"]

data/ext/bytebuffer/extconf.rb

@@ -0,0 +1,9 @@
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("bytebuffer") do |bb|
+  bb.profile = ENV.fetch("RB_SYS_CARGO_PROFILE", :dev).to_sym
+  bb.ext_dir = "."
+  bb.clean_after_install = true
+  bb.auto_install_rust_toolchain = true
+end

data/lib/bytebuffer/patch/linux/bytebuffer-read_i8-read_i16-1721497558.patch

@@ -0,0 +1,31 @@
+--- lib/bytebuffer.rb.orig	2024-07-20 14:25:37
++++ lib/bytebuffer.rb	2024-07-20 14:26:17
+@@ -178,11 +178,14 @@
+ 
+   # Read a single 8-bit unsigned integer from the {ByteBuffer}.
+   # @return [Integer] the read value.
+-  def read_u8; ByteBufferExtension.read_u8(@ptr); end
++  def read_u8; ByteBufferExtension.read_u8(@ptr) & 0xff; end
+ 
+   # Read a single 8-bit signed integer from the {ByteBuffer}.
+   # @return [Integer] the read value.
+-  def read_i8; ByteBufferExtension.read_i8(@ptr); end
++  def read_i8
++    v=ByteBufferExtension.read_i8(@ptr)
++    (v&(0xff/2))-(v&(0xff/2+1))
++  end
+ 
+   # Read a single 16-bit unsigned integer from the {ByteBuffer}.
+   # @return [Integer] the read value.
+@@ -190,7 +193,10 @@
+ 
+   # Read a single 16-bit signed integer from the {ByteBuffer}.
+   # @return [Integer] the read value.
+-  def read_i16; ByteBufferExtension.read_i16(@ptr); end
++  def read_i16
++    v=ByteBufferExtension.read_i16(@ptr)
++    (v&(0xffff/2))-(v&(0xffff/2+1))
++  end
+ 
+   # Read a single 32-bit unsigned integer from the {ByteBuffer}.
+   # @return [Integer] the read value.

data/lib/bytebuffer/version.rb

@@ -1,5 +1,5 @@
 class ByteBuffer
   # @!attribute [r] VERSION
   # @return [Integer] version number of the library
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

data/lib/bytebuffer.rb

@@ -5,7 +5,11 @@ require_relative 'bytebuffer/version'
 module ByteBufferExtension
   extend FFI::Library
 
-  ffi_lib("ext/libext.#{FFI::Platform::LIBSUFFIX}")
+  case FFI::Platform::OS
+  when 'linux' then ffi_lib ["#{File.dirname(__FILE__)}/bytebuffer.so"]
+  when 'darwin' then ffi_lib ["#{File.dirname(__FILE__)}/bytebuffer.bundle"]
+  else ffi_lib ["#{File.dirname(__FILE__)}/bytebuffer.so"]
+  end
 
   attach_function(:new, :new, [], :pointer)
   attach_function(:from_bytes, :from_bytes, [:pointer, :int], :pointer)
@@ -173,11 +177,14 @@ class ByteBuffer
 
   # Read a single 8-bit unsigned integer from the {ByteBuffer}.
   # @return [Integer] the read value.
-  def read_u8; ByteBufferExtension.read_u8(@ptr); end
+  def read_u8; ByteBufferExtension.read_u8(@ptr) & 0xff; end
 
   # Read a single 8-bit signed integer from the {ByteBuffer}.
   # @return [Integer] the read value.
-  def read_i8; ByteBufferExtension.read_i8(@ptr); end
+  def read_i8
+    v=ByteBufferExtension.read_i8(@ptr)
+    (v&(0xff/2))-(v&(0xff/2+1))
+  end
 
   # Read a single 16-bit unsigned integer from the {ByteBuffer}.
   # @return [Integer] the read value.
@@ -185,7 +192,10 @@ class ByteBuffer
 
   # Read a single 16-bit signed integer from the {ByteBuffer}.
   # @return [Integer] the read value.
-  def read_i16; ByteBufferExtension.read_i16(@ptr); end
+  def read_i16
+    v=ByteBufferExtension.read_i16(@ptr)
+    (v&(0xffff/2))-(v&(0xffff/2+1))
+  end
 
   # Read a single 32-bit unsigned integer from the {ByteBuffer}.
   # @return [Integer] the read value.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bytebuffer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Patrick W.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,28 +84,32 @@ description: A gem that provides a ByteBuffer class based on the bytebuffer rust
 email: Sickday@pm.me
 executables: []
 extensions:
-- ext/extconf.rb
+- ext/bytebuffer/extconf.rb
 extra_rdoc_files: []
 files:
 - ".github/workflows/pages.yml"
 - ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
+- Cargo.lock
+- Cargo.toml
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bytebuffer.gemspec
-- ext/Cargo.lock
-- ext/Cargo.toml
-- ext/Makefile
-- ext/extconf.rb
-- ext/src/lib.rs
+- ext/bytebuffer/Cargo.toml
+- ext/bytebuffer/extconf.rb
+- ext/bytebuffer/src/lib.rs
 - lib/bytebuffer.rb
+- lib/bytebuffer/patch/linux/bytebuffer-read_i8-read_i16-1721497558.patch
 - lib/bytebuffer/version.rb
-homepage: 
+homepage: https://github.com/sickday/bytebuffer-rb
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/sickday/bytebuffer-rb
+  documentation_uri: https://sickday.github.io/bytebuffer-rb/
 post_install_message: 
 rdoc_options: []
 require_paths:

data/ext/Makefile

@@ -1,57 +0,0 @@
-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

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