debug_helper 1.8.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +572 -314
  4. data/bin/console +14 -14
  5. data/lib/debug_helper/handler.rb +8 -2
  6. data/lib/debug_helper/version.rb +1 -1
  7. data/markdown/readme/Rakefile +2 -1
  8. data/markdown/readme/class_inclusions.md +1 -0
  9. data/markdown/readme/classes/array/circular/show.md +2 -2
  10. data/markdown/readme/classes/array/circular/show.yaml +2 -2
  11. data/markdown/readme/classes/array/mixed/show.md +9 -9
  12. data/markdown/readme/classes/array/mixed/show.yaml +9 -9
  13. data/markdown/readme/classes/array/nested/show.md +3 -3
  14. data/markdown/readme/classes/array/nested/show.yaml +3 -3
  15. data/markdown/readme/classes/array/simple/show.md +1 -1
  16. data/markdown/readme/classes/array/simple/show.yaml +1 -1
  17. data/markdown/readme/classes/custom/both/foo.rb +21 -0
  18. data/markdown/readme/classes/custom/both/foo_handler.rb +27 -0
  19. data/markdown/readme/classes/custom/both/show.md +100 -0
  20. data/markdown/readme/classes/custom/both/show.rb +5 -0
  21. data/markdown/readme/classes/custom/both/show.yaml +20 -0
  22. data/markdown/readme/classes/custom/both/template.md +19 -0
  23. data/markdown/readme/classes/custom/instance/foo.rb +13 -0
  24. data/markdown/readme/classes/custom/instance/foo_handler.rb +18 -0
  25. data/markdown/readme/classes/custom/instance/show.md +74 -0
  26. data/markdown/readme/classes/custom/instance/show.rb +5 -0
  27. data/markdown/readme/classes/custom/instance/show.yaml +11 -0
  28. data/markdown/readme/classes/custom/instance/template.md +19 -0
  29. data/markdown/readme/classes/custom/singleton/foo.rb +13 -0
  30. data/markdown/readme/classes/custom/singleton/foo_handler.rb +18 -0
  31. data/markdown/readme/classes/custom/singleton/show.md +74 -0
  32. data/markdown/readme/classes/custom/singleton/show.rb +5 -0
  33. data/markdown/readme/classes/custom/singleton/show.yaml +11 -0
  34. data/markdown/readme/classes/custom/singleton/template.md +19 -0
  35. data/markdown/readme/classes/custom/template.md +10 -0
  36. data/markdown/readme/classes/dir/simple/show.md +3 -3
  37. data/markdown/readme/classes/dir/simple/show.yaml +3 -3
  38. data/markdown/readme/classes/exception/simple/show.md +3 -3
  39. data/markdown/readme/classes/exception/simple/show.yaml +3 -3
  40. data/markdown/readme/classes/file/simple/show.md +17 -17
  41. data/markdown/readme/classes/file/simple/show.yaml +17 -17
  42. data/markdown/readme/classes/hash/circular/show.md +12 -12
  43. data/markdown/readme/classes/hash/circular/show.yaml +12 -12
  44. data/markdown/readme/classes/hash/mixed/show.md +20 -20
  45. data/markdown/readme/classes/hash/mixed/show.yaml +20 -20
  46. data/markdown/readme/classes/hash/nested/show.md +27 -27
  47. data/markdown/readme/classes/hash/nested/show.yaml +27 -27
  48. data/markdown/readme/classes/hash/simple/show.md +12 -12
  49. data/markdown/readme/classes/hash/simple/show.yaml +12 -12
  50. data/markdown/readme/classes/io/simple/show.md +4 -4
  51. data/markdown/readme/classes/io/simple/show.yaml +4 -4
  52. data/markdown/readme/classes/match_data/multiple_captures/show.md +5 -5
  53. data/markdown/readme/classes/match_data/multiple_captures/show.yaml +5 -5
  54. data/markdown/readme/classes/match_data/named_captures/show.md +5 -5
  55. data/markdown/readme/classes/match_data/named_captures/show.yaml +5 -5
  56. data/markdown/readme/classes/match_data/simple/show.md +5 -5
  57. data/markdown/readme/classes/match_data/simple/show.yaml +5 -5
  58. data/markdown/readme/classes/open_struct/circular/show.md +6 -6
  59. data/markdown/readme/classes/open_struct/circular/show.yaml +6 -6
  60. data/markdown/readme/classes/open_struct/mixed/show.md +17 -17
  61. data/markdown/readme/classes/open_struct/mixed/show.yaml +17 -17
  62. data/markdown/readme/classes/open_struct/nested/show.md +18 -18
  63. data/markdown/readme/classes/open_struct/nested/show.yaml +18 -18
  64. data/markdown/readme/classes/open_struct/simple/show.md +9 -9
  65. data/markdown/readme/classes/open_struct/simple/show.yaml +9 -9
  66. data/markdown/readme/classes/range/exclude_end/show.md +3 -3
  67. data/markdown/readme/classes/range/exclude_end/show.yaml +3 -3
  68. data/markdown/readme/classes/range/include_end/show.md +3 -3
  69. data/markdown/readme/classes/range/include_end/show.yaml +3 -3
  70. data/markdown/readme/classes/regexp/named_captures/show.md +5 -5
  71. data/markdown/readme/classes/regexp/named_captures/show.yaml +5 -5
  72. data/markdown/readme/classes/regexp/simple/show.md +5 -5
  73. data/markdown/readme/classes/regexp/simple/show.yaml +5 -5
  74. data/markdown/readme/classes/set/circular/show.md +2 -2
  75. data/markdown/readme/classes/set/circular/show.yaml +2 -2
  76. data/markdown/readme/classes/set/mixed/show.md +9 -9
  77. data/markdown/readme/classes/set/mixed/show.yaml +9 -9
  78. data/markdown/readme/classes/set/nested/show.md +3 -3
  79. data/markdown/readme/classes/set/nested/show.yaml +3 -3
  80. data/markdown/readme/classes/set/simple/show.md +1 -1
  81. data/markdown/readme/classes/set/simple/show.yaml +1 -1
  82. data/markdown/readme/classes/string/multiline/show.md +5 -5
  83. data/markdown/readme/classes/string/multiline/show.yaml +5 -5
  84. data/markdown/readme/classes/string/simple/show.md +5 -5
  85. data/markdown/readme/classes/string/simple/show.yaml +5 -5
  86. data/markdown/readme/classes/struct/circular/show.md +20 -20
  87. data/markdown/readme/classes/struct/circular/show.yaml +20 -20
  88. data/markdown/readme/classes/struct/mixed/show.md +18 -18
  89. data/markdown/readme/classes/struct/mixed/show.yaml +18 -18
  90. data/markdown/readme/classes/struct/nested/show.md +21 -21
  91. data/markdown/readme/classes/struct/nested/show.yaml +21 -21
  92. data/markdown/readme/classes/struct/simple/show.md +10 -10
  93. data/markdown/readme/classes/struct/simple/show.yaml +10 -10
  94. data/markdown/readme/classes/symbol/simple/show.md +3 -3
  95. data/markdown/readme/classes/symbol/simple/show.yaml +3 -3
  96. data/markdown/readme/options/depth/show.md +15 -15
  97. data/markdown/readme/options/depth/show.yaml +15 -15
  98. data/markdown/readme/template.md +11 -8
  99. metadata +21 -2
data/markdown/readme/template.md CHANGED
@@ -1,15 +1,14 @@
1
1
  # Debug Helper
2
2
 
3
- ## New in Version 1.8
3
+ [![Gem](https://img.shields.io/gem/v/debug_helper.svg?style=flat)](http://rubygems.org/gems/debug_helper "View this project in Rubygems")
4
4
 
5
- Classes analyzed:
5
+ ## New in Version 2.0
6
6
 
7
- - [Dir](#dir)
8
- - [Exception](#exception)
9
- - [Range](#range)
10
- - [Regexp](#regexp)
11
- - [IO](#io)
12
- - [MatchData](#matchdata)
7
+ Previously, ```debug_helper``` explicated objects for only certain classes in the Ruby core and standard library.
8
+
9
+ This version supports custom explication of user-defined classes. This means, in effect, that you can use ```debug_helper``` to explicate any classes you choose.
10
+
11
+ See [Custom](#custom).
13
12
 
14
13
  ## About Debug Helper
15
14
 
@@ -37,6 +36,10 @@ Others are treated as:
37
36
 
38
37
  - [Object](#object)
39
38
 
39
+ But wait, there's more! For your own classes, you can create your own handlers:
40
+
41
+ - [Custom](#custom)
42
+
40
43
  ## Class Method or Module Method?
41
44
 
42
45
  Most examples in this documentation show use of the class method:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: debug_helper
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - burdettelamar
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-07-28 00:00:00.000000000 Z
11
+ date: 2018-08-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -113,6 +113,25 @@ files:
113
113
  - markdown/readme/classes/array/simple/show.yaml
114
114
  - markdown/readme/classes/array/simple/template.md
115
115
  - markdown/readme/classes/array/template.md
116
+ - markdown/readme/classes/custom/both/foo.rb
117
+ - markdown/readme/classes/custom/both/foo_handler.rb
118
+ - markdown/readme/classes/custom/both/show.md
119
+ - markdown/readme/classes/custom/both/show.rb
120
+ - markdown/readme/classes/custom/both/show.yaml
121
+ - markdown/readme/classes/custom/both/template.md
122
+ - markdown/readme/classes/custom/instance/foo.rb
123
+ - markdown/readme/classes/custom/instance/foo_handler.rb
124
+ - markdown/readme/classes/custom/instance/show.md
125
+ - markdown/readme/classes/custom/instance/show.rb
126
+ - markdown/readme/classes/custom/instance/show.yaml
127
+ - markdown/readme/classes/custom/instance/template.md
128
+ - markdown/readme/classes/custom/singleton/foo.rb
129
+ - markdown/readme/classes/custom/singleton/foo_handler.rb
130
+ - markdown/readme/classes/custom/singleton/show.md
131
+ - markdown/readme/classes/custom/singleton/show.rb
132
+ - markdown/readme/classes/custom/singleton/show.yaml
133
+ - markdown/readme/classes/custom/singleton/template.md
134
+ - markdown/readme/classes/custom/template.md
116
135
  - markdown/readme/classes/dir/simple/show.md
117
136
  - markdown/readme/classes/dir/simple/show.rb
118
137
  - markdown/readme/classes/dir/simple/show.yaml