hexdump 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc17566453285686c384ffb48945dfa526b3d4ea24a3edec8b193540ec40fead
-  data.tar.gz: cfd9d433a9d11d85b43cd98a46e4b8c1aa67dcc572bd0ebfd7771469bbc315ed
+  metadata.gz: 7f797d519e67c6284088b0052bc49a75b7fb7b7588d1cdc8b01d017039272c77
+  data.tar.gz: d1920db1ac10b3b2d07bcc3a5423f0764751eb6d2ac64e2e5ddb09ed14cf6e4d
 SHA512:
-  metadata.gz: bcc397a847ff0d4b9cfef884d6c8c97ed344cbded5242cfeccd2e6e61dc755a4dfb3ac20ddfc65d66f1428dce3ba36ab46858c9c2fdb2e43905b73c4f39e0c10
-  data.tar.gz: 3917cbf496621c7ddd8e9aec840be04b1836145f082fa0eefe016438cba570cda39013becd7a07fefdb8e4a0c1e9a13b17690f238da468ed528792c043e1c1f4
+  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,11 +1,84 @@
+### 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 :
+  * `:char` - signed 8bit ASCII character
+  * `:uchar` - unsigned 8bit ASCII character
+  * `:int8` - signed 8bit integer
+  * `:uin8` / `:byte` - unsigned 8bit integer (default)
+  * `:int16` / `:short` - signed 16bit integer
+  * `:int16_le` / `:short_le` - signed 16bit integer (little endian)
+  * `:int16_be` / `:short_be` - signed 16bit integer (big endian)
+  * `:int16_ne` / `:short_ne` - signed 16bit integer (network endian)
+  * `:uint16` / `:ushort` - unsigned 16bit integer
+  * `: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 (little endian)
+  * `:uint32_be` / `:uint_be` / `:ulong_be` - unsigned 32bit integer (big endian)
+  * `:uint32_ne` / `:uint_ne` / `:ulong_ne` - unsigned 32bit 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)
+  * `:float_ne` - single precision 32bit floating-point number (network endian)
+  * `:double` - double precision 64bit floating-point number
+  * `:double_le` - double precision 64bit floating-point number (little endian)
+  * `:double_be` - double precision 64bit floating-point number (big endian)
+  * `:double_ne` - double precision 64bit floating-point number (network endian)
+* Added support for optionally skipping N bytes or reading at most N bytes of
+  data (ex: `offset: 10` and `length: 100`).
+* Added support for optional zero-padding of the data so it aligns with the type
+  size (ex: `zero_pad: true`).
+* Added support for displaying the index in a separate numeric base than the
+  numeric columns (ex: `index_base: 10, base: 2`). Defaults to base 16.
+* Added support for omitting repeating rows with a `*` (ex: `repeating: true` or
+  `repeating: false` to disable).
+* Added support for grouping columns together like GNU `hexdump -C` (ex:
+  `group_columns: 4`).
+* Added support for grouping characters together (ex: `group_chars: 4`).
+* Added support for grouping characters together to align with the type's size
+  (ex: `group_chars: :type`).
+* Added support for displaying UTF-8 characters or other character encodings.
+* Added support for disabling the characters column entirely
+  (ex: `chars_column: false`).
+* Added support for ANSI styling and highlighting (ex: `style: {...}` and
+  `highlights: {...}`).
+* Added {Hexdump::ModuleMethods} to provide a top-level
+  {Hexdump::ModuleMethods#hexdump hexdump} method.
+  * Include {Hexdump::ModuleMethods} into {Kernel} by default.
+* Added preliminary truffleruby support.
+  * Only issue was https://github.com/oracle/truffleruby/issues/2426
+* `hexdump` methods now accept a block for configuring the hexdump instance.
+* Renamed `Hexdump::Dumper` to {Hexdump::Hexdump}.
+* Renamed the `:width` option to `:columns`.
+
 ### 0.3.0 / 2021-04-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.
 
@@ -22,7 +95,7 @@
 ### 0.2.2 / 2012-05-27
 
 * Added {Hexdump::VERSION}.
-* Rescue `RangeError`s in {Hexdump::Dumper#format_printable}.
+* Rescue `RangeError`s in `Hexdump::Dumper#format_printable`.
 * Fixed a typo in `benchmarks/hexdump.rb` (thanks ColMcp).
 * Fixed a typo in Source URL, in the README (thanks Lawrence Woodman).
 * Documented the `:endian` option for {Hexdump.dump}.
@@ -31,12 +104,12 @@
 
 ### 0.2.1 / 2011-06-11
 
-* Fixed a major bug in {Hexdump::Dumper#dump}, where the line buffers
+* Fixed a major bug in `Hexdump::Dumper#dump`, where the line buffers
   were not being cleared.
 
 ### 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,6 +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