hexdump 0.3.0 → 1.0.1

data/benchmark.rb

@@ -5,43 +5,50 @@ $LOAD_PATH.unshift(File.expand_path('../lib',__FILE__))
 require 'hexdump'
 require 'benchmark'
 
-DATA = ((0..255).map { |b| b.chr }.join) * (1024 * 100)
-OUTPUT = Class.new { def <<(data); end }.new
+class NullOutput
+  def <<(data)
+  end
+end
+
+size_mb = 1
+puts "Generating #{size_mb}Mb of random data ..."
+data = Array.new(size_mb * 1024 * 1024) { rand(255).chr }.join
+output = NullOutput.new
 
-Benchmark.bm(33) do |b|
-  b.report('Hexdump.dump (output)') do
-    Hexdump.dump(DATA, :output => OUTPUT)
+types = Hexdump::TYPES.values.uniq.map(&Hexdump::TYPES.method(:key))
+
+Benchmark.bm(42) do |b|
+  b.report('Hexdump.hexdump(data)') do
+    Hexdump.hexdump(data, output: output)
   end
 
-  b.report('Hexdump.dump width=256 (output)') do
-    Hexdump.dump(DATA, width: 256, output: OUTPUT)
+  b.report("Hexdump.hexdump(data, repeating: false)") do
+    Hexdump.hexdump(data, repeating: false, output: output)
   end
 
-  b.report('Hexdump.dump ascii=true (output)') do
-    Hexdump.dump(DATA, ascii: true, output: OUTPUT)
+  b.report("Hexdump.hexdump(data, chars_column: false)") do
+    Hexdump.hexdump(data, chars_column: false, output: output)
   end
 
-  [2, 4, 8].each do |word_size|
-    b.report("Hexdump.dump word_size=#{word_size} (output)") do
-      Hexdump.dump(DATA, word_size: word_size, output: OUTPUT)
-    end
+  b.report('Hexdump.hexdump(data, columns: 256)') do
+    Hexdump.hexdump(data, columns: 256, output: output)
   end
 
-  b.report('Hexdump.dump (block)') do
-    Hexdump.dump(DATA) { |index,hex,print| }
+  b.report('Hexdump.hexdump(data, group_columns: 4)') do
+    Hexdump.hexdump(data, group_columns: 4, output: output)
   end
 
-  b.report('Hexdump.dump width=256 (block)') do
-    Hexdump.dump(DATA, width: 256) { |index,hex,print| }
+  b.report('Hexdump.hexdump(data, group_chars: 4)') do
+    Hexdump.hexdump(data, group_chars: 4, output: output)
   end
 
-  b.report('Hexdump.dump ascii=true (block)') do
-    Hexdump.dump(DATA, ascii: true) { |index,hex,print| }
+  b.report('Hexdump.hexdump(data, encoding: :utf8)') do
+    Hexdump.hexdump(data, encoding: :utf8, output: output)
   end
 
-  [2, 4, 8].each do |word_size|
-    b.report("Hexdump.dump word_size=#{word_size} (block)") do
-      Hexdump.dump(DATA, word_size: word_size) { |index,hex,print| }
+  types.each do |type|
+    b.report("Hexdump.hexdump(data, type: #{type.inspect})") do
+      Hexdump.hexdump(data, type: type, output: output)
     end
   end
 end

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/chars.rb

@@ -0,0 +1,46 @@
+module Hexdump
+  #
+  # @api private
+  #
+  # @since 1.0.0
+  #
+  class Chars
+
+    # The encoding to convert the characters to.
+    #
+    # @return [Encoding, nil]
+    attr_reader :encoding
+
+    #
+    # Initializes the chars formatter.
+    #
+    # @param [Encoding, nil] encoding
+    #   The encoding to convert characters to.
+    #
+    def initialize(encoding=nil)
+      @encoding = encoding
+    end
+
+    #
+    # Formats a string of characters.
+    #
+    # @param [String] chars
+    #   The input string of raw characters.
+    #
+    # @return [String]
+    #   The formatted string of raw characters.
+    #
+    def scrub(chars)
+      if @encoding
+        chars.force_encoding(@encoding)
+        chars.scrub!('.')
+        chars.gsub!(/[^[:print:]]/u,'.')
+      else
+        chars.tr!("^\x20-\x7e",'.')
+      end
+
+      chars
+    end
+
+  end
+end

data/lib/hexdump/core_ext/file.rb

@@ -1,4 +1,4 @@
-require 'hexdump/hexdump'
+require_relative 'io'
 
 class File
 
@@ -8,14 +8,76 @@ class File
   # @param [String] path
   #   The path of the file.
   #
-  # @param [Hash] options
-  #   Additional options.
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments for {Hexdump::Hexdump#initialize}.
   #
-  # @see Hexdump.dump
+  # @option kwargs [#print] :output ($stdout)
+  #   The output to print the hexdump to.
   #
-  def self.hexdump(path,options={},&block)
+  # @option kwargs [:int8, :uint8, :char, :uchar, :byte, :int16, :int16_le, :int16_be, :int16_ne, :uint16, :uint16_le, :uint16_be, :uint16_ne, :short, :short_le, :short_be, :short_ne, :ushort, :ushort_le, :ushort_be, :ushort_ne, :int32, :int32_le, :int32_be, :int32_ne, :uint32, :uint32_le, :uint32_be, :uint32_ne, :int, :long, :long_le, :long_be, :long_ne, :uint, :ulong, :ulong_le, :ulong_be, :ulong_ne, :int64, :int64_le, :int64_be, :int64_ne, :uint64, :uint64_le, :uint64_be, :uint64_ne, :long_long, :long_long_le, :long_long_be, :long_long_ne, :ulong_long, :ulong_long_le, :ulong_long_be, :ulong_long_ne, :float, :float_le, :float_be, :float_ne, :double, :double_le, :double_be, :double_ne] :type (:byte)
+  #   The type to decode the data as.
+  #
+  # @option kwargs [Integer, nil] :offset
+  #   Controls whether to skip N number of bytes before starting to read data.
+  #
+  # @option kwargs [Integer, nil] :length
+  #   Controls control many bytes to read.
+  #
+  # @option kwargs [Boolean] :zero_pad (false)
+  #   Enables or disables zero padding of data, so that the remaining bytes
+  #   can be decoded as a uint, int, or float.
+  #
+  # @option kwargs [Integer] :columns (16)
+  #   The number of bytes to dump for each line.
+  #
+  # @option kwargs [Integer, nil] :group_columns
+  #   Separate groups of columns with an additional space.
+  #
+  # @option kwargs [Integer, :type, nil] :group_chars
+  #   Group chars into columns.
+  #   If `:type`, then the chars will be grouped by the `type`'s size.
+  #
+  # @option kwargs [Boolean] :repeating
+  #   Controls whether to omit repeating duplicate rows data with a `*`.
+  #
+  # @option kwargs [16, 10, 8, 2] :base (16)
+  #   The base to print bytes in.
+  #
+  # @option kwargs [16, 10, 8, 2] :index_base (16)
+  #   Control the base that the index is displayed in.
+  #
+  # @option kwargs [Integer, nil] :index_offset
+  #   The offset to start the index at.
+  #
+  # @option kwargs [Boolean] :chars_column (true)
+  #   Controls whether to display the characters column.
+  #
+  # @option kwargs [:ascii, :utf8, Encoding, nil] :encoding
+  #   The encoding to display the characters in.
+  #
+  # @option kwargs [Boolean, Hash{:index,:numeric,:chars => Symbol,Array<Symbol>}] :style
+  #   Enables theming of index, numeric, or chars columns.
+  #
+  # @option kwargs [Boolean, Hash{:index,:numeric,:chars => Hash{String,Regexp => Symbol,Array<Symbol>}}] :highlights
+  #   Enables selective highlighting of index, numeric, or chars columns.
+  #
+  # @yield [hexdump]
+  #   If a block is given, it will be passed the newly initialized hexdump
+  #   instance.
+  #
+  # @yieldparam [Hexdump::Hexdump] hexdump
+  #   The newly initialized hexdump instance.
+  #
+  # @see IO#hexdump
+  #
+  # @example
+  #   File.hexdump("/bin/ls")
+  #   # 00000000  7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00  |.ELF............|
+  #   # ...
+  #
+  def self.hexdump(path,**kwargs,&block)
     self.open(path,'rb') do |file|
-      Hexdump.dump(file,options,&block)
+      file.hexdump(**kwargs,&block)
     end
   end
 

data/lib/hexdump/core_ext/io.rb

@@ -1,7 +1,7 @@
-require 'hexdump/hexdump'
+require_relative '../mixin'
 
 class IO
 
-  include Hexdump
+  include Hexdump::Mixin
 
 end

data/lib/hexdump/core_ext/kernel.rb

@@ -0,0 +1,5 @@
+require_relative '../module_methods'
+
+module Kernel
+  include Hexdump::ModuleMethods
+end

data/lib/hexdump/core_ext/string.rb

@@ -1,7 +1,7 @@
-require 'hexdump/hexdump'
+require_relative '../mixin'
 
 class String
 
-  include Hexdump
+  include Hexdump::Mixin
 
 end

data/lib/hexdump/core_ext/string_io.rb

@@ -1,9 +1,9 @@
-require 'hexdump/hexdump'
+require_relative '../mixin'
 
 require 'stringio'
 
 class StringIO
 
-  include Hexdump
+  include Hexdump::Mixin
 
 end

data/lib/hexdump/core_ext.rb

@@ -1,4 +1,5 @@
-require 'hexdump/core_ext/string'
-require 'hexdump/core_ext/string_io'
-require 'hexdump/core_ext/io'
-require 'hexdump/core_ext/file'
+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/format_string.rb

@@ -0,0 +1,43 @@
+module Hexdump
+  #
+  # @api private
+  #
+  # @since 1.0.0
+  #
+  class FormatString
+
+    #
+    # Initializes the format string.
+    #
+    # @param [String] fmt
+    #   The format string.
+    #
+    def initialize(fmt)
+      @fmt = fmt
+    end
+
+    #
+    # Formats the given value.
+    #
+    # @param [Integer, Float] value
+    #   The given value.
+    #
+    # @return [String]
+    #   The formatted value.
+    #
+    def %(value)
+      sprintf(@fmt,value)
+    end
+
+    #
+    # Converts the format string back into a String.
+    #
+    # @return [String]
+    #   The raw format string.
+    #
+    def to_s
+      @fmt
+    end
+
+  end
+end