leb128 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed16554ca16a052d5cfa797d55edc70a79d4c02
-  data.tar.gz: 46b3d05dd5714fcc60cb4015967037a09e8ba547
+  metadata.gz: bf3a19c67617bdb7e0195e364134def4c55f1bd0
+  data.tar.gz: 77ae39dca195965e95a4efc0a437f27c11afcf14
 SHA512:
-  metadata.gz: ae77aacabcc90c23c515a9e1150dd643c9038ce73cd1f8213234c6a448cf4dc3bcf85ee62edddf9e51431387b2fb8604403a299f0a382117e64022ab69f89ac6
-  data.tar.gz: 9867aae8687da55df2c60d83b73a2eaf9962a2978df78db2d27a890595d9219d2aacb2aacb24de9792973c680eec377e9f1102a165ed10c2c3cb07140f347e11
+  metadata.gz: a95c66b3d490f333055219fa1a2177d73faf63b33f047edc6fc2971857fcf657534bd6837dbb40b638430a658b51dff386420312e641e3f79c0fc5080ddd6bab
+  data.tar.gz: ab733a9ddec874581862857d3b8b5d95495716046264d6b63917d38abc0137765e723071cc8b65ad164b2f6da6f04400fb9bc5bf51fef002a9d2f5c959492bc9

data/README.md

@@ -2,7 +2,7 @@
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cl8n/leb128/master/LICENSE.md) [![Build Status](https://travis-ci.org/cl8n/leb128.svg?branch=master)](https://travis-ci.org/cl8n/leb128) [![Documentation](https://img.shields.io/badge/docs-rubydoc.info-orange.svg)](http://www.rubydoc.info/gems/leb128)
 
-This gem is a pair of utility functions for encoding and decoding LEB128-compressed integers.
+This gem is a set of utility functions for encoding and decoding LEB128-compressed integers.
 
 As a visual example, this is an excerpt from the [LEB128 Wikipedia page](https://en.wikipedia.org/wiki/LEB128) describing how an integer is encoded into an unsigned LEB128:
 
@@ -41,20 +41,20 @@ 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:
+Encode integers into LEB128-compressed data by using the `encode_unsigned` and `encode_signed` methods. The functions take one argument, being the integer to encode. The following encodes the given integer and returns a new StringIO containing it:
 
 ```ruby
-LEB128.encode(-0x143f, true)
-#=> #<StringIO:0x00000003533e20>
+LEB128.encode_signed(-0x143f)
+#=> #<StringIO:0x00000000000000>
 ```
 
-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:
+Decode LEB128-compressed data into integers by using the `decode_unsigned` and `decode_signed` methods. The functions take two arguments: a StringIO containing the LEB128-compressed data, and an optional 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)
+LEB128.decode_unsigned(sio)
 #=> 11201
 ```
 

data/leb128.gemspec

@@ -1,16 +1,16 @@
-Gem::Specification.new do |spec|
-  spec.name          = "leb128"
-  spec.version       = "0.1.1"
-  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
+Gem::Specification.new do |spec|
+  spec.name          = "leb128"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Clayton Bonigut"]
+
+  spec.summary       = %q{A set 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

@@ -1,18 +1,17 @@
 require 'stringio'
 
-# Includes a pair of functions to encode and decode the LEB128 integer compression type.
+# Includes a set of functions to encode and decode the LEB128 integer compression type.
 module LEB128
-  # Encode an integer into LEB128-compressed data.
+  # Encode an unsigned integer into LEB128-compressed data.
   #
   # @param value [Integer]
-  # @param signed [Boolean]
   # @return [StringIO]
   #
   # @example
-  #   LEB128.encode(-0x143f, true) #=> #<StringIO:0x00000003533e20>
+  #   LEB128.encode_unsigned(0x2bc1) #=> #<StringIO:0x00000000000000>
 
-  def self.encode(value, signed)
-    if value < 0 && !signed
+  def self.encode_unsigned(value)
+    if value < 0
       raise(ArgumentError,
             'Cannot encode a negative integer to an unsigned LEB128')
     end
@@ -20,24 +19,65 @@ module LEB128
     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
+      byte |= 0x80 if value != 0
+      io.putc(byte)
+      break if value == 0
+    end
+    io.pos = 0
+    io
+  end
+
+  # Encode a signed integer into LEB128-compressed data.
+  #
+  # @param value [Integer]
+  # @return [StringIO]
+  #
+  # @example
+  #   LEB128.encode_signed(-0x143f) #=> #<StringIO:0x00000000000000>
+
+  def self.encode_signed(value)
+    io = StringIO.new
+    loop do
+      byte = value & 0x7F
+      value >>= 7
+      byte |= 0x80 unless (value == 0 && byte & 0x40 == 0) ||
+                          (value == -1 && byte & 0x40 != 0)
       io.putc(byte)
-      break if (signed && byte & 0x80 == 0) ||
-               (!signed && value == 0)
+      break if byte & 0x80 == 0
     end
     io.pos = 0
     io
   end
 
-  # Decode LEB128-compressed data into an integer.
+  # Decode unsigned LEB128-compressed data into an integer.
+  #
+  # @param io [StringIO]
+  # @param index [Integer]
+  # @return [Integer]
+  #
+  # @example
+  #   sio = StringIO.new
+  #   sio.putc(0xc1)
+  #   sio.putc(0x57)
+  #   LEB128.decode_unsigned(sio) #=> 11201
+
+  def self.decode_unsigned(io, 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
+      break if byte & 0x80 == 0
+      offset += 7
+    end
+    value
+  end
+
+  # Decode signed LEB128-compressed data into an integer.
   #
   # @param io [StringIO]
-  # @param signed [Boolean]
   # @param index [Integer]
   # @return [Integer]
   #
@@ -45,9 +85,9 @@ module LEB128
   #   sio = StringIO.new
   #   sio.putc(0xc1)
   #   sio.putc(0x57)
-  #   LEB128.decode(sio, false) #=> 11201
+  #   LEB128.decode_signed(sio) #=> -5183
 
-  def self.decode(io, signed, index = 0)
+  def self.decode_signed(io, index = 0)
     io.pos = index
     raise(EOFError) if io.eof?
     value = 0
@@ -57,7 +97,7 @@ module LEB128
       value |= (byte & 0x7F) << offset
       offset += 7
       if byte & 0x80 == 0
-        value |= -(1 << offset) if signed && byte & 0x40 != 0
+        value |= -(1 << offset) unless byte & 0x40 == 0
         break
       end
     end

data/test/test_leb128.rb

@@ -6,7 +6,7 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0xc1)
     buffer.putc(0x57)
-    actual = LEB128.decode(buffer, true)
+    actual = LEB128.decode_signed(buffer)
     expected = -0x143f
     assert_equal(expected, actual)
   end
@@ -15,7 +15,7 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0x8e)
     buffer.putc(0x32)
-    actual = LEB128.decode(buffer, true)
+    actual = LEB128.decode_signed(buffer)
     expected = 0x190e
     assert_equal(expected, actual)
   end
@@ -24,7 +24,7 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0xc1)
     buffer.putc(0x57)
-    actual = LEB128.decode(buffer, false)
+    actual = LEB128.decode_unsigned(buffer)
     expected = 0x2bc1
     assert_equal(expected, actual)
   end
@@ -33,7 +33,7 @@ class LEB128Test < Minitest::Test
     assert_raises(EOFError) do
       buffer = StringIO.new
       buffer.putc(0x01)
-      LEB128.decode(buffer, false, 1)
+      LEB128.decode_unsigned(buffer, 1)
     end
   end
 
@@ -41,7 +41,7 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0xc1)
     buffer.putc(0x57)
-    actual = LEB128.encode(-0x143f, true).string
+    actual = LEB128.encode_signed(-0x143f).string
     expected = buffer.string
     assert_equal(expected, actual)
   end
@@ -50,14 +50,14 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0x8e)
     buffer.putc(0x32)
-    actual = LEB128.encode(0x190e, true).string
+    actual = LEB128.encode_signed(0x190e).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)
+      LEB128.encode_unsigned(-0x01)
     end
     assert_equal('Cannot encode a negative integer to an unsigned LEB128', exception.message)
   end
@@ -66,7 +66,7 @@ class LEB128Test < Minitest::Test
     buffer = StringIO.new
     buffer.putc(0xc1)
     buffer.putc(0x57)
-    actual = LEB128.encode(0x2bc1, false).string
+    actual = LEB128.encode_unsigned(0x2bc1).string
     expected = buffer.string
     assert_equal(expected, actual)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leb128
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Clayton Bonigut
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,6 @@ 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.
+summary: A set of utility functions for encoding and decoding LEB128-compressed integers.
 test_files: []
 has_rdoc: