sixword 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 510c9016d6296108aea1122a763e3389c608715e
-  data.tar.gz: 8e93476177ebc6c328c7ea7972b65b9c6f660e83
+  metadata.gz: a5f8241501d3ec9a161b47b2b3d013de7eee6c7f
+  data.tar.gz: 0df5938f25ccf57e734f53d0fce16dc87504121f
 SHA512:
-  metadata.gz: 5c295ddfd1e6b4c616cc1257bd71a0aab7707c42bab0fafa8b88b5e9ee3c29658d8715ffb236353f27d2018b6cb46285769a0f8ee50a0030b474423cc08f0d0b
-  data.tar.gz: 32824743c047bba15734a0819bb896ba1c9ff299b9cfb6214da582fe5c4999560e595fe249b82b2aa7942193811003d5402547aee62a187ba2835c050599c294
+  metadata.gz: 50dd98d6d7c3ae1c0936c05be2cb0b21eb63141701fe329baa58b3eaf3224621817dd2406d7b4532e24e1e3a305aa849e181d47800ecf2370f8e932dfbf1191d
+  data.tar.gz: e42402107439bdf45dbb38b79b039b08d8af4f7454f10486147684bb83a8873eacdc7cd83e91d257bf95f19448bd7af9ca01eed7a9b2d5c173738d35c4f3d5e0

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - "2.1" # latest 2.1.x
   - "2.2" # latest 2.2.x
   - "jruby-19mode"
+  - "jruby-head"
 script:
   bundle exec rake test
 sudo: false

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org).
 
 ## [Unreleased]
 
+## [0.3.4] -- 2015-12-06
+
+- Add multi-sentence output option for encoding mode (-w, --line-width). This
+  allows users to output multiples of 6 words on a line when encoding.
+
 ## [0.3.3] -- 2015-12-01
 
 - Fix handling of words that straddle the 2048-byte buffer boundary. Previously

data/README.md

@@ -79,7 +79,7 @@ The same data, but hex encoded
     $ sixword -dH <<< 'BEAK NET SITE ROTH SWIM FORM'
     54657374696e670a
 
-    $ sixword -dF <<< 'BEAK NET SITE ROTH SWIM FORM'
+    $ sixword -df <<< 'BEAK NET SITE ROTH SWIM FORM'
     5465 7374 696E 670A
 
     $ sixword -d -S colons <<< 'BEAK NET SITE ROTH SWIM FORM'

data/bin/sixword

@@ -86,9 +86,16 @@ Options:
       options[:hex_style] = 'lowercase'
     end
 
-    opts.on('-f', '--fingerprint', 'Short for --hex-style fingerprint') do
+    opts.on('-f', '--fingerprint', 'Short for --hex-style fingerprint', ' ') do
       options[:hex_style] = 'fingerprint'
     end
+
+    #
+
+    opts.on('-w', '--line-width NUM',
+            'Print NUM sentences per line when encoding') do |arg|
+      options[:line_width] = Integer(arg)
+    end
   end
 
   begin

data/lib/sixword/cli.rb

@@ -27,6 +27,8 @@ module Sixword
     # @option options [:encode, :decode] :mode (:encode)
     # @option options [Boolean] :pad (false)
     # @option options [String] :hex_style
+    # @option options [Integer] :line_width (1) In encode mode, the number of
+    #   sentences to output per line.
     #
     def initialize(filename, options)
       @filename = filename
@@ -125,11 +127,29 @@ module Sixword
     end
 
     def do_encode!
+      sentences_per_line = options.fetch(:line_width, 1)
+      if sentences_per_line <= 0
+        sentences_per_line = 1 << 32
+      end
+
+      sentences = []
+
       process_encode_input do |chunk|
         Sixword.encode_iter(chunk, words_per_slice:6, pad:pad?) do |encoded|
-          yield encoded
+          sentences << encoded
+
+          # yield sentences once we reach sentences_per_line of them
+          if sentences.length >= sentences_per_line
+            yield sentences.join(' ')
+            sentences.clear
+          end
         end
       end
+
+      # yield any leftover sentences
+      unless sentences.empty?
+        yield sentences.join(' ')
+      end
     end
 
     def process_encode_input

data/lib/sixword/version.rb

@@ -1,4 +1,4 @@
 module Sixword
   # version string
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/cli/cli_spec.rb

@@ -0,0 +1,156 @@
+RSpec.describe Sixword::CLI do
+
+  @@test_warnings = Set.new
+  def warn_once(label, message)
+    unless @@test_warnings.include?(label)
+      warn message
+      @@test_warnings << label
+    end
+  end
+
+  if RUBY_ENGINE == 'jruby' && JRUBY_VERSION.start_with?('1.7')
+    RunningJruby17 = true
+  else
+    RunningJruby17 = false
+  end
+
+  # hack around jruby9 warnings on travis
+  if RUBY_ENGINE == 'jruby' && ENV['TRAVIS'] && JRUBY_VERSION.start_with?('9.0')
+    RunningTravisJruby9 = true
+    SixwordOutputPrefix = "jruby: warning: unknown property jruby.cext.enabled\n" * 2
+  else
+    RunningTravisJruby9 = false
+  end
+
+  # Run a command with input and validate the expected output and exit status.
+  def run(cmd, input_string, expected_output, expected_exitstatus=0)
+    output = nil
+
+    if RunningJruby17
+      warn_once('jruby17', 'test warning: skipping unsupported popen option :err')
+      opts = {}
+    else
+      opts = {err: [:child, :out]}
+    end
+
+    IO.popen(cmd, 'r+', opts) do |p|
+      p.write(input_string)
+      p.close_write
+      output = p.read
+    end
+
+    if expected_output.is_a?(Regexp)
+      expect(output).to match(expected_output)
+    else
+      expect(output).to eq(expected_output)
+    end
+
+    expect($?.exited?).to eq(true) unless RunningJruby17
+    expect($?.exitstatus).to eq(expected_exitstatus)
+  end
+
+  SixwordExecutable = File.dirname(__FILE__) + '/../../bin/sixword'
+
+  def run_sixword(opts, input_string, expected_output, expected_exitstatus=0)
+
+    # hack around IO.popen stderr behavior in ruby 1.9
+    if RUBY_VERSION.start_with?('1.9') && expected_exitstatus != 0 &&
+       (expected_output.is_a?(Regexp) || !expected_output.empty?)
+
+      warn_once('ruby19', "test warning: overriding output #{expected_output.inspect} with ''")
+      expected_output = ''
+    end
+
+    if RunningTravisJruby9 && expected_output.is_a?(String)
+      expected_output = SixwordOutputPrefix + expected_output
+    end
+
+    run([SixwordExecutable] + opts, input_string, expected_output, expected_exitstatus)
+  end
+
+  it 'handles basic encoding and decoding' do
+    run_sixword(['-e'], "Testing\n", "BEAK NET SITE ROTH SWIM FORM\n")
+    run_sixword([], "Testing\n", "BEAK NET SITE ROTH SWIM FORM\n")
+    run_sixword(['-d'], "BEAK NET SITE ROTH SWIM FORM\n", "Testing\n")
+    run_sixword(['-d'], "beak net site roth swim form\n", "Testing\n")
+
+    run_sixword(['-v'], '', 'sixword ' + Sixword::VERSION + "\n")
+  end
+
+  it 'returns expected error codes in various conditions' do
+    run_sixword(%w{-e --hex-style nonexistent}, '', /unknown hex style/, 2)
+    run_sixword(['-d'], "BEAK NET SITE ROTH SWIM FOR\n", /Parity bits do not match/, 3)
+    run_sixword(['-d'], "ZZZ A A A A A\n", /Unknown word: "ZZZ"/, 4)
+    run_sixword(['-d'], "AAAAAA A A A A A\n", /1-4 chars/, 5)
+
+    run_sixword(['-d'], "A\n", /multiple of 6 words/, 10)
+  end
+
+  it 'handles padding' do
+    run_sixword([], 'foo', "CHUB EMIL MUDD A A A5\n")
+    run_sixword(['-d'], "CHUB EMIL MUDD A A A5\n", 'foo')
+  end
+
+  it 'rejects padding when -p is given' do
+    run_sixword(['-ep'], '.', /multiple of 8 or use pad_encode/, 10)
+    run_sixword(['-dp'], "CHUB EMIL MUDD A A A5\n", /Unknown word: "A5"/, 4)
+  end
+
+  it 'handles basic hex styles' do
+    run_sixword(['-H'], "54:65:73:74:69:6e:67:0a\n", "BEAK NET SITE ROTH SWIM FORM\n")
+    run_sixword(['-H'], "54657374696e670a\n", "BEAK NET SITE ROTH SWIM FORM\n")
+    run_sixword(['-H'], "5465 7374 696E 670A\n", "BEAK NET SITE ROTH SWIM FORM\n")
+
+    run_sixword(['-dH'], "BEAK NET SITE ROTH SWIM FORM\n", "54657374696e670a\n")
+    run_sixword(['-df'], "BEAK NET SITE ROTH SWIM FORM\n", "5465 7374 696E 670A\n")
+    run_sixword(%w{-d -S colons}, "BEAK NET SITE ROTH SWIM FORM\n", "54:65:73:74:69:6e:67:0a\n")
+  end
+
+  it 'should encode/decode RFC hex vectors correctly' do
+    Sixword::TestVectors::HexTests.each do |_section, tests|
+      tests.each do |hex, sentence|
+        debug_puts "0x#{hex} <=> #{sentence}"
+
+        if sentence.split.length > 6
+          expected_encoded = sentence.split.each_slice(6).map {|line| line.join(' ')}.join("\n")
+        else
+          expected_encoded = sentence
+        end
+
+        run_sixword(['-df'], sentence, hex + "\n")
+        run_sixword(['-ef'], hex, expected_encoded + "\n")
+      end
+    end
+  end
+
+  it 'should handle all null bytes correctly' do
+    run_sixword(['-ep'], "\0" * 8, "A A A A A A\n")
+    run_sixword(['-dp'], "A A A A A A\n", "\0" * 8)
+  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|
+      encoded_s = encoded.join(' ') + "\n"
+      run_sixword(['-e'], binary, encoded_s)
+      run_sixword(['-d'], encoded_s, binary)
+    end
+  end
+
+  it 'should encode N sentences per line' do
+    input = 'The quick brown fox jump'
+
+    {
+      0 => "BEAK US ACHE SOUR BERN LOLA CORE ARC HULK SLID DREW DUE CHUB ENDS BOG RUSS BESS MAST\n",
+      1 => "BEAK US ACHE SOUR BERN LOLA\nCORE ARC HULK SLID DREW DUE\nCHUB ENDS BOG RUSS BESS MAST\n",
+      2 => "BEAK US ACHE SOUR BERN LOLA CORE ARC HULK SLID DREW DUE\nCHUB ENDS BOG RUSS BESS MAST\n",
+      3 => "BEAK US ACHE SOUR BERN LOLA CORE ARC HULK SLID DREW DUE CHUB ENDS BOG RUSS BESS MAST\n",
+      4 => "BEAK US ACHE SOUR BERN LOLA CORE ARC HULK SLID DREW DUE CHUB ENDS BOG RUSS BESS MAST\n",
+    }.each_pair do |width, expected_output|
+      run_sixword(['-e', '-w %d' % width], input, expected_output)
+    end
+  end
+end

data/spec/test_vectors.rb

@@ -4,7 +4,7 @@ module Sixword
     # from RFC 2289 and RFC 1751
     HexTests = {
       'rfc2289 parity' => {
-        '85c43ee03857765b' => 'FOWL KID MASH DEAD DUAL OAF',
+        '85C4 3EE0 3857 765B' => 'FOWL KID MASH DEAD DUAL OAF',
       },
       'rfc2289 md4' => {
         'D185 4218 EBBB 0B51' => 'ROME MUG FRED SCAN LIVE LACE',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sixword
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Andy Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,11 +128,12 @@ files:
 - lib/sixword/version.rb
 - lib/sixword/words.rb
 - sixword.gemspec
-- spec/sixword/hex_spec.rb
-- spec/sixword/lib_spec.rb
-- spec/sixword_spec.rb
+- spec/cli/cli_spec.rb
 - spec/spec_helper.rb
 - spec/test_vectors.rb
+- spec/unit/sixword/hex_spec.rb
+- spec/unit/sixword/lib_spec.rb
+- spec/unit/sixword_spec.rb
 homepage: https://github.com/ab/sixword
 licenses:
 - GPL-3
@@ -153,14 +154,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Implementation of RFC 2289 compatible 6-word encoding
 test_files:
-- spec/sixword/hex_spec.rb
-- spec/sixword/lib_spec.rb
-- spec/sixword_spec.rb
+- spec/cli/cli_spec.rb
 - spec/spec_helper.rb
 - spec/test_vectors.rb
+- spec/unit/sixword/hex_spec.rb
+- spec/unit/sixword/lib_spec.rb
+- spec/unit/sixword_spec.rb
 has_rdoc: