kiwi-schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 152e96108e00da08616725a10209ae3416c6f9ec611fe4502206d27f33545a7e
+  data.tar.gz: 04d75522e8b59fd2135d2e477bc1e2220127abb422e80ed7e31ad9e8a17f8751
+SHA512:
+  metadata.gz: 94d70eaa4a840b0c25d5468fd1bcdca0bc880eed42e31efda43f742c397cf9ed3e1e7ce9948e76681fc8eaa50d96a70335435d179bd18ac064e56472d9e89bd6
+  data.tar.gz: 48a71dc215afa11eeb16ba94c3aaaff95477964269700c2d2e7b49e430ac3c1b7466e3b720693c8f694b09184a38c8fa31ad069ee9f2bd2ca2a97ef4ea5ba804

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kiwi-schema.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    kiwi-schema (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kiwi-schema!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,43 @@
+# kiwi-schema GEM
+
+Kiwi is a schema-based binary format for efficiently encoding trees of data.
+
+This is a ruby implementation of the kiwi message format, see [evanw/kiwi](https://github.com/evanw/kiwi/).
+
+Note:
+
+This gem is a just for fun work-in-progress, probably slow, and not yet proven to work in all cases, so be warned.
+You definitely want to take a look at the original C++, Rust, and JS implementations from Evan first.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kiwi-schema'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install kiwi-schema
+
+## Usage
+
+```ruby
+require "kiwi"
+
+# This is the encoding of the Kiwi schema "message ABC { int[] xyz = 1; }"
+schema_bytes = [1, 65, 66, 67, 0, 2, 1, 120, 121, 122, 0, 5, 1, 1]
+schema = Kiwi::Schema.from_binary(schema_bytes)
+schema.encode_abc({ "xyz" => [99, -12] }) # => [1, 2, 198, 1, 23, 0]
+schema.decode_abc([1, 2, 198, 1, 23, 0])  # => {"xyz"=>[99, -12]}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/haberbyte/kiwi-schema.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kiwi/schema"
+
+require "irb"
+IRB.start(__FILE__)

data/kiwi-schema.gemspec

@@ -0,0 +1,17 @@
+require_relative 'lib/kiwi'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kiwi-schema"
+  spec.version       = Kiwi::VERSION
+  spec.authors       = ["Jan Habermann"]
+  spec.email         = ["jan@habermann.io"]
+  spec.summary       = %q{Kiwi encoding/decoding in ruby}
+  spec.description   = %q{Kiwi encoding/decoding in ruby}
+  spec.homepage      = "https://www.github/com/haberbyte/kiwi-schema"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/kiwi.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Kiwi
+  VERSION = "0.1.0"
+  
+  autoload :ByteBuffer, "kiwi/byte_buffer"
+  autoload :Definition, "kiwi/definition"
+  autoload :Field, "kiwi/field"
+  autoload :Schema, "kiwi/schema"
+end

data/lib/kiwi/byte_buffer.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Kiwi
+  class ByteBuffer
+    attr_reader :data
+    attr_reader :index
+
+    def initialize(data = [])
+      @data = data
+      @index = 0
+    end
+
+    def read_byte
+      if index >= data.length
+        raise RangeError, "Index out of bounds"
+      else
+        value = data[index]
+        @index += 1
+        value
+      end
+    end
+
+    def read_bytes(len)
+      if index + len > data.length
+        raise RangeError, "Read bytes out of bounds"
+      else
+        value = data[index..(index + len)]
+        @index += len
+        value
+      end
+    end
+
+    def read_bool
+      read_byte == 0x1
+    end
+
+    def read_var_int
+      value = read_var_uint
+
+      if (value & 1) != 0
+        ~(value >> 1)
+      else
+        value >> 1
+      end
+    end
+
+    def read_var_uint
+      shift = 0
+      result = 0
+
+      loop do
+        byte = read_byte
+        result |= (byte & 127) << shift
+        shift += 7
+
+        break if (byte & 128) == 0 || shift >= 35
+      end
+
+      result
+    end
+
+    def read_var_float
+      first = read_byte
+      return 0.0 if first == 0
+      raise RangeError, "Index out of bounds" if index + 3 > data.length
+      bits = first | (data[index] << 8) | (data[index + 1] << 16) | (data[index + 2] << 24)
+      bits = (bits << 23) | (bits >> 9) # Move the exponent back into place
+      value = [bits].pack("L").unpack("F*")[0]
+      @index += 3
+      value
+    end
+
+    def read_string
+      result = []
+
+      loop do
+        char = read_byte
+        break if char == 0
+        result << char
+      end
+
+      result.pack("C*").force_encoding("UTF-8")
+    end
+
+    def write_bool(value)
+      data.push(value ? 0x1 : 0x0)
+    end
+
+    def write_byte(value)
+      data.push(value & 255)
+    end
+
+    # Write a variable-length signed 32-bit integer to the end of the buffer.
+    def write_var_int(value)
+      write_var_uint((value << 1) ^ (value >> 31))
+    end
+
+    def write_var_uint(value)
+      loop do
+        byte = value & 127
+        value = value >> 7
+
+        if value == 0
+          write_byte(byte)
+          return
+        end
+
+        write_byte(byte | 128)
+      end
+    end
+
+    def write_var_float(value)
+      bits = [value].pack("F*").unpack("L")[0]
+      bits = (bits >> 23) | (bits << 9)
+      bytes = [bits].pack("L").unpack("C*")
+
+      if (bytes[0] & 255) == 0
+        data.push(0)
+      else
+        data.push(*bytes)
+      end
+    end
+
+    def write_string(value)
+      data.push(*value.bytes)
+      data.push(0)
+    end
+  end
+end

data/lib/kiwi/definition.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Kiwi
+  class Definition
+    KIND_ENUM = 0
+    KIND_STRUCT = 1
+    KIND_MESSAGE = 2
+
+    attr_accessor :name, :index, :kind, :fields
+    attr_reader :field_value_to_index, :field_name_to_index
+
+    def initialize(name:, kind:, fields: [])
+      @name = name
+      @kind = kind
+      @fields = fields
+      @index = 0
+      @field_name_to_index = {}
+      @field_value_to_index = {}
+
+      @fields.each_with_index do |field, i|
+        field_value_to_index[field.value] = i
+        field_name_to_index[field.name] = i
+      end
+    end
+
+    def field(name)
+      if idx = field_name_to_index[name]
+        fields[idx]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/kiwi/field.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kiwi
+  class Field
+    TYPE_BOOL = -1
+    TYPE_BYTE = -2
+    TYPE_INT = -3
+    TYPE_UINT = -4
+    TYPE_FLOAT = -5
+    TYPE_STRING = -6
+
+    attr_reader :name, :type_id, :is_array, :value
+
+    def initialize(name:, type_id:, is_array:, value:)
+      @name = name
+      @type_id = type_id
+      @is_array = is_array
+      @value = value
+    end
+  end
+end

data/lib/kiwi/schema.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Kiwi
+  class Schema
+    def self.from_binary(bytes)
+      defs = []
+      bb = ByteBuffer.new(bytes)
+      definition_count = bb.read_var_uint
+
+      (0...definition_count).each do
+        definition_name = bb.read_string
+        kind = bb.read_byte
+        field_count = bb.read_var_uint
+        fields = []
+
+        (0...(field_count)).each do |field|
+          name = bb.read_string
+          type_id = bb.read_var_int
+          is_array = bb.read_bool
+          value = bb.read_var_uint
+          fields << Field.new(name: name, type_id: type_id, is_array: is_array, value: value)
+        end
+
+        defs << Definition.new(name: definition_name, kind: kind, fields: fields)
+      end
+
+      Kiwi::Schema.new(defs: defs)
+    end
+
+    def initialize(defs: [])
+      @defs = defs
+      @def_name_to_index = {}
+
+      @defs.each_with_index do |definition, i|
+        definition.index = i
+        @def_name_to_index[definition.name] = i
+
+        if definition.kind == Definition::KIND_MESSAGE
+          define_singleton_method(:"encode_#{definition.name.downcase}") do |message|
+            encode(definition.index, message)
+          end
+
+          define_singleton_method(:"decode_#{definition.name.downcase}") do |bytes|
+            decode(definition.index, bytes)
+          end
+        end
+      end
+    end
+
+    def decode(type_id, bytes)
+      decode_bb(type_id, ByteBuffer.new(bytes))
+    end
+
+    def encode(type_id, value)
+      bb = ByteBuffer.new
+      encode_bb(type_id, value, bb)
+      bb.data
+    end
+
+    def definitions
+      @defs
+    end
+
+    private
+
+      attr_reader :defs, :def_name_to_index
+
+      def decode_bb(type_id, byte_buffer)
+        case type_id
+        when Field::TYPE_BOOL
+          byte_buffer.read_bool
+        when Field::TYPE_BYTE
+          byte_buffer.read_byte
+        when Field::TYPE_INT
+          byte_buffer.read_var_int
+        when Field::TYPE_UINT
+          byte_buffer.read_var_uint
+        when Field::TYPE_FLOAT
+          byte_buffer.read_var_float
+        when Field::TYPE_STRING
+          byte_buffer.read_string
+        else
+          definition = defs[type_id]
+
+          case definition.kind
+          when Definition::KIND_ENUM
+            if index = definition.field_value_to_index[byte_buffer.read_var_uint]
+              definition.fields[index].name
+            else
+              raise RuntimeError
+            end
+          when Definition::KIND_STRUCT
+            fields = {}
+            definition.fields.each do |field|
+              fields[field.name] = decode_field(field, byte_buffer)
+            end
+            fields
+          when Definition::KIND_MESSAGE
+            fields = {}
+            loop do
+              value = byte_buffer.read_var_uint
+              return fields if value == 0
+
+              if index = definition.field_value_to_index[value]
+                field = definition.fields[index]
+                fields[field.name] = decode_field(field, byte_buffer)
+              else
+                raise RuntimeError
+              end
+            end
+          end
+        end
+      end
+
+      def decode_field(field, byte_buffer)
+        if field.is_array
+          len = byte_buffer.read_var_uint
+          array = []
+          (0...len).each do
+            array << decode_bb(field.type_id, byte_buffer)
+          end
+          array
+        else
+          decode_bb(field.type_id, byte_buffer)
+        end
+      end
+
+      def encode_bb(type_id, value, byte_buffer)
+        case type_id
+        when Field::TYPE_BOOL
+          byte_buffer.write_bool(value)
+        when Field::TYPE_BYTE
+          byte_buffer.write_byte(value)
+        when Field::TYPE_INT
+          byte_buffer.write_var_int(value)
+        when Field::TYPE_UINT
+          byte_buffer.write_var_uint(value)
+        when Field::TYPE_FLOAT
+          byte_buffer.write_var_float(value)
+        when Field::TYPE_STRING
+          byte_buffer.write_string(value)
+        else
+          definition = defs[type_id]
+
+          case definition.kind
+          when Definition::KIND_ENUM
+            enum = definition.field(value)
+            byte_buffer.write_var_uint(enum.value)
+          when Definition::KIND_STRUCT
+            definition.fields.each do |field|
+              if !(field_value = value[field.name]).nil?
+                encode_value(field, field_value, byte_buffer)
+              else
+                raise ArgumentError, "missing required field #{field.name}"
+              end
+            end
+          when Definition::KIND_MESSAGE
+            value.each do |field_name, field_value|
+              field = definition.field(field_name)
+              if !field.nil?
+                byte_buffer.write_var_uint(field.value)
+                encode_value(field, field_value, byte_buffer)
+              end
+            end
+            byte_buffer.write_byte(0)
+          end
+        end
+      end
+
+      def encode_value(field, value, byte_buffer)
+        if field.is_array
+          byte_buffer.write_var_uint(value.length)
+          value.each { |v| encode_bb(field.type_id, v, byte_buffer) }
+        else
+          encode_bb(field.type_id, value, byte_buffer)
+        end
+      end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: kiwi-schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Habermann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-22 00:00:00.000000000 Z
+dependencies: []
+description: Kiwi encoding/decoding in ruby
+email:
+- jan@habermann.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- kiwi-schema.gemspec
+- lib/kiwi.rb
+- lib/kiwi/byte_buffer.rb
+- lib/kiwi/definition.rb
+- lib/kiwi/field.rb
+- lib/kiwi/schema.rb
+homepage: https://www.github/com/haberbyte/kiwi-schema
+licenses: []
+metadata:
+  homepage_uri: https://www.github/com/haberbyte/kiwi-schema
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Kiwi encoding/decoding in ruby
+test_files: []