hexhelper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09ced30dd9c164580fc5ae58cdb57017754b6163
+  data.tar.gz: 684781351e0bd8bcf0b3f5b8e316226600b431d6
+SHA512:
+  metadata.gz: 9dc22a33d841058aceb7affed3d243da28c0b2d9d0185c17c0a51147e83a7077c374adf526ac1478d9e87b62d26eb51602ad31c19493ab725877e6ce3eb33743
+  data.tar.gz: d4b4882c9a1a78c0cdaf6731ab11c3bf8334663a07205bd95ea353a72f3f4cb05bdf86dccc83c32a379afc40f0c3f51a8a5ea29aff0584e5fb4c1ac59b4ed55c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hexhelper.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2013-2017, Ron Bowes
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+- Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,39 @@
+# Hexhelper
+
+This gem simply makes it easy to dump a binary string as nicely formatted hex.
+
+I found myself copying and pasting this code/project to a million different
+projects, so I thought it'd make sense to create a gem out of it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hexhelper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hexhelper
+
+## Usage
+
+Using it is simple!
+
+```ruby
+require 'hexhelper'
+
+str = "This is a test string\x00\x01\x02"
+puts Hexhelper::to_s(str)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/iagox86/hexhelper
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hexhelper"
+
+# 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

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/hexhelper.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hexhelper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hexhelper"
+  spec.version       = Hexhelper::VERSION
+  spec.authors       = ["iagox86"]
+  spec.email         = ["ron-git@skullsecurity.org"]
+
+  spec.summary       = "A simple gem for printing nicely-formatted hex strings"
+  spec.homepage      = "https://github.com/iagox86/hexhelper"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

data/lib/hexhelper/version.rb

@@ -0,0 +1,3 @@
+module Hexhelper
+  VERSION = "0.0.1"
+end

data/lib/hexhelper.rb

@@ -0,0 +1,79 @@
+# Encoding: ASCII-8BIT
+##
+# hexhelper.rb
+# Created November, 2012
+# By Ron Bowes
+#
+# See: LICENSE.md
+#
+# This is a simple utility class that converts an arbitrary binary string into
+# a user-readable string.
+##
+
+class HexHelper
+  BYTE_NUMBER_LENGTH  = 8
+  SPACES_BEFORE_HEX   = 2
+  SPACES_BEFORE_ASCII = 2
+  LINE_LENGTH         = 16
+
+  # Convert the arbitrary binary data, 'data', into a user-readable string.
+  def self.to_s(data, indent: 0, offset: nil)
+    length = data.length
+    out = (' ' * indent)
+
+    0.upto(length - 1) do |i|
+      # This section encodes all the hex lines, including the final partial line
+      if((i % LINE_LENGTH) == 0)
+        if(i != 0)
+          # Subtract one from the indent because we print a space surrounding
+          # the actual hex number
+          out = out + "\n" + (' ' * indent)
+        end
+        # Minus 1, so we can potentially replace the last one with a current-
+        # place marker
+        out = out + ("%0#{BYTE_NUMBER_LENGTH}x" % i) + " " * (SPACES_BEFORE_HEX - 1)
+        if(offset && (i == offset))
+          out = out + '<'
+        else
+          out = out + ' '
+        end
+      end
+
+      out = out + ("%02x" % data[i].ord)
+      # Always put a '>' immediately after the highlighted offset
+      if(i == offset)
+        out = out + '>'
+      # Put a '>' after the value before the chosen offset, unless we're at
+      # the end of a line or the absolute end
+      elsif((i + 1 == offset) && (((i + 1) % LINE_LENGTH) != 0) && ((i + 1) % length) != 0)
+        out = out + '<'
+      else
+        out = out + ' '
+      end
+
+      if(((i + 1) % LINE_LENGTH) == 0)
+        out = out + (" " * SPACES_BEFORE_ASCII)
+        LINE_LENGTH.step(1, -1) do |j|
+          out = out + ("%c" % ((data[i + 1 - j].ord > 0x20 && data[i + 1 - j].ord < 0x80) ? data[i + 1 - j].ord : ?.))
+        end
+      end
+
+    end
+
+    # This encodes the partial line of ascii, plus the spaces before
+    if((length % LINE_LENGTH) != 0)
+      # Add extra spaces between the hex and the ascii
+      (length % LINE_LENGTH).upto(LINE_LENGTH - 1) do |i|
+        out = out + ('   ') # The width of a hex character and a space
+      end
+      out = out + (' ' * SPACES_BEFORE_ASCII)
+
+      # Add the final line of characters
+      (length - (length % LINE_LENGTH)).upto(length - 1) do |i|
+        out = out + ("%c" % ((data[i].ord > 0x20 && data[i].ord < 0x80) ? data[i].ord : ?.))
+      end
+    end
+
+    return out
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: hexhelper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- iagox86
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ron-git@skullsecurity.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hexhelper.gemspec
+- lib/hexhelper.rb
+- lib/hexhelper/version.rb
+homepage: https://github.com/iagox86/hexhelper
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple gem for printing nicely-formatted hex strings
+test_files: []