trick_bag 0.63.1 → 0.64.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2ef229476828aed3a6f31de68df08fd63c4ab68
-  data.tar.gz: 657324791c88fb759a394f5f3df239e7dd1b7aad
+  metadata.gz: 93b00bbcaf07fa98422e6fae2c1000f39666cbdb
+  data.tar.gz: 4eda3ed496a91247fbecd43402adfc91143ad064
 SHA512:
-  metadata.gz: 1be63b3498bc587b88af96dac47a96179c11299a4075efa84634e478e7edb73e9301e21b08869273f43b60785507abe140b7c8c9821f60f1b5efbefb1a4dc759
-  data.tar.gz: 4143932e28bb58aafc887a3faba3322b662562649dc37c6f9663e884c5cfdaa5e52abf079bc76d437367ad4c794fa52a79079f6ee13348812abf9d304ac57993
+  metadata.gz: e9e26ea432ced1e895d6546ce1530aaf474a4117e445907392de1234c70004100975e99d2e8e17f9f0af8e5713615834789023c7b127f122373012fa74eea1c8
+  data.tar.gz: 2502fb4ec60ff4c3e073aed59ed3ca5b016e48da70aac8cb1bbc9114fe7c318ceb3fdd5b1ce99f33cccc1195dcd3aa1e134afb4331bed3d9949b3522c02d2827

data/RELEASE_NOTES.md

@@ -1,3 +1,13 @@
+## v0.64.1
+
+* Minor documentation fix.
+
+
+## v0.64.0
+
+* Add BinaryToHexAndAscii formatter.
+
+
 ## v0.63.1
 
 * Put SshOutputReader in TrickBag::Networking module.

data/lib/trick_bag/collections/collection_access.rb

@@ -28,7 +28,7 @@ module CollectionAccess
       begin
         Integer(object)
       rescue
-        raise "Key is not a number string: #{object}"
+        raise "Key cannot be converted to an Integer: #{object}"
       end
     end
 

data/lib/trick_bag/formatters/binary_to_hex_and_ascii.rb

@@ -0,0 +1,73 @@
+module TrickBag
+
+# Takes a string as input and formats it to a string containing offset,
+# hex values, and ASCII values, with unprintable chars printed as '.'.
+# Call as TrickBag::BinaryToHexAndAscii.format(byte_array_or_string)
+#
+# Sample Output:
+
+# require 'trick_bag'
+# array = Array.new(32) { |i| i * 7 }
+# puts TrickBag::BinaryToHexAndAscii.format(array)
+
+# 0x   0  00 07 0E 15 | 1C 23 2A 31 | 38 3F 46 4D | 54 5B 62 69  .....#*18?FMT[bi
+# 0x  10  70 77 7E 85 | 8C 93 9A A1 | A8 AF B6 BD | C4 CB D2 D9  pw~.............
+
+module BinaryToHexAndAscii
+
+  module_function
+
+  def format(byte_array_or_string)
+    byte_array = if byte_array_or_string.is_a?(String)
+      byte_array_or_string.bytes
+    else
+      byte_array_or_string
+    end
+
+    result = ''
+    offset = 0
+    byte_array.each_slice(16) do |bytes|
+      result << format_line(offset, bytes) << "\n"
+      offset += 16
+    end
+    result
+  end
+
+
+  def one_to_four_bytes_as_hex(bytes)
+    bytes.map { |b| "%02X" % b }.join(' ')
+  end
+
+
+  def offset_string(offset)
+    "0x%4x" % [offset] # Offset, e.g. "0x   0" or "0x  10"
+  end
+
+
+  def join_hex_sections(sections)
+    sections.join(' | ')
+  end
+
+
+  def ascii_char(byte)
+    (32..126).include?(byte) ? byte.chr : '.'
+  end
+
+
+  def ascii_string(bytes)
+    bytes.map { |b| ascii_char(b) }.join
+  end
+
+
+  def format_line(offset, bytes)
+    sections = bytes.each_slice(4).to_a.map { |slice| one_to_four_bytes_as_hex(slice) }
+
+    offset_string(offset) \
+        << '  ' \
+        << join_hex_sections(sections).ljust(53) \
+        << '  ' \
+        << ascii_string(bytes)
+  end
+end
+
+end

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = '0.63.1'
+  VERSION = '0.64.1'
 end

data/spec/trick_bag/formatters/binary_to_hex_and_ascii_spec.rb

@@ -0,0 +1,73 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/trick_bag/formatters/binary_to_hex_and_ascii'
+
+
+module TrickBag
+module BinaryToHexAndAscii
+
+  describe BinaryToHexAndAscii do
+
+    include BinaryToHexAndAscii
+
+
+    context '#one_to_four_bytes_as_hex' do
+
+      specify '1 byte works' do
+        expect(one_to_four_bytes_as_hex([1])).to eq('01')
+      end
+
+      specify '4 bytes works' do
+        expect(one_to_four_bytes_as_hex([0, 16, 64, 255])).to eq('00 10 40 FF')
+      end
+
+    end
+
+
+    context '#offset_string' do
+      specify '0x8000 works' do
+        expect(offset_string(0x8000)).to match(/8000/)
+      end
+
+    end
+
+
+    context '#join_hex_sections' do
+      specify 'is correctly formatted' do
+        expect(join_hex_sections(%w(a b c))).to eq('a | b | c')
+      end
+    end
+
+
+    context '#ascii_char' do
+
+      test = ->(value, expected) do
+        specify "Ascii char of #{value} should be #{expected}" do
+          expect(ascii_char(value)).to eq(expected)
+        end
+      end
+      test.('a'.ord, 'a')
+      test.('*'.ord, '*')
+      test.('_'.ord, '_')
+      test.(27, '.')
+      test.(127, '.')
+      test.(255, '.')
+    end
+
+
+    context '#format' do
+
+      specify '1 line works' do
+        bytes = Array.new(15) { |i| i * 8 }
+        expect(format(bytes)).to eq("0x   0  00 08 10 18 | 20 28 30 38 | 40 48 50 58 | 60 68 70     .... (08@HPX`hp\n")
+      end
+
+      specify '2 lines works' do
+        bytes = Array.new(32) { |i| i * 7 }
+        expect(format(bytes)).to eq( \
+"0x   0  00 07 0E 15 | 1C 23 2A 31 | 38 3F 46 4D | 54 5B 62 69  .....#*18?FMT[bi
+0x  10  70 77 7E 85 | 8C 93 9A A1 | A8 AF B6 BD | C4 CB D2 D9  pw~.............\n")
+      end
+    end
+  end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.63.1
+  version: 0.64.1
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -146,6 +146,7 @@ files:
 - lib/trick_bag/enumerables/endless_last_enumerable.rb
 - lib/trick_bag/enumerables/file_line_reader.rb
 - lib/trick_bag/enumerables/filtered_enumerable.rb
+- lib/trick_bag/formatters/binary_to_hex_and_ascii.rb
 - lib/trick_bag/formatters/erb_renderer.rb
 - lib/trick_bag/formatters/formatters.rb
 - lib/trick_bag/functional/functional.rb
@@ -178,6 +179,7 @@ files:
 - spec/trick_bag/enumerables/endless_last_enumerable_spec.rb
 - spec/trick_bag/enumerables/file_line_reader_spec.rb
 - spec/trick_bag/enumerables/filtered_enumerable_spec.rb
+- spec/trick_bag/formatters/binary_to_hex_and_ascii_spec.rb
 - spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/functional/functional_spec.rb
@@ -219,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Miscellaneous general useful tools.
@@ -233,6 +235,7 @@ test_files:
 - spec/trick_bag/enumerables/endless_last_enumerable_spec.rb
 - spec/trick_bag/enumerables/file_line_reader_spec.rb
 - spec/trick_bag/enumerables/filtered_enumerable_spec.rb
+- spec/trick_bag/formatters/binary_to_hex_and_ascii_spec.rb
 - spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/functional/functional_spec.rb