philiprehberger-hex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27120f5b94f3fc6caff3242cb9a368571f59f8f3f7e27318acd36ad728ab7932
+  data.tar.gz: d72f73c7bf1f89d494af6c35a7bd42faf692feccf6a0bf37bd8eb6a66a6f5309
+SHA512:
+  metadata.gz: 942dae412ae29a010081d6dc0a83dbe975cceeb3ef9437fe5b078bb1e3241e8bdcb325b203016ae20e429d74e16803ba8feff1c167120c0b2996a13e18dd1c90
+  data.tar.gz: bd8559b024e501599b0a5a2e0dacb0f6c799e559ddc9ae5ea06f4a41af73301765ee3fab6a076a84b7de4812f728f0270a07c5f1ffad09cae496fd6d64fffa0e

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+
+- Initial release
+- Hex encoding and decoding
+- xxd-style hex dump output
+- Configurable hex grouping format
+- Hex string validation

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# philiprehberger-hex
+
+[![Tests](https://github.com/philiprehberger/rb-hex/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-hex/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-hex.svg)](https://rubygems.org/gems/philiprehberger-hex)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-hex)](LICENSE)
+
+Hex encoding, decoding, and dump formatting for binary data
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-hex'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-hex
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/hex'
+
+Philiprehberger::Hex.encode('hello')     # => "68656c6c6f"
+Philiprehberger::Hex.decode('68656c6c6f') # => "hello"
+```
+
+### Hex Dump
+
+```ruby
+Philiprehberger::Hex.dump("Hello, World!\n")
+# 00000000:  4865 6c6c 6f2c 2057 6f72 6c64 210a       Hello, World!.
+```
+
+### Grouped Format
+
+```ruby
+Philiprehberger::Hex.format('hello', group: 1)  # => "68 65 6c 6c 6f"
+Philiprehberger::Hex.format('hello', group: 2)  # => "6865 6c6c 6f"
+```
+
+### Validation
+
+```ruby
+Philiprehberger::Hex.valid?('abcdef')  # => true
+Philiprehberger::Hex.valid?('xyz')     # => false
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `Hex.encode(str)` | Encode a string to hexadecimal |
+| `Hex.decode(hex)` | Decode a hexadecimal string to binary |
+| `Hex.dump(str)` | Produce an xxd-style hex dump |
+| `Hex.format(str, group:)` | Format hex output with configurable grouping |
+| `Hex.valid?(str)` | Check if a string is valid hexadecimal |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/hex/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Hex
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/hex.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'hex/version'
+
+module Philiprehberger
+  module Hex
+    class Error < StandardError; end
+
+    HEX_PATTERN = /\A[0-9a-fA-F]*\z/
+
+    def self.validate_string!(str)
+      raise Error, 'expected a String' unless str.is_a?(String)
+    end
+
+    private_class_method :validate_string!
+
+    # Encode a string to hexadecimal
+    #
+    # @param str [String]
+    # @return [String] hex-encoded string
+    def self.encode(str)
+      validate_string!(str)
+      str.unpack1('H*')
+    end
+
+    # Decode a hexadecimal string to binary
+    #
+    # @param hex [String] hex-encoded string
+    # @return [String] decoded binary string
+    def self.decode(hex)
+      validate_string!(hex)
+      raise Error, 'invalid hex string: odd length' if hex.length.odd?
+      raise Error, 'invalid hex string: non-hex characters' unless valid?(hex)
+
+      [hex].pack('H*')
+    end
+
+    # Produce an xxd-style hex dump
+    #
+    # @param str [String]
+    # @return [String] formatted hex dump
+    def self.dump(str)
+      validate_string!(str)
+      lines = []
+      bytes = str.bytes
+
+      bytes.each_slice(16).with_index do |chunk, index|
+        offset = Kernel.format('%08x', index * 16)
+        hex_part = chunk.each_slice(2).map { |pair| pair.map { |b| Kernel.format('%02x', b) }.join }.join(' ')
+        ascii_part = chunk.map { |b| b.between?(32, 126) ? b.chr : '.' }.join
+        lines << Kernel.format('%-10s %-40s %s', "#{offset}:", hex_part, ascii_part)
+      end
+
+      lines.join("\n")
+    end
+
+    # Format a string as grouped hex
+    #
+    # @param str [String]
+    # @param group [Integer] number of bytes per group
+    # @return [String] grouped hex string
+    def self.format(str, group: 2)
+      validate_string!(str)
+      hex = encode(str)
+      hex.scan(/.{1,#{group * 2}}/).join(' ')
+    end
+
+    # Check if a string is valid hexadecimal
+    #
+    # @param str [String]
+    # @return [Boolean]
+    def self.valid?(str)
+      return false unless str.is_a?(String)
+      return false if str.empty?
+
+      HEX_PATTERN.match?(str)
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-hex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Encode and decode hexadecimal strings, produce xxd-style hex dumps, format
+  hex output with configurable grouping, and validate hex strings.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/hex.rb
+- lib/philiprehberger/hex/version.rb
+homepage: https://github.com/philiprehberger/rb-hex
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-hex
+  source_code_uri: https://github.com/philiprehberger/rb-hex
+  changelog_uri: https://github.com/philiprehberger/rb-hex/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-hex/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Hex encoding, decoding, and dump formatting for binary data
+test_files: []