debug_helper 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 406088664ae54129aca926d0cf20499386614ecf
-  data.tar.gz: d035993096295a1cec96701c0093c2f6486cfb17
+  metadata.gz: 046cfef48272f5af4958be3ef459f40acfbbaf44
+  data.tar.gz: c2fcde6be53604dff5157586373826e78d0b20bc
 SHA512:
-  metadata.gz: f1b4f3182d07acc36dacec517f6f919b99b2011efe909591a5d8ac81197c78540622fb9f8bf4ed85d7cf3cfccf6e57ce1f61deb2b67c7ac70246f1dd03e9fd6a
-  data.tar.gz: 9c2811314cf2210896b71530b0659ccd0180c4bbcce8fb98fb790f5c46154dab40a319a1c2f19115688a1a1677fe1f6f8ed25d02ae222661370efc1590235c12
+  metadata.gz: 17083bc4f2add3f38ce66b69a100784e9b26af5be6e64386e4a89324549ba4e0cfcc2c6f22c60d5f2d08ae69b0d1f81d86ffcb5462bd5e7b44208466cf7ecd0e
+  data.tar.gz: ff9755d3b0ebee673b81cd0acf624cb4b619eede892b7c208ca326fe7f21028de77c1c0cc5e346452719c63883fd17a4c2352ab82b0212301ac7c2f2f9a8eaa3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    debug_helper (1.6.0)
+    debug_helper (1.7.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,18 @@
 # Debug Helper
 
+## New in Version 1.7
+
+Classes analyzed:
+
+- [File](#file)
+- [Set](#set)
+
+Options:
+
+- [```depth```](#option-depth)
+
+## About 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```:
@@ -33,6 +46,8 @@ Classes treated in detail:
 - [Struct](#struct)
 - [String](#string)
 - [Symbol](#symbol)
+- [File](#file)
+- [Set](#set)
 
 Others are treated as:
 
@@ -598,6 +613,168 @@ Symbol (message='My symbol' size=11):
   to_s: lorem_ipsum
   encoding: !ruby/encoding US-ASCII
 ```
+### File
+
+#### Simple File
+
+This example shows a simple file.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+file = File.new(__FILE__)
+DebugHelper.show(file, 'My simple file')
+```
+
+The output shows details of the file.
+
+```show.yaml```:
+```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-13 11:44:18.000000000 -05:00
+  ctime: 2018-07-13 11:41:01.000000000 -05:00
+  executable?: false
+  exist?: true
+  ftype: file
+  mtime: 2018-07-13 11:44:18.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
+```
+### Set
+
+#### Simple Set
+
+This example shows a simple set of integers.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new([5, 10, 15])
+DebugHelper.show(set, 'My simple set')
+```
+
+The output shows details of the set.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My simple set' size=3):
+  Element 0: Fixnum 5
+  Element 1: Fixnum 10
+  Element 2: Fixnum 15
+```
+
+#### Mixed Set
+
+This example shows a set of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+require 'set'
+
+set = Set.new([0, 'one', :two])
+DebugHelper.show(set, 'My mixed set')
+```
+
+The output shows details of the set.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My mixed set' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    String (size=3):
+      to_s: one
+      encoding: !ruby/encoding UTF-8
+      ascii_only?: true
+      bytesize: 3
+  Element 2:
+    Symbol (size=3):
+      to_s: two
+      encoding: !ruby/encoding US-ASCII
+```
+
+#### Nested Sets
+
+This example shows nested sets.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new(
+    [0,
+     Set.new([1, 2]),
+     Set.new([3, 4]),
+     ])
+DebugHelper.show(set, 'My nested sets')
+```
+
+The output shows details of the sets.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My nested sets' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    Set (size=2):
+      Element 0: Fixnum 1
+      Element 1: Fixnum 2
+  Element 2:
+    Set (size=2):
+      Element 0: Fixnum 3
+      Element 1: Fixnum 4
+```
+
+#### Circular Sets
+
+This example shows sets that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set_0 = Set.new([])
+set_1 = Set.new([])
+set_0.add(set_1)
+set_1.add(set_0)
+DebugHelper.show(set_0, 'My circular sets')
+```
+
+The output shows details of the sets.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My circular sets' size=1):
+  Element 0:
+    Set (size=1):
+      Element 0: 'Set #<Set: {#<Set: {#<Set: {...}>}>}>'
+```
 ### Object
 
 Classes not mentioned above are not analyzed, but are treated more simply.
@@ -620,8 +797,7 @@ The output shows details of the datetime.
 
 ```show.yaml```:
 ```yaml
---- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
-...
+--- 'DateTime (message=''My datetime'') #<DateTime: 2018-07-14T10:18:04-05:00 ((2458314j,55084s,502867000n),-18000s,2299161j)>'
 ```
 
 #### Range
@@ -660,7 +836,7 @@ The output shows details of the regexp.
 
 ```show.yaml```:
 ```yaml
---- Regexp (message='My regexp') (?-mix:foo)
+--- Regexp (message='My regexp') /foo/
 ...
 ```
 

data/lib/debug_helper.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'yaml'
 
 require 'debug_helper/version'
@@ -45,10 +46,11 @@ class DebugHelper
               show_array(obj, message, info)
             when obj.kind_of?(Hash)
               show_hash(obj, message, info)
+            when obj.kind_of?(Set)
+              show_array(obj, message, info)
             when obj.kind_of?(Struct)
               show_struct(obj, message, info)
             # when obj.kind_of?(Range)
-            # when obj.kind_of?(Set)
             else
               show_object(obj, message, info)
           end
@@ -89,7 +91,7 @@ class DebugHelper
     methods = methods_for_object(obj)
     if methods.nil?
       message_info = message.nil? ? '' : " (message='#{message}')"
-      "#{obj.class.name}#{message_info} #{obj}"
+      "#{obj.class.name}#{message_info} #{obj.inspect}"
     else
       content = {}
       attrs = {:message => message}
@@ -152,11 +154,23 @@ class DebugHelper
                   {
                       # The instance forms of some of these require the file to be open.
                       :class => {
-                          :path => [obj.path],
+                          :absolute_path => [obj.path],
                           :atime => [obj.path],
                           :ctime => [obj.path],
+                          :executable? => [obj.path],
+                          :exist? => [obj.path],
+                          :ftype => [obj.path],
                           :mtime => [obj.path],
+                          :path => [obj.path],
+                          :pipe? => [obj.path],
+                          :readable? => [obj.path],
+                          :realpath => [obj.path],
+                          :setgid? => [obj.path],
+                          :setuid? => [obj.path],
                           :size => [obj.path],
+                          :socket? => [obj.path],
+                          :symlink? => [obj.path],
+                          :writable? => [obj.path],
                       },
                       :instance => [],
                   }

data/lib/debug_helper/version.rb

@@ -1,3 +1,3 @@
 class DebugHelper
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/markdown/readme/Rakefile

@@ -19,6 +19,8 @@ namespace :build do
         Struct
         String
         Symbol
+        File
+        Set
         Object
       /
       class_dir_names = class_names.collect {|x| x.downcase}

data/markdown/readme/class_inclusions.md

@@ -3,4 +3,6 @@
 @[:markdown](classes/struct/template.md)
 @[:markdown](classes/string/template.md)
 @[:markdown](classes/symbol/template.md)
+@[:markdown](classes/file/template.md)
+@[:markdown](classes/set/template.md)
 @[:markdown](classes/object/template.md)

data/markdown/readme/class_links.md

@@ -3,3 +3,5 @@
 - [Struct](#struct)
 - [String](#string)
 - [Symbol](#symbol)
+- [File](#file)
+- [Set](#set)

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

@@ -0,0 +1,36 @@
+#### Simple File
+
+This example shows a simple file.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+file = File.new(__FILE__)
+DebugHelper.show(file, 'My simple file')
+```
+
+The output shows details of the file.
+
+```show.yaml```:
+```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-13 11:44:18.000000000 -05:00
+  ctime: 2018-07-13 11:41:01.000000000 -05:00
+  executable?: false
+  exist?: true
+  ftype: file
+  mtime: 2018-07-13 11:44:18.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
+```

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+file = File.new(__FILE__)
+DebugHelper.show(file, 'My simple file')

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

@@ -0,0 +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-13 11:44:18.000000000 -05:00
+  ctime: 2018-07-13 11:41:01.000000000 -05:00
+  executable?: false
+  exist?: true
+  ftype: file
+  mtime: 2018-07-13 11:44:18.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

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

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

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

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

data/markdown/readme/classes/object/datetime/show.md

@@ -14,6 +14,5 @@ The output shows details of the datetime.
 
 ```show.yaml```:
 ```yaml
---- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
-...
+--- 'DateTime (message=''My datetime'') #<DateTime: 2018-07-14T10:18:04-05:00 ((2458314j,55084s,502867000n),-18000s,2299161j)>'
 ```

data/markdown/readme/classes/object/datetime/show.yaml

@@ -1,2 +1 @@
---- DateTime (message='My datetime') 2018-07-13T09:59:53-05:00
-...
+--- 'DateTime (message=''My datetime'') #<DateTime: 2018-07-14T10:18:04-05:00 ((2458314j,55084s,502867000n),-18000s,2299161j)>'

data/markdown/readme/classes/object/regexp/show.md

@@ -14,6 +14,6 @@ The output shows details of the regexp.
 
 ```show.yaml```:
 ```yaml
---- Regexp (message='My regexp') (?-mix:foo)
+--- Regexp (message='My regexp') /foo/
 ...
 ```

data/markdown/readme/classes/object/regexp/show.yaml

@@ -1,2 +1,2 @@
---- Regexp (message='My regexp') (?-mix:foo)
+--- Regexp (message='My regexp') /foo/
 ...

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

@@ -0,0 +1,29 @@
+#### Circular Sets
+
+This example shows sets that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set_0 = Set.new([])
+set_1 = Set.new([])
+set_0.add(set_1)
+set_1.add(set_0)
+DebugHelper.show(set_0, 'My circular sets')
+```
+
+The output shows details of the sets.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My circular sets' size=1):
+  Element 0:
+    Set (size=1):
+      Element 0: 'Set #<Set: {#<Set: {#<Set: {...}>}>}>'
+```

data/markdown/readme/classes/set/circular/show.rb

@@ -0,0 +1,9 @@
+require 'set'
+
+require 'debug_helper'
+
+set_0 = Set.new([])
+set_1 = Set.new([])
+set_0.add(set_1)
+set_1.add(set_0)
+DebugHelper.show(set_0, 'My circular sets')

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

@@ -0,0 +1,5 @@
+---
+Set (message='My circular sets' size=1):
+  Element 0:
+    Set (size=1):
+      Element 0: 'Set #<Set: {#<Set: {#<Set: {...}>}>}>'

data/markdown/readme/classes/set/circular/template.md

@@ -0,0 +1,11 @@
+#### Circular Sets
+
+This example shows sets that make a circular reference.
+
+@[ruby](show.rb)
+
+The output shows details of the sets.
+
+The circular reference is not followed.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,32 @@
+#### Mixed Set
+
+This example shows a set of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+require 'set'
+
+set = Set.new([0, 'one', :two])
+DebugHelper.show(set, 'My mixed set')
+```
+
+The output shows details of the set.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My mixed set' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    String (size=3):
+      to_s: one
+      encoding: !ruby/encoding UTF-8
+      ascii_only?: true
+      bytesize: 3
+  Element 2:
+    Symbol (size=3):
+      to_s: two
+      encoding: !ruby/encoding US-ASCII
+```

data/markdown/readme/classes/set/mixed/show.rb

@@ -0,0 +1,6 @@
+require 'debug_helper'
+
+require 'set'
+
+set = Set.new([0, 'one', :two])
+DebugHelper.show(set, 'My mixed set')

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

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

data/markdown/readme/classes/set/mixed/template.md

@@ -0,0 +1,9 @@
+#### Mixed Set
+
+This example shows a set of mixed values.
+
+@[ruby](show.rb)
+
+The output shows details of the set.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,34 @@
+#### Nested Sets
+
+This example shows nested sets.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new(
+    [0,
+     Set.new([1, 2]),
+     Set.new([3, 4]),
+     ])
+DebugHelper.show(set, 'My nested sets')
+```
+
+The output shows details of the sets.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My nested sets' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    Set (size=2):
+      Element 0: Fixnum 1
+      Element 1: Fixnum 2
+  Element 2:
+    Set (size=2):
+      Element 0: Fixnum 3
+      Element 1: Fixnum 4
+```

data/markdown/readme/classes/set/nested/show.rb

@@ -0,0 +1,10 @@
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new(
+    [0,
+     Set.new([1, 2]),
+     Set.new([3, 4]),
+     ])
+DebugHelper.show(set, 'My nested sets')

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

@@ -0,0 +1,11 @@
+---
+Set (message='My nested sets' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    Set (size=2):
+      Element 0: Fixnum 1
+      Element 1: Fixnum 2
+  Element 2:
+    Set (size=2):
+      Element 0: Fixnum 3
+      Element 1: Fixnum 4

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

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

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

@@ -0,0 +1,24 @@
+#### Simple Set
+
+This example shows a simple set of integers.
+
+```show.rb```:
+```ruby
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new([5, 10, 15])
+DebugHelper.show(set, 'My simple set')
+```
+
+The output shows details of the set.
+
+```show.yaml```:
+```yaml
+---
+Set (message='My simple set' size=3):
+  Element 0: Fixnum 5
+  Element 1: Fixnum 10
+  Element 2: Fixnum 15
+```

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

@@ -0,0 +1,6 @@
+require 'set'
+
+require 'debug_helper'
+
+set = Set.new([5, 10, 15])
+DebugHelper.show(set, 'My simple set')

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

@@ -0,0 +1,5 @@
+---
+Set (message='My simple set' size=3):
+  Element 0: Fixnum 5
+  Element 1: Fixnum 10
+  Element 2: Fixnum 15

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

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

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

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

data/markdown/readme/template.md

@@ -1,5 +1,18 @@
 # Debug Helper
 
+## New in Version 1.7
+
+Classes analyzed:
+
+- [File](#file)
+- [Set](#set)
+
+Options:
+
+- [```depth```](#option-depth)
+
+## About 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_helper
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,11 @@ files:
 - markdown/readme/classes/array/simple/show.yaml
 - markdown/readme/classes/array/simple/template.md
 - markdown/readme/classes/array/template.md
+- markdown/readme/classes/file/simple/show.md
+- markdown/readme/classes/file/simple/show.rb
+- markdown/readme/classes/file/simple/show.yaml
+- markdown/readme/classes/file/simple/template.md
+- markdown/readme/classes/file/template.md
 - markdown/readme/classes/hash/circular/show.md
 - markdown/readme/classes/hash/circular/show.rb
 - markdown/readme/classes/hash/circular/show.yaml
@@ -124,6 +129,23 @@ files:
 - markdown/readme/classes/object/regexp/show.yaml
 - markdown/readme/classes/object/regexp/template.md
 - markdown/readme/classes/object/template.md
+- markdown/readme/classes/set/circular/show.md
+- markdown/readme/classes/set/circular/show.rb
+- markdown/readme/classes/set/circular/show.yaml
+- markdown/readme/classes/set/circular/template.md
+- markdown/readme/classes/set/mixed/show.md
+- markdown/readme/classes/set/mixed/show.rb
+- markdown/readme/classes/set/mixed/show.yaml
+- markdown/readme/classes/set/mixed/template.md
+- markdown/readme/classes/set/nested/show.md
+- markdown/readme/classes/set/nested/show.rb
+- markdown/readme/classes/set/nested/show.yaml
+- markdown/readme/classes/set/nested/template.md
+- markdown/readme/classes/set/simple/show.md
+- markdown/readme/classes/set/simple/show.rb
+- markdown/readme/classes/set/simple/show.yaml
+- markdown/readme/classes/set/simple/template.md
+- markdown/readme/classes/set/template.md
 - markdown/readme/classes/string/multiline/show.md
 - markdown/readme/classes/string/multiline/show.rb
 - markdown/readme/classes/string/multiline/show.yaml