debug_me 1.0.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f1a9993af0c276f8ee37bf6cef26f6ab11174bb1735a177c45112e6963ef2a3
-  data.tar.gz: ad89e6defd63f3b981f98c048c427d7a4d2b62851b848d2f5536f6f60809fa49
+  metadata.gz: 406de0bd607687bab5c7a46e6dfde187353c24dfaf0800e2b5c0cd9223a8faf8
+  data.tar.gz: f3f85a306a6455e2e699558a41e7d78b7eded223f862ce34c8ee02e3f487a268
 SHA512:
-  metadata.gz: df0fda4a35106408648278a8e823b7e9c1666250cd7a0e7a8373166b7ab9bce0c7fff0db6c79a7f06b56d69247eb5317aea227fdc079dbf1c99d9c57d1fe6089
-  data.tar.gz: 5a76a8d3e574f983a482498e620c8f9f4dba90ae9a5b815ab5a0133e56c766b112a89242b60b75a03b256a9fe5e597a0e171182e67dc8aec85fd2512faabcc28
+  metadata.gz: 7ae3bf7696135d7d42ee5c0894a0d8d57b1ee2e93ce1236622b17f882ceaa67b9b0ac8769a2be01dd3291947363d5323c04138e2c5fdf141d0f1efcc20aa3b4c
+  data.tar.gz: 3d756257d84c6e72edaf7debfb6d7100fa8a7f43a81254cbcdbdf204cf8ff118c163a7136a92be076b017b2cd411fc1075f596e140a361036c41f0ed88e2e505

data/.envrc

@@ -0,0 +1,9 @@
+# .envrc
+# using the tool "direnv"
+# brew install direnv
+#
+# $RR means repository root or rails root
+# alias rr='cd $RR'
+#
+
+export RR=`pwd`

data/README.md

@@ -15,6 +15,8 @@ DebugMe::debug_me(){} works with local, instance and class variables.
 
 ## Recent Changes
 
+* 1.1.1 Added global constant $DEBUG_ME as a boolean; default is true. when false the debug_me method does nothing.
+* 1.1.0 Changes the output formatting w/r/t the use of levels option; add :backtrace option for full backtrace
 * 1.0.6 Added support for variable backtrack length via the :levels option
 * 1.0.5 Added support for an instance of a Logger class.
 * 1.0.4 Added :strftime to the options; changed the default format from decimal seconds since epic to something that is more easy comprehend on a clock.
@@ -46,6 +48,9 @@ debug_me # Prints only the header banner consisting of tag, method name, file na
 debug_me('INFO') # Also prints only the header but with a different tag
 
 debug_me(levels: 5) # Along with the header, show the call stack back this many levels
+debug_me{:backtrace}          # show the entire call stack
+debug_me{[ :backtrace ]} will # show the entire call stack
+debug_me(levels: 5){[ :backtrace ]} # will only show the first 5 levels of the backtrace - ie. the levels parameter supersedes :backtrace
 
 debug_me {} # prints the default header and __ALL__ variables
 
@@ -105,6 +110,8 @@ DebugMeDefaultOptions = {
   strftime:  '%Y-%m-%d %H:%M:%S.%6N', # timestamp format
   header: true,     # Print a header string before printing the variables
   levels: 0,        # Number of additional backtrack entries to display
+  skip1:  false,    # skip 1 blank line in front of a new output block
+  skip2:  false,    # skip 2 blank lines in front of a new output block
   lvar:   true,     # Include local variables
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output

data/lib/debug_me/version.rb

@@ -2,7 +2,7 @@ module DebugMe
   # I know.  Its weird to duplicate the name space; but,
   # doing this allows you to include DebugMe in your code
   # to get direct access to the debug_me method without
-  # poluting your code with an object name that is so
+  # polluting your code with an object name that is so
   # common.
-  DEBUG_ME_VERSION = '1.0.6'
+  DEBUG_ME_VERSION = '1.1.1'
 end

data/lib/debug_me.rb

@@ -1,12 +1,16 @@
 require 'pp'
 require_relative 'debug_me/version'
 
+$DEBUG_ME = true
+
 DebugMeDefaultOptions = {
   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
   levels: 0,        # Number of additional backtrack entries to display
+  skip1:  false,    # skip 1 lines between different outputs
+  skip2:  false,    # skip 2 lines between different outputs
   lvar:   true,     # Include local variables
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output
@@ -18,6 +22,7 @@ DebugMeDefaultOptions = {
 
 module DebugMe
   def debug_me(options = {}, &block)
+    return unless $DEBUG_ME
 
     if 'Hash' == options.class.to_s
       options = DebugMeDefaultOptions.merge(options)
@@ -25,7 +30,10 @@ module DebugMe
       options = DebugMeDefaultOptions.merge(tag: options)
     end
 
-    out_string = ''
+    skip        = ''
+    skip        = "\n"    if options[:skip1]
+    skip        = "\n\n"  if options[:skip2]
+    out_string  = ''
 
     f = options[:file]
     l = options[:logger]
@@ -33,24 +41,29 @@ module DebugMe
     s += Time.now.strftime(options[:strftime])+' ' if options[:time]
     s += "#{options[:tag]}"
     bt = caller # where_from under 1.8.6 its a stack trace array under 1.8.7+ as a string
+    bt_out = []
 
     if options[:header]
       cf = bt.is_a?(Array) ? bt[0] : bt
-      out_string = sprintf("%s Source:  %s\n", s, cf)
+      out_string = sprintf("%s Source:  %s\n", skip+s, cf)
       if options[:levels] > 0
         levels = options[:levels].to_i
-        bt[1..levels].each_with_index do |cff, level|
-          out_string += sprintf("%s Source: FROM (%02d) : %s\n", s, level, cff)
+        bt[1..levels].each_with_index do |cff, level |
+          bt_out << [level, cff]
         end
       end
     end
 
-    if block_given?
-
-      block_value = [block.call].flatten.compact
+    if block_given? || bt_out.size > 0
+      block_value = []
+      block_value << 'backtrace' if bt_out.size > 0
+      if block_given?
+        [block.call].flatten.compact.each do |v|
+          block_value << v
+        end
+      end
 
       if block_value.empty?
-        block_value = []
         block_value += [eval('local_variables', block.binding)] if options[:lvar]
         block_value += [eval('instance_variables', block.binding)] if options[:ivar]
         block_value += [self.class.send('class_variables')] if options[:cvar]
@@ -61,7 +74,12 @@ module DebugMe
       block_value.map!(&:to_s)
 
       block_value.each do |v|
-        ev = eval("defined?(#{v})",block.binding).nil? ? '<undefined>' : eval(v, block.binding)
+
+        ev  = if 'backtrace' == v
+                bt_out.size > 0 ? bt_out : bt[1..10000]
+              else
+                eval("defined?(#{v})",block.binding).nil? ? '<undefined>' : eval(v, block.binding)
+              end
         out_string += sprintf( "%s %s -=> %s", s,v,ev.pretty_inspect)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_me
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.1
 platform: ruby
 authors:
 - Dewayne VanHoozer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".rultor.yml"
 - Gemfile
@@ -65,7 +66,7 @@ homepage: http://github.com/MadBomber/debug_me
 licenses:
 - You want it, its yours
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: A tool to print the labeled value of variables.
 test_files: []