sixword 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 412a951ad1786d3f978ebc77305e6b7094004b36
-  data.tar.gz: 1a70321549259a131a8a10a536117d29a529110a
+SHA256:
+  metadata.gz: b74ea6c562414ef7a07f742098179f75bccb9807cd5e75161d5f8cb2a04ee780
+  data.tar.gz: 9e5842fc333709e4469d518d5fcffd90987a60fff2c070892923e69dcff19c93
 SHA512:
-  metadata.gz: 9a2ca1765246ff2b0df8e4ae6b6f8554abec1fbbf7c07478b5e9b36ea38e7b34cb22e352b8c49c4786e9ebaf85927a3d270c48f005fa7e8fba4a00ab24ea09b0
-  data.tar.gz: 0b44ad6d9bd5c7d2b7d0c5ddf9272357be00bf4e1917a46321c595afd72d754a33eae2eda1af3c503539f388427345b59d8ffc81e0505e544b139e910845d760
+  metadata.gz: 8b238947058e4b05daadb950f3c67f72c7ace5982d97b7e7ec68ad5047ec93ccf3b82af3b0cd9956296e04b1f625a6c0d755db6f3443612ba947a5cf68a16a9d
+  data.tar.gz: 05d8e291207ad2fcc499584a7647de32ef7f9c4a41a2d9d6b35c0a8629de7eb552e880e938a3990fa4ea2a52f8b22b618372b1bc05c2981104027da028d0eb27

data/.github/workflows/tests.yml

@@ -0,0 +1,18 @@
+name: tests
+on: [push, pull_request]
+jobs:
+  run-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]  #, macos-latest
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.6, 2.7, '3.0', head, jruby, jruby-head]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/.rubocop-disables.yml

@@ -120,13 +120,10 @@ Style/SpaceInsideBlockBraces:
 Style/SpaceInsideHashLiteralBraces:
   Enabled: false
 
-# TODO this is affected by rubocop bug
-# https://github.com/bbatsov/rubocop/issues/2448
-#
 # Offense count: 27
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
   # SupportedStyles:
   #   - comma
   #   - no_comma
@@ -136,6 +133,10 @@ Style/TrailingComma:
 Style/WordArray:
   Enabled: false
 
+# Definitely do NOT assign variables within a conditional. Christ.
+Style/ConditionalAssignment:
+  Enabled: false
+
 # ********************************
 
 # Configuration parameters: AllowedVariables.

data/CHANGELOG.md

@@ -4,6 +4,22 @@ This project adheres to [Semantic Versioning](http://semver.org).
 
 ## [Unreleased]
 
+## [0.3.5] -- 2018-03-28
+
+- Fix up rubocop config etc.
+
+## [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
+  any word that was split over the boundary would be mangled into two words,
+  resulting in an error or incorrect output. This only affected the sixword
+  CLI. [#3](https://github.com/ab/sixword/issues/3)
+
 ## [0.3.2] -- 2015-11-25
 
 - Add lots of documentation and a change log!

data/README.md

@@ -1,7 +1,7 @@
 # Sixword
 
 [![Gem Version](https://badge.fury.io/rb/sixword.svg)](https://rubygems.org/gems/sixword)
-[![Build status](https://travis-ci.org/ab/sixword.svg)](https://travis-ci.org/ab/sixword)
+[![Build status](https://github.com/ab/sixword/actions/workflows/tests.yml/badge.svg)](https://github.com/ab/sixword/actions/workflows/tests.yml)
 [![Code Climate](https://codeclimate.com/github/ab/sixword.svg)](https://codeclimate.com/github/ab/sixword)
 [![Inline Docs](http://inch-ci.org/github/ab/sixword.svg?branch=master)](http://www.rubydoc.info/github/ab/sixword/master)
 
@@ -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
@@ -165,16 +185,15 @@ module Sixword
 
     # Yield data 6 words at a time until EOF
     def read_input_by_6_words
-      block_size = 2048
       word_arr = []
 
       while true
-        buf = stream.read(block_size)
-        if buf.nil?
+        line = stream.gets
+        if line.nil?
           break # EOF
         end
 
-        buf.scan(/\S+/) do |word|
+        line.scan(/\S+/) do |word|
           word_arr << word
 
           # return the array if we have accumulated 6 words

data/lib/sixword/lib.rb

@@ -96,7 +96,8 @@ module Sixword
 
       # check parity
       unless parity_int(int) == parity
-        raise InvalidParity.new("Parity bits do not match")
+        raise InvalidParity.new("Parity bits do not match: " +
+                                word_array.join(' ').inspect)
       end
 
       # omit padding bits, if any

data/lib/sixword/version.rb

@@ -1,4 +1,4 @@
 module Sixword
   # version string
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'.freeze
 end

data/lib/sixword/words.rb

@@ -258,11 +258,7 @@ module Sixword
     "WITH",  "WOLF",  "WONT",  "WOOD",  "WOOL",  "WORD",  "WORE",  "WORK",
     "WORM",  "WORN",  "WOVE",  "WRIT",  "WYNN",  "YALE",  "YANG",  "YANK",
     "YARD",  "YARN",  "YAWL",  "YAWN",  "YEAH",  "YEAR",  "YELL",  "YOGA",
-    "YOKE"   ]
-
-  # mutability sucks
-  WORDS.freeze
-  WORDS.each(&:freeze)
+    "YOKE"   ].map(&:freeze).freeze
 
   # A mapping from Word => Integer index in the word list
   WORDS_HASH = Hash[WORDS.each_with_index.to_a]

data/sixword.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'sixword'
   spec.version       = Sixword::VERSION
   spec.authors       = ['Andy Brody']
-  spec.email         = ['abrody@abrody.com']
+  spec.email         = ['git@abrody.com']
   spec.summary       = 'Implementation of RFC 2289 compatible 6-word encoding'
   spec.description   = <<-EOM
     Sixword implements the 6-word binary encoding created for S/Key (tm) and
@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
   spec.add_development_dependency 'yard'
 
   spec.required_ruby_version = '>= 1.9.3'

data/spec/cli/cli_spec.rb

@@ -0,0 +1,158 @@
+require 'set'
+
+RSpec.describe Sixword::CLI do
+
+  TestWarnings = Set.new
+  def warn_once(label, message)
+    unless TestWarnings.include?(label)
+      warn message
+      TestWarnings << 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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -104,17 +104,17 @@ description: |2
 
       See also: Bubble Babble, PGP Word List, Diceware, Base64, Base32
 email:
-- abrody@abrody.com
+- git@abrody.com
 executables:
 - sixword
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop-disables.yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -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
@@ -152,15 +153,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.0.3.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
-has_rdoc: 
+- spec/unit/sixword/hex_spec.rb
+- spec/unit/sixword/lib_spec.rb
+- spec/unit/sixword_spec.rb

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1" # latest 2.1.x
-  - "2.2" # latest 2.2.x
-  - "jruby-19mode"
-script:
-  bundle exec rake test