hexdump 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c7d2cd541f81ae5ed4191d544eac913e7e9b2f55fad23320fedb00ce6b02eb2
-  data.tar.gz: 6c12dd82076f8b2bf1272ad47f9e509c6f0553642c9ad2079eeab38bca3dad36
+  metadata.gz: 7f797d519e67c6284088b0052bc49a75b7fb7b7588d1cdc8b01d017039272c77
+  data.tar.gz: d1920db1ac10b3b2d07bcc3a5423f0764751eb6d2ac64e2e5ddb09ed14cf6e4d
 SHA512:
-  metadata.gz: cf2a9fc5999b94a8ad91b5bcef2a001a66e1e2f9e177b37c7e256df6775b708d84e061b0024428f3c6a0834d42f148d714f0e200a923b64f979761d500f60088
-  data.tar.gz: 7044bdfd16ff11ac1cb38b9d1f9d28faf61d147d1f5f2932e37e018479de77c194e587e39342a45103c6c4acc2128f09463d1b56f44637f99e850103c07a7c87
+  metadata.gz: a2e74dcd20c447a3ce959a7af67b65bcaa95a1805c56d9ea205b106d6a04547ff8dd642ae94b5c09213c5356222d7818782805dd38ad7d4b37b6254c9047c218
+  data.tar.gz: b70d82e23d3eeab44dcec8e617198fad89cec5052a37d421d8bdc9ffaf128af6a03a0babca98105c9a8ac1c92406fe956c01426c292be56524a9ad41b79417cd

data/.github/workflows/ruby.yml

@@ -9,16 +9,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.gitignore

@@ -1,4 +1,5 @@
 /Gemfile.lock
+/coverage
 /doc/
 /pkg/
 /vendor/bundle/

data/.yardopts

@@ -1 +1 @@
---markup markdown --title "hexdump Documentation" --protected --quiet
+--markup markdown --title "hexdump Documentation" --protected

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 1.0.1 / 2024-01-23
+
+* Switched to using `require_relative` to improve load-times.
+* Correctly alias `:long`/`:ulong` to `:int32`/`:uint32`.
+* Disable ANSI styling in {Hexdump#hexdump} if the output is not a TTY.
+* Removed the old `hexdump/extensions` file in favor of `hexdump/core_ext`.
+
 ### 1.0.0 / 2021-08-31
 
 * Added the ability to hexdump typed data. Available `type:`s are :
@@ -68,10 +75,10 @@
 
 * Require Ruby >= 2.0.0.
 * Added support for Ruby 3.0.
-* {Hexdump.dump}, {Hexdump#dump}, and {Hexdump::Dumper#initialize} now accept
+* {Hexdump.dump}, {Hexdump#dump}, and `Hexdump::Dumper#initialize` now accept
   keyword arguments.
-* {Hexdump::Dumper#each} now returns the total number of bytes read.
-* {Hexdump::Dumper#dump} now prints the final number of bytes read on the last
+* `Hexdump::Dumper#each` now returns the total number of bytes read.
+* `Hexdump::Dumper#dump` now prints the final number of bytes read on the last
   line.
 * Micro-optimizations to improve performance on JRuby and TruffleRuby.
 
@@ -102,7 +109,7 @@
 
 ### 0.2.0 / 2011-06-11
 
-* Added {Hexdump::Dumper}.
+* Added `Hexdump::Dumper`.
 * Added support for hexdumping 1, 2, 4, 8 byte words.
 * Added support for hexdumping Little and Big Endian words.
 * Optimized the hexdump algorithm to not use Arrays, use a lookup table

data/Gemfile

@@ -6,7 +6,9 @@ group :development do
   gem 'rake'
   gem 'rubygems-tasks', '~> 0.2'
   gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.20'
   gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
   gem 'yard',           '~> 0.9'
   gem 'yard-spellcheck', require: false
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2021 Hal Brodigan
+Copyright (c) 2011-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,15 @@
 # hexdump.rb
 
 [![CI](https://github.com/postmodern/hexdump.rb/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/hexdump.rb/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/hexdump.svg)](https://badge.fury.io/rb/hexdump)
 
 * [Source](https://github.com/postmodern/hexdump.rb)
 * [Issues](https://github.com/postmodern/hexdump.rb/issues)
-* [Documentation](http://rubydoc.info/gems/hexdump/frames)
+* [Documentation](https://rubydoc.info/gems/hexdump)
 
 ## Description
 
-Simple and Fast hexdumping for Ruby.
+Fully Featured and Fast hexdumping for Ruby.
 
 ## Features
 
@@ -27,24 +28,29 @@ Simple and Fast hexdumping for Ruby.
   * `uint16_le` / `ushort_le` - unsigned 16bit integer (little endian)
   * `uint16_be` / `ushort_be` - unsigned 16bit integer (big endian)
   * `uint16_ne` / `ushort_ne` - unsigned 16bit integer (network endian)
-  * `int32` / `int` / `long` - signed 32bit integer
-  * `int32_le` / `int_le` / `long_le` - signed 32bit integer (little endian)
-  * `int32_be` / `int_be` / `long_be` - signed 32bit integer (big endian)
-  * `int32_ne` / `int_ne` / `long_ne` - signed 32bit integer (network endian)
-  * `uint32` / `uint` / `ulong` - unsigned 32bit integer
-  * `uint32_le` / `uint_le` / `ulong_le` - unsigned 32bit integer
+  * `int32` / `int` - signed 32bit integer
+  * `int32_le` / `int_le` - signed 32bit integer (little endian)
+  * `int32_be` / `int_be` - signed 32bit integer (big endian)
+  * `int32_ne` / `int_ne` - signed 32bit integer (network endian)
+  * `uint32` / `uint` / - unsigned 32bit integer
+  * `uint32_le` / `uint_le` - unsigned 32bit integer
     (little endian)
-  * `uint32_be` / `uint_be` / `ulong_be` - unsigned 32bit integer (big endian)
-  * `uint32_ne` / `uint_ne` / `ulong_ne` - unsigned 32bit integer
+  * `uint32_be` / `uint_be` - unsigned 32bit integer (big endian)
+  * `uint32_ne` / `uint_ne` - unsigned 32bit integer
+    (network endian)
+  * `int64` / `long` / `long_long` - signed 64bit integer
+  * `int64_le` / `long_le` / `long_long_le` - signed 64bit integer
+    (little endian)
+  * `int64_be` / `long_be` / `long_long_be` - signed 64bit integer (big endian)
+  * `int64_ne` / `long_ne` / `long_long_ne` - signed 64bit integer
+    (network endian)
+  * `uint64` `ulong` / `ulong_long` - unsigned 64bit integer
+  * `uint64_le` / `ulong_le` / `ulong_long_le` - unsigned 64bit integer
+     (little endian)
+  * `uint64_be` / `ulong_be` / `ulong_long_be` - unsigned 64bit integer
+    (big endian)
+  * `uint64_ne` / `ulong_ne` / `ulong_long_ne` - unsigned 64bit integer
     (network endian)
-  * `int64` / `long_long` - signed 64bit integer
-  * `int64_le` / `long_long_le` - signed 64bit integer (little endian)
-  * `int64_be` / `long_long_be` - signed 64bit integer (big endian)
-  * `int64_ne` / `long_long_ne` - signed 64bit integer (network endian)
-  * `uint64` / `ulong_long` - unsigned 64bit integer
-  * `uint64_le` / `ulong_long_le` - unsigned 64bit integer (little endian)
-  * `uint64_be` / `ulong_long_be` - unsigned 64bit integer (big endian)
-  * `uint64_ne` / `ulong_long_ne` - unsigned 64bit integer (network endian)
   * `float` - single precision 32bit floating-point number
   * `float_le` - single precision 32bit floating-point number (little endian)
   * `float_be` - single precision 32bit floating-point number (big endian)
@@ -66,6 +72,12 @@ Simple and Fast hexdumping for Ruby.
 * Makes {String}, {StringIO}, {IO}, {File} objects hexdumpable.
 * Fast-ish.
 
+## Requirements
+
+* [Ruby] >= 2.0.0
+
+[Ruby]: https://www.ruby-lang.org/
+
 ## Install
 
 ```shell
@@ -241,7 +253,7 @@ Hexdump.hexdump("ABCD" * 7, type: :uint32_be)
 ### Int Type
 
 ```ruby
-Hexdump.hexdump([65535, -1].pack("LL"), type: :int32_be, base: 10)
+Hexdump.hexdump([65535, -1].pack("LL"), type: :int32, base: 10)
 # 00000000       65535         -1                          |........|
 # 00000008
 ```

data/gemspec.yml

@@ -1,6 +1,6 @@
 name: hexdump
 summary: Hexdump Strings and IO objects.
-description: Simple and Fast hexdumping for Ruby.
+description: Fully Featured and Fast hexdumping for Ruby.
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
@@ -12,6 +12,7 @@ metadata:
   source_code_uri:   https://github.com/postmodern/hexdump.rb
   bug_tracker_uri:   https://github.com/postmodern/hexdump.rb/issues
   changelog_uri:     https://github.com/postmodern/hexdump.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 
 required_ruby_version: ">= 2.0.0"
 

data/hexdump.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'hexdump/version'
+                  require_relative 'lib/hexdump/version'
                   Hexdump::VERSION
                 end
 

data/lib/hexdump/core_ext/file.rb

@@ -1,4 +1,4 @@
-require 'hexdump/core_ext/io'
+require_relative 'io'
 
 class File
 
@@ -9,7 +9,7 @@ class File
   #   The path of the file.
   #
   # @param [Hash{Symbol => Object}] kwargs
-  #   Additional keyword arguments for {Format#initialize}.
+  #   Additional keyword arguments for {Hexdump::Hexdump#initialize}.
   #
   # @option kwargs [#print] :output ($stdout)
   #   The output to print the hexdump to.

data/lib/hexdump/core_ext/io.rb

@@ -1,4 +1,4 @@
-require 'hexdump/mixin'
+require_relative '../mixin'
 
 class IO
 

data/lib/hexdump/core_ext/kernel.rb

@@ -1,7 +1,5 @@
-require 'hexdump/module_methods'
-
-module ::Kernel
-  private
+require_relative '../module_methods'
 
+module Kernel
   include Hexdump::ModuleMethods
 end

data/lib/hexdump/core_ext/string.rb

@@ -1,4 +1,4 @@
-require 'hexdump/mixin'
+require_relative '../mixin'
 
 class String
 

data/lib/hexdump/core_ext/string_io.rb

@@ -1,4 +1,4 @@
-require 'hexdump/mixin'
+require_relative '../mixin'
 
 require 'stringio'
 

data/lib/hexdump/core_ext.rb

@@ -1,5 +1,5 @@
-require 'hexdump/core_ext/string'
-require 'hexdump/core_ext/string_io'
-require 'hexdump/core_ext/io'
-require 'hexdump/core_ext/file'
-require 'hexdump/core_ext/kernel'
+require_relative 'core_ext/string'
+require_relative 'core_ext/string_io'
+require_relative 'core_ext/io'
+require_relative 'core_ext/file'
+require_relative 'core_ext/kernel'

data/lib/hexdump/hexdump.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'hexdump/types'
-require 'hexdump/reader'
-require 'hexdump/numeric'
-require 'hexdump/chars'
-require 'hexdump/theme'
+require_relative 'types'
+require_relative 'reader'
+require_relative 'numeric'
+require_relative 'chars'
+require_relative 'theme'
 
 module Hexdump
   #
@@ -93,7 +93,7 @@ module Hexdump
     # @param [Integer] index_offset
     #   The offset to start the index at.
     #
-    # @param [Boolean] chars
+    # @param [Boolean] chars_column
     #   Controls whether to display the characters column.
     #
     # @param [:ascii, :utf8, Encoding, nil] encoding
@@ -481,16 +481,14 @@ module Hexdump
     #   The given block will be passed the hexdump break-down of each
     #   row.
     #
-    # @yieldparam [Integer, '*'] index
+    # @yieldparam [Integer] index
     #   The index of the hexdumped row.
-    #   If the index is `'*'`, then it indicates the beginning of repeating
-    #   rows of data.
     #
     # @yieldparam [Array<Integer>, Array<Float>] values
     #   The decoded values.
     #
-    # @yieldparam [String] chars
-    #   A raw characters that were read.
+    # @yieldparam [Array<String>, nil] chars
+    #   The underlying raw characters that were read.
     #
     # @return [Integer, Enumerator]
     #   If a block is given, then the final number of bytes read is returned.
@@ -584,7 +582,7 @@ module Hexdump
     #   The given block will be passed the hexdump break-down of each
     #   row.
     #
-    # @yieldparam [Integer, '*'] index
+    # @yieldparam [String] index
     #   The index of the hexdumped row.
     #   If the index is `'*'`, then it indicates the beginning of repeating
     #   rows of data.
@@ -592,7 +590,7 @@ module Hexdump
     # @yieldparam [Array<String>, nil] numeric
     #   The numeric representation of the row.
     #
-    # @yieldparam [Array<String>, nil] chars
+    # @yieldparam [String, nil] chars
     #   The printable representation of the row.
     #
     # @return [String, Enumerator]
@@ -736,7 +734,7 @@ module Hexdump
     # @param [#each_byte] data
     #   The data to be hexdumped.
     #
-    # @param [#print] output
+    # @param [#<<] output
     #   The output to dump the hexdump to.
     #
     # @return [nil]
@@ -749,7 +747,7 @@ module Hexdump
         raise(ArgumentError,"output must support the #<< method")
       end
 
-      ansi = theme? && $stdout.tty?
+      ansi = theme? && output.tty?
 
       each_line(data, ansi: ansi) do |line|
         output << line

data/lib/hexdump/mixin.rb

@@ -1,4 +1,4 @@
-require 'hexdump/hexdump'
+require_relative 'hexdump'
 
 module Hexdump
   #
@@ -27,9 +27,6 @@ module Hexdump
     # @param [#print] output ($stdout)
     #   The output to print the hexdump to.
     #
-    # @param [Integer] offset
-    #   The offset to start the index at.
-    #
     # @param [Hash{Symbol => Object}] kwargs
     #   Additional keyword arguments for {Hexdump#initialize}.
     #
@@ -114,9 +111,6 @@ module Hexdump
     #
     # Outputs the hexdump to a String.
     #
-    # @param [Integer] offset
-    #   The offset to start the index at.
-    #
     # @param [Hash{Symbol => Object}] kwargs
     #   Additional keyword arguments for {Hexdump#initialize}.
     #

data/lib/hexdump/module_methods.rb

@@ -1,4 +1,4 @@
-require 'hexdump/hexdump'
+require_relative 'hexdump'
 
 module Hexdump
   #

data/lib/hexdump/numeric/binary.rb

@@ -1,5 +1,5 @@
-require 'hexdump/numeric/exceptions'
-require 'hexdump/format_string'
+require_relative 'exceptions'
+require_relative '../format_string'
 
 module Hexdump
   module Numeric

data/lib/hexdump/numeric/char_or_int.rb

@@ -1,4 +1,4 @@
-require 'hexdump/format_string'
+require_relative '../format_string'
 
 module Hexdump
   module Numeric
@@ -9,7 +9,7 @@ module Hexdump
     #
     class CharOrInt < FormatString
 
-      # @return [Base::Hexadecimal, Base::Decimal, Base::Octal, Base::Binary]
+      # @return [Hexadecimal, Decimal, Octal, Binary]
       attr_reader :base
 
       # @return [Encoding, nil]
@@ -18,7 +18,7 @@ module Hexdump
       #
       # Initializes the character format.
       #
-      # @param [Base::Hexadecimal, Base::Decimal, Base::Octal, Base::Binary] base
+      # @param [Hexadecimal, Decimal, Octal, Binary] base
       #   The numeric base format to fallback to if a value does not map to a
       #   character.
       #
@@ -32,6 +32,11 @@ module Hexdump
         super("%#{@base.width}s")
       end
 
+      #
+      # The string width associated with the numeric base.
+      #
+      # @return [Integer]
+      #
       def width
         @base.width
       end

data/lib/hexdump/numeric/decimal.rb

@@ -1,4 +1,4 @@
-require 'hexdump/format_string'
+require_relative '../format_string'
 
 module Hexdump
   module Numeric

data/lib/hexdump/numeric/hexadecimal.rb

@@ -1,4 +1,4 @@
-require 'hexdump/format_string'
+require_relative '../format_string'
 
 module Hexdump
   module Numeric

data/lib/hexdump/numeric/octal.rb

@@ -1,5 +1,5 @@
-require 'hexdump/numeric/exceptions'
-require 'hexdump/format_string'
+require_relative 'exceptions'
+require_relative '../format_string'
 
 module Hexdump
   module Numeric

data/lib/hexdump/numeric.rb

@@ -1,5 +1,5 @@
-require 'hexdump/numeric/binary'
-require 'hexdump/numeric/octal'
-require 'hexdump/numeric/decimal'
-require 'hexdump/numeric/hexadecimal'
-require 'hexdump/numeric/char_or_int'
+require_relative 'numeric/binary'
+require_relative 'numeric/octal'
+require_relative 'numeric/decimal'
+require_relative 'numeric/hexadecimal'
+require_relative 'numeric/char_or_int'

data/lib/hexdump/reader.rb

@@ -32,7 +32,8 @@ module Hexdump
     #   The type to decode the data as.
     #
     # @param [Integer, nil] offset
-    #   Controls whether to offset N number of bytes before starting to read data.
+    #   Controls whether to offset N number of bytes before starting to read
+    #   data.
     #
     # @param [Integer, nil] length
     #   Controls control many bytes to read.
@@ -103,8 +104,6 @@ module Hexdump
         raise(ArgumentError,"the given data must respond to #each_byte")
       end
 
-      count = 0
-
       if @type.size == 1
         each_byte(data) do |b|
           yield b.chr
@@ -133,7 +132,7 @@ module Hexdump
 
             yield buffer
           else
-            # yield the reamining partial buffer
+            # yield the remaining partial buffer
             yield buffer[0,index]
           end
         end
@@ -173,24 +172,24 @@ module Hexdump
                         when :little then 'S<'
                         when :big    then 'S>'
                         else
-                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                         end
                       when 4
                         case @type.endian
                         when :little then 'L<'
                         when :big    then 'L>'
                         else
-                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                         end
                       when 8
                         case @type.endian
                         when :little then 'Q<'
                         when :big    then 'Q>'
                         else
-                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                          raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                         end
                       else
-                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.name}")
+                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.inspect}")
                       end
 
         each_slice(data) do |slice|
@@ -221,24 +220,24 @@ module Hexdump
                       when :little then 's<'
                       when :big    then 's>'
                       else
-                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                       end
                     when 4
                       case @type.endian
                       when :little then 'l<'
                       when :big    then 'l>'
                       else
-                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                       end
                     when 8
                       case @type.endian
                       when :little then 'q<'
                       when :big    then 'q>'
                       else
-                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                        raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                       end
                     else
-                      raise(TypeError,"unsupported type size #{@type.size} for #{@type.name}")
+                      raise(TypeError,"unsupported type size #{@type.size} for #{@type.inspect}")
                     end
 
       each_slice(data) do |slice|
@@ -266,17 +265,17 @@ module Hexdump
                       when 4 then 'e'
                       when 8 then 'E'
                       else
-                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.name}")
+                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.inspect}")
                       end
                     when :big
                       case @type.size
                       when 4 then 'g'
                       when 8 then 'G'
                       else
-                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.name}")
+                        raise(TypeError,"unsupported type size #{@type.size} for #{@type.inspect}")
                       end
                     else
-                      raise(TypeError,"unsupported endian #{@type.endian} for #{@type.name}")
+                      raise(TypeError,"unsupported endian #{@type.endian} for #{@type.inspect}")
                     end
 
       each_slice(data) do |slice|

data/lib/hexdump/theme/ansi.rb

@@ -52,7 +52,8 @@ module Hexdump
       #
       # Initializes an ANSI control sequence.
       #
-      # @param [Symbol, Array<Symbol>] style
+      # @param [Symbol, Array<Symbol>] parameters
+      #   The ANSI styling parameters. See {PARAMETERS}.
       #
       def initialize(parameters)
         @parameters = parameters

data/lib/hexdump/theme/rule.rb

@@ -1,4 +1,4 @@
-require 'hexdump/theme/ansi'
+require_relative 'ansi'
 
 require 'strscan'
 

data/lib/hexdump/theme.rb

@@ -1,4 +1,4 @@
-require 'hexdump/theme/rule'
+require_relative 'theme/rule'
 
 module Hexdump
   #

data/lib/hexdump/type.rb

@@ -19,13 +19,14 @@ module Hexdump
     #
     # Initializes the type.
     #
-    # @param [Symbol] name
+    # @param [1, 2, 4, 8] size
+    #   The type's size in bytes.
     #
     # @param [:little, :big, nil] endian
-    #
-    # @param [1, 2, 4, 8] size
+    #   The endianness of the type. `nil` indicates the type has no endianness.
     #
     # @param [Boolean] signed
+    #   Indicates whether the type is signed or unsigned.
     #
     # @raise [ArgumentError]
     #   Invalid `endian:` or `size:` values.

data/lib/hexdump/types.rb

@@ -1,4 +1,4 @@
-require 'hexdump/type'
+require_relative 'type'
 
 module Hexdump
   #
@@ -76,15 +76,15 @@ module Hexdump
   TYPES[:uint_be] = TYPES[:uint32_be]
   TYPES[:uint_ne] = TYPES[:uint32_ne]
 
-  TYPES[:long]    = TYPES[:int32]
-  TYPES[:long_le] = TYPES[:int32_le]
-  TYPES[:long_be] = TYPES[:int32_be]
-  TYPES[:long_ne] = TYPES[:int32_ne]
+  TYPES[:long]    = TYPES[:int64]
+  TYPES[:long_le] = TYPES[:int64_le]
+  TYPES[:long_be] = TYPES[:int64_be]
+  TYPES[:long_ne] = TYPES[:int64_ne]
 
-  TYPES[:ulong]    = TYPES[:uint32]
-  TYPES[:ulong_le] = TYPES[:uint32_le]
-  TYPES[:ulong_be] = TYPES[:uint32_be]
-  TYPES[:ulong_ne] = TYPES[:uint32_ne]
+  TYPES[:ulong]    = TYPES[:uint64]
+  TYPES[:ulong_le] = TYPES[:uint64_le]
+  TYPES[:ulong_be] = TYPES[:uint64_be]
+  TYPES[:ulong_ne] = TYPES[:uint64_ne]
 
   TYPES[:long_long]    = TYPES[:int64]
   TYPES[:long_long_le] = TYPES[:int64_le]

data/lib/hexdump/version.rb

@@ -1,4 +1,4 @@
 module Hexdump
   # hexdump version
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/hexdump.rb

@@ -1,6 +1,6 @@
-require 'hexdump/module_methods'
-require 'hexdump/core_ext'
-require 'hexdump/version'
+require_relative 'hexdump/module_methods'
+require_relative 'hexdump/core_ext'
+require_relative 'hexdump/version'
 
 module Hexdump
   extend ModuleMethods

data/spec/core_ext_spec.rb

@@ -19,6 +19,6 @@ describe "Hexdump core_ext" do
   end
 
   it "should include Hexdump::ModuleMethods into ::Kernel" do
-    expect(::Kernel).to include(Hexdump::ModuleMethods)
+    expect(Kernel).to include(Hexdump::ModuleMethods)
   end
 end

data/spec/format_string_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'hexdump/format_string'
+
+describe Hexdump::FormatString do
+  let(:fmt) { "%x" }
+
+  subject { described_class.new(fmt) }
+
+  describe "#%" do
+    let(:value) { 255 }
+
+    it "must format the given value" do
+      expect(subject % value).to eq(fmt % value)
+    end
+  end
+
+  describe "#to_s" do
+    it "must return the format string" do
+      expect(subject.to_s).to eq(fmt)
+    end
+  end
+end

data/spec/reader_spec.rb

@@ -53,11 +53,13 @@ describe Hexdump::Reader do
     end
   end
 
+  let(:type) { Hexdump::TYPES[:byte] }
+
+  subject { described_class.new(type) }
+
   describe "#each_byte" do
     let(:type)  { Hexdump::TYPES[:uint8] }
 
-    subject { described_class.new(type) }
-
     let(:chars) { %w[A B C D] }
     let(:data)  { chars.join  }
     let(:bytes) { data.bytes  }
@@ -107,8 +109,6 @@ describe Hexdump::Reader do
       let(:chars) { %w[A B C D]           }
       let(:data)  { "ABCD"                }
 
-      subject { described_class.new(type) }
-
       it "must yield each consequetize character" do
         expect { |b|
           subject.each_slice(data,&b)
@@ -147,8 +147,6 @@ describe Hexdump::Reader do
       let(:slices) { %w[AA BB CC DD EE FF]  }
       let(:data)   { "AABBCCDDEEFF"         }
 
-      subject { described_class.new(type) }
-
       it "must yield each slice of the String" do
         expect { |b|
           subject.each_slice(data,&b)
@@ -220,9 +218,7 @@ describe Hexdump::Reader do
       let(:bytes) { [0x41, 0x42, 0x43, 0x44] }
       let(:raw)   { bytes.map(&:chr) }
       let(:data)  { raw.join }
-      let(:type)  { Hexdump::TYPES[:int8] }
-
-      subject { described_class.new(type) }
+      let(:type)  { Hexdump::TYPES[:uint8] }
 
       it "must yield each byte" do
         expect { |b|
@@ -239,8 +235,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('S<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -273,8 +267,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('S>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -311,8 +303,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('L<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -345,8 +335,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('L>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -383,8 +371,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('Q<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -417,8 +403,6 @@ describe Hexdump::Reader do
         let(:raw)   { uints.map { |uint| [uint].pack('Q>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_uint(data,&b)
@@ -463,8 +447,6 @@ describe Hexdump::Reader do
       let(:raw)   { ints.map { |int| [int].pack('c') } }
       let(:data)  { raw.join }
 
-      subject { described_class.new(type) }
-
       it "must decode the bytes" do
         expect { |b|
           subject.each_int(data,&b)
@@ -480,8 +462,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('s<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -489,7 +469,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01".encode(Encoding::BINARY) }
+          let(:data) { "\x11".encode(Encoding::BINARY) }
 
           it "must yield the remaining bytes and nil" do
             expect { |b|
@@ -503,7 +483,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x01)
+              }.to yield_with_args("#{data}\x00",0x11)
             end
           end
         end
@@ -514,8 +494,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('s>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -523,7 +501,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01".encode(Encoding::BINARY) }
+          let(:data) { "\x11".encode(Encoding::BINARY) }
 
           it "must yield the remaining bytes and nil" do
             expect { |b|
@@ -537,7 +515,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x0100)
+              }.to yield_with_args("#{data}\x00",0x1100)
             end
           end
         end
@@ -552,8 +530,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('l<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -561,7 +537,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01\x02\x03".encode(Encoding::BINARY) }
+          let(:data) { "\x11\x22\x33".encode(Encoding::BINARY) }
 
           it "must yield the remaining bytes and nil" do
             expect { |b|
@@ -575,7 +551,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x00030201)
+              }.to yield_with_args("#{data}\x00",0x00332211)
             end
           end
         end
@@ -586,8 +562,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('l>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -595,7 +569,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01\x02\x03".encode(Encoding::BINARY) }
+          let(:data) { "\x11\x22\x33".encode(Encoding::BINARY) }
 
           it "must yield the remaining bytes and nil" do
             expect { |b|
@@ -609,7 +583,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x01020300)
+              }.to yield_with_args("#{data}\x00",0x11223300)
             end
           end
         end
@@ -624,8 +598,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('q<') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -633,7 +605,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01\x02\x03\x04\x05\x06\x07".encode(Encoding::BINARY) }
+          let(:data) { "\x11\x22\x33\x44\x55\x66\x77".encode(Encoding::BINARY) }
 
           it "must yield the remaining bytes and nil" do
             expect { |b|
@@ -647,7 +619,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x0007060504030201)
+              }.to yield_with_args("#{data}\x00",0x0077665544332211)
             end
           end
         end
@@ -658,8 +630,6 @@ describe Hexdump::Reader do
         let(:raw)   { ints.map { |int| [int].pack('q>') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_int(data,&b)
@@ -667,7 +637,7 @@ describe Hexdump::Reader do
         end
 
         context "but there is not enough bytes to decode a value" do
-          let(:data) { "\x01\x02\x03\x04\x05\x06\x07".encode(Encoding::BINARY) }
+          let(:data) { "\x11\x22\x33\x44\x55\x66\x77".encode(Encoding::BINARY) }
 
           it "must yield nil and the remaining bytes" do
             expect { |b|
@@ -681,7 +651,7 @@ describe Hexdump::Reader do
             it "must yield the zero-padded data and partially decoded int" do
               expect { |b|
                 subject.each_int(data,&b)
-              }.to yield_with_args("#{data}\x00",0x0102030405060700)
+              }.to yield_with_args("#{data}\x00",0x1122334455667700)
             end
           end
         end
@@ -698,6 +668,8 @@ describe Hexdump::Reader do
   end
 
   describe "#each_float" do
+    let(:type)  { Hexdump::TYPES[:float] }
+
     context "when the type has size of 4" do
       let(:floats) { [1.0, -3.0, 5.0, -7.0, 9.0] }
 
@@ -706,8 +678,6 @@ describe Hexdump::Reader do
         let(:raw)   { floats.map { |float| [float].pack('e') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_float(data,&b)
@@ -726,7 +696,7 @@ describe Hexdump::Reader do
           context "but #zero_pad? is true" do
             subject { described_class.new(type, zero_pad: true) }
 
-            it "must yield the zero-padded data and partially decoded int" do
+            it "must yield the zero-padded data and partially decoded float" do
               expect { |b|
                 subject.each_float(data,&b)
               }.to yield_with_args("#{data}\x00",2.7622535458617227e-40)
@@ -740,8 +710,6 @@ describe Hexdump::Reader do
         let(:raw)   { floats.map { |float| [float].pack('g') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_float(data,&b)
@@ -760,7 +728,7 @@ describe Hexdump::Reader do
           context "but #zero_pad? is true" do
             subject { described_class.new(type, zero_pad: true) }
 
-            it "must yield the zero-padded data and partially decoded int" do
+            it "must yield the zero-padded data and partially decoded float" do
               expect { |b|
                 subject.each_float(data,&b)
               }.to yield_with_args("#{data}\x00",2.387938139551892e-38)
@@ -778,8 +746,6 @@ describe Hexdump::Reader do
         let(:raw)   { floats.map { |float| [float].pack('E') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in little-endian order" do
           expect { |b|
             subject.each_float(data,&b)
@@ -798,7 +764,7 @@ describe Hexdump::Reader do
           context "but #zero_pad? is true" do
             subject { described_class.new(type, zero_pad: true) }
 
-            it "must yield the zero-padded data and partially decoded int" do
+            it "must yield the zero-padded data and partially decoded float" do
               expect { |b|
                 subject.each_float(data,&b)
               }.to yield_with_args("#{data}\x00",9.76739841864353e-309)
@@ -812,8 +778,6 @@ describe Hexdump::Reader do
         let(:raw)   { floats.map { |float| [float].pack('G') } }
         let(:data)  { raw.join }
 
-        subject { described_class.new(type) }
-
         it "must decode the bytes in big-endian order" do
           expect { |b|
             subject.each_float(data,&b)
@@ -832,7 +796,7 @@ describe Hexdump::Reader do
           context "but #zero_pad? is true" do
             subject { described_class.new(type, zero_pad: true) }
 
-            it "must yield the zero-padded data and partially decoded int" do
+            it "must yield the zero-padded data and partially decoded float" do
               expect { |b|
                 subject.each_float(data,&b)
               }.to yield_with_args("#{data}\x00",8.207880399131826e-304)
@@ -852,6 +816,45 @@ describe Hexdump::Reader do
   end
 
   describe "#each" do
+    context "when #type is a UInt" do
+      let(:type)  { Hexdump::TYPES[:uint32] }
+      let(:uints) { [1, 2, 3] }
+      let(:raw)   { uints.map { |uint| [uint].pack('L') } }
+      let(:data)  { raw.join }
+
+      it "must yield decoded integers" do
+        expect { |b|
+          subject.each(data,&b)
+        }.to yield_successive_args(*raw.zip(uints))
+      end
+    end
+
+    context "when #type is a Int" do
+      let(:type) { Hexdump::TYPES[:int32] }
+      let(:ints) { [1, 2, 3] }
+      let(:raw)  { ints.map { |int| [int].pack('l') } }
+      let(:data) { raw.join }
+
+      it "must yield decoded integers" do
+        expect { |b|
+          subject.each(data,&b)
+        }.to yield_successive_args(*raw.zip(ints))
+      end
+    end
+
+    context "when #type is a Float" do
+      let(:type)   { Hexdump::TYPES[:float] }
+      let(:floats) { [1.0, 2.0, 3.0] }
+      let(:raw)    { floats.map { |float| [float].pack('e') } }
+      let(:data)   { raw.join }
+
+      it "must yield decoded integers" do
+        expect { |b|
+          subject.each(data,&b)
+        }.to yield_successive_args(*raw.zip(floats))
+      end
+    end
+
     context "when the given data does not define #each_byte" do
       it do
         expect {

data/spec/spec_helper.rb

@@ -1 +1,3 @@
 require 'rspec'
+require 'simplecov'
+SimpleCov.start

data/spec/types_spec.rb

@@ -448,25 +448,25 @@ describe "Hexdump::TYPES" do
 
   describe "long" do
     it "must be an alias to int32" do
-      expect(subject[:long]).to be(subject[:int32])
+      expect(subject[:long]).to be(subject[:int64])
     end
   end
 
   describe "long_le" do
     it "must be an alias to int32_le" do
-      expect(subject[:long_le]).to be(subject[:int32_le])
+      expect(subject[:long_le]).to be(subject[:int64_le])
     end
   end
 
   describe "long_be" do
     it "must be an alias to int32_be" do
-      expect(subject[:long_be]).to be(subject[:int32_be])
+      expect(subject[:long_be]).to be(subject[:int64_be])
     end
   end
 
   describe "long_ne" do
     it "must be an alias to int32_ne" do
-      expect(subject[:long_ne]).to be(subject[:int32_ne])
+      expect(subject[:long_ne]).to be(subject[:int64_ne])
     end
   end
 
@@ -496,25 +496,25 @@ describe "Hexdump::TYPES" do
 
   describe "ulong" do
     it "must be an alias to uint32" do
-      expect(subject[:ulong]).to be(subject[:uint32])
+      expect(subject[:ulong]).to be(subject[:uint64])
     end
   end
 
   describe "ulong_le" do
     it "must be an alias to uint32_le" do
-      expect(subject[:ulong_le]).to be(subject[:uint32_le])
+      expect(subject[:ulong_le]).to be(subject[:uint64_le])
     end
   end
 
   describe "ulong_be" do
     it "must be an alias to uint32_be" do
-      expect(subject[:ulong_be]).to be(subject[:uint32_be])
+      expect(subject[:ulong_be]).to be(subject[:uint64_be])
     end
   end
 
   describe "ulong_ne" do
     it "must be an alias to uint32_ne" do
-      expect(subject[:ulong_ne]).to be(subject[:uint32_ne])
+      expect(subject[:ulong_ne]).to be(subject[:uint64_ne])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexdump
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Simple and Fast hexdumping for Ruby.
+description: Fully Featured and Fast hexdumping for Ruby.
 email: postmodern.mod3@gmail.com
 executables: []
 extensions: []
@@ -54,7 +54,6 @@ files:
 - lib/hexdump/core_ext/kernel.rb
 - lib/hexdump/core_ext/string.rb
 - lib/hexdump/core_ext/string_io.rb
-- lib/hexdump/extensions.rb
 - lib/hexdump/format_string.rb
 - lib/hexdump/hexdump.rb
 - lib/hexdump/mixin.rb
@@ -75,6 +74,7 @@ files:
 - lib/hexdump/version.rb
 - spec/chars_spec.rb
 - spec/core_ext_spec.rb
+- spec/format_string_spec.rb
 - spec/hexdump_class_spec.rb
 - spec/hexdump_module_spec.rb
 - spec/mixin_spec.rb
@@ -98,6 +98,7 @@ metadata:
   source_code_uri: https://github.com/postmodern/hexdump.rb
   bug_tracker_uri: https://github.com/postmodern/hexdump.rb/issues
   changelog_uri: https://github.com/postmodern/hexdump.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Hexdump Strings and IO objects.

data/lib/hexdump/extensions.rb

@@ -1,2 +0,0 @@
-# DEPRECATED: use hexdump/core_ext instead.
-require 'hexdump/core_ext'