vox-etf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c4afc3d3f48eb9687bfc79372892ee356c7e9f4d70211c71ddedf0b59d4318
-  data.tar.gz: 2f1b5060659fc9a35fa8d0b1ee1f5665c5c37d4254864961c14ead7d07048b9b
+  metadata.gz: 814a39714371d1d129be3606ee5f4f00045c6f6a35fdbcae83bec672cec55d33
+  data.tar.gz: f2cd32adb4fa957dd6bf692babe956f7f8569251bac15658ae1445d476c342d3
 SHA512:
-  metadata.gz: 8fd31825a494ea4b863be1f3a5c252951598987cca09137f7eb8c71e62a01992011dfaff5c72f123845667ece12c96db6ab5663276d47f59b70d17cd3e9c2d06
-  data.tar.gz: de91811cddb61a4523cf66501c86893fe4e1c6dd16fd9ca07dd6984a06d64fce3bab2d8daa82050f67bb1b3ee8287fcd3cdc6282c23039f80d2a445bd8333e48
+  metadata.gz: 7fc627a3904d13c023aa85092010b11ea4a281a2ca93992c39a1e13293b9d1768362a12114c6cefa6c9afae1075bc1902fbcee337f3a8a852ec8fbe75754a5b7
+  data.tar.gz: d26faa973c98490470b43735e5f45c0dbe53759499def683ac6d80fd662af94e158951702014ca6a55bafed2f2a2839226b5b67709d28a9f2adfc62a09d3f807

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/etf.hpp

@@ -1,7 +1,5 @@
 #pragma once
 
-#include "./etf_reader.hpp"
-
 #define ETF_VERSION 131
 
 // Term IDs, first byte of any term.
@@ -41,17 +39,6 @@ enum term
 };
 
 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

@@ -2,6 +2,6 @@
 
 module Vox
   module ETF
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   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.1
 platform: ruby
 authors:
 - Matthew Carey