sixword 0.2.0 → 0.3.0

data/lib/sixword/lib.rb

@@ -65,7 +65,7 @@ module Sixword
       # omit padding bits, if any
       int >>= padding * 8
 
-      int
+      [int, 8 - padding]
     end
 
     # Extract the padding from a word, e.g. 'WORD3' => 'WORD', 3
@@ -78,7 +78,8 @@ module Sixword
     end
 
     def self.decode_6_words_to_bstring(word_array, padding_ok)
-      int_to_byte_array(decode_6_words(word_array, padding_ok)).map(&:chr).join
+      int_to_byte_array(*decode_6_words(word_array, padding_ok)).
+        map(&:chr).join
     end
 
     def self.word_to_bits(word)
@@ -119,6 +120,17 @@ module Sixword
       parity & 0b11
     end
 
+    # Given an array of bytes, pack them into a single Integer.
+    #
+    # For example:
+    #
+    #     >> byte_array_to_int([1, 2])
+    #     => 258
+    #
+    # @param byte_array [Array<Fixnum>]
+    #
+    # @return Integer
+    #
     def self.byte_array_to_int(byte_array)
       int = 0
       byte_array.each do |byte|
@@ -128,7 +140,23 @@ module Sixword
       int
     end
 
-    def self.int_to_byte_array(int)
+    # Given an Integer, unpack it into an array of bytes.
+    #
+    # For example:
+    #
+    #     >> int_to_byte_array(258)
+    #     => [1, 2]
+    #
+    #     >> int_to_byte_array(258, 3)
+    #     => [0, 1, 2]
+    #
+    # @param int [Integer]
+    # @param length [Integer] (nil) Left zero padded size of byte array to
+    #   return. If not provided, no leading zeroes will be added.
+    #
+    # @return Array<Fixnum>
+    #
+    def self.int_to_byte_array(int, length=nil)
       unless int >= 0
         raise ArgumentError.new("Not sure what to do with negative numbers")
       end
@@ -140,6 +168,15 @@ module Sixword
         int >>= 8
       end
 
+      # pad to appropriate length with leading zeroes
+      if length
+        raise ArgumentError.new("Cannot pad to length < 0") if length < 0
+
+        while arr.length < length
+          arr << 0
+        end
+      end
+
       arr.reverse!
 
       arr

data/lib/sixword/version.rb

@@ -1,3 +1,3 @@
 module Sixword
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/sixword/lib_spec.rb

@@ -16,7 +16,17 @@ describe Sixword::Lib do
       %w{ROME MUG FRED SCAN LIVE LACE} => 0xD1854218EBBB0B51,
     }.each do |words, int|
       debug_puts "Decoding 6-word array: #{words.inspect}"
-      Sixword::Lib.decode_6_words(words, false).should == int
+      Sixword::Lib.decode_6_words(words, false).should == [int, 8]
     end
   end
+
+
+  it 'should convert byte arrays to ints' do
+    Sixword::Lib.byte_array_to_int([1, 2]).should == 258
+  end
+
+  it 'should convert ints to byte arrays' do
+    Sixword::Lib.int_to_byte_array(258).should == [1, 2]
+    Sixword::Lib.int_to_byte_array(258, 3).should == [0, 1, 2]
+  end
 end

data/spec/sixword_spec.rb

@@ -56,6 +56,24 @@ describe Sixword do
     end
   end
 
+  it 'should handle all null bytes correctly' do
+    binary = "\0" * 8
+    encoded = ['A'] * 6
+    Sixword.encode(binary).should == encoded
+    Sixword.decode(encoded).should == binary
+  end
+
+  it 'should handle padded null bytes correctly' do
+    {
+      "\0\0\0foo" => ["A", "A", "HAY", "SLEW", "TROT", "A2"],
+      "\0\0\0foo\0\0" => ["A", "A", "HAY", "SLEW", "TROT", "A"],
+      "foo\0\0" => ["CHUB", "EMIL", "MUDD", "A", "A", "A3"],
+    }.each do |binary, encoded|
+      Sixword.pad_encode(binary).should == encoded
+      Sixword.pad_decode(encoded).should == binary
+    end
+  end
+
   it 'should convert hex strings to byte strings' do
     {"03e755bf6982fa55" => "\x03\xe7\x55\xbf\x69\x82\xfa\x55",
      "19dd19a502ca2d60" => "\x19\xdd\x19\xa5\x02\xca\x2d\x60",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixword
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1062992431278592122
+      hash: -2360590348015650263
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1062992431278592122
+      hash: -2360590348015650263
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23