debug_me 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12a0c426af49f51958f84424b8bd2160f1b3a139d75b7c83a8b7021adb8788d
-  data.tar.gz: 4c7b31bbddfa1a029410413c3847ec31ac678fe004a0e53d263457f4c822c1de
+  metadata.gz: 2f1a9993af0c276f8ee37bf6cef26f6ab11174bb1735a177c45112e6963ef2a3
+  data.tar.gz: ad89e6defd63f3b981f98c048c427d7a4d2b62851b848d2f5536f6f60809fa49
 SHA512:
-  metadata.gz: ac86537e986b53194dce7d08605aaef788d5a48849f205e80b82ca27cb6af01793952b93b305dad2e0a8ea7f37b75d153de2cba7630d0d41ce6424e1e9d08133
-  data.tar.gz: 3dbcce464705ce68215d50e9e28b6c56a38e94b869edb7340b7ce648c3acced7db2ccf40b50ad83df8d75812e0c6d046725cdecd0537f8e64ad78651c4e6047e
+  metadata.gz: df0fda4a35106408648278a8e823b7e9c1666250cd7a0e7a8373166b7ab9bce0c7fff0db6c79a7f06b56d69247eb5317aea227fdc079dbf1c99d9c57d1fe6089
+  data.tar.gz: 5a76a8d3e574f983a482498e620c8f9f4dba90ae9a5b815ab5a0133e56c766b112a89242b60b75a03b256a9fe5e597a0e171182e67dc8aec85fd2512faabcc28

data/README.md

@@ -15,6 +15,7 @@ DebugMe::debug_me(){} works with local, instance and class variables.
 
 ## Recent Changes
 
+* 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.
 
@@ -44,6 +45,8 @@ 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 {} # prints the default header and __ALL__ variables
 
 debug_me {:just_this_variable} # prints the default header and the value of only one specific variable
@@ -101,6 +104,7 @@ DebugMeDefaultOptions = {
   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
   lvar:   true,     # Include local variables
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output

data/debug_me.gemspec

@@ -5,7 +5,7 @@ require 'debug_me/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'debug_me'
-  spec.version       = DebugMe::VERSION
+  spec.version       = DebugMe::DEBUG_ME_VERSION
   spec.authors       = ['Dewayne VanHoozer']
   spec.email         = ['dvanhoozer@gmail.com']
   spec.summary       = 'A tool to print the labeled value of variables.'

data/lib/debug_me.rb

@@ -6,6 +6,7 @@ DebugMeDefaultOptions = {
   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
   lvar:   true,     # Include local variables
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output
@@ -31,10 +32,18 @@ module DebugMe
     s = ''
     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
-
-    out_string = sprintf("%s Source: %s\n",s,wf) if options[:header]
+    bt = caller # where_from under 1.8.6 its a stack trace array under 1.8.7+ as a string
+
+    if options[:header]
+      cf = bt.is_a?(Array) ? bt[0] : bt
+      out_string = sprintf("%s Source:  %s\n", 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)
+        end
+      end
+    end
 
     if block_given?
 

data/lib/debug_me/version.rb

@@ -1,3 +1,8 @@
 module DebugMe
-  VERSION = '1.0.5'
+  # 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
+  # common.
+  DEBUG_ME_VERSION = '1.0.6'
 end

data/tests/debug_me_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'awesome_print'
+require 'amazing_print'
 require 'logger'
 require 'pathname'
 
@@ -38,6 +38,27 @@ describe DebugMe do
 
   end # describe "source header included" do
 
+
+
+  describe "Add more from the call stack" do
+
+    before do
+      @my_world_view = WorldView.new
+    end
+
+    it 'supports multiple levels from the call stack' do
+      result = @my_world_view.one
+      # debug_me returns everything as one big long string
+      # with embedded new lines.  In the WorldView class
+      # method six is called from five, which is called from four, three, two, one.
+      # The ":levels" options is set to 5 so expect the
+      # normal source header followed by 5 additional
+      # entries from the call stack.
+      assert_equal(result.split("\n").size, 6)
+    end
+  end
+
+
   describe "source header excluded" do
 
   	before do

data/tests/world_view.rb

@@ -30,4 +30,14 @@ class WorldView
       cconst: true
     ){}
   end
+
+  def one;    two;    end
+  def two;    three;  end
+  def three;  four;   end
+  def four;   five;   end
+  def five;   six;    end
+
+  def six
+    debug_me(tag:'How did I get here?', levels: 5)
+  end
 end # class WorldView

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_me
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: A tool to print the labeled value of variables.