debug_me 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b580ce21e94329c161f88ed59b1ab4253ebcced2342f5b53bb8f19331165b9e
-  data.tar.gz: c61d2b6b1071199a06cb9db9034893da11de869e1f8b1110c9406ab1ace17f13
+  metadata.gz: 0ee6256c053274e46630862e170317e97ea6bb0aa27394661473d0acd84fcb1d
+  data.tar.gz: 0e080550b9660678ec343b9650d89e8153e3e386913ac94d73f72c7eb70a87df
 SHA512:
-  metadata.gz: 579fba5c98c8fe2445b02982aa6ec4c975dff81c21b40d20204f69d8e2ce0be7f084df878d8551a3fa1222a61b0597fd900d81a2d284ff97140a14dd3cdc7ecc
-  data.tar.gz: 62190a395d1207487b61d30184fc5d8420d9b539caa8f4213cf8544d69df2a20a6a6d1fc4c964f54f11b9f6930599c34d4bc79da2ea91cf33649fbc20dc05439
+  metadata.gz: 9479b7df27c05071f452eafd7a016ea34bfa42952217d1c1f81ec885e069ccb212f00c0339f3d918ccc2edcb215c030ff0a5808c61067cb48570a0c9bc91fd96
+  data.tar.gz: 29d34ee5dc5ec7534e0342a1187d8c15fc118bda3266c1ebcf37376090eb73b5327e22aace77db84052545b60170ce6c9433aa59dd88e024a6a8d6ffba7f0cd8

data/README.md

@@ -1,13 +1,21 @@
 # DebugMe
 
-This thing is pretty old.  There are much better
+A tool to print the labeled value of variables.
+
+This thing is pretty old;but, so am I.  For the gray
+in our hair we still to the job.
+
+There are much complex/comprehensive
 ways of debugging in a complex application.  But,
 you know, I keep returning to this little method
 time after time.  I guess that marks me as a geezer.
 
-A tool to print the labeled value of variables.
 
-Works with local, instance and class variables.
+DebugMe::debug_me(){} works with local, instance and class variables.
+
+## Recent Changes
+
+* 1.0.4 Added :strftime to the options; changed the default format from decimal seconds since epic to something that os more easy comprehend on a clock.
 
 ## Installation
 
@@ -45,9 +53,9 @@ debug_me { [:this_one, :that_one, :that_other_one] } # prints default header and
 # Each element of the array is 'eval'ed with the context binding of the caller
 debug_me(){[ :my_var, 'my_complex_var_or_method[my_var]' ]}
 
-debug_me(:header => false) {} # disables the printing of the header; prints all variables
+debug_me(header: false) {} # disables the printing of the header; prints all variables
 
-debug_me(:tag => 'MyTag', :header => false) {} # disables header, sets different tag, prints all variables
+debug_me(tag: 'MyTag', :header => false) {} # disables header, sets different tag, prints all variables
 
 debug_me('=== LOOK ===') {} # changes the tag and prints all variables with a header line
 
@@ -55,28 +63,52 @@ debug_me('=== LOOK ===') {:@foo} # changes the tag, prints a header line and a s
 
 debug_me('=== LOOK ===') {:@@foo} # changes the tag, prints a header line and a specific class variable
 
-debug_me(:ivar => false, :cvar => false) {} # print only the local variables with the default tag and a header line
+debug_me(ivar: false, cvar: false) {} # print only the local variables with the default tag and a header line
+
+```
+
+Most of the examples above use symbols to designate the variables that you want
+to be shown with their name as a label.  You can also use strings.  With strings
+you are not limited to just variables.  Consider these examples:
+
+```ruby
+debug_me {[ 'some_array.size', 'SomeDatabaseModel.count' ]}
+
+# What a backtrace with your variables?
+
+debug_me {[
+  :my_variable,
+  'some_hash.keys.reject{|k| k.to_s.start_with?('A')}',
+  'caller' ]}  # yes, caller is a kernel method that will give a backtrace
+
+# You can also get into trouble so be careful.  The symbols and strings
+# are evaluated in the context of the caller.  Within the string any
+# command or line of code can be given.  SO DO NOT try to use
+# something silly like debug_me{ 'system("rm -fr /")'}
 
 ```
 
 ## Default Options
 
-The default options are maintained in a global constant `DebugMeDefaultOptions` that is outside of the `DebugMe` name space.  I did that so that if you do `include DebugMe` to make access to the method eaier you could still have the constant with a function specific name that would be outside of anything that you may have already coded in you program.
+The default options is a global constant `DebugMeDefaultOptions` that is outside of the `DebugMe` name space.  I did that so that if you do `include DebugMe` to make access to the method easier you could still have the constant with a function specific name that would be outside of anything that you may have already coded in you program.
+
+Notice that this constant is outside of the DebugMe's module namespace.
 
 ```
 DebugMeDefaultOptions = {
-  tag: 'DEBUG:',   # A tag to prepend to each output line
-  time: true,      # Include a time-stamp in front of the tag
-  header: true,    # Print a header string before printing the variables
-  lvar: true,      # Include local variables
-  ivar: true,      # Include instance variables in the output
-  cvar: true,      # Include class variables in the output
-  cconst: true,    # Include class constants
-  file: $stdout    # The output file
+  tag:    'DEBUG',  # A tag to prepend to each output line
+  time:   true,     # Include a time-stamp in front of the tag
+  strftime:  '%Y-%m-%d %H:%M:%S.%6N', # timestamp format
+  header: true,     # Print a header string before printing the variables
+  lvar:   true,     # Include local variables
+  ivar:   true,     # Include instance variables in the output
+  cvar:   true,     # Include class variables in the output
+  cconst: true,     # Include class constants
+  file:   $stdout   # The output file
 }
 ```
 
-If you want the output of the method to always got to STDERR then do this:
+If you want the output of the method to always go to STDERR then do this:
 
 ```
 require 'debug_me'

data/lib/debug_me.rb

@@ -2,14 +2,15 @@ require 'pp'
 require_relative 'debug_me/version'
 
 DebugMeDefaultOptions = {
-  tag: 'DEBUG:',   # A tag to prepend to each output line
-  time: true,      # Include a time-stamp in front of the tag
-  header: true,    # Print a header string before printing the variables
-  lvar: true,      # Include local variables
-  ivar: true,      # Include instance variables in the output
-  cvar: true,      # Include class variables in the output
-  cconst: true,    # Include class constants
-  file: $stdout    # The output file
+  tag:    'DEBUG',  # A tag to prepend to each output line
+  time:   true,     # Include a time-stamp in front of the tag
+  strftime:  '%Y-%m-%d %H:%M:%S.%6N', # timestamp format
+  header: true,     # Print a header string before printing the variables
+  lvar:   true,     # Include local variables
+  ivar:   true,     # Include instance variables in the output
+  cvar:   true,     # Include class variables in the output
+  cconst: true,     # Include class constants
+  file:   $stdout   # The output file
 }
 
 module DebugMe
@@ -25,8 +26,8 @@ module DebugMe
 
     f = options[:file]
     s = ''
-    s += "#{sprintf('%010.6f', Time.now.to_f)} " if options[:time]
-    s += " #{options[:tag]}"
+    s += Time.now.strftime(options[:strftime])+' ' if options[:time]
+    s += "#{options[:tag]}"
     wf = caller # where_from under 1.8.6 its a stack trace array under 1.8.7 is a string
     wf = wf[0] if 'Array' == wf.class.to_s
 

data/lib/debug_me/version.rb

@@ -1,3 +1,3 @@
 module DebugMe
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/tests/world_view.rb

@@ -3,20 +3,23 @@ class WorldView
   A = 1
   B = 2
   C = 3
+
   def initialize
-    @a,@b,@c = 1,2,3
-    @@d, @@e, @@f = 4,5,6
+    @a,@b,@c       = 1,2,3
+    @@d, @@e, @@f   = 4,5,6
   end
+
   def everything
     debug_me(
-      file:nil,
-      header:true,
-      lvar: true,
-      ivar: true,
-      cvar: true,
+      file:   nil,
+      header: true,
+      lvar:   true,
+      ivar:   true,
+      cvar:   true,
       cconst: true
     ){}
   end
+
   def my_constants
     debug_me(
       file:nil,
@@ -26,6 +29,5 @@ class WorldView
       cvar: false,
       cconst: true
     ){}
-
   end
 end # class WorldView

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_me
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A tool to print the labeled value of variables.