debug_helper 1.0.0

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

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

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

@@ -0,0 +1,29 @@
+#### Simple Struct
+
+This example shows a simple struct.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct = MyStruct.new(0, 1, 2)
+DebugHelper.show(struct, 'My simple struct')
+```
+
+The output shows details of the struct.
+
+```show.yaml```:
+```yaml
+---
+MyStruct (name='My simple struct' size=3):
+  Member 0:
+    Name: :a
+    Value: Fixnum 0
+  Member 1:
+    Name: :b
+    Value: Fixnum 1
+  Member 2:
+    Name: :c
+    Value: Fixnum 2
+```

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

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

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

@@ -0,0 +1,11 @@
+---
+MyStruct (name='My simple struct' size=3):
+  Member 0:
+    Name: :a
+    Value: Fixnum 0
+  Member 1:
+    Name: :b
+    Value: Fixnum 1
+  Member 2:
+    Name: :c
+    Value: Fixnum 2

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

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

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

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

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

@@ -0,0 +1,18 @@
+#### Simple Symbol
+
+This example shows a simple symbol.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+DebugHelper.show(:lorem_ipsum, 'My symbol')
+```
+
+The output shows details of the symbol.
+
+```show.yaml```:
+```yaml
+---
+Symbol (name='My symbol' size=11 encoding=US-ASCII): :lorem_ipsum
+```

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

@@ -0,0 +1,3 @@
+require 'debug_helper'
+
+DebugHelper.show(:lorem_ipsum, 'My symbol')

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

@@ -0,0 +1,2 @@
+---
+Symbol (name='My symbol' size=11 encoding=US-ASCII): :lorem_ipsum

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

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

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

@@ -0,0 +1,3 @@
+### Symbol
+
+@[:markdown](simple/show.md)

data/markdown/readme/classes/template.md

@@ -0,0 +1,12 @@
+## Classes
+
+@[:markdown](array/template.md)
+
+@[:markdown](hash/template.md)
+
+@[:markdown](struct/template.md)
+
+@[:markdown](string/template.md)
+
+@[:markdown](symbol/template.md)
+

data/markdown/readme/show_array.rb

@@ -0,0 +1,3 @@
+array.each_with_index do |item, i|
+  p [i, item]
+end

data/markdown/readme/show_hash.rb

@@ -0,0 +1,3 @@
+hash.each_pair do |key, value|
+  p [key, value]
+end

data/markdown/readme/template.md

@@ -0,0 +1,25 @@
+# Debug Helper
+
+If (like me), your debugging style is [printf debugging](https://en.wikipedia.org/wiki/Debugging#Techniques), you will have shoved this into your code many times:
+
+@[ruby](show_hash.rb)
+
+And this:
+
+@[ruby](show_array.rb)
+
+This helper assists in debugging by printing an analysis of a given object.  The analysis is a ```yaml``` structure, and is written to ```stdout```.
+
+For certain classes (see below), the analysis is very detailed.
+
+For the collection classes ```Array```, ```Hash```, and ```Struct```, the analysis is also recursive;  that is, the collection's values are themselves analyzed.
+
+Classes treated in detail:
+
+@[:markdown](class_links.md)
+
+Others are treated as:
+
+- [Object](#object)
+
+@[:markdown](class_inclusions.md)

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: debug_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- burdettelamar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- burdettelamar@yahoo.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- debug_helper.gemspec
+- lib/debug_helper.rb
+- lib/debug_helper/version.rb
+- markdown/readme/Rakefile
+- markdown/readme/class_inclusions.md
+- markdown/readme/class_links.md
+- markdown/readme/classes/array/circular/show.md
+- markdown/readme/classes/array/circular/show.rb
+- markdown/readme/classes/array/circular/show.yaml
+- markdown/readme/classes/array/circular/template.md
+- markdown/readme/classes/array/mixed/show.md
+- markdown/readme/classes/array/mixed/show.rb
+- markdown/readme/classes/array/mixed/show.yaml
+- markdown/readme/classes/array/mixed/template.md
+- markdown/readme/classes/array/nested/show.md
+- markdown/readme/classes/array/nested/show.rb
+- markdown/readme/classes/array/nested/show.yaml
+- markdown/readme/classes/array/nested/template.md
+- markdown/readme/classes/array/simple/show.md
+- markdown/readme/classes/array/simple/show.rb
+- markdown/readme/classes/array/simple/show.yaml
+- markdown/readme/classes/array/simple/template.md
+- markdown/readme/classes/array/template.md
+- markdown/readme/classes/hash/circular/show.md
+- markdown/readme/classes/hash/circular/show.rb
+- markdown/readme/classes/hash/circular/show.yaml
+- markdown/readme/classes/hash/circular/template.md
+- markdown/readme/classes/hash/mixed/show.md
+- markdown/readme/classes/hash/mixed/show.rb
+- markdown/readme/classes/hash/mixed/show.yaml
+- markdown/readme/classes/hash/mixed/template.md
+- markdown/readme/classes/hash/nested/show.md
+- markdown/readme/classes/hash/nested/show.rb
+- markdown/readme/classes/hash/nested/show.yaml
+- markdown/readme/classes/hash/nested/template.md
+- markdown/readme/classes/hash/simple/show.md
+- markdown/readme/classes/hash/simple/show.rb
+- markdown/readme/classes/hash/simple/show.yaml
+- markdown/readme/classes/hash/simple/template.md
+- markdown/readme/classes/hash/template.md
+- markdown/readme/classes/object/datetime/show.md
+- markdown/readme/classes/object/datetime/show.rb
+- markdown/readme/classes/object/datetime/show.yaml
+- markdown/readme/classes/object/datetime/template.md
+- markdown/readme/classes/object/range/show.md
+- markdown/readme/classes/object/range/show.rb
+- markdown/readme/classes/object/range/show.yaml
+- markdown/readme/classes/object/range/template.md
+- markdown/readme/classes/object/regexp/show.md
+- markdown/readme/classes/object/regexp/show.rb
+- markdown/readme/classes/object/regexp/show.yaml
+- markdown/readme/classes/object/regexp/template.md
+- markdown/readme/classes/object/template.md
+- markdown/readme/classes/string/multiline/show.md
+- markdown/readme/classes/string/multiline/show.rb
+- markdown/readme/classes/string/multiline/show.yaml
+- markdown/readme/classes/string/multiline/template.md
+- markdown/readme/classes/string/simple/show.md
+- markdown/readme/classes/string/simple/show.rb
+- markdown/readme/classes/string/simple/show.yaml
+- markdown/readme/classes/string/simple/template.md
+- markdown/readme/classes/string/template.md
+- markdown/readme/classes/struct/circular/show.md
+- markdown/readme/classes/struct/circular/show.rb
+- markdown/readme/classes/struct/circular/show.yaml
+- markdown/readme/classes/struct/circular/template.md
+- markdown/readme/classes/struct/mixed/show.md
+- markdown/readme/classes/struct/mixed/show.rb
+- markdown/readme/classes/struct/mixed/show.yaml
+- markdown/readme/classes/struct/mixed/template.md
+- markdown/readme/classes/struct/nested/show.md
+- markdown/readme/classes/struct/nested/show.rb
+- markdown/readme/classes/struct/nested/show.yaml
+- markdown/readme/classes/struct/nested/template.md
+- markdown/readme/classes/struct/simple/show.md
+- markdown/readme/classes/struct/simple/show.rb
+- markdown/readme/classes/struct/simple/show.yaml
+- markdown/readme/classes/struct/simple/template.md
+- markdown/readme/classes/struct/template.md
+- markdown/readme/classes/symbol/simple/show.md
+- markdown/readme/classes/symbol/simple/show.rb
+- markdown/readme/classes/symbol/simple/show.yaml
+- markdown/readme/classes/symbol/simple/template.md
+- markdown/readme/classes/symbol/template.md
+- markdown/readme/classes/template.md
+- markdown/readme/show_array.rb
+- markdown/readme/show_hash.rb
+- markdown/readme/template.md
+homepage: https://github.com/BurdetteLamar/debug_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Help for printf-style debugging.
+test_files: []