vox-etf 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3946973c5609f6a44d6f1bc0ea10d3f5ed7095dd0009ddaaa64593c90de538
-  data.tar.gz: 6e50761784880810734201a0d6e4684c2def7b6f4e7de0464ac8e42491768a12
+  metadata.gz: 20430b5c79bc96dd01b89eb8a15e4f18ad5387d2da0401a32757207a8e4bb997
+  data.tar.gz: 030dfda27dbe590878dd76514f151afb2d0ef275dfa1d3056f8712ecd514efda
 SHA512:
-  metadata.gz: 111a3cc908087690d58e0ac939c3b3d1576d05bfc50fdb457e55eaa0ee54b71f1ae29bfb804e234c98bae047c8809803f5268ab1fddb5808cfff81ed5a492007
-  data.tar.gz: c176eb3b67e1d83d6972eb50e5263f57286a37c1093b47ad3c92f3513f4e1c2902ec4b218dce4e813f004cd4e6d8e8917cdef223f40d1650db4e115c78a85fb6
+  metadata.gz: 8abe290ea1d4816ec4c9db1e408bc0540d54ebb8659d1e6f617c6524adfd2ce010013bf20d25eca76bd5ad9fd284343219b9d22c14cfc81de57d1ef663e73e4b
+  data.tar.gz: f1c124d99a11e882a2351b95937ce8b341e25322d057111be055b229cb44ea4f1d21c1fc0aa6f5fe638ec1f6369851f1957f3f812bada7fcb4bf5fd4980ee68c

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());
         }

data/ext/vox/encoder.hpp

@@ -57,13 +57,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);
         }

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/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.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vox-etf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matthew Carey