debug_helper 1.8.0 → 2.0.0

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "debug_helper"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "debug_helper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/lib/debug_helper/handler.rb

@@ -29,10 +29,13 @@ class DebugHelper
         args = call_info
         if args.empty?
           value = obj.send(method)
+          key = "#{obj.class.name}##{method.to_s}"
         else
           value = obj.send(method, *args)
+          arglist = args.collect {|arg| arg.inspect}.join(', ')
+          key = "#{obj.class.name}##{method.to_s}(#{arglist})"
         end
-        content.store(method.to_s, value)
+        content.store(key, value)
       end
       calls_for_class.each do |call_info|
         klass = Object.const_get(obj.class.name)
@@ -44,10 +47,13 @@ class DebugHelper
         args = call_info
         if args.empty?
           value = klass.send(method)
+          key = "#{klass}.#{method.to_s}"
         else
           value = klass.send(method, *args)
+          arglist = args.collect {|arg| arg.inspect}.join(', ')
+          key = "#{klass}.#{method.to_s}(#{arglist})"
         end
-        content.store(method.to_s, value)
+        content.store(key, value)
       end
       if each_with_index?
         obj.each_with_index do |item, i|

data/lib/debug_helper/version.rb

@@ -1,3 +1,3 @@
 class DebugHelper
-  VERSION = "1.8.0"
+  VERSION = "2.0.0"
 end

data/markdown/readme/Rakefile

@@ -30,6 +30,7 @@ namespace :build do
         Struct
         Symbol
         Object
+        Custom
       /
       class_dir_names = []
       correct_dir_names = {
@@ -67,7 +68,7 @@ namespace :build do
           :open_struct => 'OpenStruct',
       }
       class_dir_names.each do |class_dir_name|
-        next if class_dir_name == 'object'
+        next if %w/object custom/.include?(class_dir_name)
         if correct_class_names.include?(class_dir_name.to_sym)
           class_name = correct_class_names.fetch(class_dir_name.to_sym)
         else

data/markdown/readme/class_inclusions.md

@@ -13,3 +13,4 @@
 @[:markdown](classes/struct/template.md)
 @[:markdown](classes/symbol/template.md)
 @[:markdown](classes/object/template.md)
+@[:markdown](classes/custom/template.md)

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

@@ -21,9 +21,9 @@ The circular reference is not followed.
 ```yaml
 ---
 Array (message='My circular arrays'):
-  size: 1
+  Array#size: 1
   Element 0:
     Array:
-      size: 1
+      Array#size: 1
       Element 0: Array [[[...]]]
 ```

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

@@ -1,7 +1,7 @@
 ---
 Array (message='My circular arrays'):
-  size: 1
+  Array#size: 1
   Element 0:
     Array:
-      size: 1
+      Array#size: 1
       Element 0: Array [[[...]]]

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

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

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

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

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

@@ -16,16 +16,16 @@ The output shows details of the arrays.
 ```yaml
 ---
 Array (message='My nested arrays'):
-  size: 3
+  Array#size: 3
   Element 0: Fixnum 0
   Element 1:
     Array:
-      size: 2
+      Array#size: 2
       Element 0: Fixnum 1
       Element 1: Fixnum 2
   Element 2:
     Array:
-      size: 2
+      Array#size: 2
       Element 0: Fixnum 3
       Element 1: Fixnum 4
 ```

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

@@ -1,14 +1,14 @@
 ---
 Array (message='My nested arrays'):
-  size: 3
+  Array#size: 3
   Element 0: Fixnum 0
   Element 1:
     Array:
-      size: 2
+      Array#size: 2
       Element 0: Fixnum 1
       Element 1: Fixnum 2
   Element 2:
     Array:
-      size: 2
+      Array#size: 2
       Element 0: Fixnum 3
       Element 1: Fixnum 4

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

@@ -16,7 +16,7 @@ The output shows details of the array.
 ```yaml
 ---
 Array (message='My simple array'):
-  size: 3
+  Array#size: 3
   Element 0: Fixnum 5
   Element 1: Fixnum 10
   Element 2: Fixnum 15

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

@@ -1,6 +1,6 @@
 ---
 Array (message='My simple array'):
-  size: 3
+  Array#size: 3
   Element 0: Fixnum 5
   Element 1: Fixnum 10
   Element 2: Fixnum 15

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

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

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

@@ -0,0 +1,27 @@
+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
+
+    def calls_for_class
+      [
+          [:my_array],
+          [:my_hash],
+          [:respond_to?, :your_array],
+          [:respond_to?, :your_hash],
+      ]
+    end
+
+  end
+
+end

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

@@ -0,0 +1,100 @@
+#### Instance and Singleton Methods
+
+This example shows a custom handler that explicates via both kinds of methods.
+
+Here's a class ```Foo``` that has instance methods and singleton 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
+
+  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```.
+
+```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
+
+    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:
+  - foo
+  - bar
+  - baz
+  Foo#my_hash:
+    :a: 0
+    :b: 1
+  Foo#respond_to?(:your_array): false
+  Foo#respond_to?(:your_hash): false
+  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/both/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/both/show.yaml

@@ -0,0 +1,20 @@
+---
+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
+  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/both/template.md

@@ -0,0 +1,19 @@
+#### Instance and Singleton Methods
+
+This example shows a custom handler that explicates via both kinds of methods.
+
+Here's a class ```Foo``` that has instance methods and singleton methods:
+ 
+@[ruby](foo.rb)
+
+Here's its custom debug handler class ```FooHandler```.
+
+@[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/instance/foo.rb

@@ -0,0 +1,13 @@
+require 'debug_helper'
+
+class Foo
+
+  def my_array
+    %w/foo bar baz/
+  end
+
+  def my_hash
+    {:a => 0, :b => 1}
+  end
+
+end