vox-etf 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - bin/*
+    - vendor/**/*
+  NewCops: enable
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+RSpec/FilePath:
+  SpecSuffixOnly: true
+
+Metrics:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matthew.b.carey@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source('https://rubygems.org')
+
+# Specify your gem's dependencies in vox-etf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matthew Carey
+
+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.

data/README.md

@@ -0,0 +1,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vox-etf'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vox-etf
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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).
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vox::Etf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vox-etf/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require('bundler/gem_tasks')
+require('rspec/core/rake_task')
+require('rake/extensiontask')
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new('etf') do |ext|
+  ext.ext_dir = 'ext/vox'
+  ext.lib_dir = 'lib/vox'
+end
+
+task(default: :compile)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require('bundler/setup')
+require('vox/etf')
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require('irb')
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require('pathname')
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path(
+  '../../Gemfile',
+  Pathname.new(__FILE__).realpath
+)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require('rubygems')
+require('bundler/setup')
+
+load(Gem.bin_path('rake', 'rake'))

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/vox/decoder.hpp

@@ -0,0 +1,356 @@
+#pragma once
+#include <zlib.h>
+#include "ruby.h"
+#include "erlpack/sysdep.h"
+#include "erlpack/constants.h"
+
+namespace etf
+{
+    class decoder
+    {
+    public:
+        decoder(VALUE str)
+            : data((const uint8_t *)RSTRING_PTR(str)), size(RSTRING_LEN(str)), offset(0)
+        {
+            if (read8() != FORMAT_VERSION)
+                rb_raise(rb_eArgError, "Invalid version: %i", ETF_VERSION);
+        }
+
+        decoder(const uint8_t *str, size_t data_size, bool skip_version = false) : data(str), size(data_size), offset(0)
+        {
+            if (skip_version)
+                return;
+            if (read8() != FORMAT_VERSION)
+                rb_raise(rb_eArgError, "Invalid version: %i", ETF_VERSION);
+        }
+
+        VALUE decode_term()
+        {
+            if (offset >= size)
+            {
+                rb_raise(rb_eRangeError, "Decoding beyond the end of the buffer");
+                return Qnil;
+            }
+
+            const uint8_t type = read8();
+            switch (type)
+            {
+            case SMALL_INTEGER_EXT:
+                return decode_small_integer();
+            case INTEGER_EXT:
+                return decode_integer();
+            case FLOAT_EXT:
+                return decode_float();
+            case NEW_FLOAT_EXT:
+                return decode_new_float();
+            case ATOM_EXT:
+            case ATOM_UTF8_EXT:
+                return decode_atom();
+            case SMALL_ATOM_EXT:
+            case SMALL_ATOM_UTF8_EXT:
+                return decode_small_atom();
+            case SMALL_TUPLE_EXT:
+                return decode_small_tuple();
+            case LARGE_TUPLE_EXT:
+                return decode_large_tuple();
+            case NIL_EXT:
+                return decode_nil();
+            case STRING_EXT:
+                return decode_string_as_list();
+            case LIST_EXT:
+                return decode_list();
+            case MAP_EXT:
+                return decode_map();
+            case BINARY_EXT:
+                return decode_binary_as_string();
+            case SMALL_BIG_EXT:
+                return decode_small_bignum();
+            case LARGE_BIG_EXT:
+                return decode_large_bignum();
+            case COMPRESSED:
+                return decode_compressed();
+            default:
+                rb_raise(rb_eArgError, "Unsupported type identifier `%i' found", type);
+                return Qnil;
+            }
+        }
+
+    private:
+        const uint8_t *data;
+        const size_t size;
+        size_t offset;
+
+        uint8_t read8(void)
+        {
+            if (offset + sizeof(uint8_t) > size)
+            {
+                rb_raise(rb_eRangeError, "Reading a byte passes the end of the buffer");
+                return 0;
+            }
+            uint8_t val = *reinterpret_cast<const uint8_t *>(data + offset);
+            offset += sizeof(uint8_t);
+            return val;
+        }
+
+        uint16_t read16()
+        {
+            if (offset + sizeof(uint16_t) > size)
+            {
+                rb_raise(rb_eRangeError, "Reading two bytes passes the end of the buffer");
+                return 0;
+            }
+
+            uint16_t val = _erlpack_be16(*reinterpret_cast<const uint16_t *>(data + offset));
+            offset += sizeof(uint16_t);
+            return val;
+        }
+
+        uint32_t read32()
+        {
+            if (offset + sizeof(uint32_t) > size)
+            {
+                rb_raise(rb_eRangeError, "Reading four bytes passes the end of the buffer");
+                return 0;
+            }
+
+            uint32_t val = _erlpack_be32(*reinterpret_cast<const uint32_t *>(data + offset));
+            offset += sizeof(uint32_t);
+            return val;
+        }
+
+        uint64_t read64()
+        {
+            if (offset + sizeof(uint64_t) > size)
+            {
+                rb_raise(rb_eRangeError, "Reading eight bytes passes the end of the buffer");
+                return 0;
+            }
+
+            uint64_t val = _erlpack_be64(*reinterpret_cast<const uint64_t *>(data + offset));
+            offset += sizeof(uint64_t);
+            return val;
+        }
+
+        VALUE decode_small_integer(void)
+        {
+            return INT2FIX(read8());
+        }
+
+        VALUE decode_integer(void)
+        {
+            return INT2NUM(read32());
+        }
+
+        VALUE decode_array(int32_t length)
+        {
+            VALUE values[length];
+
+            for (int32_t index = 0; index < length; index++)
+                values[index] = decode_term();
+            return rb_ary_new_from_values(length, values);
+        }
+
+        VALUE decode_list()
+        {
+            const uint32_t length = read32();
+            VALUE array = decode_array(length);
+            const uint8_t tail = read8();
+
+            if (tail != term::nil)
+            {
+                rb_raise(rb_eArgError, "List doesn't end with `NIL`, but it must!");
+                return Qnil;
+            }
+
+            return array;
+        }
+
+        VALUE decode_tuple(uint32_t length)
+        {
+            return decode_array(length);
+        }
+
+        VALUE decode_nil()
+        {
+            return rb_ary_new();
+        }
+
+        VALUE decode_map()
+        {
+            const uint32_t length = read32();
+            VALUE hash = rb_hash_new();
+
+            for (uint32_t index = 0; index < length; index++)
+            {
+                const VALUE key = decode_term();
+                const VALUE value = decode_term();
+
+                rb_hash_aset(hash, key, value);
+            }
+
+            return hash;
+        }
+
+        const char *read_string(uint32_t length)
+        {
+            if (offset + length > size)
+            {
+                rb_raise(rb_eRangeError, "Reading sequence past the end of the buffer");
+                return 0;
+            }
+
+            const uint8_t *str = data + offset;
+            offset += length;
+            return (const char *)str;
+        }
+
+        VALUE process_atom(const char *atom, uint16_t length)
+        {
+            if (atom == NULL)
+            {
+                return Qnil;
+            }
+
+            if (length >= 3 && length <= 5)
+            {
+                if (length == 3 && strncmp(atom, "nil", 3) == 0)
+                    return Qnil;
+                // Is this actually a possible to receive from discord?
+                // It's defined in the js erlpack decoder but I'm not sure.
+                else if (length == 4 && strncmp(atom, "null", 4) == 0)
+                    return Qnil;
+                else if (length == 4 && strncmp(atom, "true", 4) == 0)
+                    return Qtrue;
+                else if (length == 5 && strncmp(atom, "false", 5) == 0)
+                    return Qfalse;
+            }
+
+            return ID2SYM(rb_intern2(atom, length));
+        }
+
+        VALUE decode_atom()
+        {
+            uint16_t length = read16();
+            const char *atom = read_string(length);
+            return process_atom(atom, length);
+        }
+
+        VALUE decode_small_atom()
+        {
+            uint8_t length = read8();
+            const char *atom = read_string(length);
+            return process_atom(atom, length);
+        }
+
+        VALUE decode_float()
+        {
+            const uint8_t FLOAT_LENGTH = 31;
+            const char *float_string = read_string(FLOAT_LENGTH);
+
+            if (float_string == NULL)
+                return Qnil;
+
+            double number;
+            char buff[FLOAT_LENGTH + 1] = {0};
+            memcpy(buff, float_string, FLOAT_LENGTH);
+
+            uint32_t count = sscanf(buff, "%lf", &number);
+            if (count != 1)
+            {
+                rb_raise(rb_eArgError, "Invalid float encoded.");
+                return Qnil;
+            }
+
+            return DBL2NUM(number);
+        }
+
+        VALUE decode_new_float()
+        {
+            uint64_t u64 = read64();
+            double dbl;
+            memcpy(&dbl, &u64, sizeof(double));
+
+            return DBL2NUM(dbl);
+        }
+
+        VALUE decode_big(uint32_t length)
+        {
+            const uint8_t sign = read8();
+            const char *buff = read_string(length);
+
+            auto flags = INTEGER_PACK_LITTLE_ENDIAN | (sign * INTEGER_PACK_NEGATIVE);
+            return rb_integer_unpack(buff, length, 1, 0, flags);
+        }
+
+        VALUE decode_small_bignum()
+        {
+            const uint8_t length = read8();
+            return decode_big(length);
+        }
+
+        VALUE decode_large_bignum()
+        {
+            const uint32_t length = read32();
+            return decode_big(length);
+        }
+
+        VALUE decode_binary_as_string()
+        {
+            const uint32_t length = read32();
+            const char *str = read_string(length);
+
+            if (str == NULL)
+                return Qnil;
+
+            return rb_str_new(str, length);
+        }
+
+        VALUE decode_string_as_list()
+        {
+            const uint16_t length = read16();
+
+            if (offset + length > size)
+            {
+                rb_raise(rb_eRangeError, "Reading sequence past the end of the buffer");
+                return Qnil;
+            }
+
+            VALUE values[length];
+            for (uint16_t index = 0; index < length; index++)
+                values[index] = INT2FIX(read8());
+            return rb_ary_new_from_values(length, values);
+        }
+
+        VALUE decode_small_tuple()
+        {
+            return decode_tuple(read8());
+        }
+
+        VALUE decode_large_tuple()
+        {
+            return decode_tuple(read32());
+        }
+
+        VALUE decode_compressed()
+        {
+            const uint32_t decompressed_size = read32();
+
+            uint64_t 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));
+
+            offset += source_size;
+            if (ret != Z_OK)
+            {
+                free(out_buffer);
+                rb_raise(rb_eArgError, "Failed to uncompress compressed item");
+                return Qnil;
+            }
+
+            decoder decompressed(out_buffer, decompressed_size, true);
+            VALUE value = decompressed.decode_term();
+            free(out_buffer);
+            return value;
+        }
+    };
+} // namespace etf