xxd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fb517531102225914b72ff4ad1adbd194d0d1b753e070c94de7eba141869b4a
+  data.tar.gz: 1dc807ace3b39c29785357468c6152084c0ef9b6b7a111001d1d368138008e1d
+SHA512:
+  metadata.gz: bf6597a2b374ad8ded3f83c5cdfb7741c4a6ae87ac0e82478ac78af2340ddfc4edfdefef12527f84deceec2867daa5832d4643f8658c9377a402aa35958c4aae
+  data.tar.gz: b7540ae0b06371817304097fcc40cfe35b861cf684e77d9b8757c9bdc4317b56dbeb38446a87c894d131e821442e9e82952309e61bd284d689127278aa72d14d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xxd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    xxd (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  xxd!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Lee Hambley
+
+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,91 @@
+# Xxd
+
+I put this Gem together one night to help make it easier to deal with binary blobs in Ruby specs/assertions.
+
+I found some libraries that can dump hex into a nice table with offsets and the printable ASCII bytes, and some
+which could parse the same, but nothing that could do both without pulling in a load of dependencies.
+
+This takes the dumbest possible approach to natively, and naïvely implement the default functionality of `xxd` from GNU.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xxd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xxd
+
+## Usage
+
+There are two methods `Xxd.dump` and `Xxd.parse`. There are no configuration options. Given a string the gem will
+print it as a hex table in this style:
+
+    00000000: 2159 a651 f852 132c 5f83 1259 9acd d837  !Y.Q.R.,_..Y...7
+    00000010: 0340 44d2 e08f 6979 46ee 40dc d6a0 bfa3  .@D...iyF.@.....
+    00000020: 0c63 a246 1eae 5ddd 9a59 9fa2 f14d d57c  .c.F..]..Y...M.|
+    00000030: f13f 8aa5 b7dd 7384 c620 133f f43c 190f  .?....s.. .?.<..
+    00000040: a89a 3f85 f958 be10 f8dd d7b5 a5d6 907f  ..?..X..........
+    00000050: 78ee 3b93 8fb5 5c51 51ed eb71 e23c 7c75  x.;...\QQ..q.<|u
+    00000060: bde0 2e05                                ....
+
+If the input is too large, all bets are off. The logic for the left column is weak.
+
+Usage from Ruby looks like this:
+
+    $ irb -Ilib -rxxd
+    irb(main):004:0> message = "this is a message consisting only of printable ascii characters"
+    => "this is a message consisting only of printable ascii characters"
+    irb(main):005:0> puts Xxd.dump(message)
+    00000000: 7468 6973 2069 7320 6120 6d65 7373 6167  this is a messag
+    00000010: 6520 636f 6e73 6973 7469 6e67 206f 6e6c  e consisting onl
+    00000020: 7920 6f66 2070 7269 6e74 6162 6c65 2061  y of printable a
+    00000030: 7363 6969 2063 6861 7261 6374 6572 73    scii characters
+    => nil
+
+Printing pure ASCII isn't very interesting, so binary output is handled thusly:
+
+    irb(main):006:0> message = File.open("/dev/urandom").read(200)
+    => "\xD6-\xBD\xC9x\xFA4\x8Dxz\x1C\xC2,:\xDF\x1FFY&\xE4UV\x9A}\x9Dv\xB9\xE3\xF2\xAAz\xF5\x9Cg\x86\x1DX\x85\xD7caQ\xE0\xBC\xBA\x04\x154|\xE3\xBBXX\xFFi\x9Ah\x16Bl\xE6\x9D\xFA\f\b\x88skaH\xD1\xAC~a\x9D\x1E\xA9\x7F\xAA\x7F\x0Er\x8C\x05_\xEF\x9C\xAD<\x1CF\xC4\xF1\xE0\xDE\xE2\xB1\xC4H\x10M\"Mu\xCD\xCD\x18W\x03\xD0<j\xE3\x0Et5e\xD8d\xC7\xE7\xD6\xFCO\xA7\xDF\x18\xE8\xC5t:iKG`\xDAG\x157\xA1~\xA6\x95{\x97\x93t\xFC\x8Bz'Z\xC7\xDEH\x04\x1D\xD7\xB32>\xB0\xA3\xBB\xFB\xD2\x9E\xEA5\xAA\xDA\x8C\xEF\xF6B|\xF7JU5\xDE4\xB6$\xBB\x88\xBD|\x92\x8E?\x04\xAC\x8A\xE3\x1F \xF6\x99\r"
+    irb(main):007:0> puts Xxd.dump(message)
+    00000000: d62d bdc9 78fa 348d 787a 1cc2 2c3a df1f  .-..x.4.xz..,:..
+    00000010: 4659 26e4 5556 9a7d 9d76 b9e3 f2aa 7af5  FY&.UV.}.v....z.
+    00000020: 9c67 861d 5885 d763 6151 e0bc ba04 1534  .g..X..caQ.....4
+    00000030: 7ce3 bb58 58ff 699a 6816 426c e69d fa0c  |..XX.i.h.Bl....
+    00000040: 0888 736b 6148 d1ac 7e61 9d1e a97f aa7f  ..skaH..~a......
+    00000050: 0e72 8c05 5fef 9cad 3c1c 46c4 f1e0 dee2  .r.._...<.F.....
+    00000060: b1c4 4810 4d22 4d75 cdcd 1857 03d0 3c6a  ..H.M"Mu...W..<j
+    00000070: e30e 7435 65d8 64c7 e7d6 fc4f a7df 18e8  ..t5e.d....O....
+    00000080: c574 3a69 4b47 60da 4715 37a1 7ea6 957b  .t:iKG`.G.7.~..{
+    00000090: 9793 74fc 8b7a 275a c7de 4804 1dd7 b332  ..t..z'Z..H....2
+    000000a0: 3eb0 a3bb fbd2 9eea 35aa da8c eff6 427c  >.......5.....B|
+    000000b0: f74a 5535 de34 b624 bb88 bd7c 928e 3f04  .JU5.4.$...|..?.
+    000000c0: ac8a e31f 20f6 990d                      .... ...
+    => nil
+
+The original message can be recovered thusly:
+
+    irb(main):012:0> Xxd.parse(Xxd.dump(message))
+    => "\xD6-\xBD\xC9x\xFA4\x8Dxz\x1C\xC2,:\xDF\x1FFY&\xE4UV\x9A}\x9Dv\xB9\xE3\xF2\xAAz\xF5\x9Cg\x86\x1DX\x85\xD7caQ\xE0\xBC\xBA\x04\x154|\xE3\xBBXX\xFFi\x9Ah\x16Bl\xE6\x9D\xFA\f\b\x88skaH\xD1\xAC~a\x9D\x1E\xA9\x7F\xAA\x7F\x0Er\x8C\x05_\xEF\x9C\xAD<\x1CF\xC4\xF1\xE0\xDE\xE2\xB1\xC4H\x10M\"Mu\xCD\xCD\x18W\x03\xD0<j\xE3\x0Et5e\xD8d\xC7\xE7\xD6\xFCO\xA7\xDF\x18\xE8\xC5t:iKG`\xDAG\x157\xA1~\xA6\x95{\x97\x93t\xFC\x8Bz'Z\xC7\xDEH\x04\x1D\xD7\xB32>\xB0\xA3\xBB\xFB\xD2\x9E\xEA5\xAA\xDA\x8C\xEF\xF6B|\xF7JU5\xDE4\xB6$\xBB\x88\xBD|\x92\x8E?\x04\xAC\x8A\xE3\x1F \xF6\x99\r"
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xxd.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "xxd"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :dump do
+  fixture = File.binread(File.join(File.dirname(__FILE__), "test/random-data-from-urandom"))
+  puts Xxd.dump(fixture)
+end
+
+task :default => :dump

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xxd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xxd.rb

@@ -0,0 +1,27 @@
+require "xxd/version"
+
+module Xxd
+  class Error < StandardError; end
+
+  def dump(input)
+    io = StringIO.new
+    res = input.bytes.each_slice(2).each_slice(8).each_with_index do |row, i|
+      io.write format(
+        "%07x0: %-40s %-16s\n",
+        i,
+        row.map { |pair| pair.map { |b| b.to_s(16).rjust(2, "0") }.join }.join(" "),
+        row.flat_map { |pair| pair.map { |b| (b >= 32 && b < 127 ? b.chr : ".") } }.flatten.join
+      )
+    end
+    io.string
+  end
+  module_function :dump
+
+  def parse(input)
+    res = input.lines.flat_map do |line|
+      line[10..48].gsub(" ", "").scan(/../).map { |hb| hb.to_i(16) }
+    end.pack("c*")
+  end
+  module_function :parse
+
+end

data/lib/xxd/version.rb

@@ -0,0 +1,3 @@
+module Xxd
+  VERSION = "0.1.0"
+end

data/xxd.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xxd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xxd"
+  spec.version       = Xxd::VERSION
+  spec.authors       = ["Lee Hambley"]
+  spec.email         = ["lee.hambley@gmail.com"]
+
+  spec.summary       = %q{simple naïve implementation of xxd in both directions for Ruby}
+  spec.homepage      = "https://github.com/leehambley/xxd"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/leehambley/xxd"
+    spec.metadata["changelog_uri"] = "https://github.com/leehambley/xxd/blob/master/CHANGELOG"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: xxd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Hambley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- lee.hambley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xxd.rb
+- lib/xxd/version.rb
+- xxd.gemspec
+homepage: https://github.com/leehambley/xxd
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leehambley/xxd
+  source_code_uri: https://github.com/leehambley/xxd
+  changelog_uri: https://github.com/leehambley/xxd/blob/master/CHANGELOG
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: simple naïve implementation of xxd in both directions for Ruby
+test_files: []