vox-etf 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c4afc3d3f48eb9687bfc79372892ee356c7e9f4d70211c71ddedf0b59d4318
-  data.tar.gz: 2f1b5060659fc9a35fa8d0b1ee1f5665c5c37d4254864961c14ead7d07048b9b
+  metadata.gz: e3745f75f9a0e5ea20d7ad1706dd25ac300839caecc8bf1263842e8ff1439652
+  data.tar.gz: e1c7a531f1e24b2af0b29bd5fd691874c6c3db0a6023aa5988c550575c2baeec
 SHA512:
-  metadata.gz: 8fd31825a494ea4b863be1f3a5c252951598987cca09137f7eb8c71e62a01992011dfaff5c72f123845667ece12c96db6ab5663276d47f59b70d17cd3e9c2d06
-  data.tar.gz: de91811cddb61a4523cf66501c86893fe4e1c6dd16fd9ca07dd6984a06d64fce3bab2d8daa82050f67bb1b3ee8287fcd3cdc6282c23039f80d2a445bd8333e48
+  metadata.gz: 0ae99c55b1320297ba7e79449979d744491adf02622cfb1bd0c58cb0249354026866c1bbb9f198f31ea5d32605eafa8142bb112b30e479855881102d12870488
+  data.tar.gz: 55076b6cea67d53c7c6acedae4806979e3ff933d56b4786d9062cbf2b6c57a407b34f9605535091e449538d86cf38ba5b9b11834d55a0afbf959cd0d3461d2e0

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+lib/vox/etf.so
+Gemfile.lock

data/README.md

@@ -1,8 +1,4 @@
-# Vox::Etf
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/vox/etf`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# Vox::ETF
 
 ## Installation
 
@@ -22,17 +18,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use the encoder/decoder independently use the respective `#encode` and `#decode` methods.
+
+```ruby
+    require 'vox/etf'
+
+    p Vox::ETF.decode("\x83l\x00\x00\x00\x03a\x01a\x02a\x03j")
+    # => [1, 2, 3]
 
-## Development
+    p Vox::ETF.encode({foo: "bar"})
+    # => "\x83t\x00\x00\x00\x01w\x03foom\x00\x00\x00\x03bar"
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To use with the Vox gateway, add this gem to your Gemfile and provide `:etf` as the encoding option to `Vox::Gateway::Client#initialize`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vox-etf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/vox-etf/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/swarley/vox-etf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/swarley/vox-etf/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/Rakefile

@@ -11,4 +11,5 @@ Rake::ExtensionTask.new('etf') do |ext|
   ext.lib_dir = 'lib/vox'
 end
 
-task(default: :compile)
+task(default: :spec)
+task spec: ['compile']

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,12 +138,20 @@ 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)
@@ -154,7 +174,11 @@ namespace etf
             for (uint32_t index = 0; index < size * 2; index += 2)
             {
                 VALUE key = RARRAY_AREF(keys, index / 2);
-                encode_object(key);
+                // Normalize keys to strings because discord
+                if (TYPE(key) == T_SYMBOL)
+                    encode_object(rb_sym2str(key));
+                else
+                    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

@@ -1,57 +1,8 @@
 #pragma once
 
-#include "./etf_reader.hpp"
-
 #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);
-inline VALUE decode_small_tuple(etf_reader *reader);
-inline VALUE decode_large_tuple(etf_reader *reader);
-inline VALUE decode_map(etf_reader *reader);
-inline VALUE decode_list(etf_reader *reader);
-inline VALUE decode_binary(etf_reader *reader);
-inline VALUE decode_string(etf_reader *reader);
-inline VALUE decode_atom(etf_reader *reader);
-inline VALUE decode_small_atom(etf_reader *reader);
-inline VALUE decode_small_bignum(etf_reader *reader);
-inline VALUE decode_large_bignum(etf_reader *reader);
-
 VALUE encode(VALUE self, VALUE input);
 
 // Setup function for ruby FFI.

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.0'
+    # @!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.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vox-etf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Matthew Carey
@@ -160,7 +160,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.