blake3ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b557aeaacfec5d4f45874dd7549de7a5ccf6b549738636e7288353451feaf9f7
-  data.tar.gz: 685492fae6050a4c0742a6cd56d66b88e1b6a9f7698a739c77bee387193574fb
+  metadata.gz: 446ad17adfad2f4096491ae74ff7f4a986f7bf4e1534248408435862ae2b5037
+  data.tar.gz: 85878e5c2e3e09bfc4b0412c05f62a428cd40b7c0f31906293dfede7ce7408d4
 SHA512:
-  metadata.gz: 31514a49570361b158dece950616e4c4b3f3ff24fdfb83e46585009366a2cbb732c12638b1bbd193309723a6899c4e37a610c52efc4b5f949082472a72537ae2
-  data.tar.gz: 4815f135a982a0e747ffb020d44252c2162d2f6c19c27d8bd34af007959f3c686151afee98e810bb34ab60b31dc66e11c6085af08b9bcb0a78086b4d100c8ca4
+  metadata.gz: 96a54200ac5a1c584e73960130818c1428b698349053bf3f7c8ca5368fe54b29b824177d5d48cfa52177b9c0dd8ae7976ea78d5ff0e2f3d6e2f03c16e0f7f98d
+  data.tar.gz: 29a7a9a19dd9edc7083a57ac79a9f66b0b454f2414a5f26b7897bf4773615b68fe5d50d7cedd200b6eaa5bba987be5ab4f2d9d4067ab4c3c9cff0e51860c23a2

data/.rubocop.yml

@@ -1,4 +1,9 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 3.0
 
 Style/StringLiterals:

data/Cargo.lock

@@ -45,9 +45,9 @@ dependencies = [
 
 [[package]]
 name = "bitflags"
-version = "2.5.0"
+version = "2.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf4b9d6a944f767f8e5e0db018570623c85f3d925ac718db4e06d0187adb21c1"
+checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
 
 [[package]]
 name = "blake3"
@@ -64,7 +64,7 @@ dependencies = [
 
 [[package]]
 name = "blake3ruby"
-version = "0.1.1"
+version = "0.2.0"
 dependencies = [
  "blake3",
  "hex",
@@ -73,9 +73,9 @@ dependencies = [
 
 [[package]]
 name = "cc"
-version = "1.0.96"
+version = "1.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "065a29261d53ba54260972629f9ca6bffa69bac13cd1fed61420f7fa68b9f8bd"
+checksum = "74b6a57f98764a267ff415d50a25e6e166f3831a5071af4995296ea97d210490"
 
 [[package]]
 name = "cexpr"
@@ -94,9 +94,9 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
 [[package]]
 name = "clang-sys"
-version = "1.7.0"
+version = "1.8.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "67523a3b4be3ce1989d607a828d036249522dd9c1c8de7f4dd2dae43a37369d1"
+checksum = "0b023947811758c97c59bf9d1c188fd619ad4718dcaa767947df1cadb14f39f4"
 dependencies = [
  "glob",
  "libc",
@@ -111,9 +111,9 @@ checksum = "f7144d30dcf0fafbce74250a3963025d8d52177934239851c917d29f1df280c2"
 
 [[package]]
 name = "either"
-version = "1.11.0"
+version = "1.13.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a47c1c47d2f5964e29c61246e81db715514cd532db6b5116a25ea3c03d6780a2"
+checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0"
 
 [[package]]
 name = "glob"
@@ -138,9 +138,9 @@ dependencies = [
 
 [[package]]
 name = "lazy_static"
-version = "1.4.0"
+version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "lazycell"
@@ -150,15 +150,15 @@ checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
 
 [[package]]
 name = "libc"
-version = "0.2.154"
+version = "0.2.155"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ae743338b92ff9146ce83992f766a31066a91a8c84a45e0e9f21e7cf6de6d346"
+checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c"
 
 [[package]]
 name = "libloading"
-version = "0.8.3"
+version = "0.8.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0c2a198fb6b0eada2a8df47933734e6d35d350665a33a3593d7164fa52c75c19"
+checksum = "e310b3a6b5907f99202fcdb4960ff45b93735d7c7d96b760fcff8db2dc0e103d"
 dependencies = [
  "cfg-if",
  "windows-targets",
@@ -166,9 +166,9 @@ dependencies = [
 
 [[package]]
 name = "magnus"
-version = "0.6.4"
+version = "0.7.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1597ef40aa8c36be098249e82c9a20cf7199278ac1c1a1a995eeead6a184479"
+checksum = "3d87ae53030f3a22e83879e666cb94e58a7bdf31706878a0ba48752994146dab"
 dependencies = [
  "magnus-macros",
  "rb-sys",
@@ -189,9 +189,9 @@ dependencies = [
 
 [[package]]
 name = "memchr"
-version = "2.7.2"
+version = "2.7.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d"
+checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
 
 [[package]]
 name = "minimal-lexical"
@@ -211,9 +211,9 @@ dependencies = [
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.81"
+version = "1.0.86"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3d1597b0c024618f09a9c3b8655b7e430397a36d23fdafec26d6965e9eec3eba"
+checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77"
 dependencies = [
  "unicode-ident",
 ]
@@ -259,9 +259,9 @@ checksum = "a35802679f07360454b418a5d1735c89716bde01d35b1560fc953c1415a0b3bb"
 
 [[package]]
 name = "regex"
-version = "1.10.4"
+version = "1.10.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c117dbdfde9c8308975b6a18d71f3f385c89461f7b3fb054288ecf2a2058ba4c"
+checksum = "b91213439dad192326a0d7c6ee3955910425f441d7038e0d6933b0aec5c4517f"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -271,9 +271,9 @@ dependencies = [
 
 [[package]]
 name = "regex-automata"
-version = "0.4.6"
+version = "0.4.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "86b83b8b9847f9bf95ef68afb0b8e6cdb80f498442f5179a29fad448fcc1eaea"
+checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -282,9 +282,9 @@ dependencies = [
 
 [[package]]
 name = "regex-syntax"
-version = "0.8.3"
+version = "0.8.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56"
+checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b"
 
 [[package]]
 name = "rustc-hash"
@@ -312,9 +312,9 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "syn"
-version = "2.0.60"
+version = "2.0.68"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "909518bc7b1c9b779f1bbf07f2929d35af9f0f37e47c6e9ef7f9dddc1e1821f3"
+checksum = "901fa70d88b9d6c98022e23b4136f9f3e54e4662c3bc1bd1d84a42a9a0f0c1e9"
 dependencies = [
  "proc-macro2",
  "quote",

data/Gemfile

@@ -5,11 +5,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in blake3ruby.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rake-compiler"
 gem "rb_sys"
 
-gem "rspec", "~> 3.0"
+group :development do
+  gem "rake", "~> 13.0"
+  gem "rake-compiler"
+end
 
-gem "rubocop", "~> 1.21"
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.21"
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blake3ruby (0.1.1)
+    blake3ruby (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -49,12 +49,23 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS
-  x86_64-darwin-21
+  aarch64-linux
+  aarch64-linux-musl
+  arm-linux
+  arm64-darwin
+  ruby
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-musl
 
 DEPENDENCIES
   blake3ruby!
@@ -63,6 +74,8 @@ DEPENDENCIES
   rb_sys
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.5.13

data/README.md

@@ -5,7 +5,7 @@
 This is a Ruby wrapper for the [BLAKE3](https://github.com/BLAKE3-team/BLAKE3) hash function written in Rust.
 
 ## Requirements
-Tested on Ruby 3.1 and 3.2.
+Tested on Ruby 3.1, 3.2 and 3.3.
 You will need to have Rust installed on your system, and the `cargo` command available in your path.
 See [here](https://www.rust-lang.org/tools/install) for instructions on how to install Rust.
 Rust is only required to build the gem, not to use it.
@@ -36,7 +36,7 @@ Basic usage is similar to the `Digest` class in the Ruby standard library:
 ```ruby
 require 'blake3ruby'
 
-Blake3ruby.hexdigest("Hello, world!") # => "ede5c0b10f2ec4979c69b52f61e42ff5b413519ce09be0f14d098dcfe5f6f98d"
+Digest::Blake3.hexdigest("Hello, world!") # => "ede5c0b10f2ec4979c69b52f61e42ff5b413519ce09be0f14d098dcfe5f6f98d"
 ```
 
 If you want to use the streaming interface, you can use the `Blake3ruby::Hasher` class:
@@ -44,8 +44,8 @@ If you want to use the streaming interface, you can use the `Blake3ruby::Hasher`
 ```ruby
 require 'blake3ruby'
 
-hasher = Blake3ruby::Hasher.new
-hasher.update("Hello, ") # => #<Blake3ruby::Hasher:0x00007f9b0a0b0e00> - returns self
+hasher = Digest::Blake3::Hasher.new
+hasher.update("Hello, ") # => #<Digest::Blake3::Hasher:0x00000001066f59a8> - returns self
 hasher.update("world!")
 hasher.finalize # => "ede5c0b10f2ec4979c69b52f61e42ff5b413519ce09be0f14d098dcfe5f6f98d"
 ```
@@ -60,9 +60,13 @@ The derive_key mode takes a context string and some key material (not a password
 ```ruby
 require 'blake3ruby'
 
-Blake3ruby.derive_key("context", "input_key_material") # => "3eaa9796d6d3db5cd5de00d44e4888fccbf4f8c878dd6ccd0c374bded6c26405"
+Digest::Blake3.derive_key("context", "input_key_material") # => "3eaa9796d6d3db5cd5de00d44e4888fccbf4f8c878dd6ccd0c374bded6c26405"
 ```
 
+## Breaking Changes in Version 0.2.0
+
+In versions 0.1.0 and 0.1.1, the Blake3ruby namespace was available. Starting from version 0.2.0, the Blake3 crypto digest has been moved to the Digest namespace where all standard Ruby digests are available. This change ensures consistency and better integration with the Ruby standard library.
+
 ## Performance
 
 The performance of this gem is comparable to the performance of the [blake3](https://github.com/BLAKE3-team/BLAKE3)
@@ -70,14 +74,53 @@ crate, which is written in Rust.
 
 The following benchmark was run on a 2015 MacBook Pro with a 2.5 GHz 4-Core Intel Core i7 processor and 16 GB of RAM.    
  ```
-               user     system      total        real
-MD5:       6.376103   0.028610   6.404713 (  6.492484)
-SHA1:      5.701825   0.014154   5.715979 (  5.721241)
-SHA3-256:  6.081136   0.014625   6.095761 (  6.102179)
-SHA3-384:  6.757476   0.013765   6.771241 (  6.778101)
-SHA3-512:  6.890564   0.014625   6.905189 (  6.909914)
-RMD160:    6.196825   0.031562   6.228387 (  6.293669)
-blake3:    2.527779   0.006833   2.534612 (  2.536978)
+MD5 (13 chars):        6.141045   0.086745   6.227790 (  6.263524)
+SHA1 (13 chars):       6.230957   0.080145   6.311102 (  6.333384)
+SHA3-256 (13 chars):   6.364485   0.093261   6.457746 (  6.491053)
+SHA3-384 (13 chars):   7.068870   0.151501   7.220371 (  7.246571)
+SHA3-512 (13 chars):   7.265794   0.152058   7.417852 (  7.443591)
+RMD160 (13 chars):     5.547123   0.075290   5.622413 (  5.642165)
+blake3 (13 chars):     2.747356   0.014433   2.761789 (  2.772582)
+
+For message length 13 chars:
+Fastest: blake3 with 2.7725820001214743 seconds
+Slowest: SHA3-512 with 7.44359099981375 seconds
+                           user     system      total        real
+MD5 (44 chars):        5.861548   0.074899   5.936447 (  5.959032)
+SHA1 (44 chars):       5.944156   0.072394   6.016550 (  6.038251)
+SHA3-256 (44 chars):   6.446754   0.096381   6.543135 (  6.570512)
+SHA3-384 (44 chars):   7.083944   0.156259   7.240203 (  7.268630)
+SHA3-512 (44 chars):   7.213243   0.154452   7.367695 (  7.396536)
+RMD160 (44 chars):     5.589189   0.075830   5.665019 (  5.689458)
+blake3 (44 chars):     2.754475   0.014872   2.769347 (  2.780263)
+
+For message length 44 chars:
+Fastest: blake3 with 2.7802629999350756 seconds
+Slowest: SHA3-512 with 7.396536000072956 seconds
+                           user     system      total        real
+MD5 (199 chars):       8.079411   0.088239   8.167650 (  8.201427)
+SHA1 (199 chars):      7.792639   0.082953   7.875592 (  7.904909)
+SHA3-256 (199 chars):  9.508372   0.106791   9.615163 (  9.648153)
+SHA3-384 (199 chars):  8.291785   0.160924   8.452709 (  8.483978)
+SHA3-512 (199 chars):  8.396180   0.160054   8.556234 (  8.590455)
+RMD160 (199 chars):    8.910650   0.087215   8.997865 (  9.028016)
+blake3 (199 chars):    3.796439   0.018845   3.815284 (  3.829479)
+
+For message length 199 chars:
+Fastest: blake3 with 3.8294790000654757 seconds
+Slowest: SHA3-256 with 9.648153000045568 seconds
+                           user     system      total        real
+MD5 (1024 chars):     15.504161   0.114951  15.619112 ( 15.671606)
+SHA1 (1024 chars):    13.007605   0.105566  13.113171 ( 13.163242)
+SHA3-256 (1024 chars): 20.968764   0.162367  21.131131 ( 21.212766)
+SHA3-384 (1024 chars): 17.255475   0.300950  17.556425 ( 17.728562)
+SHA3-512 (1024 chars): 17.697881   0.400774  18.098655 ( 18.404827)
+RMD160 (1024 chars):  23.639904   0.458113  24.098017 ( 24.535302)
+blake3 (1024 chars):   8.123303   0.178863   8.302166 (  8.499843)
+
+For message length 1024 chars:
+Fastest: blake3 with 8.499842999968678 seconds
+Slowest: RMD160 with 24.535302000120282 seconds
 ```
 
 Another benchmark was run on a 2022 MacBook Pro with a Apple M1 processor and 16 GB of RAM.    

data/Rakefile

@@ -11,6 +11,7 @@ RuboCop::RakeTask.new
 
 require "rake/extensiontask"
 
+desc "Compile the Rust source code for the Blake3ruby extension"
 task build: :compile
 
 Rake::ExtensionTask.new("blake3ruby") do |ext|

data/blake3ruby.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Nightforge/blake3ruby"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/ext/blake3ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "blake3ruby"
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 authors = ["Nightforge <modo00@gmail.com>"]
 publish = false
@@ -9,7 +9,7 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
-magnus = { version = "0.6.4" }
+magnus = { version = "0.7.1" }
 hex = { version = "0.4.3" }
 blake3 = { version = "1.5.1" }
 

data/ext/blake3ruby/src/lib.rs

@@ -1,8 +1,8 @@
-use magnus::{define_module, define_class, class, function, method, prelude::*, Error};
+use magnus::{define_module, class, function, method, prelude::*, Error};
 
 fn hexdigest(subject: String) -> String {
     let hash = blake3::hash(subject.as_bytes());
-    return hash.to_string()
+    return hash.to_string();
 }
 
 fn derive_key(context: String, key: String) -> String {
@@ -15,7 +15,7 @@ struct Hasher {
     hasher: blake3::Hasher,
 }
 
-#[magnus::wrap(class = "Hasher")]
+#[magnus::wrap(class = "Digest::Blake3::Hasher")]
 struct MutHasher(std::cell::RefCell<Hasher>);
 
 impl MutHasher {
@@ -28,26 +28,27 @@ impl MutHasher {
 
     fn update(&self, subject: String) -> Self {
         self.0.borrow_mut().hasher.update(subject.as_bytes());
-        return Self(self.0.clone())
+        return Self(self.0.clone());
     }
 
     fn finalize(&self) -> String {
         let hash = self.0.borrow().hasher.finalize();
-        return hash.to_string()
+        return hash.to_string();
     }
 }
 
 #[magnus::init]
 fn init() -> Result<(), Error> {
-    let blake3ruby = define_module("Blake3ruby")?;
-    blake3ruby.define_singleton_method("hexdigest", function!(hexdigest, 1))?;
-    blake3ruby.define_singleton_method("derive_key", function!(derive_key, 2))?;
+    let digest = define_module("Digest")?;
+    let blake3 = digest.define_module("Blake3")?;
+    
+    blake3.define_singleton_method("hexdigest", function!(hexdigest, 1))?;
+    blake3.define_singleton_method("derive_key", function!(derive_key, 2))?;
 
-    let class = define_class("Hasher", class::object())?;
+    let class = blake3.define_class("Hasher", class::object())?;
     class.define_singleton_method("new", function!(MutHasher::new, 0))?;
     class.define_method("update", method!(MutHasher::update, 1))?;
     class.define_method("finalize", method!(MutHasher::finalize, 0))?;
 
-    blake3ruby.define_class("Hasher", class)?;
     Ok(())
 }

data/lib/blake3ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blake3ruby
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/sig/blake3ruby.rbs

@@ -1,4 +1,16 @@
 module Blake3ruby
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end
+
+module Digest
+  module Blake3
+    def self.hexdigest(subject: String) -> String
+    def self.derive_key(context: String, key: String) -> String
+
+    class Hasher
+      def self.new: () -> Digest::Blake3::Hasher
+      def update: (subject: String) -> Digest::Blake3::Hasher
+      def finalize: () -> String
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blake3ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nightforge
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-30 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for the blake3 hash function using the Rust implementation
 email:
@@ -42,6 +42,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Nightforge/blake3ruby
   source_code_uri: https://github.com/Nightforge/blake3ruby
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: