leb128 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20748dc4ff2f263fdf41f1a864716734727820d2
+  data.tar.gz: 1429a8e432ebbf3564c7f5b65ed88801ffca98e4
+SHA512:
+  metadata.gz: 96530e760a059bab741ad7f017693d3890e09e5262644c9bffc06d120a81921125f2b56c1b400c2de11aed63f47729cd0604e923a140ad411739e96b22730cae
+  data.tar.gz: ead3aa1418ce06b4f313c4d365c248cc381b890a8bd70e34e5e98cf40f392de5acc314b09359ebacb6c1bacb1f199d26f5dc953ca3d4f2daf4ffa7777914f3cd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Clayton Bonigut
+
+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,50 @@
+# LEB128
+
+This gem is a pair of utility functions for encoding and decoding LEB128-compressed integers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'leb128'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leb128
+
+## Usage
+
+Require the Gem:
+
+```ruby
+require 'leb128'
+```
+
+### Encoding and Decoding
+
+Encode integers into LEB128-compressed data by using the `encode` method. The first argument takes an integer, and the second takes a bool that tells whether to use a signed datatype or not. The following encodes the given integer and returns a new StringIO containing it:
+
+```ruby
+LEB128.encode(-0x143f, true)
+#=> #<StringIO:0x00000003533e20>
+```
+
+Decode LEB128-compressed data into integers by using the `decode` method. The first argument takes a StringIO, the second takes a bool that tells whether to use a signed datatype or not, and the third takes an integer that sets the position of the StringIO (default is 0). The following decodes the given StringIO and returns a new integer containing it:
+
+```ruby
+sio = StringIO.new
+sio.putc(0xc1)
+sio.putc(0x57)
+LEB128.decode(sio, false)
+#=> 11201
+```
+
+## License
+
+This gem is available as open source under the terms of the MIT License. See [LICENSE.md](https://github.com/cl8n/leb128/blob/master/LICENSE.md) and <https://opensource.org/licenses/MIT>.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/leb128.rb']
+end
+
+task :default => :test

data/leb128.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |spec|
+  spec.name          = "leb128"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Clayton Bonigut"]
+
+  spec.summary       = %q{A pair of utility functions for encoding and decoding LEB128-compressed integers.}
+  spec.homepage      = "https://github.com/cl8n/leb128"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard"
+end

data/lib/leb128.rb

@@ -0,0 +1,63 @@
+require 'stringio'
+
+# Includes a pair of functions to encode and decode the LEB128 integer compression type.
+module LEB128
+  # Encode an integer into LEB128-compressed data.
+  #
+  # @param value [Integer]
+  # @param signed [Boolean]
+  # @return [StringIO]
+  #
+  # @example
+  #   LEB128.encode(-0x143f, true) #=> #<StringIO:0x00000003533e20>
+
+  def self.encode(value, signed)
+    if value < 0 && !signed
+      raise(ArgumentError, 'Cannot encode a negative integer to an unsigned LEB128')
+    end
+    io = StringIO.new
+    loop do
+      byte = value & 0x7F
+      value >>= 7
+      if signed
+        byte |= 0x80 unless (value == 0 && byte & 0x40 == 0) || (value == -1 && byte & 0x40 != 0)
+      elsif value != 0
+        byte |= 0x80
+      end
+      io.putc(byte)
+      break if (signed && byte & 0x80 == 0) || (!signed && value == 0)
+    end
+    io.pos = 0
+    io
+  end
+
+  # Decode LEB128-compressed data into an integer.
+  #
+  # @param io [StringIO]
+  # @param signed [Boolean]
+  # @param index [Integer]
+  # @return [Integer]
+  #
+  # @example
+  #   sio = StringIO.new
+  #   sio.putc(0xc1)
+  #   sio.putc(0x57)
+  #   LEB128.decode(sio, false) #=> 11201
+
+  def self.decode(io, signed, index = 0)
+    io.pos = index
+    raise(EOFError) if io.eof?
+    value = 0
+    offset = 0
+    loop do
+      byte = io.read(1).unpack('C')[0]
+      value |= (byte & 0x7F) << offset
+      offset += 7
+      if byte & 0x80 == 0
+        value |= -(1 << offset) if signed && byte & 0x40 != 0
+        break
+      end
+    end
+    value
+  end
+end

data/test/test_leb128.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'leb128'
+
+class LEB128Test < Minitest::Test
+  def test_decode_signed_negative_leb128
+    buffer = StringIO.new
+    buffer.putc(0xc1)
+    buffer.putc(0x57)
+    actual = LEB128.decode(buffer, true)
+    expected = -0x143f
+    assert_equal(expected, actual)
+  end
+
+  def test_decode_signed_positive_leb128
+    buffer = StringIO.new
+    buffer.putc(0x8e)
+    buffer.putc(0x32)
+    actual = LEB128.decode(buffer, true)
+    expected = 0x190e
+    assert_equal(expected, actual)
+  end
+
+  def test_decode_unsigned_leb128
+    buffer = StringIO.new
+    buffer.putc(0xc1)
+    buffer.putc(0x57)
+    actual = LEB128.decode(buffer, false)
+    expected = 0x2bc1
+    assert_equal(expected, actual)
+  end
+
+  def test_decode_eoferror
+    assert_raises(EOFError) do
+      buffer = StringIO.new
+      buffer.putc(0x01)
+      LEB128.decode(buffer, false, 1)
+    end
+  end
+
+  def test_encode_signed_negative_int
+    buffer = StringIO.new
+    buffer.putc(0xc1)
+    buffer.putc(0x57)
+    actual = LEB128.encode(-0x143f, true).string
+    expected = buffer.string
+    assert_equal(expected, actual)
+  end
+
+  def test_encode_signed_positive_int
+    buffer = StringIO.new
+    buffer.putc(0x8e)
+    buffer.putc(0x32)
+    actual = LEB128.encode(0x190e, true).string
+    expected = buffer.string
+    assert_equal(expected, actual)
+  end
+
+  def test_encode_unsigned_negative_int_argumenterror
+    exception = assert_raises(ArgumentError) do
+      LEB128.encode(-0x01, false)
+    end
+    assert_equal('Cannot encode a negative integer to an unsigned LEB128', exception.message)
+  end
+
+  def test_encode_unsigned_positive_int
+    buffer = StringIO.new
+    buffer.putc(0xc1)
+    buffer.putc(0x57)
+    actual = LEB128.encode(0x2bc1, false).string
+    expected = buffer.string
+    assert_equal(expected, actual)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: leb128
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clayton Bonigut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- leb128.gemspec
+- lib/leb128.rb
+- test/test_leb128.rb
+homepage: https://github.com/cl8n/leb128
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A pair of utility functions for encoding and decoding LEB128-compressed integers.
+test_files: []
+has_rdoc: