debug_helper 1.7.0 → 1.8.0

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

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

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

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

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

@@ -0,0 +1,23 @@
+#### Simple IO
+
+This example shows a simple ```IO```.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+io = IO.new(IO.sysopen(__FILE__, 'r'), 'r')
+DebugHelper.show(io, 'My simple io')
+```
+
+The output shows details of the ```IO```.
+
+```show.yaml```:
+```yaml
+---
+IO (message='My simple io'):
+  autoclose?: true
+  binmode?: false
+  closed?: false
+  tty?: false
+```

data/markdown/readme/classes/io/simple/show.rb

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+io = IO.new(IO.sysopen(__FILE__, 'r'), 'r')
+DebugHelper.show(io, 'My simple io')

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

@@ -0,0 +1,6 @@
+---
+IO (message='My simple io'):
+  autoclose?: true
+  binmode?: false
+  closed?: false
+  tty?: false

data/markdown/readme/classes/io/simple/template.md

@@ -0,0 +1,9 @@
+#### Simple IO
+
+This example shows a simple ```IO```.
+
+@[ruby](show.rb)
+
+The output shows details of the ```IO```.
+
+@[yaml](show.yaml)

data/markdown/readme/classes/io/template.md

@@ -0,0 +1,3 @@
+### IO
+
+@[:markdown](simple/show.md)

data/markdown/readme/classes/match_data/multiple_captures/show.md

@@ -0,0 +1,33 @@
+#### Multiple Captures
+
+This example shows a ```MatchData``` with multiple captures.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+match_data = /(.)(.)(\d+)(\d)/.match('THX1138.')
+DebugHelper.show(match_data, 'My MatchData with named captures')
+```
+
+The output shows details of the ```MatchData```.
+
+```show.yaml```:
+```yaml
+---
+MatchData (message='My MatchData with named captures'):
+  size: 5
+  regexp: !ruby/regexp /(.)(.)(\d+)(\d)/
+  to_a:
+  - HX1138
+  - H
+  - X
+  - '113'
+  - '8'
+  captures:
+  - H
+  - X
+  - '113'
+  - '8'
+  names: []
+```

data/markdown/readme/classes/match_data/multiple_captures/show.rb

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+match_data = /(.)(.)(\d+)(\d)/.match('THX1138.')
+DebugHelper.show(match_data, 'My MatchData with named captures')

data/markdown/readme/classes/match_data/multiple_captures/show.yaml

@@ -0,0 +1,16 @@
+---
+MatchData (message='My MatchData with named captures'):
+  size: 5
+  regexp: !ruby/regexp /(.)(.)(\d+)(\d)/
+  to_a:
+  - HX1138
+  - H
+  - X
+  - '113'
+  - '8'
+  captures:
+  - H
+  - X
+  - '113'
+  - '8'
+  names: []

data/markdown/readme/classes/match_data/multiple_captures/template.md

@@ -0,0 +1,9 @@
+#### Multiple Captures
+
+This example shows a ```MatchData``` with multiple captures.
+
+@[ruby](show.rb)
+
+The output shows details of the ```MatchData```.
+
+@[yaml](show.yaml)

data/markdown/readme/classes/match_data/named_captures/show.md

@@ -0,0 +1,31 @@
+#### Named Captures
+
+This example shows a ```MatchData``` with named captures.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+match_data = /(?<x>.)(?<y>.)?/.match("a")
+DebugHelper.show(match_data, 'My MatchData with named captures')
+```
+
+The output shows details of the ```MatchData```.
+
+```show.yaml```:
+```yaml
+---
+MatchData (message='My MatchData with named captures'):
+  size: 3
+  regexp: !ruby/regexp /(?<x>.)(?<y>.)?/
+  to_a:
+  - a
+  - a
+  - 
+  captures:
+  - a
+  - 
+  names:
+  - x
+  - y
+```

data/markdown/readme/classes/match_data/named_captures/show.rb

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+match_data = /(?<x>.)(?<y>.)?/.match("a")
+DebugHelper.show(match_data, 'My MatchData with named captures')

data/markdown/readme/classes/match_data/named_captures/show.yaml

@@ -0,0 +1,14 @@
+---
+MatchData (message='My MatchData with named captures'):
+  size: 3
+  regexp: !ruby/regexp /(?<x>.)(?<y>.)?/
+  to_a:
+  - a
+  - a
+  - 
+  captures:
+  - a
+  - 
+  names:
+  - x
+  - y

data/markdown/readme/classes/match_data/named_captures/template.md

@@ -0,0 +1,9 @@
+#### Named Captures
+
+This example shows a ```MatchData``` with named captures.
+
+@[ruby](show.rb)
+
+The output shows details of the ```MatchData```.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,25 @@
+#### Simple MatchData
+
+This example shows a simple ```MatchData```.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+match_data = /[a-z]/.match('abc')
+DebugHelper.show(match_data, 'My simple MatchData')
+```
+
+The output shows details of the ```MatchData```.
+
+```show.yaml```:
+```yaml
+---
+MatchData (message='My simple MatchData'):
+  size: 1
+  regexp: !ruby/regexp /[a-z]/
+  to_a:
+  - a
+  captures: []
+  names: []
+```

data/markdown/readme/classes/match_data/simple/show.rb

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+match_data = /[a-z]/.match('abc')
+DebugHelper.show(match_data, 'My simple MatchData')

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

@@ -0,0 +1,8 @@
+---
+MatchData (message='My simple MatchData'):
+  size: 1
+  regexp: !ruby/regexp /[a-z]/
+  to_a:
+  - a
+  captures: []
+  names: []

data/markdown/readme/classes/match_data/simple/template.md

@@ -0,0 +1,9 @@
+#### Simple MatchData
+
+This example shows a simple ```MatchData```.
+
+@[ruby](show.rb)
+
+The output shows details of the ```MatchData```.
+
+@[yaml](show.yaml)

data/markdown/readme/classes/match_data/template.md

@@ -0,0 +1,7 @@
+### MatchData
+
+@[:markdown](simple/show.md)
+
+@[:markdown](multiple_captures/show.md)
+
+@[:markdown](named_captures/show.md)

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

@@ -0,0 +1,23 @@
+#### Unanalyzed Object
+
+This example shows an object that will not be analyzed.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+class MyClass
+  def inspect
+    'My class inspection'
+  end
+end
+DebugHelper.show(MyClass.new, 'My class')
+```
+
+The output shows details of the object.
+
+```show.yaml```:
+```yaml
+--- MyClass (message='My class') My class inspection
+...
+```

data/markdown/readme/classes/object/object/show.rb

@@ -0,0 +1,8 @@
+require 'debug_helper'
+
+class MyClass
+  def inspect
+    'My class inspection'
+  end
+end
+DebugHelper.show(MyClass.new, 'My class')

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

@@ -0,0 +1,2 @@
+--- MyClass (message='My class') My class inspection
+...

data/markdown/readme/classes/object/object/template.md

@@ -0,0 +1,9 @@
+#### Unanalyzed Object
+
+This example shows an object that will not be analyzed.
+
+@[ruby](show.rb)
+
+The output shows details of the object.
+
+@[yaml](show.yaml)

data/markdown/readme/classes/object/template.md

@@ -2,10 +2,4 @@
 
 Classes not mentioned above are not analyzed, but are treated more simply.
 
-A few examples are shown below.
-
-@[:markdown](datetime/show.md)
-
-@[:markdown](range/show.md)
-
-@[:markdown](regexp/show.md)
+@[:markdown](object/show.md)

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

@@ -0,0 +1,40 @@
+#### Circular OpenStructs
+
+This example shows open structs that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'ostruct'
+require 'debug_helper'
+
+ostruct_0 = OpenStruct.new
+ostruct_1 = OpenStruct.new
+ostruct_0.a = ostruct_1
+ostruct_1.a = ostruct_0
+DebugHelper.show(ostruct_0, 'My circular ostruct')
+```
+
+The output shows details of the open structs.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+OpenStruct (message='My circular ostruct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: a
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: 'OpenStruct #<OpenStruct a=#<OpenStruct a=#<OpenStruct ...>>>'
+```

data/markdown/readme/classes/open_struct/circular/show.rb

@@ -0,0 +1,8 @@
+require 'ostruct'
+require 'debug_helper'
+
+ostruct_0 = OpenStruct.new
+ostruct_1 = OpenStruct.new
+ostruct_0.a = ostruct_1
+ostruct_1.a = ostruct_0
+DebugHelper.show(ostruct_0, 'My circular ostruct')

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

@@ -0,0 +1,17 @@
+---
+OpenStruct (message='My circular ostruct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: a
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: 'OpenStruct #<OpenStruct a=#<OpenStruct a=#<OpenStruct ...>>>'