tinybits 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340b92ea6c9e9782aa1b63c08c226d23bae56d1d5780dc46fb79f9c0a508b71b
-  data.tar.gz: 7fdeb074fe4a24e061834e1084702ee97827698eaa46f907b7b0a756b7ea05be
+  metadata.gz: 579aa574466ff4f72f4e9fa59940d3d14fc773404cb73296b2b1498551da6d2f
+  data.tar.gz: 5edf98872ab8d59a3868b0dc6e3b05271d8dbdba7664afc039ca219820a7b247
 SHA512:
-  metadata.gz: 0c286652db3de7817fbea5241f10221f666cc298121348dbe5718f9221c6d9ef4beed593d478851367b877bc3c66bbf1dcc359b4fb5997221790353bf1bbbcb9
-  data.tar.gz: 9b67f07cb2c1b656aa7dc843fd8441760473ba8047af09cc220508ed9e604889ab213b2f4c69855c4dbe9114190836b5603c898d0c3c4f8ce9b68b2dd77539c4
+  metadata.gz: 887b0b5c435cd7da039af2b370f680c5266c06cad1db665e54436f81a22172837495739c051ccea3050a446e055ca24a9198269a51bdb7005fec79d398c37758
+  data.tar.gz: 44c1cd7a40ccf330d8ca96a5c7203b6ce60c07c00c3580fe28440ef0b62c6c083ad4417143a52afce3ae0553eefbc7a9d9035e7011d13557f682704be6f5ad5d

data/ext/tinybits/extconf.rb

@@ -1,5 +1,6 @@
 require 'mkmf'
 
+$CFLAGS << " -O3 -march=native"
 
 dir_config('tinybits_ext')
 create_makefile('tinybits_ext')

data/ext/tinybits/tinybits.h

@@ -1,6 +1,6 @@
 /**
  * TinyBits Amalgamated Header
- * Generated on: Sun May  4 03:12:10 AM CEST 2025
+ * Generated on: Sun May  4 05:43:30 PM CEST 2025
  */
 
 #ifndef TINY_BITS_H
@@ -89,8 +89,11 @@ typedef struct HashTable {
 
 static inline uint32_t fast_hash_32(const char* str, uint16_t len) {
     uint32_t hash = len;
-    hash = (hash << 16) | (((unsigned char)str[0] << 8) | (unsigned char)str[1]);
-    hash ^= (((unsigned char)str[len-2] << 24) | ((unsigned char)str[len-1] << 16));
+    hash = (hash << 24) | 
+           ((unsigned char)str[0] << 16) | 
+           ((unsigned char)str[1] << 8 ) | 
+           ((unsigned char)str[len-1]);
+    //hash ^= (((unsigned char)str[len-2] << 24) | ((unsigned char)str[len-1] << 16));
     return hash;
 }
 
@@ -652,7 +655,7 @@ static inline int pack_str(tiny_bits_packer *encoder, char* str, uint32_t str_le
             HashEntry entry = encoder->encode_table.cache[index - 1];
             if (hash_code == entry.hash 
                 && str_len == entry.length
-                && (str_len <= 4 || (fast_memcmp(str, encoder->buffer + entry.offset, str_len) == 0) )) {
+                && fast_memcmp(str, encoder->buffer + entry.offset, str_len) == 0 ) {
                 id = index - 1;
                 found = 1;
                 break;

data/ext/tinybits/tinybits_ext.c

@@ -4,8 +4,23 @@
 #include "tinybits.h"
 
 // Ruby module and classes
+/*
+ * Document-module: TinyBits
+ *
+ * A Ruby extension for fast binary serialization and deserialization of Ruby objects.
+ */
 VALUE rb_mTinyBits;
+/*
+ * Document-class: TinyBits::Packer
+ *
+ * The Packer class handles serialization of Ruby objects to the TinyBits binary format.
+ */
 VALUE rb_cPacker;
+/*
+ * Document-class: TinyBits::Unpacker
+ *
+ * The Unpacker class handles deserialization of TinyBits binary format to Ruby objects.
+ */
 VALUE rb_cUnpacker;
 
 // Forward declarations
@@ -75,6 +90,13 @@ static VALUE rb_packer_alloc(VALUE klass) {
     return TypedData_Wrap_Struct(klass, &packer_data_type, packer_data);
 }
 
+/* 
+ * Document-method: initialize
+ *
+ * Initializes a new Packer object
+ *
+ * @return [Packer] The initialized packer object.
+ */
 static VALUE rb_packer_init(VALUE self) {
     PackerData* packer_data;
     TypedData_Get_Struct(self, PackerData, &packer_data_type, packer_data);
@@ -141,7 +163,17 @@ static inline int pack_ruby_object_recursive(tiny_bits_packer* packer, VALUE obj
     }
 }
 
-// keeps the public API the same.
+/*
+ * Document-method: pack
+ * 
+ * Packs a Ruby object into a binary string.
+ * Supports Ruby types: String, Array, Hash, Integer, Float, nil, true, false, Symbol, and Time.
+ * Objects can implement a `to_tinybits` method to provide custom serialization.
+ *
+ * @param obj [Object] The Ruby object to pack.
+ * @return [String] The packed binary string (frozen).
+ * @raise [RuntimeError] If packing fails due to unsupported types or other errors.
+ */
 static VALUE rb_pack(VALUE self, VALUE obj) {
     PackerData* packer_data;
     TypedData_Get_Struct(self, PackerData, &packer_data_type, packer_data);
@@ -169,6 +201,16 @@ static VALUE rb_pack(VALUE self, VALUE obj) {
     return result;
 }
 
+/*
+ * Document-method: push
+ *
+ * Appends a packed object to the current buffer.
+ * Inserts a separator when appending to non-empty buffer.
+ *
+ * @param obj [Object] The Ruby object to append.
+ * @return [Integer] The number of bytes added to the buffer.
+ * @raise [RuntimeError] If packing fails.
+ */
 static VALUE rb_push(VALUE self, VALUE obj) {
     PackerData* packer_data;
     TypedData_Get_Struct(self, PackerData, &packer_data_type, packer_data);
@@ -199,6 +241,13 @@ static VALUE rb_push(VALUE self, VALUE obj) {
     return INT2FIX(packer_data->packer->current_pos - initial_pos);
 }
 
+/*
+ * Document-method: to_s
+ *
+ * Returns the current packed buffer as a string.
+ *
+ * @return [String] The current packed buffer contents (frozen).
+ */
 static VALUE rb_to_s(VALUE self){
     PackerData* packer_data;
     TypedData_Get_Struct(self, PackerData, &packer_data_type, packer_data);

data/lib/tinybits/version.rb

@@ -1,3 +1,3 @@
 module TinyBits
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/tinybits.rb

@@ -2,6 +2,19 @@ require_relative './tinybits/version'
 require 'tinybits_ext'
 
 module TinyBits
+  # packs an object to a binary string
+  # @param obj [Object] The Ruby object to pack.
+  # @return [String] The packed binary string (frozen).
+  # @raise [RuntimeError] If packing fails due to unsupported types or other errors.
+  # this is a convinience interface, a better way is to instantiate a TinyBits::Packer
+  # object and use its #pack method
   def self.pack(object) = Packer.new.pack(object)
+
+  # unpacks an object from a binary string
+  # @param buffer [String] The Ruby string holding the packed buffer.
+  # @return [Object] The unpacked Ruby Object (all strings within the object will be frozen).
+  # @raise [RuntimeError] If unpacking fails due to unsupported types or malformed data.
+  # this is a convinience interface, a better way is to instantiate a TinyBits::Unpacker
+  # object and use its #unpack method
   def self.unpack(buffer) = Unpacker.new.unpack(buffer)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tinybits
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mohamed Hassan