debug_helper 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb726c44604dca3873eee267d8b1232bc55f637
-  data.tar.gz: 5072c0c19bdc5729bf0134a65b5f5df894a688d4
+  metadata.gz: 406088664ae54129aca926d0cf20499386614ecf
+  data.tar.gz: d035993096295a1cec96701c0093c2f6486cfb17
 SHA512:
-  metadata.gz: e2fb59ddebe2f696de7728f28e9ec74b71f93baece609ee7d12783fd69c1ae7fad56bec37dd706d0032457b7cfe9e1bcef5022ac512e074baf8a9747c1d14806
-  data.tar.gz: c7241f9cfccef40479196a8c7c4def698ecef721adfd0157e086449ebada8ca60906d7e820cce4137809a35cd8c35d033974217275b3a3d157c51102e5e4ad36
+  metadata.gz: f1b4f3182d07acc36dacec517f6f919b99b2011efe909591a5d8ac81197c78540622fb9f8bf4ed85d7cf3cfccf6e57ce1f61deb2b67c7ac70246f1dd03e9fd6a
+  data.tar.gz: 9c2811314cf2210896b71530b0659ccd0180c4bbcce8fb98fb790f5c46154dab40a319a1c2f19115688a1a1677fe1f6f8ed25d02ae222661370efc1590235c12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    debug_helper (1.5.0)
+    debug_helper (1.6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,6 +24,8 @@ For certain classes (see below), the analysis is very detailed.
 
 For the collection classes ```Array```, ```Hash```, and ```Struct```, the analysis is also recursive;  that is, the collection's values are themselves analyzed.
 
+You can control the depth of recursion using option ```depth```.  See [Options](#options).
+
 Classes treated in detail:
 
 - [Array](#array)
@@ -100,10 +102,15 @@ The output shows details of the array.
 Array (message='My mixed array' size=3):
   Element 0: Fixnum 0
   Element 1:
-    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-    - one
+    String (size=3):
+      to_s: one
+      encoding: !ruby/encoding UTF-8
+      ascii_only?: true
+      bytesize: 3
   Element 2:
-    Symbol (size=3 encoding=US-ASCII): :two
+    Symbol (size=3):
+      to_s: two
+      encoding: !ruby/encoding US-ASCII
 ```
 
 #### Nested Arrays
@@ -184,15 +191,21 @@ The output shows details of the hash.
 Hash (size=3 message='My simple hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 1
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 2
 ```
 
@@ -220,19 +233,30 @@ The output shows details of the hash.
 Hash (size=3 message='My mixed hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII
 ```
 
 #### Nested Hashes
@@ -264,29 +288,41 @@ The output shows details of the hashes.
 Hash (size=2 message='My nested hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :b
+            Symbol (size=1):
+              to_s: b
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 0
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :c
+            Symbol (size=1):
+              to_s: c
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 1
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :d
+      Symbol (size=1):
+        to_s: d
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :e
+            Symbol (size=1):
+              to_s: e
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 2
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :f
+            Symbol (size=1):
+              to_s: f
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 3
 ```
 
@@ -315,12 +351,16 @@ The circular reference is not followed.
 Hash (size=1 message='My circular hashes'):
   Pair 0:
     Key:
-      Symbol (size=3 encoding=US-ASCII): :foo
+      Symbol (size=3):
+        to_s: foo
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=1):
         Pair 0:
           Key:
-            Symbol (size=3 encoding=US-ASCII): :bar
+            Symbol (size=3):
+              to_s: bar
+              encoding: !ruby/encoding US-ASCII
           Value: Hash {:foo=>{:bar=>{...}}}
 ```
 ### Struct
@@ -380,12 +420,17 @@ MyStruct (message='My mixed struct' size=3):
   Member 1:
     Name: :b
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Member 2:
     Name: :c
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII
 ```
 
 #### Nested Structs
@@ -496,8 +541,11 @@ The output shows details of the string.
 ```show.yaml```:
 ```yaml
 ---
-String (message='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
-- Lorem ipsum
+String (message='My simple string' size=11):
+  to_s: Lorem ipsum
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 11
 ```
 
 #### Multiline String
@@ -520,10 +568,13 @@ The output shows details of the string.
 ```show.yaml```:
 ```yaml
 ---
-String (message='My multiline string' size=122 encoding=UTF-8 ascii_only=true bytesize=122):
-- |
-  Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
-  sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+String (message='My multiline string' size=122):
+  to_s: |
+    Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+    sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 122
 ```
 ### Symbol
 
@@ -543,7 +594,9 @@ The output shows details of the symbol.
 ```show.yaml```:
 ```yaml
 ---
-Symbol (message='My symbol' size=11 encoding=US-ASCII): :lorem_ipsum
+Symbol (message='My symbol' size=11):
+  to_s: lorem_ipsum
+  encoding: !ruby/encoding US-ASCII
 ```
 ### Object
 
@@ -567,7 +620,7 @@ The output shows details of the datetime.
 
 ```show.yaml```:
 ```yaml
---- DateTime (message='My datetime') 2018-07-04T14:49:11-05:00
+--- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
 ...
 ```
 
@@ -610,3 +663,83 @@ The output shows details of the regexp.
 --- Regexp (message='My regexp') (?-mix:foo)
 ...
 ```
+
+## Options
+
+### Option ```depth```
+
+This example shows how option ```depth``` affects output.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0,
+       [1,
+        [2,
+         [3,
+          [4]
+         ]
+        ]
+       ]
+]
+(1..5).each do |depth|
+  message = "Show depth #{depth}"
+  DebugHelper.show(ary, message, {:depth => depth})
+end
+```
+
+The output shows output for various depths.
+
+```show.yaml```:
+```yaml
+---
+Array (message='Show depth 1' size=2):
+  Element 0: Fixnum 0
+  Element 1: Array [1, [2, [3, [4]]]]
+---
+Array (message='Show depth 2' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1: Array [2, [3, [4]]]
+---
+Array (message='Show depth 3' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1: Array [3, [4]]
+---
+Array (message='Show depth 4' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1: Array [4]
+---
+Array (message='Show depth 5' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1:
+                Array (size=1):
+                  Element 0: Fixnum 4
+```

data/lib/debug_helper.rb

@@ -6,8 +6,8 @@ class DebugHelper
 
   module Putd
 
-    def putd(obj, message)
-      DebugHelper.show(obj, message)
+    def putd(obj, message, options = {})
+      DebugHelper.show(obj, message, options)
     end
 
   end
@@ -15,25 +15,29 @@ class DebugHelper
   attr_accessor \
       :obj,
       :message,
-      :object_ids
+      :object_ids,
+      :depth
 
-  def self.show(obj, message = obj.class)
-    debug_helper = DebugHelper.new(obj, message)
+  def self.show(obj, message = obj.class, options = {})
+    debug_helper = DebugHelper.new(obj, message, options)
     x = debug_helper.send(:_show, obj, message, info = {})
     puts x.to_yaml
   end
 
   private
 
-  def initialize(obj, message)
+  def initialize(obj, message, options)
     self.obj = obj
     self.message = message
+    self.depth = options[:depth] || 3
     self.object_ids = []
   end
 
   def _show(obj, message, info)
     if object_ids.include?(obj.object_id)
       s = show_object(obj, message, info)
+    elsif depth == object_ids.size
+      s = show_object(obj, message, info)
     else
       object_ids.push(obj.object_id)
       s = case
@@ -41,19 +45,15 @@ class DebugHelper
               show_array(obj, message, info)
             when obj.kind_of?(Hash)
               show_hash(obj, message, info)
-            when obj.kind_of?(String)
-              show_string(obj, message, info)
             when obj.kind_of?(Struct)
               show_struct(obj, message, info)
-            when obj.kind_of?(Symbol)
-              show_symbol(obj, message, info)
             # when obj.kind_of?(Range)
             # when obj.kind_of?(Set)
             else
               show_object(obj, message, info)
           end
+      object_ids.pop
     end
-    object_ids.pop
     s
   end
 
@@ -86,19 +86,28 @@ class DebugHelper
   end
 
   def show_object(obj, message, info)
-    message_info = message.nil? ? '' : " (message='#{message}')"
-    "#{obj.class.name}#{message_info} #{obj}"
-  end
-
-  def show_string(obj, message, info)
-    attrs = {
-        :message => message,
-        :size => obj.size,
-        :encoding => obj.encoding,
-        :ascii_only => obj.ascii_only?,
-        :bytesize => obj.bytesize,
-    }
-    _show_item(obj.class.name, [obj], attrs, info)
+    methods = methods_for_object(obj)
+    if methods.nil?
+      message_info = message.nil? ? '' : " (message='#{message}')"
+      "#{obj.class.name}#{message_info} #{obj}"
+    else
+      content = {}
+      attrs = {:message => message}
+      methods[:instance].each do |instance_method|
+        value = obj.send(instance_method)
+        if instance_method == :size
+          attrs.store(:size, value)
+        else
+          content.store(instance_method.to_s, value)
+        end
+      end
+      methods[:class].each do |pair|
+        class_method, arguments = *pair
+        value = Object.const_get(obj.class.to_s).send(class_method, *arguments)
+        content.store(class_method.to_s, value)
+      end
+      _show_item(obj.class.name, content, attrs, info)
+    end
   end
 
   def show_struct(obj, message, info)
@@ -117,15 +126,6 @@ class DebugHelper
     _show_item(obj.class.name, content, attrs, info)
   end
 
-  def show_symbol(obj, message, info)
-    attrs = {
-        :message => message,
-        :size => obj.size,
-        :encoding => obj.encoding,
-    }
-    _show_item(obj.class.name, obj, attrs, info)
-  end
-
   def _show_item(class_name, content, attrs, info)
     message = attrs[:message]
     unless message.nil?
@@ -141,8 +141,49 @@ class DebugHelper
     attrs.each_pair do |key, value|
       a.push("#{key}=#{value}") unless value.nil?
     end
+    return class_name if a.empty?
     attrs_s = a.join(' ')
     "#{class_name} (#{attrs_s})"
   end
 
+  def methods_for_object(obj)
+    methods = case
+                when obj.kind_of?(File)
+                  {
+                      # The instance forms of some of these require the file to be open.
+                      :class => {
+                          :path => [obj.path],
+                          :atime => [obj.path],
+                          :ctime => [obj.path],
+                          :mtime => [obj.path],
+                          :size => [obj.path],
+                      },
+                      :instance => [],
+                  }
+                when obj.kind_of?(String)
+                  {
+                      :class => {},
+                      :instance => [
+                          :to_s,
+                          :size,
+                          :encoding,
+                          :ascii_only?,
+                          :bytesize,
+                      ]
+                  }
+                when obj.kind_of?(Symbol)
+                  {
+                      :class => {},
+                      :instance => [
+                          :to_s,
+                          :size,
+                          :encoding,
+                      ]
+                  }
+                else
+                  nil
+              end
+    methods
+  end
+
 end

data/lib/debug_helper/version.rb

@@ -1,3 +1,3 @@
 class DebugHelper
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/markdown/readme/Rakefile

@@ -5,6 +5,12 @@ namespace :build do
   desc 'Build README.md'
   task :readme do
     # Make output files.
+    Dir.chdir('options/depth') do
+      command = 'ruby show.rb > show.yaml'
+      system(command)
+      command = 'markdown_helper include --pristine template.md show.md'
+      system(command)
+    end
     class_dir_names = nil
     Dir.chdir('classes') do
       class_names = %w/
@@ -21,9 +27,9 @@ namespace :build do
           case_dir_names = Dir.glob('*').select {|f| File.directory? f}
           case_dir_names.each do |case_dir_name|
             Dir.chdir(case_dir_name) do
-              command = "ruby show.rb > show.yaml"
+              command = 'ruby show.rb > show.yaml'
               system(command)
-              command = "markdown_helper include --pristine template.md show.md"
+              command = 'markdown_helper include --pristine template.md show.md'
               system(command)
             end
           end

data/markdown/readme/classes/array/mixed/show.md

@@ -18,8 +18,13 @@ The output shows details of the array.
 Array (message='My mixed array' size=3):
   Element 0: Fixnum 0
   Element 1:
-    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-    - one
+    String (size=3):
+      to_s: one
+      encoding: !ruby/encoding UTF-8
+      ascii_only?: true
+      bytesize: 3
   Element 2:
-    Symbol (size=3 encoding=US-ASCII): :two
+    Symbol (size=3):
+      to_s: two
+      encoding: !ruby/encoding US-ASCII
 ```

data/markdown/readme/classes/array/mixed/show.yaml

@@ -2,7 +2,12 @@
 Array (message='My mixed array' size=3):
   Element 0: Fixnum 0
   Element 1:
-    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-    - one
+    String (size=3):
+      to_s: one
+      encoding: !ruby/encoding UTF-8
+      ascii_only?: true
+      bytesize: 3
   Element 2:
-    Symbol (size=3 encoding=US-ASCII): :two
+    Symbol (size=3):
+      to_s: two
+      encoding: !ruby/encoding US-ASCII

data/markdown/readme/classes/hash/circular/show.md

@@ -23,11 +23,15 @@ The circular reference is not followed.
 Hash (size=1 message='My circular hashes'):
   Pair 0:
     Key:
-      Symbol (size=3 encoding=US-ASCII): :foo
+      Symbol (size=3):
+        to_s: foo
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=1):
         Pair 0:
           Key:
-            Symbol (size=3 encoding=US-ASCII): :bar
+            Symbol (size=3):
+              to_s: bar
+              encoding: !ruby/encoding US-ASCII
           Value: Hash {:foo=>{:bar=>{...}}}
 ```

data/markdown/readme/classes/hash/circular/show.yaml

@@ -2,10 +2,14 @@
 Hash (size=1 message='My circular hashes'):
   Pair 0:
     Key:
-      Symbol (size=3 encoding=US-ASCII): :foo
+      Symbol (size=3):
+        to_s: foo
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=1):
         Pair 0:
           Key:
-            Symbol (size=3 encoding=US-ASCII): :bar
+            Symbol (size=3):
+              to_s: bar
+              encoding: !ruby/encoding US-ASCII
           Value: Hash {:foo=>{:bar=>{...}}}

data/markdown/readme/classes/hash/mixed/show.md

@@ -22,17 +22,28 @@ The output shows details of the hash.
 Hash (size=3 message='My mixed hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII
 ```

data/markdown/readme/classes/hash/mixed/show.yaml

@@ -2,16 +2,27 @@
 Hash (size=3 message='My mixed hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII

data/markdown/readme/classes/hash/nested/show.md

@@ -27,28 +27,40 @@ The output shows details of the hashes.
 Hash (size=2 message='My nested hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :b
+            Symbol (size=1):
+              to_s: b
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 0
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :c
+            Symbol (size=1):
+              to_s: c
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 1
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :d
+      Symbol (size=1):
+        to_s: d
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :e
+            Symbol (size=1):
+              to_s: e
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 2
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :f
+            Symbol (size=1):
+              to_s: f
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 3
 ```

data/markdown/readme/classes/hash/nested/show.yaml

@@ -2,27 +2,39 @@
 Hash (size=2 message='My nested hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :b
+            Symbol (size=1):
+              to_s: b
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 0
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :c
+            Symbol (size=1):
+              to_s: c
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 1
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :d
+      Symbol (size=1):
+        to_s: d
+        encoding: !ruby/encoding US-ASCII
     Value:
       Hash (size=2):
         Pair 0:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :e
+            Symbol (size=1):
+              to_s: e
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 2
         Pair 1:
           Key:
-            Symbol (size=1 encoding=US-ASCII): :f
+            Symbol (size=1):
+              to_s: f
+              encoding: !ruby/encoding US-ASCII
           Value: Fixnum 3

data/markdown/readme/classes/hash/simple/show.md

@@ -18,14 +18,20 @@ The output shows details of the hash.
 Hash (size=3 message='My simple hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 1
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 2
 ```

data/markdown/readme/classes/hash/simple/show.yaml

@@ -2,13 +2,19 @@
 Hash (size=3 message='My simple hash'):
   Pair 0:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :a
+      Symbol (size=1):
+        to_s: a
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 0
   Pair 1:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :b
+      Symbol (size=1):
+        to_s: b
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 1
   Pair 2:
     Key:
-      Symbol (size=1 encoding=US-ASCII): :c
+      Symbol (size=1):
+        to_s: c
+        encoding: !ruby/encoding US-ASCII
     Value: Fixnum 2

data/markdown/readme/classes/object/datetime/show.md

@@ -14,6 +14,6 @@ The output shows details of the datetime.
 
 ```show.yaml```:
 ```yaml
---- DateTime (message='My datetime') 2018-07-04T14:49:11-05:00
+--- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
 ...
 ```

data/markdown/readme/classes/object/datetime/show.yaml

@@ -1,2 +1,2 @@
---- DateTime (message='My datetime') 2018-07-04T14:49:11-05:00
+--- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
 ...

data/markdown/readme/classes/string/multiline/show.md

@@ -18,8 +18,11 @@ The output shows details of the string.
 ```show.yaml```:
 ```yaml
 ---
-String (message='My multiline string' size=122 encoding=UTF-8 ascii_only=true bytesize=122):
-- |
-  Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
-  sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+String (message='My multiline string' size=122):
+  to_s: |
+    Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+    sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 122
 ```

data/markdown/readme/classes/string/multiline/show.yaml

@@ -1,5 +1,8 @@
 ---
-String (message='My multiline string' size=122 encoding=UTF-8 ascii_only=true bytesize=122):
-- |
-  Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
-  sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+String (message='My multiline string' size=122):
+  to_s: |
+    Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+    sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 122

data/markdown/readme/classes/string/simple/show.md

@@ -15,6 +15,9 @@ The output shows details of the string.
 ```show.yaml```:
 ```yaml
 ---
-String (message='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
-- Lorem ipsum
+String (message='My simple string' size=11):
+  to_s: Lorem ipsum
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 11
 ```

data/markdown/readme/classes/string/simple/show.yaml

@@ -1,3 +1,6 @@
 ---
-String (message='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
-- Lorem ipsum
+String (message='My simple string' size=11):
+  to_s: Lorem ipsum
+  encoding: !ruby/encoding UTF-8
+  ascii_only?: true
+  bytesize: 11

data/markdown/readme/classes/struct/mixed/show.md

@@ -23,10 +23,15 @@ MyStruct (message='My mixed struct' size=3):
   Member 1:
     Name: :b
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Member 2:
     Name: :c
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII
 ```

data/markdown/readme/classes/struct/mixed/show.yaml

@@ -6,9 +6,14 @@ MyStruct (message='My mixed struct' size=3):
   Member 1:
     Name: :b
     Value:
-      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
-      - one
+      String (size=3):
+        to_s: one
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
   Member 2:
     Name: :c
     Value:
-      Symbol (size=3 encoding=US-ASCII): :two
+      Symbol (size=3):
+        to_s: two
+        encoding: !ruby/encoding US-ASCII

data/markdown/readme/classes/symbol/simple/show.md

@@ -14,5 +14,7 @@ The output shows details of the symbol.
 ```show.yaml```:
 ```yaml
 ---
-Symbol (message='My symbol' size=11 encoding=US-ASCII): :lorem_ipsum
+Symbol (message='My symbol' size=11):
+  to_s: lorem_ipsum
+  encoding: !ruby/encoding US-ASCII
 ```

data/markdown/readme/classes/symbol/simple/show.yaml

@@ -1,2 +1,4 @@
 ---
-Symbol (message='My symbol' size=11 encoding=US-ASCII): :lorem_ipsum
+Symbol (message='My symbol' size=11):
+  to_s: lorem_ipsum
+  encoding: !ruby/encoding US-ASCII

data/markdown/readme/options/depth/show.md

@@ -0,0 +1,77 @@
+### Option ```depth```
+
+This example shows how option ```depth``` affects output.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0,
+       [1,
+        [2,
+         [3,
+          [4]
+         ]
+        ]
+       ]
+]
+(1..5).each do |depth|
+  message = "Show depth #{depth}"
+  DebugHelper.show(ary, message, {:depth => depth})
+end
+```
+
+The output shows output for various depths.
+
+```show.yaml```:
+```yaml
+---
+Array (message='Show depth 1' size=2):
+  Element 0: Fixnum 0
+  Element 1: Array [1, [2, [3, [4]]]]
+---
+Array (message='Show depth 2' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1: Array [2, [3, [4]]]
+---
+Array (message='Show depth 3' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1: Array [3, [4]]
+---
+Array (message='Show depth 4' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1: Array [4]
+---
+Array (message='Show depth 5' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1:
+                Array (size=1):
+                  Element 0: Fixnum 4
+```

data/markdown/readme/options/depth/show.rb

@@ -0,0 +1,15 @@
+require 'debug_helper'
+
+ary = [0,
+       [1,
+        [2,
+         [3,
+          [4]
+         ]
+        ]
+       ]
+]
+(1..5).each do |depth|
+  message = "Show depth #{depth}"
+  DebugHelper.show(ary, message, {:depth => depth})
+end

data/markdown/readme/options/depth/show.yaml

@@ -0,0 +1,49 @@
+---
+Array (message='Show depth 1' size=2):
+  Element 0: Fixnum 0
+  Element 1: Array [1, [2, [3, [4]]]]
+---
+Array (message='Show depth 2' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1: Array [2, [3, [4]]]
+---
+Array (message='Show depth 3' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1: Array [3, [4]]
+---
+Array (message='Show depth 4' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1: Array [4]
+---
+Array (message='Show depth 5' size=2):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1:
+        Array (size=2):
+          Element 0: Fixnum 2
+          Element 1:
+            Array (size=2):
+              Element 0: Fixnum 3
+              Element 1:
+                Array (size=1):
+                  Element 0: Fixnum 4

data/markdown/readme/options/depth/template.md

@@ -0,0 +1,9 @@
+### Option ```depth```
+
+This example shows how option ```depth``` affects output.
+
+@[ruby](show.rb)
+
+The output shows output for various depths.
+
+@[yaml](show.yaml)

data/markdown/readme/template.md

@@ -14,6 +14,8 @@ For certain classes (see below), the analysis is very detailed.
 
 For the collection classes ```Array```, ```Hash```, and ```Struct```, the analysis is also recursive;  that is, the collection's values are themselves analyzed.
 
+You can control the depth of recursion using option ```depth```.  See [Options](#options).
+
 Classes treated in detail:
 
 @[:markdown](class_links.md)
@@ -42,3 +44,7 @@ putd obj, message
 Just be sure to ```include DebugHelper::Putd```.
 
 @[:markdown](class_inclusions.md)
+
+## Options
+
+@[:markdown](options/depth/show.md)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_helper
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-07 00:00:00.000000000 Z
+date: 2018-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,10 @@ files:
 - markdown/readme/classes/symbol/simple/template.md
 - markdown/readme/classes/symbol/template.md
 - markdown/readme/classes/template.md
+- markdown/readme/options/depth/show.md
+- markdown/readme/options/depth/show.rb
+- markdown/readme/options/depth/show.yaml
+- markdown/readme/options/depth/template.md
 - markdown/readme/show_array.rb
 - markdown/readme/show_hash.rb
 - markdown/readme/template.md