show_data 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eafd7abc3122b12cb30090e0ca8ab760edbeccd9
+  data.tar.gz: e05b91f2ddd06417c274a211fded767567ea8d36
+SHA512:
+  metadata.gz: 4c8a1e035ab7a6d3fd7993163df90dffc0f6d4816569cf2f39d49fb97913e6ca1314a979cab33f91c81a469f6cc1a219650e2f69e44edac6ac5c9380464f5224
+  data.tar.gz: 3bcf645d3838316bc648f5d615ad9fd23a55e372c607358833ad5379b903304c0f7501846fb171e239aa1086087037cbe56e3e7449d1884e56081e8574e2402c

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alan Stebbens
+
+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/lib/show_data.rb

@@ -0,0 +1,135 @@
+# show-data.rb
+#
+# show_data -- show the results of any data a pretty way
+#
+#   Copyright (C) 2008-2013  Alan K. Stebbens <aks@stebbens.org>
+#
+#   This program is free software; you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation; either version 2 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program; if not, write to the Free Software
+#   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# Alan K. Stebbens, aks@stebbens.org, Jan 2008
+# $Revision$
+# $Id$
+#
+# 2008/10/14 aks: 
+#  Added support for OpenStruct objects
+#  Fixed symbol key representation
+
+#require 'ostruct'			# don't need this if we're careful
+
+def format_data(data, indent=0)
+  s = ''
+  klass = data.class
+  if (klass == Array) 
+    s += format_array( data, indent )
+  elsif klass == Hash
+    s += format_hash( data.keys, data.values, indent )
+  elsif %w( Time Date DateTime ).include?(klass.to_s)
+    s += data.to_s                      # use default formatting
+  elsif klass.to_s == "OpenStruct"
+    s += (prefix = "#<OpenStruct")
+    hash = data.marshal_dump
+    s += format_hash( hash.keys, hash.values, indent + prefix.length, ' ', '>' )
+  elsif data.inspect =~ /^(\#<struct \w+)/	# structure?
+    s += $1 + ' '
+    s += format_hash(data.members, data.values, indent + $1.length + 1, ' ', '>' )
+  elsif data.respond_to?(:attributes)
+    attrs = data.attributes
+    if (text = data.inspect) =~ /^(\#<[^:>]+: )/
+      s += (prefix = $1)
+    else
+      s += (prefix = text.split(' ').first)
+    end
+    s += format_hash(attrs.keys, attrs.values, indent + prefix.length, ' ', '>')
+  elsif data.respond_to?(:instance_variables) and (vars = data.instance_variables.sort).size > 0
+    s += (prefix = data.inspect.split(' ').first) + ' '
+    s += format_hash(vars, vars.map{|v| data.instance_eval(v.to_s)}, indent + prefix.length + 1, ' ', '>')
+  else
+    s += data.inspect
+  end
+  s += "\n" if indent == 0
+  s
+end
+
+def format_array( data, indent, open_char = '[', close_char = ']' )
+  indexlen = data.size.to_s.length
+  s = "["
+  indexfmt = "[%0#{indexlen}d]: "
+  nextindent = indent + indexlen + 5
+  indentstr = ' ' * nextindent
+  data.each_index do |x|
+    s += sprintf(indexfmt, x)
+    s += format_data(data[x], nextindent)
+    s += sprintf(",\n" + ' '*indent + ' ') unless x == data.length - 1
+  end
+  s += "\n" + ' ' * indent + ']'
+end
+
+# format a hash
+#    args: keys, values, indent, open char, close char, right-align
+# returns: formatted string
+#
+# if the hash looks like this: { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }
+# then display it like this:
+#
+#  {      'key1' => 'value1',
+#    'aLongkey2' => 'value2',
+#         'key3' => 'value3'
+#   }
+#
+# the formatter tries to align the '=>' and everything around it, unless the
+# FALSE object is passed as the "right_align" value.
+#
+# Recursively format nested object values.  The '{' and '} are defaults.
+#
+
+def format_hash( hash_keys, hash_values, indent, open_char = '{', close_char = '}', right_align = nil)
+  s = open_char + ' '
+  maxkeylen = 0
+  if right_align or right_align.nil?		# align maybe?
+    #complex = 0
+    hash_keys.each_index do |x| 
+      k, v = hash_keys[x], hash_values[x]
+      kl = k.class == Symbol ? 1 + k.to_s.length : 2 + k.length
+      maxkeylen = kl if maxkeylen < kl 
+      #complex += v.size if v.class == Hash || v.class == Array || v.class == OpenStruct
+    end
+    # if the data complexity is < 60%, and the maxkeylen is defined, then allow right-align
+    #maxkeylen = 0 if hash_keys.size > 0 && (complex.to_f / hash_keys.size.to_f) < 0.6
+  end
+  keyfmt = maxkeylen > 0 ?  "%#{maxkeylen}s => " : "%s => "
+  indentstr = ' ' * indent + '  '
+  count = 0
+  hash_keys.each_index do |x|
+    key, val = hash_keys[x], hash_values[x]
+    if key.class == Symbol			# Symbols have different representation
+      formatted_key = sprintf(keyfmt, ':' + key.to_s)	# :somesymbol
+    else
+      formatted_key = sprintf(keyfmt, "'" + key + "'")	# 'somekey'
+    end
+    s += formatted_key
+    vs = format_data(val, indent + formatted_key.size + 2)
+    s += vs
+    count += 1
+    s += ",\n" + indentstr unless count >= hash_keys.size
+  end
+  s += "\n" + ' ' * indent + close_char
+end
+
+def show_data(data, indent=0)
+  puts format_data(data, indent)
+end
+
+# end of show-data.rb
+# vim: sw=2 ai

data/test/test_show_data.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# test-show-data.rb
+#
+# Test show-data.rb
+#
+# Alan K. Stebbens <aks@stebbens.org>
+
+$:.unshift '.', '../test', 'test'
+
+require 'helper'
+
+require 'date'
+require 'time'
+
+array = [ 1, 2, 3, 10, 11, 12, 1.2, 34.567, 'apple', 'banana', 'cherry', :symbol1, :symbol2,
+          Date.parse("2005-12-25"), Time.parse("2006-07-04 12:01:02") ]
+show_data array
+
+ahash = { 'a' => 'apple', 'b' => 'banana', 'c' => 'cherry' }
+show_data ahash
+
+nested = [ [ 'a', 1.2, 'b' ], [ 'd', :symbol ], [ [ 'ape', 'monkey', 'chimp' ], [ 'banana', 'leaves' ], 2.99 ] ]
+show_data nested
+
+combo = [ ahash, ahash.invert, nested ]
+show_data combo
+
+puts ''
+puts "Testing Struct display"
+
+Vars = Struct::new( :aVar, :varB, :varC, :reallyLongVarName, :andAnotherVar )
+vars1 = Vars.new( 'firstValue', :secondValue, %w( the third value ), 
+		   { :a => 'first', :nother => '2nd', :test => 'last item' },
+		   nested )
+show_data vars1
+
+puts ''
+puts "Testing OpenStruct display .."
+
+require 'ostruct'
+data = OpenStruct.new(ahash.invert)
+show_data data
+
+puts 'Testing a complicated OpenStruct ..'
+data.complicated = vars1
+show_data data
+
+class TestObj
+  attr_accessor :first, :second, :third
+  def initialize( first='first thing', second='second thing', third='third thing')
+    @first = first
+    @second = second
+    @third = third
+    self
+  end
+end
+
+testo1 = TestObj.new(1, 2, 3)
+testo2 = TestObj.new('a', 'b', 'c')
+testo3 = TestObj.new('I', 'II', 'III')
+show_data testo1
+show_data testo2
+show_data testo3
+testo4 = TestObj.new(testo1, testo2, testo3)
+show_data testo4
+
+exit

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: show_data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alan Stebbens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: 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: jeweler
+  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: "\tFormat or pretty-print Ruby data, including arrays, hashes, and structs.\n\tThe
+  keys ond values f the arrays and hashes are aligned for easy readability.\n\tObject
+  attributes are similarly aligned.\n"
+email: aks@stebbens.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/show_data.rb
+- test/test_show_data.rb
+homepage: http://github.com/aks/show_data
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Format or pretty-print Ruby data
+test_files:
+- test/test_show_data.rb