zhexdump 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0405a9a00093fb08a5ff3294e1636d3350e49c83f478c2d4e1fa1575b72bb83
-  data.tar.gz: 0cf51636f3344e94c0e9a5647fbe1cb9f54b1d134e0d22cd7c595d2f41a03552
+  metadata.gz: 2a3f2ca2cbd4b74eb7d4f2e369155faed551cd1aae88c68b69b83db782b3bbad
+  data.tar.gz: e1755f4ee72a7144923ccb822d53214455ca0971e82a7cc94c104cf529865675
 SHA512:
-  metadata.gz: e117316024d5ecc48f7eefa79cff23603ef728959791c522a93aa50dafc50f05f202aeb17ee5994d2ebe9bd22c1d881840cfad3c6a392076c7aabd6da4f06b4d
-  data.tar.gz: c3d12f02963fa811e42d44f93a328eebb2a81964350b2f3edebd7666f4ef2122c1fd01488e05be2d690784dae86fbdb0c2d109f76d9d9d929360a4ab3d911171
+  metadata.gz: 130772c539567807650e00be726963b6af7c7f9773b537e01410f7229d7baf1f8187c4edb05e8536a15073a3d37193720b312e4f6047d00b1ac47369c95356a9
+  data.tar.gz: c3b20059c90fe00c3e45b4eaff82f196dfd3b68515047bc0d7f1d3360678e7891684cdc7d3ffa32e149b316fdf132c686ff4f2da5eb994002545d5ea363e5403

data/lib/zhexdump/version.rb

@@ -1,3 +1,3 @@
 module ZHexdump
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/zhexdump.rb

@@ -19,7 +19,15 @@ module ZHexdump
     r
   end
 
+  @defaults = {}
+
   class << self
+    attr_accessor :defaults
+
+    def _get_param(h, key, default)
+      h.fetch(key, defaults.fetch(key, default))
+    end
+
     def dump data, h = {}
       offset      = h.fetch(:offset, 0)
       dedup       = h.fetch(:dedup, true)
@@ -30,13 +38,20 @@ module ZHexdump
         offset = 0
       end
 
-      add           = h[:add]    || 0
-      size          = h[:size]   || (data.size-offset)
-      tail          = h[:tail]   || "\n"
-      width         = h[:width]  || 0x10                 # row width, in bytes
-      output        = h[:output] || $>
-      indent        = h[:indent] || 0
-      offset_format = h[:offset_format] || "%08x: "
+      add           = _get_param(h, :add, 0)
+      size          = _get_param(h, :size, data.size-offset)
+      tail          = _get_param(h, :tail, "\n")
+      width         = _get_param(h, :width, 16)
+      output        = _get_param(h, :output, $stdout)
+      indent        = _get_param(h, :indent, 0)
+      offset_format = _get_param(h, :offset_format, "%08x: ")
+      group_size    = _get_param(h, :group_size, 8)
+      group_sep     = _get_param(h, :group_separator, ' ')
+      show_ascii    = _get_param(h, :show_ascii, true)
+
+      byte_format   = _get_param(h, :byte_format, "%02x")
+      no_byte_str   = _get_param(h, :no_byte_str, '  ')
+      byte_sep      = _get_param(h, :byte_separator, ' ')
 
       indent = ' ' * indent
       size = data.size-offset if size+offset > data.size
@@ -45,12 +60,13 @@ module ZHexdump
       while true
         ascii = ''; hex = ''
         width.times do |i|
-          hex << ' ' if i%8==0 && i>0
+          hex << group_sep if group_size > 0 && i > 0 && i % group_size == 0
           if c = ((size > 0) && data[offset+i])
-            hex << "%02x " % c.ord
-            ascii << ((32..126).include?(c.ord) ? c : '.')
+            ord = c.ord
+            hex << (byte_format % ord) << byte_sep
+            ascii << (ord == 0 ? ' ' : ((32..126).include?(ord) ? c : '.'))
           else
-            hex << '   '
+            hex << no_byte_str << byte_sep
             ascii << ' '
           end
           size-=1
@@ -67,7 +83,11 @@ module ZHexdump
         else
           row = indent + (show_offset ? (offset_format % (offset + add)) : '') + hex
           yield(row, offset+add, ascii) if block_given?
-          row << ' |' + ascii + "|"
+          if show_ascii
+            row << ' |' + ascii + "|"
+          else
+            row.rstrip! # remove trailing spaces
+          end
           output << "\n" if offset > start
           output << row
           prevdup = false

data/spec/hexdump_spec.rb

@@ -59,10 +59,10 @@ describe ZHexdump do
     s = ''
     ZHexdump.dump data, :output => s, :indent => 2
     a = s.split("\n")
-    a[0].should == "  00000000: 66 6f 6f 62 61 72 00 00  00 00 00 00 00 00 00 00  |foobar..........|"
-    a[1].should == "  00000010: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|"
+    a[0].should == "  00000000: 66 6f 6f 62 61 72 00 00  00 00 00 00 00 00 00 00  |foobar          |"
+    a[1].should == "  00000010: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |                |"
     a[2].should == "  *"
-    a[3].should == "  00000060: 00 00 00 00 00 00 00 00  00 00                    |..........      |"
+    a[3].should == "  00000060: 00 00 00 00 00 00 00 00  00 00                    |                |"
   end
 
   it "adds :add to offset shown" do
@@ -170,4 +170,34 @@ describe ZHexdump do
     data = "foo"
     data.to_hexdump.should == "00000000: 66 6f 6f                                          |foo             |\n"
   end
+
+  it "respects :group size" do
+    data = "foobarbaz"
+    data.to_hexdump(group_size: 3).should == "00000000: 66 6f 6f  62 61 72  62 61 7a                          |foobarbaz       |\n"
+  end
+
+  it "respects :group_separator" do
+    data = "foobarbaz"
+    data.to_hexdump(group_size: 3, group_separator: "| ").should == "00000000: 66 6f 6f | 62 61 72 | 62 61 7a |          |          |     |foobarbaz       |\n"
+  end
+
+  it "respects :show_ascii" do
+    data = "foobarbaz" * 2 
+    data.to_hexdump(show_ascii: false).should == "00000000: 66 6f 6f 62 61 72 62 61  7a 66 6f 6f 62 61 72 62\n00000010: 61 7a\n"
+  end
+
+  it "respects :byte_format" do
+    data = "foobarbaz"
+    data.to_hexdump(byte_format: "%03o").should == "00000000: 146 157 157 142 141 162 142 141  172                       |foobarbaz       |\n"
+  end
+
+  it "respects :byte_separator" do
+    data = "foobarbaz"
+    data.to_hexdump(byte_separator: ":").should == "00000000: 66:6f:6f:62:61:72:62:61: 7a:  :  :  :  :  :  :  : |foobarbaz       |\n"
+  end
+
+  it "respects :no_byte_str" do
+    data = "foobarbaz"
+    data.to_hexdump(no_byte_str: "??").should == "00000000: 66 6f 6f 62 61 72 62 61  7a ?? ?? ?? ?? ?? ?? ??  |foobarbaz       |\n"
+  end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ require File.join(File.dirname(__FILE__), '../lib/zhexdump.rb')
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   #config.filter_run :focus
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhexdump
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-02 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A highly flexible hexdump implementation.