debug_helper 1.0.0

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+datetime = DateTime.now
+DebugHelper.show(datetime, 'My datetime')

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

@@ -0,0 +1,2 @@
+--- DateTime (name='My datetime') 2018-06-29T17:20:16-05:00
+...

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

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

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

@@ -0,0 +1,19 @@
+#### Range
+
+This example shows a range.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+range = Range.new(0, 9)
+DebugHelper.show(range, 'My range')
+```
+
+The output shows details of the range.
+
+```show.yaml```:
+```yaml
+--- Range (name='My range') 0..9
+...
+```

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+range = Range.new(0, 9)
+DebugHelper.show(range, 'My range')

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

@@ -0,0 +1,2 @@
+--- Range (name='My range') 0..9
+...

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

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

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

@@ -0,0 +1,19 @@
+#### Regexp
+
+This example shows a regexp.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+regexp = Regexp.new('foo')
+DebugHelper.show(regexp, 'My regexp')
+```
+
+The output shows details of the regexp.
+
+```show.yaml```:
+```yaml
+--- Regexp (name='My regexp') (?-mix:foo)
+...
+```

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+regexp = Regexp.new('foo')
+DebugHelper.show(regexp, 'My regexp')

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

@@ -0,0 +1,2 @@
+--- Regexp (name='My regexp') (?-mix:foo)
+...

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

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

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

@@ -0,0 +1,11 @@
+### Object
+
+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)

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

@@ -0,0 +1,25 @@
+#### Multiline String
+
+This example shows a multiline string.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+s = <<EOT
+Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+EOT
+DebugHelper.show(s, 'My multiline string')
+```
+
+The output shows details of the string.
+
+```show.yaml```:
+```yaml
+---
+String (name='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.
+```

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

@@ -0,0 +1,7 @@
+require 'debug_helper'
+
+s = <<EOT
+Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+EOT
+DebugHelper.show(s, 'My multiline string')

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

@@ -0,0 +1,5 @@
+---
+String (name='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.

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

@@ -0,0 +1,9 @@
+#### Multiline String
+
+This example shows a multiline string.
+
+@[ruby](show.rb)
+
+The output shows details of the string.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,20 @@
+#### Simple String
+
+This example shows a simple string.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+s = 'Lorem ipsum'
+DebugHelper.show(s, 'My simple string')
+```
+
+The output shows details of the string.
+
+```show.yaml```:
+```yaml
+---
+String (name='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
+- Lorem ipsum
+```

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+s = 'Lorem ipsum'
+DebugHelper.show(s, 'My simple string')

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

@@ -0,0 +1,3 @@
+---
+String (name='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
+- Lorem ipsum

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

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

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

@@ -0,0 +1,5 @@
+### String
+
+@[:markdown](simple/show.md)
+
+@[:markdown](multiline/show.md)

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

@@ -0,0 +1,45 @@
+#### Circular Structs
+
+This example shows structs that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct_0 = MyStruct.new(0, 1, 2)
+struct_1 = MyStruct.new(3, 4, 5)
+struct_0.a = struct_1
+struct_1.a = struct_0
+DebugHelper.show(struct_0, 'My circular struct')
+```
+
+The output shows details of the structs.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+MyStruct (name='My circular struct' size=3):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct (size=3):
+        Member 0:
+          Name: :a
+          Value: 'MyStruct #<struct MyStruct a=#<struct MyStruct a=#<struct MyStruct:...>,
+            b=4, c=5>, b=1, c=2>'
+        Member 1:
+          Name: :b
+          Value: Fixnum 4
+        Member 2:
+          Name: :c
+          Value: Fixnum 5
+  Member 1:
+    Name: :b
+    Value: Fixnum 1
+  Member 2:
+    Name: :c
+    Value: Fixnum 2
+```

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

@@ -0,0 +1,8 @@
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct_0 = MyStruct.new(0, 1, 2)
+struct_1 = MyStruct.new(3, 4, 5)
+struct_0.a = struct_1
+struct_1.a = struct_0
+DebugHelper.show(struct_0, 'My circular struct')

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

@@ -0,0 +1,22 @@
+---
+MyStruct (name='My circular struct' size=3):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct (size=3):
+        Member 0:
+          Name: :a
+          Value: 'MyStruct #<struct MyStruct a=#<struct MyStruct a=#<struct MyStruct:...>,
+            b=4, c=5>, b=1, c=2>'
+        Member 1:
+          Name: :b
+          Value: Fixnum 4
+        Member 2:
+          Name: :c
+          Value: Fixnum 5
+  Member 1:
+    Name: :b
+    Value: Fixnum 1
+  Member 2:
+    Name: :c
+    Value: Fixnum 2

data/markdown/readme/classes/struct/circular/template.md

@@ -0,0 +1,11 @@
+#### Circular Structs
+
+This example shows structs that make a circular reference.
+
+@[ruby](show.rb)
+
+The output shows details of the structs.
+
+The circular reference is not followed.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,32 @@
+#### Mixed Struct
+
+This example shows a struct of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct = MyStruct.new(0, 'one', :two)
+DebugHelper.show(struct, 'My mixed struct')
+```
+
+The output shows details of the struct.
+
+```show.yaml```:
+```yaml
+---
+MyStruct (name='My mixed struct' size=3):
+  Member 0:
+    Name: :a
+    Value: Fixnum 0
+  Member 1:
+    Name: :b
+    Value:
+      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+      - one
+  Member 2:
+    Name: :c
+    Value:
+      Symbol (size=3 encoding=US-ASCII): :two
+```

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

@@ -0,0 +1,5 @@
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct = MyStruct.new(0, 'one', :two)
+DebugHelper.show(struct, 'My mixed struct')

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

@@ -0,0 +1,14 @@
+---
+MyStruct (name='My mixed struct' size=3):
+  Member 0:
+    Name: :a
+    Value: Fixnum 0
+  Member 1:
+    Name: :b
+    Value:
+      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+      - one
+  Member 2:
+    Name: :c
+    Value:
+      Symbol (size=3 encoding=US-ASCII): :two

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

@@ -0,0 +1,9 @@
+#### Mixed Struct
+
+This example shows a struct of mixed values.
+
+@[ruby](show.rb)
+
+The output shows details of the struct.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,43 @@
+#### Nested Structs
+
+This example shows nested structs.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct_0 = Struct.new(:a, :b)
+MyStruct_1 = Struct.new(:c, :d)
+struct_1a = MyStruct_1.new(2, 3)
+struct_1b = MyStruct_1.new(4, 5)
+struct_0 = MyStruct_0.new(struct_1a, struct_1b)
+DebugHelper.show(struct_0, 'My nested struct')
+```
+
+The output shows details of the structs.
+
+```show.yaml```:
+```yaml
+---
+MyStruct_0 (name='My nested struct' size=2):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 2
+        Member 1:
+          Name: :d
+          Value: Fixnum 3
+  Member 1:
+    Name: :b
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 4
+        Member 1:
+          Name: :d
+          Value: Fixnum 5
+```

data/markdown/readme/classes/struct/nested/show.rb

@@ -0,0 +1,8 @@
+require 'debug_helper'
+
+MyStruct_0 = Struct.new(:a, :b)
+MyStruct_1 = Struct.new(:c, :d)
+struct_1a = MyStruct_1.new(2, 3)
+struct_1b = MyStruct_1.new(4, 5)
+struct_0 = MyStruct_0.new(struct_1a, struct_1b)
+DebugHelper.show(struct_0, 'My nested struct')

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

@@ -0,0 +1,22 @@
+---
+MyStruct_0 (name='My nested struct' size=2):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 2
+        Member 1:
+          Name: :d
+          Value: Fixnum 3
+  Member 1:
+    Name: :b
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 4
+        Member 1:
+          Name: :d
+          Value: Fixnum 5