vox-etf 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814a39714371d1d129be3606ee5f4f00045c6f6a35fdbcae83bec672cec55d33
-  data.tar.gz: f2cd32adb4fa957dd6bf692babe956f7f8569251bac15658ae1445d476c342d3
+  metadata.gz: 4435ae55a1631c64aa810ea8f6f0beb899f1e3363498f36cd13b2cd661704a97
+  data.tar.gz: 23df68f172a4d60529e72b40d02c74fbe96a342bacf534aad606047c54543167
 SHA512:
-  metadata.gz: 7fc627a3904d13c023aa85092010b11ea4a281a2ca93992c39a1e13293b9d1768362a12114c6cefa6c9afae1075bc1902fbcee337f3a8a852ec8fbe75754a5b7
-  data.tar.gz: d26faa973c98490470b43735e5f45c0dbe53759499def683ac6d80fd662af94e158951702014ca6a55bafed2f2a2839226b5b67709d28a9f2adfc62a09d3f807
+  metadata.gz: ca076026d2625686aa7f8f6428ff33a6a7b40571eecb68478ed4684883658854e749e123053544d1861f9bff13b9c8f7d310047afa95ad70ed059036a1b0e4a3
+  data.tar.gz: b708e0871cfae5fb34b74f28024e607684ca386eaf0bc9c9ec9d668a900ab7b3e89f3d2a1b101d4b7fffd3dc870f91c4fb1b11101b01d6ac4e40d0de1b856998

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());
         }
@@ -156,7 +183,7 @@ namespace etf
             VALUE array = decode_array(length);
             const uint8_t tail = read8();
 
-            if (tail != term::nil)
+            if (tail != NIL_EXT)
             {
                 rb_raise(rb_eArgError, "List doesn't end with `NIL`, but it must!");
                 return Qnil;
@@ -278,7 +305,7 @@ namespace etf
             const uint8_t sign = read8();
             const char *buff = read_string(length);
 
-            auto flags = INTEGER_PACK_LITTLE_ENDIAN | (sign * INTEGER_PACK_NEGATIVE);
+            int flags = INTEGER_PACK_LITTLE_ENDIAN | (sign * INTEGER_PACK_NEGATIVE);
             return rb_integer_unpack(buff, length, 1, 0, flags);
         }
 

data/ext/vox/encoder.hpp

@@ -1,5 +1,7 @@
 #include "erlpack/encoder.h"
+#include "erlpack/constants.h"
 #include "etf.hpp"
+#include "ruby.h"
 
 namespace etf
 {
@@ -56,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);
         }
@@ -101,7 +113,7 @@ namespace etf
             {
                 // id byte | n byte | sign byte | data
                 uint8_t buff[3 + byte_count];
-                buff[0] = term::small_big;
+                buff[0] = SMALL_BIG_EXT;
                 buff[1] = byte_count;
                 buff[2] = FIX2LONG(bignum) >= 0 ? 0 : 1;
                 rb_integer_pack(bignum, buff + 3, byte_count, sizeof(uint8_t), 0, INTEGER_PACK_LITTLE_ENDIAN);
@@ -111,7 +123,7 @@ namespace etf
             {
                 // id byte | 4 byte n | sign byte | data
                 uint8_t buff[6 + byte_count];
-                buff[0] = term::large_big;
+                buff[0] = LARGE_BIG_EXT;
                 _erlpack_store32(buff + 1, byte_count);
                 buff[5] = RBIGNUM_SIGN(bignum) ? 0 : 1;
                 rb_integer_pack(bignum, buff + 6, byte_count, sizeof(uint8_t), 0, INTEGER_PACK_LITTLE_ENDIAN);
@@ -126,18 +138,25 @@ namespace etf
 
         void encode_array(VALUE array)
         {
-            erlpack_append_list_header(erl_buff, RARRAY_LEN(array));
             uint32_t size = RARRAY_LEN(array);
+            if (size == 0)
+            {
+                erlpack_append_nil_ext(erl_buff);
+                return;
+            }
+
+            erlpack_append_list_header(erl_buff, size);
             for (uint32_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)
@@ -154,6 +173,7 @@ namespace etf
             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/etf.hpp

@@ -2,42 +2,6 @@
 
 #define ETF_VERSION 131
 
-// Term IDs, first byte of any term.
-enum term
-{
-    new_float = 70,
-    bit_binary = 77,
-    atom_cache = 82,
-    new_pid = 88,
-    new_port = 89,
-    newer_reference = 90,
-    small_integer = 97,
-    integer = 98,
-    // annoying
-    etf_float = 99,
-    atom = 100,
-    reference = 101,
-    port = 102,
-    pid = 103,
-    small_tuple = 104,
-    large_tuple = 105,
-    nil = 106,
-    string = 107,
-    list = 108,
-    binary = 109,
-    small_big = 110,
-    large_big = 111,
-    new_fun = 112,
-    // annoying
-    etf_export = 113,
-    new_reference = 114,
-    small_atom = 115,
-    map = 116,
-    fun = 117,
-    atom_utf8 = 118,
-    small_atom_utf8 = 119
-};
-
 VALUE decode(VALUE self, VALUE input);
 VALUE encode(VALUE self, VALUE input);
 

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.1'
+    # @!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.6'
   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.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Matthew Carey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-12 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
@@ -160,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ETF decoding/encoding for vox.