sixword 0.3.1 → 0.3.2

data/spec/sixword/lib_spec.rb

@@ -1,13 +1,11 @@
-require_relative '../rspec_helper'
-
-describe Sixword::Lib do
+RSpec.describe Sixword::Lib do
   it 'should encode 64 bits correctly' do
     {
       [0xd1, 0x85, 0x42, 0x18, 0xeb, 0xbb, 0x0b, 0x51] =>
         %w{ROME MUG FRED SCAN LIVE LACE},
     }.each do |barray, sentence|
       debug_puts "Encoding bit array: #{barray.inspect}"
-      Sixword::Lib.encode_64_bits(barray).should == sentence
+      expect(Sixword::Lib.encode_64_bits(barray)).to eq(sentence)
     end
   end
 
@@ -16,17 +14,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, 8]
+      expect(Sixword::Lib.decode_6_words(words, false)).to eq([int, 8])
     end
   end
 
 
   it 'should convert byte arrays to ints' do
-    Sixword::Lib.byte_array_to_int([1, 2]).should == 258
+    expect(Sixword::Lib.byte_array_to_int([1, 2])).to eq(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]
+    expect(Sixword::Lib.int_to_byte_array(258)).to eq([1, 2])
+    expect(Sixword::Lib.int_to_byte_array(258, 3)).to eq([0, 1, 2])
   end
 end

data/spec/sixword_spec.rb

@@ -1,37 +1,36 @@
 # coding: binary
-require_relative 'rspec_helper'
 
-describe Sixword do
+RSpec.describe Sixword do
   it 'should encode RFC hex vectors correctly' do
-    Sixword::TestVectors::HexTests.each do |section, tests|
+    Sixword::TestVectors::HexTests.each do |_section, tests|
       tests.each do |hex, sentence|
         words = sentence.split
         byte_string = Sixword::Hex.decode(hex)
         debug_puts "Encode 0x#{hex} => #{words.inspect}"
-        Sixword.encode(byte_string).should == words
+        expect(Sixword.encode(byte_string)).to eq(words)
       end
     end
   end
 
   it 'should decode RFC vectors to hex correctly' do
-    Sixword::TestVectors::HexTests.each do |section, tests|
+    Sixword::TestVectors::HexTests.each do |_section, tests|
       tests.each do |hex, sentence|
         words = sentence.split
         byte_string = Sixword::Hex.decode(hex)
         debug_puts "Decode #{words.inspect} => 0x#{hex}"
-        Sixword.decode(words).should == byte_string
+        expect(Sixword.decode(words)).to eq(byte_string)
       end
     end
   end
 
   it 'should decode with correct parity' do
-    Sixword::TestVectors::ParityTest.find_all {|k, v| v}.each do |sentence, _|
+    Sixword::TestVectors::ParityTest.find_all {|_k, v| v}.each do |sentence, _|
       debug_puts "correct parity: #{sentence.inspect}"
       expect { Sixword.decode(sentence) }.to_not raise_error
     end
   end
   it 'should raise with incorrect parity' do
-    Sixword::TestVectors::ParityTest.find_all {|k, v| !v}.each do |sentence, _|
+    Sixword::TestVectors::ParityTest.find_all {|_k, v| !v}.each do |sentence, _|
       debug_puts "incorrect parity: #{sentence.inspect}"
       expect { Sixword.decode(sentence) }.
         to raise_error(Sixword::InvalidParity)
@@ -53,15 +52,15 @@ describe Sixword do
       byte_string = Sixword::Hex.decode(hex)
       debug_puts "Encoding #{hex.inspect} to sentences"
       debug_puts " => #{sentences.inspect}"
-      Sixword.encode_to_sentences(byte_string).should == sentences
+      expect(Sixword.encode_to_sentences(byte_string)).to eq(sentences)
     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
+    expect(Sixword.encode(binary)).to eq(encoded)
+    expect(Sixword.decode(encoded)).to eq(binary)
   end
 
   it 'should handle padded null bytes correctly' do
@@ -70,8 +69,8 @@ describe Sixword do
       "\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
+      expect(Sixword.pad_encode(binary)).to eq(encoded)
+      expect(Sixword.pad_decode(encoded)).to eq(binary)
     end
   end
 
@@ -90,7 +89,7 @@ describe Sixword do
        "6C617A7920646F672E" =>
        "The quick brown fox jumps over the lazy dog.",
     }.each do |hex_string, byte_string|
-      Sixword::Hex.decode(hex_string).should == byte_string
+      expect(Sixword::Hex.decode(hex_string)).to eq(byte_string)
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+require_relative '../lib/sixword'
+require_relative 'test_vectors'
+
+# TODO: use a real logger
+$debug = ENV['DEBUG']
+def debug_puts(*args, &blk)
+  if $debug
+    puts(*args, &blk)
+  end
+end
+
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/test_vectors.rb

@@ -45,7 +45,7 @@ module Sixword
           'RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE',
         'EFF8 1F9B FBC6 5350 920C DD74 16DE 8009' =>
           'TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL',
-      }
+      },
     }
 
     # from RFC 2289

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sixword
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andy Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,34 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +112,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop-disables.yml"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,10 +128,10 @@ files:
 - lib/sixword/version.rb
 - lib/sixword/words.rb
 - sixword.gemspec
-- spec/rspec_helper.rb
 - spec/sixword/hex_spec.rb
 - spec/sixword/lib_spec.rb
 - spec/sixword_spec.rb
+- spec/spec_helper.rb
 - spec/test_vectors.rb
 homepage: https://github.com/ab/sixword
 licenses:
@@ -108,13 +153,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Implementation of RFC 2289 compatible 6-word encoding
 test_files:
-- spec/rspec_helper.rb
 - spec/sixword/hex_spec.rb
 - spec/sixword/lib_spec.rb
 - spec/sixword_spec.rb
+- spec/spec_helper.rb
 - spec/test_vectors.rb
+has_rdoc: 

data/spec/rspec_helper.rb

@@ -1,10 +0,0 @@
-require_relative '../lib/sixword'
-require_relative 'test_vectors'
-
-# TODO: use a real logger
-$debug = ENV['DEBUG']
-def debug_puts(*args, &blk)
-  if $debug
-    puts(*args, &blk)
-  end
-end