debug_helper 1.7.0 → 1.8.0

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

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

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

@@ -0,0 +1,51 @@
+#### Mixed OpenStruct
+
+This example shows an open struct of mixed values.
+
+```show.rb```:
+```ruby
+require 'ostruct'
+require 'debug_helper'
+
+ostruct = OpenStruct.new(:a => 0, :b => 'one', :c => :two)
+DebugHelper.show(ostruct, 'My mixed open struct')
+```
+
+The output shows details of the open struct.
+
+```show.yaml```:
+```yaml
+---
+OpenStruct (message='My mixed open struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 0
+  Member 1:
+    Name:
+      Symbol:
+        to_s: b
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      String:
+        to_s: one
+        size: 3
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
+  Member 2:
+    Name:
+      Symbol:
+        to_s: c
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      Symbol:
+        to_s: two
+        size: 3
+        encoding: !ruby/encoding US-ASCII
+```

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

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

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

@@ -0,0 +1,33 @@
+---
+OpenStruct (message='My mixed open struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 0
+  Member 1:
+    Name:
+      Symbol:
+        to_s: b
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      String:
+        to_s: one
+        size: 3
+        encoding: !ruby/encoding UTF-8
+        ascii_only?: true
+        bytesize: 3
+  Member 2:
+    Name:
+      Symbol:
+        to_s: c
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      Symbol:
+        to_s: two
+        size: 3
+        encoding: !ruby/encoding US-ASCII

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

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

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

@@ -0,0 +1,73 @@
+#### Nested OpenStructs
+
+This example shows nested open structs.
+
+```show.rb```:
+```ruby
+require 'ostruct'
+require 'debug_helper'
+
+ostruct = OpenStruct.new(
+                        :a => OpenStruct.new(
+                                            :b => 0,
+                                            :c => 1,
+                        ),
+                        :d => OpenStruct.new(
+                                            :e => 2,
+                                            :f => 3,
+                        )
+)
+DebugHelper.show(ostruct, 'My nested struct')
+```
+
+The output shows details of the open structs.
+
+```show.yaml```:
+```yaml
+---
+OpenStruct (message='My nested struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: b
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 0
+        Member 1:
+          Name:
+            Symbol:
+              to_s: c
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 1
+  Member 1:
+    Name:
+      Symbol:
+        to_s: d
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: e
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 2
+        Member 1:
+          Name:
+            Symbol:
+              to_s: f
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 3
+```

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

@@ -0,0 +1,14 @@
+require 'ostruct'
+require 'debug_helper'
+
+ostruct = OpenStruct.new(
+                        :a => OpenStruct.new(
+                                            :b => 0,
+                                            :c => 1,
+                        ),
+                        :d => OpenStruct.new(
+                                            :e => 2,
+                                            :f => 3,
+                        )
+)
+DebugHelper.show(ostruct, 'My nested struct')

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

@@ -0,0 +1,46 @@
+---
+OpenStruct (message='My nested struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: b
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 0
+        Member 1:
+          Name:
+            Symbol:
+              to_s: c
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 1
+  Member 1:
+    Name:
+      Symbol:
+        to_s: d
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value:
+      OpenStruct:
+        Member 0:
+          Name:
+            Symbol:
+              to_s: e
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 2
+        Member 1:
+          Name:
+            Symbol:
+              to_s: f
+              size: 1
+              encoding: !ruby/encoding US-ASCII
+          Value: Fixnum 3

data/markdown/readme/classes/open_struct/nested/template.md

@@ -0,0 +1,9 @@
+#### Nested OpenStructs
+
+This example shows nested open structs.
+
+@[ruby](show.rb)
+
+The output shows details of the open structs.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,41 @@
+#### Simple OpenStruct
+
+This example shows a simple open struct.
+
+```show.rb```:
+```ruby
+require 'ostruct'
+require 'debug_helper'
+
+ostruct = OpenStruct.new(:a => 0, :b => 1, :c => 2)
+DebugHelper.show(ostruct, 'My simple struct')
+```
+
+The output shows details of the open struct.
+
+```show.yaml```:
+```yaml
+---
+OpenStruct (message='My simple struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 0
+  Member 1:
+    Name:
+      Symbol:
+        to_s: b
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 1
+  Member 2:
+    Name:
+      Symbol:
+        to_s: c
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 2
+```

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

@@ -0,0 +1,5 @@
+require 'ostruct'
+require 'debug_helper'
+
+ostruct = OpenStruct.new(:a => 0, :b => 1, :c => 2)
+DebugHelper.show(ostruct, 'My simple struct')

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

@@ -0,0 +1,23 @@
+---
+OpenStruct (message='My simple struct'):
+  Member 0:
+    Name:
+      Symbol:
+        to_s: a
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 0
+  Member 1:
+    Name:
+      Symbol:
+        to_s: b
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 1
+  Member 2:
+    Name:
+      Symbol:
+        to_s: c
+        size: 1
+        encoding: !ruby/encoding US-ASCII
+    Value: Fixnum 2

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

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

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

@@ -0,0 +1,9 @@
+### OpenStruct
+
+@[:markdown](simple/show.md)
+
+@[:markdown](mixed/show.md)
+
+@[:markdown](nested/show.md)
+
+@[:markdown](circular/show.md)

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

@@ -0,0 +1,22 @@
+#### Exclusive Range
+
+This example shows a ```Range``` that excludes its end value.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+range = (0...4)
+DebugHelper.show(range, 'My exclusive range')
+```
+
+The output shows details of the ```Range```.
+
+```show.yaml```:
+```yaml
+---
+Range (message='My exclusive range'):
+  first: 0
+  last: 4
+  exclude_end?: true
+```

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

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

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

@@ -0,0 +1,5 @@
+---
+Range (message='My exclusive range'):
+  first: 0
+  last: 4
+  exclude_end?: true

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

@@ -0,0 +1,9 @@
+#### Exclusive Range
+
+This example shows a ```Range``` that excludes its end value.
+
+@[ruby](show.rb)
+
+The output shows details of the ```Range```.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,22 @@
+#### Inclusive Range
+
+This example shows a ```Range``` that includes its end value.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+range = (0..4)
+DebugHelper.show(range, 'My inclusive range')
+```
+
+The output shows details of the ```Range```.
+
+```show.yaml```:
+```yaml
+---
+Range (message='My inclusive range'):
+  first: 0
+  last: 4
+  exclude_end?: false
+```

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

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

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

@@ -0,0 +1,5 @@
+---
+Range (message='My inclusive range'):
+  first: 0
+  last: 4
+  exclude_end?: false