tinybits 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ab487694dc35eabde1bebda52a2726074ab6c80ef84ce2c845141c9732283c
-  data.tar.gz: 5c3b2c2eb52a15fb5e32d54c37d705fd41c9ec4759464519c599f83f517b9e2b
+  metadata.gz: 579aa574466ff4f72f4e9fa59940d3d14fc773404cb73296b2b1498551da6d2f
+  data.tar.gz: 5edf98872ab8d59a3868b0dc6e3b05271d8dbdba7664afc039ca219820a7b247
 SHA512:
-  metadata.gz: 65fd3c3a22a67d8a1a6a218644d4ed82171386202de0b09ce86c285501852cf40c71690820defbf811be66db29da6346d9e933878027377e1ac0c680c08cdf60
-  data.tar.gz: 6d389ea71dac6c417956d98dfe545f3baa015f2947ce968d9f8ec2f0dbe62ffdd5f841fb789658b00a69fe7975b8ed7788b1747a2867440fee10f0c19b05c243
+  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/test_date.rb

@@ -7,19 +7,30 @@ t = [Time.now, nil, true, false]
 
 
 
-
+=begin
 puts packer.dump(t).bytesize
 
 puts t
 puts t2 = unpacker.unpack(packer.pack(t))
 puts t == t2
-
+=end
+
+class User
+  def initialize(name:, title:)
+    @name = name
+    @title = title
+  end
+  
+  def to_tinybits
+    {"name" => @name, "title" => @title}
+  end
+end
 
 objects = [{"abc": 123}, {"abc": [1, 2, "abc"]}, ["xyz", "abc", "xyz", 7.6] ]
 
 puts "----------------"
 
-packer.reset
+#packer.reset
 
 objects.each do |obj|
   puts packer << obj
@@ -31,7 +42,21 @@ puts buffer.bytesize
 
 unpacker.buffer = buffer
 
+
 while(value = unpacker.pop)
   pp value
   puts "+++++++++++++++++++++++++"
 end
+
+packer.reset
+
+user = User.new(name: "Mohamed", title: "Father")
+
+data = { "user" => user, "tags" => ["user", "Father"] }
+
+pp user
+pp user.to_tinybits
+packed = packer.pack(data)
+puts packed.bytesize
+pp unpacker.unpack(packed)
+

data/ext/tinybits/tinybits.h

@@ -1,6 +1,6 @@
 /**
  * TinyBits Amalgamated Header
- * Generated on: Sat May  3 09:20:46 PM 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] << 8) | (unsigned char)str[len-1]);
+    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;
@@ -1052,7 +1055,7 @@ static inline enum tiny_bits_type _unpack_str(tiny_bits_unpacker *decoder, uint8
         }
         value->str_blob_val.id = 0;
         // Handle new string (not deduplicated)
-        if(decoder->strings_count < TB_HASH_CACHE_SIZE){
+        if(decoder->strings_count < TB_HASH_CACHE_SIZE && len >= 2 && len <= 128){
             if (decoder->strings_count >= decoder->strings_size) {
                 size_t new_size = decoder->strings_size * 2;
                 void *new_strings = realloc(decoder->strings, new_size * sizeof(*decoder->strings));

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);
@@ -131,13 +153,27 @@ static inline int pack_ruby_object_recursive(tiny_bits_packer* packer, VALUE obj
                 double unixtime = NUM2DBL(rb_funcall(obj, rb_intern("to_f"), 0));
                 return pack_datetime(packer, unixtime, FIX2INT(rb_time_utc_offset(obj)));    
             }
+            if(rb_respond_to(obj, rb_intern("to_tinybits"))){
+                VALUE custom_obj = rb_funcall(obj, rb_intern("to_tinybits"), 0);
+                return pack_ruby_object_recursive(packer, custom_obj, context);
+            }
             //printf("Unsupported type encountered during packing: %s", rb_obj_classname(obj));
             rb_warn("Unsupported type encountered during packing: %s", rb_obj_classname(obj));
             return 0;
     }
 }
 
-// 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);
@@ -165,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);
@@ -195,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.2.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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tinybits
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mohamed Hassan
 bindir: bin
 cert_chain: []
-date: 2025-05-03 00:00:00.000000000 Z
+date: 2025-05-04 00:00:00.000000000 Z
 dependencies: []
 description: TinyBits is a Ruby gem that wraps the TinyBits C serializartion library,
   offering Rubyists the power of serializion with intger/float compression and string