debug_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb6a987450802b19bf3b2e7627185c7bbacee42f
+  data.tar.gz: 22252b082a4f4c6073b39bcb018d25826a097a2d
+SHA512:
+  metadata.gz: 6892932fd1b46356cb94ea20e9ca6c259710c84d73742253dec38c63b6c12c7c2541dc6ba863cc91c21dc8f4496ce15e48662492cd0e90cac2a3d73ecdb3266d
+  data.tar.gz: da0a37b7abacf2e4721902551e4b26edcaec71e3b3a129e633f3b2fbb8a53dcfe28bf214d09593695c78b5ccff03ad3a7f2944780943e6dcd7774a7fa4627f18

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/.idea/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at burdettelamar@yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in debug_helper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    debug_helper (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  debug_helper!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 burdettelamar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,593 @@
+# 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:
+
+```show_hash.rb```:
+```ruby
+hash.each_pair do |key, value|
+  p [key, value]
+end
+```
+
+And this:
+
+```show_array.rb```:
+```ruby
+array.each_with_index do |item, i|
+  p [i, item]
+end
+```
+
+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:
+
+- [Array](#array)
+- [Hash](#hash)
+- [Struct](#struct)
+- [String](#string)
+- [Symbol](#symbol)
+
+Others are treated as:
+
+- [Object](#object)
+
+### Array
+
+#### Simple Array
+
+This example shows a simple array of integers.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [5, 10, 15]
+DebugHelper.show(ary, 'My simple array')
+```
+
+The output shows details of the array.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My simple array' size=3):
+  Element 0: Fixnum 5
+  Element 1: Fixnum 10
+  Element 2: Fixnum 15
+```
+
+#### Mixed Array
+
+This example shows an array of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0, 'one', :two]
+DebugHelper.show(ary, 'My mixed array')
+```
+
+The output shows details of the array.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My mixed array' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+    - one
+  Element 2:
+    Symbol (size=3 encoding=US-ASCII): :two
+```
+
+#### Nested Arrays
+
+This example shows nested arrays.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0, [1, 2], [3, 4]]
+DebugHelper.show(ary, 'My nested arrays')
+```
+
+The output shows details of the arrays.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My nested arrays' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1: Fixnum 2
+  Element 2:
+    Array (size=2):
+      Element 0: Fixnum 3
+      Element 1: Fixnum 4
+```
+
+#### Circular Arrays
+
+This example shows arrays that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary_0 = []
+ary_1 = []
+ary_0.push(ary_1)
+ary_1.push(ary_0)
+DebugHelper.show(ary_0, 'My circular arrays')
+```
+
+The output shows details of the arrays.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My circular arrays' size=1):
+  Element 0:
+    Array (size=1):
+      Element 0: Array [[[...]]]
+```
+### Hash
+
+#### Simple Hash
+
+This example shows a simple hash.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+hash = {:a => 0, :b => 1, :c => 2}
+DebugHelper.show(hash, 'My simple hash')
+```
+
+The output shows details of the hash.
+
+```show.yaml```:
+```yaml
+---
+Hash (size=3 name='My simple hash'):
+  Pair 0:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :a
+    Value: Fixnum 0
+  Pair 1:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :b
+    Value: Fixnum 1
+  Pair 2:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :c
+    Value: Fixnum 2
+```
+
+#### Mixed Hash
+
+This example shows a hash of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+hash = {
+    :a => 0,
+    :b => 'one',
+    :c => :two,
+}
+DebugHelper.show(hash, 'My mixed hash')
+```
+
+The output shows details of the hash.
+
+```show.yaml```:
+```yaml
+---
+Hash (size=3 name='My mixed hash'):
+  Pair 0:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :a
+    Value: Fixnum 0
+  Pair 1:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :b
+    Value:
+      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+      - one
+  Pair 2:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :c
+    Value:
+      Symbol (size=3 encoding=US-ASCII): :two
+```
+
+#### Nested Hashes
+
+This example shows nested hashes.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+hash = {
+    :a => {
+        :b => 0,
+        :c => 1,
+    },
+    :d => {
+        :e => 2,
+        :f => 3,
+    }
+}
+DebugHelper.show(hash, 'My nested hash')
+```
+
+The output shows details of the hashes.
+
+```show.yaml```:
+```yaml
+---
+Hash (size=2 name='My nested hash'):
+  Pair 0:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :a
+    Value:
+      Hash (size=2):
+        Pair 0:
+          Key:
+            Symbol (size=1 encoding=US-ASCII): :b
+          Value: Fixnum 0
+        Pair 1:
+          Key:
+            Symbol (size=1 encoding=US-ASCII): :c
+          Value: Fixnum 1
+  Pair 1:
+    Key:
+      Symbol (size=1 encoding=US-ASCII): :d
+    Value:
+      Hash (size=2):
+        Pair 0:
+          Key:
+            Symbol (size=1 encoding=US-ASCII): :e
+          Value: Fixnum 2
+        Pair 1:
+          Key:
+            Symbol (size=1 encoding=US-ASCII): :f
+          Value: Fixnum 3
+```
+
+#### Circular Hashes
+
+This example shows hashes that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+hash_0 = {}
+hash_1 = {}
+hash_0.store(:foo, hash_1)
+hash_1.store(:bar, hash_0)
+DebugHelper.show(hash_0, 'My circular hashes')
+```
+
+The output shows details of the hashes.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+Hash (size=1 name='My circular hashes'):
+  Pair 0:
+    Key:
+      Symbol (size=3 encoding=US-ASCII): :foo
+    Value:
+      Hash (size=1):
+        Pair 0:
+          Key:
+            Symbol (size=3 encoding=US-ASCII): :bar
+          Value: Hash {:foo=>{:bar=>{...}}}
+```
+### Struct
+
+#### 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
+```
+
+#### Mixed Struct
+
+This example shows a struct of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct = MyStruct.new(0, 'one', :two)
+DebugHelper.show(struct, 'My mixed struct')
+```
+
+The output shows details of the struct.
+
+```show.yaml```:
+```yaml
+---
+MyStruct (name='My mixed struct' size=3):
+  Member 0:
+    Name: :a
+    Value: Fixnum 0
+  Member 1:
+    Name: :b
+    Value:
+      String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+      - one
+  Member 2:
+    Name: :c
+    Value:
+      Symbol (size=3 encoding=US-ASCII): :two
+```
+
+#### Nested Structs
+
+This example shows nested structs.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct_0 = Struct.new(:a, :b)
+MyStruct_1 = Struct.new(:c, :d)
+struct_1a = MyStruct_1.new(2, 3)
+struct_1b = MyStruct_1.new(4, 5)
+struct_0 = MyStruct_0.new(struct_1a, struct_1b)
+DebugHelper.show(struct_0, 'My nested struct')
+```
+
+The output shows details of the structs.
+
+```show.yaml```:
+```yaml
+---
+MyStruct_0 (name='My nested struct' size=2):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 2
+        Member 1:
+          Name: :d
+          Value: Fixnum 3
+  Member 1:
+    Name: :b
+    Value:
+      MyStruct_1 (size=2):
+        Member 0:
+          Name: :c
+          Value: Fixnum 4
+        Member 1:
+          Name: :d
+          Value: Fixnum 5
+```
+
+#### Circular Structs
+
+This example shows structs that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+MyStruct = Struct.new(:a, :b, :c)
+struct_0 = MyStruct.new(0, 1, 2)
+struct_1 = MyStruct.new(3, 4, 5)
+struct_0.a = struct_1
+struct_1.a = struct_0
+DebugHelper.show(struct_0, 'My circular struct')
+```
+
+The output shows details of the structs.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+MyStruct (name='My circular struct' size=3):
+  Member 0:
+    Name: :a
+    Value:
+      MyStruct (size=3):
+        Member 0:
+          Name: :a
+          Value: 'MyStruct #<struct MyStruct a=#<struct MyStruct a=#<struct MyStruct:...>,
+            b=4, c=5>, b=1, c=2>'
+        Member 1:
+          Name: :b
+          Value: Fixnum 4
+        Member 2:
+          Name: :c
+          Value: Fixnum 5
+  Member 1:
+    Name: :b
+    Value: Fixnum 1
+  Member 2:
+    Name: :c
+    Value: Fixnum 2
+```
+### String
+
+#### Simple String
+
+This example shows a simple string.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+s = 'Lorem ipsum'
+DebugHelper.show(s, 'My simple string')
+```
+
+The output shows details of the string.
+
+```show.yaml```:
+```yaml
+---
+String (name='My simple string' size=11 encoding=UTF-8 ascii_only=true bytesize=11):
+- Lorem ipsum
+```
+
+#### Multiline String
+
+This example shows a multiline string.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+s = <<EOT
+Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+EOT
+DebugHelper.show(s, 'My multiline string')
+```
+
+The output shows details of the string.
+
+```show.yaml```:
+```yaml
+---
+String (name='My multiline string' size=122 encoding=UTF-8 ascii_only=true bytesize=122):
+- |
+  Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
+  sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
+```
+### Symbol
+
+#### 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
+```
+### Object
+
+Classes not mentioned above are not analyzed, but are treated more simply.
+
+A few examples are shown below.
+
+#### DateTime
+
+This example shows a datetime.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+datetime = DateTime.now
+DebugHelper.show(datetime, 'My datetime')
+```
+
+The output shows details of the datetime.
+
+```show.yaml```:
+```yaml
+--- DateTime (name='My datetime') 2018-06-29T18:32:57-05:00
+...
+```
+
+#### Range
+
+This example shows a range.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+range = Range.new(0, 9)
+DebugHelper.show(range, 'My range')
+```
+
+The output shows details of the range.
+
+```show.yaml```:
+```yaml
+--- Range (name='My range') 0..9
+...
+```
+
+#### Regexp
+
+This example shows a regexp.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+regexp = Regexp.new('foo')
+DebugHelper.show(regexp, 'My regexp')
+```
+
+The output shows details of the regexp.
+
+```show.yaml```:
+```yaml
+--- Regexp (name='My regexp') (?-mix:foo)
+...
+```