debug_me 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ee6256c053274e46630862e170317e97ea6bb0aa27394661473d0acd84fcb1d
-  data.tar.gz: 0e080550b9660678ec343b9650d89e8153e3e386913ac94d73f72c7eb70a87df
+  metadata.gz: b12a0c426af49f51958f84424b8bd2160f1b3a139d75b7c83a8b7021adb8788d
+  data.tar.gz: 4c7b31bbddfa1a029410413c3847ec31ac678fe004a0e53d263457f4c822c1de
 SHA512:
-  metadata.gz: 9479b7df27c05071f452eafd7a016ea34bfa42952217d1c1f81ec885e069ccb212f00c0339f3d918ccc2edcb215c030ff0a5808c61067cb48570a0c9bc91fd96
-  data.tar.gz: 29d34ee5dc5ec7534e0342a1187d8c15fc118bda3266c1ebcf37376090eb73b5327e22aace77db84052545b60170ce6c9433aa59dd88e024a6a8d6ffba7f0cd8
+  metadata.gz: ac86537e986b53194dce7d08605aaef788d5a48849f205e80b82ca27cb6af01793952b93b305dad2e0a8ea7f37b75d153de2cba7630d0d41ce6424e1e9d08133
+  data.tar.gz: 3dbcce464705ce68215d50e9e28b6c56a38e94b869edb7340b7ce648c3acced7db2ccf40b50ad83df8d75812e0c6d046725cdecd0537f8e64ad78651c4e6047e

data/README.md

@@ -2,10 +2,10 @@
 
 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.
+This thing is pretty old; but, so am I.  Even with the gray
+in our hair we still do the job.
 
-There are much complex/comprehensive
+There are much more 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.
@@ -15,7 +15,8 @@ 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.
+* 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.
 
 ## Installation
 
@@ -94,7 +95,7 @@ The default options is a global constant `DebugMeDefaultOptions` that is outside
 
 Notice that this constant is outside of the DebugMe's module namespace.
 
-```
+```ruby
 DebugMeDefaultOptions = {
   tag:    'DEBUG',  # A tag to prepend to each output line
   time:   true,     # Include a time-stamp in front of the tag
@@ -104,23 +105,88 @@ DebugMeDefaultOptions = {
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output
   cconst: true,     # Include class constants
+  logger: nil,      # Pass in a logger class instance like Rails.logger
   file:   $stdout   # The output file
 }
 ```
 
 If you want the output of the method to always go to STDERR then do this:
 
-```
+```ruby
 require 'debug_me'
-DebugMeDefaultOptions[:file] = $stderr
+DebugMeDefaultOptions[:file] = $stderr  # or STDERR
 ```
 If you want the `debug_me` output to go to a real file:
 
-```
+```ruby
 DebugMeDefaultOptions[:file] = File.open('debug_me.log', 'w')
 
 ```
 
+## Using a Logger class instance
+
+If you are working in Rails and want all the `debug_me` output to go to the Rails.logger its as easy as:
+```ruby
+DebugMeDefaultOptions[:logger] = Rails.logger
+
+```
+
+Or while working in rails you only want to add a marker to the Rails.logger do this:
+```ruby
+debug_me(logger: Rails.logger, tag: 'Hello World')
+```
+
+If you are working in Rails and want to use both the standard `debug_me` functions and occassionally put stuff into the Rails.logger but do not want to always remember the option settings then do something line this in a `config/initializers/aaaaa_debug_me.rb` file:
+
+```ruby
+# config/initializers/aaaaa_debug_me.rb
+
+require 'debug_me'
+
+module DebugMe
+  def log_me(message, options={}, &block)
+    options = {logger: Rails.logger, time: false, header: false, tag: message}
+    block_given? ? debug_me(options, block) : debug_me(options)
+  end
+end
+
+include DebugMe
+
+# Just setup the base name.  The parent path will be added below ...
+debug_me_file_name  = 'debug_me'
+
+# NOTE: you could add a timestamp to the filename
+# debug_me_file_name += '_' + Time.now.strftime('%Y%m%d%H%M%S')
+
+debug_me_file_name += '_' + Process.argv0.gsub('/',' ').split(' ').last
+# NOTE: by using the Process.argv0 ... you get multiple log files for
+#       rails, rake, sidekiq etc.
+
+debug_me_file_name += '.log'
+
+debug_me_filepath = Rails.root + 'log' + debug_me_file_name
+
+debug_me_file = File.open(debug_me_filepath, 'w')
+
+debug_me_file.puts <<~RULER
+
+  ==================== Starting New Test Run --------->>>>>>
+
+RULER
+
+# Set application wide options in the DebugMeDefaultOptions hash
+DebugMeDefaultOptions[:file] = debug_me_file
+
+debug_me{['ENV']}
+
+```
+
+What that does for your Rails application is dump all of your system environment variables and their values to a debug_me log file in the log directory of the application.
+
+It also adds a new method `log_me` which you can use to send stuff to the `Rails.logger` instance.  The method used by `debug_me` for the `logger` instance is always the `debug` method.
+
+## Conclusion
+
 The rest of the default options are obvious.
 
 You can always over-ride the default options on a case by case basis like this:

data/lib/debug_me.rb

@@ -10,6 +10,8 @@ DebugMeDefaultOptions = {
   ivar:   true,     # Include instance variables in the output
   cvar:   true,     # Include class variables in the output
   cconst: true,     # Include class constants
+  logger: nil,      # Pass in an instance of logger class like Rails.logger
+                    # must respond_to? :debug
   file:   $stdout   # The output file
 }
 
@@ -25,6 +27,7 @@ module DebugMe
     out_string = ''
 
     f = options[:file]
+    l = options[:logger]
     s = ''
     s += Time.now.strftime(options[:strftime])+' ' if options[:time]
     s += "#{options[:tag]}"
@@ -60,10 +63,14 @@ module DebugMe
       f.flush
     end
 
+    unless l.nil?
+      l.debug(out_string) if l.respond_to? :debug
+    end
+
     return out_string
   end ## def debug_me( options={}, &block )
 
   # def log_me(msg, opts={})
-  #   debug_me({:tag => msg, :header => false}.merge(opts))
+  #   debug_me({tag: msg, header: false}.merge(opts))
   # end
 end # module DebugMe

data/lib/debug_me/version.rb

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

data/tests/debug_me_test.rb

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+require 'awesome_print'
+require 'logger'
+require 'pathname'
+
 require_relative '../lib/debug_me'
 include DebugMe
 
@@ -224,6 +228,45 @@ describe DebugMe do
 
   end # describe "works with class CONSTANTS" do
 
+  describe "works with a Logger class" do
+
+    it 'default logger class is nil' do
+      DebugMeDefaultOptions[:logger].must_equal nil
+    end
+
+    it 'works with standard ruby Logger class' do
+      logger_output_path = Pathname.pwd + 'logger_class_output.txt'
+      logger_output_path.exist?.must_equal false
+
+      logger        = Logger.new(logger_output_path)
+      logger.level  = Logger::DEBUG
+
+      out_string    = debug_me(
+                                logger: logger,         # Use instance of Ruby's Logger
+                                time:   false,          # turn off debug_me's timestamp
+                                file:   nil,            # don't write to STDOUT the default
+                                tag:    'Hello World'   # say hello
+                              )
+      # Generates an entry like this:
+=begin
+      # Logfile created on 2020-04-27 16:16:38 -0500 by logger.rb/v1.4.2
+      D, [2020-04-27T16:16:38.580889 #54662] DEBUG -- : Hello World Source: debug_me_test.rb:244:in `block (3 levels) in <main>'
+=end
+
+      lines   = logger_output_path.read.split("\n")
+
+      lines.size.must_equal 2
+
+      lines[0].start_with?('# Logfile created on').must_equal   true
+      lines[1].start_with?('D, [').must_equal                   true
+      lines[1].include?('DEBUG').must_equal                     true
+      lines[1].include?('Hello World').must_equal               true
+      lines[1].include?('debug_me_test.rb').must_equal          true
+      lines[1].include?(out_string.chomp).must_equal            true
+
+      logger_output_path.delete
+    end
 
+  end
 
 end # describe DebugMe do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_me
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-04-27 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.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A tool to print the labeled value of variables.