vox-etf 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3946973c5609f6a44d6f1bc0ea10d3f5ed7095dd0009ddaaa64593c90de538
-  data.tar.gz: 6e50761784880810734201a0d6e4684c2def7b6f4e7de0464ac8e42491768a12
+  metadata.gz: 5a6a2cc3e5abff452aed1b87b83f3c9906fa673cdac9251b92051492d7de0ff2
+  data.tar.gz: 2caddaa1b5163345f676d9649c624e9ec2580e770d32dddecd2325800e9845d0
 SHA512:
-  metadata.gz: 111a3cc908087690d58e0ac939c3b3d1576d05bfc50fdb457e55eaa0ee54b71f1ae29bfb804e234c98bae047c8809803f5268ab1fddb5808cfff81ed5a492007
-  data.tar.gz: c176eb3b67e1d83d6972eb50e5263f57286a37c1093b47ad3c92f3513f4e1c2902ec4b218dce4e813f004cd4e6d8e8917cdef223f40d1650db4e115c78a85fb6
+  metadata.gz: 56ff3b112058ec393869a0532905bad5f27adcd533a7427cacea86ffdbae49b261ca4a258dc33683af52bf0bce0c44fb6554a08b11d99a6c2a1c3862deb1ae8c
+  data.tar.gz: 96482eb0de9485c5938724b8d06d136028907ec99270a0bf46239d33b6313b1ad7207df021206099c11528f3dcbde8faeabdf0ba18f4cb007dad9061dc01f21c

data/ext/vox/decoder.hpp

@@ -4,6 +4,33 @@
 #include "erlpack/sysdep.h"
 #include "erlpack/constants.h"
 
+/* This code is highly derivative of discord's erlpack decoder
+ * targeting Javascript.
+ * 
+ * 
+ *   MIT License
+ *
+ *    Copyright (c) 2017 Discord
+ *
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *   of this software and associated documentation files (the "Software"), to deal
+ *   in the Software without restriction, including without limitation the rights
+ *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *   copies of the Software, and to permit persons to whom the Software is
+ *   furnished to do so, subject to the following conditions:
+ *
+ *   The above copyright notice and this permission notice shall be included in all
+ *   copies or substantial portions of the Software.
+ *
+ *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *   SOFTWARE.
+ */
+
 namespace etf
 {
     class decoder
@@ -131,12 +158,12 @@ namespace etf
             return val;
         }
 
-        VALUE decode_small_integer(void)
+        VALUE decode_small_integer()
         {
             return INT2FIX(read8());
         }
 
-        VALUE decode_integer(void)
+        VALUE decode_integer()
         {
             return INT2NUM(read32());
         }
@@ -335,9 +362,9 @@ namespace etf
         {
             const uint32_t decompressed_size = read32();
 
-            uint64_t source_size = decompressed_size;
+            unsigned long source_size = decompressed_size;
             uint8_t *out_buffer = (uint8_t *)malloc(decompressed_size);
-            const int ret = uncompress(out_buffer, &source_size, (const unsigned char *)(data + offset), (uint64_t)(size - offset));
+            const int ret = uncompress(out_buffer, &source_size, (const unsigned char *)(data + offset), (uLong)(size - offset));
 
             offset += source_size;
             if (ret != Z_OK)

data/ext/vox/encoder.hpp

@@ -1,6 +1,7 @@
 #include "erlpack/encoder.h"
 #include "erlpack/constants.h"
 #include "etf.hpp"
+#include "ruby.h"
 
 namespace etf
 {
@@ -57,13 +58,23 @@ namespace etf
                 encode_hash(input);
                 break;
             default:
-                rb_raise(rb_eArgError, "Unsupported serialization type");
+                if (rb_respond_to(input, rb_intern("to_hash")))
+                {
+                    VALUE hash = rb_funcall(input, rb_intern("to_hash"), 0);
+                    Check_Type(hash, T_HASH);
+                    encode_hash(hash);
+                }
+                else
+                {
+                    rb_raise(rb_eArgError, "Unsupported serialization type");
+                }
+
                 break;
             }
         }
 
         VALUE
-        r_string(void)
+        r_string()
         {
             return rb_str_new(erl_buff->buf, erl_buff->length);
         }
@@ -88,11 +99,11 @@ namespace etf
 
         void encode_fixnum(VALUE fixnum)
         {
-            long l = FIX2LONG(fixnum);
-            if (l > 0 && l <= 0xFF)
-                erlpack_append_small_integer(erl_buff, (unsigned char)l);
+            uint32_t n = NUM2UINT(fixnum);
+            if (n > 0 && n <= UINT8_MAX)
+                erlpack_append_small_integer(erl_buff, (uint8_t)n);
             else
-                erlpack_append_integer(erl_buff, l);
+                erlpack_append_integer(erl_buff, n);
         }
 
         void encode_bignum(VALUE bignum)
@@ -127,18 +138,30 @@ namespace etf
 
         void encode_array(VALUE array)
         {
-            erlpack_append_list_header(erl_buff, RARRAY_LEN(array));
-            uint32_t size = RARRAY_LEN(array);
-            for (uint32_t index = 0; index < size; index++)
+            uint64_t size = RARRAY_LEN(array);
+            if (size == 0)
+            {
+                erlpack_append_nil_ext(erl_buff);
+                return;
+            }
+            else if (size > UINT32_MAX)
+            {
+                rb_raise(rb_eRangeError, "Array size is too large to fit into a 32 bit integer.");
+                return;
+            }
+
+            erlpack_append_list_header(erl_buff, size);
+            for (size_t index = 0; index < size; index++)
             {
                 encode_object(RARRAY_AREF(array, index));
             }
+
+            erlpack_append_nil_ext(erl_buff);
         }
 
         void encode_symbol(VALUE symbol)
         {
-            VALUE str = rb_sym2str(symbol);
-            erlpack_append_atom_utf8(erl_buff, RSTRING_PTR(str), RSTRING_LEN(str));
+            encode_string(rb_sym2str(symbol));
         }
 
         void encode_string(VALUE string)
@@ -148,13 +171,20 @@ namespace etf
 
         void encode_hash(VALUE hash)
         {
-            uint32_t size = RHASH_SIZE(hash);
+            uint64_t size = RHASH_SIZE(hash);
+            if (size > UINT32_MAX)
+            {
+                rb_raise(rb_eRangeError, "Hash size is too large to fit into a 32 bit integer");
+                return;
+            }
+
             erlpack_append_map_header(erl_buff, size);
             VALUE keys = rb_funcall(hash, rb_intern("keys"), 0);
 
             for (uint32_t index = 0; index < size * 2; index += 2)
             {
                 VALUE key = RARRAY_AREF(keys, index / 2);
+                // Normalize keys to strings because discord
                 encode_object(key);
                 encode_object(rb_hash_aref(hash, key));
             }

data/ext/vox/etf.cpp

@@ -3,10 +3,6 @@
 #include "decoder.hpp"
 #include "etf.hpp"
 
-// Decode an ETF term from a ruby string
-// @param self [Object] Vox::ETF
-// @param input [Rice::String] The ETF term to be decoded.
-// @return [Rice::Object] Whatever the term is, as a ruby object.
 VALUE decode(VALUE self, VALUE input)
 {
     Check_Type(input, T_STRING);

data/ext/vox/extconf.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require('mkmf-rice')
+require('mkmf')
 
 find_header('ruby.h')
 find_header('zlib.h')

data/lib/vox/etf/version.rb

@@ -1,7 +1,26 @@
 # frozen_string_literal: true
 
+# Container for Vox components.
 module Vox
+  # Default ETF adapter for vox's gateway component.
   module ETF
-    VERSION = '0.1.2'
+    # @!parse [ruby]
+    #   # Encode an object to an ETF term. This method accepts, `Integer`, `Float`,
+    #   # `String`, `Symbol`, `Hash`, `Array`, `nil`, `true`, and `false` objects.
+    #   # It also allows any object that responds to `#to_hash => Hash`. 
+    #   # @param input [Object, #to_hash] The object to be encoded as an ETF term.
+    #   # @return [String] The ETF term encoded as a packed string.
+    #   def self.encode(input)
+    #   end
+    
+    # @!parse [ruby]
+    #   # Decode an ETF term from a string.
+    #   # @param input [String] The ETF term to be decoded.
+    #   # @return [Object] The ETF term decoded to an object.
+    #   def self.decode(input)
+    #   end
+
+    # Gem version
+    VERSION = '0.1.7'
   end
 end

data/vox-etf.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.extensions << 'ext/vox/extconf.rb'
 
-  spec.add_dependency 'rice', '~> 2.2.0'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rake-compiler', '~> 1.1.1'
   spec.add_development_dependency 'rspec', '~> 3.9.0'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vox-etf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Matthew Carey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rice
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement