debug_helper 1.8.0 → 2.0.0

data/markdown/readme/classes/custom/instance/foo_handler.rb

@@ -0,0 +1,18 @@
+require 'debug_helper'
+
+class DebugHelper
+
+  class FooHandler < Handler
+
+    def calls_for_instance
+      [
+          [:my_array],
+          [:my_hash],
+          [:respond_to?, :your_array],
+          [:respond_to?, :your_hash],
+      ]
+    end
+
+  end
+
+end

data/markdown/readme/classes/custom/instance/show.md

@@ -0,0 +1,74 @@
+#### Instance Methods
+
+This example shows a custom handler that explicates via instance methods.
+
+Here's a class ```Foo``` that has some instance methods:
+ 
+```foo.rb```:
+```ruby
+require 'debug_helper'
+
+class Foo
+
+  def my_array
+    %w/foo bar baz/
+  end
+
+  def my_hash
+    {:a => 0, :b => 1}
+  end
+
+end
+```
+
+Here's its custom debug handler class ```FooHandler```.  The array returned by method ```calls_for_instance``` tells the base class ```Handler``` which methods to call for the explication, and what arguments to pass, if any.
+
+```foo_handler.rb```:
+```ruby
+require 'debug_helper'
+
+class DebugHelper
+
+  class FooHandler < Handler
+
+    def calls_for_instance
+      [
+          [:my_array],
+          [:my_hash],
+          [:respond_to?, :your_array],
+          [:respond_to?, :your_hash],
+      ]
+    end
+
+  end
+
+end
+```
+
+Here's a program that uses the custom handler.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+require_relative 'foo'
+require_relative 'foo_handler'
+
+DebugHelper.show(Foo.new, 'My class Foo')
+```
+
+The output shows details of the object.
+
+```show.yaml```:
+```yaml
+---
+Foo (message='My class Foo'):
+  Foo#my_array:
+  - foo
+  - bar
+  - baz
+  Foo#my_hash:
+    :a: 0
+    :b: 1
+  Foo#respond_to?(:your_array): false
+  Foo#respond_to?(:your_hash): false
+```

data/markdown/readme/classes/custom/instance/show.rb

@@ -0,0 +1,5 @@
+require 'debug_helper'
+require_relative 'foo'
+require_relative 'foo_handler'
+
+DebugHelper.show(Foo.new, 'My class Foo')

data/markdown/readme/classes/custom/instance/show.yaml

@@ -0,0 +1,11 @@
+---
+Foo (message='My class Foo'):
+  Foo#my_array:
+  - foo
+  - bar
+  - baz
+  Foo#my_hash:
+    :a: 0
+    :b: 1
+  Foo#respond_to?(:your_array): false
+  Foo#respond_to?(:your_hash): false

data/markdown/readme/classes/custom/instance/template.md

@@ -0,0 +1,19 @@
+#### Instance Methods
+
+This example shows a custom handler that explicates via instance methods.
+
+Here's a class ```Foo``` that has some instance methods:
+ 
+@[ruby](foo.rb)
+
+Here's its custom debug handler class ```FooHandler```.  The array returned by method ```calls_for_instance``` tells the base class ```Handler``` which methods to call for the explication, and what arguments to pass, if any.
+
+@[ruby](foo_handler.rb)
+
+Here's a program that uses the custom handler.
+
+@[ruby](show.rb)
+
+The output shows details of the object.
+
+@[yaml](show.yaml)

data/markdown/readme/classes/custom/singleton/foo.rb

@@ -0,0 +1,13 @@
+require 'debug_helper'
+
+class Foo
+
+  def self.my_array
+    %w/bat bam bad/
+  end
+
+  def self.my_hash
+    {:c => 2, :d => 3}
+  end
+
+end

data/markdown/readme/classes/custom/singleton/foo_handler.rb

@@ -0,0 +1,18 @@
+require 'debug_helper'
+
+class DebugHelper
+
+  class FooHandler < Handler
+
+    def calls_for_class
+      [
+          [:my_array],
+          [:my_hash],
+          [:respond_to?, :your_array],
+          [:respond_to?, :your_hash],
+      ]
+    end
+
+  end
+
+end

data/markdown/readme/classes/custom/singleton/show.md

@@ -0,0 +1,74 @@
+#### Singleton Methods
+
+This example shows a custom handler that explicates via singleton methods.
+
+Here's a class ```Foo``` that has some singleton methods:
+ 
+```foo.rb```:
+```ruby
+require 'debug_helper'
+
+class Foo
+
+  def self.my_array
+    %w/bat bam bad/
+  end
+
+  def self.my_hash
+    {:c => 2, :d => 3}
+  end
+
+end
+```
+
+Here's its custom debug handler class ```FooHandler```.  The array returned in method ```calls_for_class``` tells the base class ```Handler``` which methods to call for the explication.
+
+```foo_handler.rb```:
+```ruby
+require 'debug_helper'
+
+class DebugHelper
+
+  class FooHandler < Handler
+
+    def calls_for_class
+      [
+          [:my_array],
+          [:my_hash],
+          [:respond_to?, :your_array],
+          [:respond_to?, :your_hash],
+      ]
+    end
+
+  end
+
+end
+```
+
+Here's a program that uses the custom handler.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+require_relative 'foo'
+require_relative 'foo_handler'
+
+DebugHelper.show(Foo.new, 'My class Foo')
+```
+
+The output shows details of the object.
+
+```show.yaml```:
+```yaml
+---
+Foo (message='My class Foo'):
+  Foo.my_array:
+  - bat
+  - bam
+  - bad
+  Foo.my_hash:
+    :c: 2
+    :d: 3
+  Foo.respond_to?(:your_array): false
+  Foo.respond_to?(:your_hash): false
+```

data/markdown/readme/classes/custom/singleton/show.rb

@@ -0,0 +1,5 @@
+require 'debug_helper'
+require_relative 'foo'
+require_relative 'foo_handler'
+
+DebugHelper.show(Foo.new, 'My class Foo')

data/markdown/readme/classes/custom/singleton/show.yaml

@@ -0,0 +1,11 @@
+---
+Foo (message='My class Foo'):
+  Foo.my_array:
+  - bat
+  - bam
+  - bad
+  Foo.my_hash:
+    :c: 2
+    :d: 3
+  Foo.respond_to?(:your_array): false
+  Foo.respond_to?(:your_hash): false

data/markdown/readme/classes/custom/singleton/template.md

@@ -0,0 +1,19 @@
+#### Singleton Methods
+
+This example shows a custom handler that explicates via singleton methods.
+
+Here's a class ```Foo``` that has some singleton methods:
+ 
+@[ruby](foo.rb)
+
+Here's its custom debug handler class ```FooHandler```.  The array returned in method ```calls_for_class``` tells the base class ```Handler``` which methods to call for the explication.
+
+@[ruby](foo_handler.rb)
+
+Here's a program that uses the custom handler.
+
+@[ruby](show.rb)
+
+The output shows details of the object.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,10 @@
+### Custom
+
+You can create custom handlers for your own classes.
+
+@[:markdown](instance/show.md)
+
+@[:markdown](singleton/show.md)
+
+@[:markdown](both/show.md)
+

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

@@ -16,13 +16,13 @@ The output shows details of the ```Dir```.
 ```yaml
 ---
 Dir (message='My simple dir'):
-  path: "."
-  entries:
+  Dir#path: "."
+  Dir.entries("."):
   - "."
   - ".."
   - show.md
   - show.rb
   - show.yaml
   - template.md
-  exist?: true
+  Dir.exist?("."): true
 ```

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

@@ -1,11 +1,11 @@
 ---
 Dir (message='My simple dir'):
-  path: "."
-  entries:
+  Dir#path: "."
+  Dir.entries("."):
   - "."
   - ".."
   - show.md
   - show.rb
   - show.yaml
   - template.md
-  exist?: true
+  Dir.exist?("."): true

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

@@ -34,9 +34,9 @@ The output shows details of the ```Exception```.
 ```yaml
 ---
 Exception (message='My simple exception'):
-  message: Boo!
-  cause: 
-  backtrace:
+  Exception#message: Boo!
+  Exception#cause: 
+  Exception#backtrace:
   - show.rb:6:in `foo'
   - show.rb:14:in `bar'
   - show.rb:18:in `baz'

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

@@ -1,8 +1,8 @@
 ---
 Exception (message='My simple exception'):
-  message: Boo!
-  cause: 
-  backtrace:
+  Exception#message: Boo!
+  Exception#cause: 
+  Exception#backtrace:
   - show.rb:6:in `foo'
   - show.rb:14:in `bar'
   - show.rb:18:in `baz'

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

@@ -16,21 +16,21 @@ The output shows details of the file.
 ```yaml
 ---
 File (message='My simple file'):
-  absolute_path: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
-  atime: 2018-07-14 12:45:32.000000000 -05:00
-  ctime: 2018-07-14 12:45:32.000000000 -05:00
-  executable?: false
-  exist?: true
-  ftype: file
-  mtime: 2018-07-14 12:45:32.000000000 -05:00
-  path: show.rb
-  pipe?: false
-  readable?: true
-  realpath: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
-  setgid?: false
-  setuid?: false
-  size: 95
-  socket?: false
-  symlink?: false
-  writable?: true
+  File.absolute_path("show.rb"): C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
+  File.atime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.ctime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.executable?("show.rb"): false
+  File.exist?("show.rb"): true
+  File.ftype("show.rb"): file
+  File.mtime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.path("show.rb"): show.rb
+  File.pipe?("show.rb"): false
+  File.readable?("show.rb"): true
+  File.realpath("show.rb"): C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
+  File.setgid?("show.rb"): false
+  File.setuid?("show.rb"): false
+  File.size("show.rb"): 95
+  File.socket?("show.rb"): false
+  File.symlink?("show.rb"): false
+  File.writable?("show.rb"): true
 ```

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

@@ -1,19 +1,19 @@
 ---
 File (message='My simple file'):
-  absolute_path: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
-  atime: 2018-07-14 12:45:32.000000000 -05:00
-  ctime: 2018-07-14 12:45:32.000000000 -05:00
-  executable?: false
-  exist?: true
-  ftype: file
-  mtime: 2018-07-14 12:45:32.000000000 -05:00
-  path: show.rb
-  pipe?: false
-  readable?: true
-  realpath: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
-  setgid?: false
-  setuid?: false
-  size: 95
-  socket?: false
-  symlink?: false
-  writable?: true
+  File.absolute_path("show.rb"): C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
+  File.atime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.ctime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.executable?("show.rb"): false
+  File.exist?("show.rb"): true
+  File.ftype("show.rb"): file
+  File.mtime("show.rb"): 2018-07-14 12:45:32.000000000 -05:00
+  File.path("show.rb"): show.rb
+  File.pipe?("show.rb"): false
+  File.readable?("show.rb"): true
+  File.realpath("show.rb"): C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
+  File.setgid?("show.rb"): false
+  File.setuid?("show.rb"): false
+  File.size("show.rb"): 95
+  File.socket?("show.rb"): false
+  File.symlink?("show.rb"): false
+  File.writable?("show.rb"): true

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

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