debug_me 1.0.1 → 1.0.2

data/lib/debug_me.rb

@@ -4,20 +4,25 @@ require_relative 'debug_me/version'
 module DebugMe
   def debug_me(options = {}, &block)
     default_options = {
-      tag: 'DEBUG:',  # A tag to prepend to each output line
+      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
+      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 'Hash' == options.class.to_s
       options = default_options.merge(options)
     else
       options = default_options.merge(tag: options)
     end
 
+    out_string = ''
+
     f = options[:file]
     s = ''
     s += "#{sprintf('%010.6f', Time.now.to_f)} " if options[:time]
@@ -25,29 +30,36 @@ module DebugMe
     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
 
-    f.puts "#{s} Source: #{wf}" if options[:header]
+    out_string = sprintf("%s Source: %s\n",s,wf) if options[:header]
 
     if block_given?
 
       block_value = [block.call].flatten.compact
 
       if block_value.empty?
-        block_value = eval('local_variables', block.binding)
+        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]
+        block_value += [self.class.constants] if options[:cconst]
         block_value = block_value.flatten.compact
-      else
-        block_value.map!(&:to_s)
       end
 
+      block_value.map!(&:to_s)
+
       block_value.each do |v|
-        ev = eval(v, block.binding)
-        f.puts "#{s} #{v} -=> #{ev.pretty_inspect}"
+        ev = eval("defined?(#{v})",block.binding).nil? ? '<undefined>' : eval(v, block.binding)
+        out_string += sprintf( "%s %s -=> %s", s,v,ev.pretty_inspect)
       end
 
     end ## if block_given?
 
-    f.flush
+    unless f.nil?
+      f.puts out_string
+      f.flush
+    end
+
+    return out_string
   end ## def debug_me( options={}, &block )
 
   # def log_me(msg, opts={})

data/lib/debug_me/version.rb

@@ -1,3 +1,3 @@
 module DebugMe
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/tests/debug_me_test.rb

@@ -0,0 +1,229 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/debug_me'
+include DebugMe
+
+require_relative './world_view'
+
+
+
+require 'minitest/autorun'
+
+describe DebugMe do
+
+  describe "source header included" do
+
+  	before do
+  	  @line = __LINE__
+  	  @file = __FILE__
+  	  @out_string = debug_me(file:nil)
+  	end
+
+    it "has the keywords DEBUG and Source" do
+      assert @out_string.include? "DEBUG"
+      assert @out_string.include? "Source"
+    end
+
+    it "includes the filename" do
+      assert @out_string.include? __FILE__
+    end
+
+    it "includes the line number" do
+      assert @out_string.include? ".rb:#{@line+2}:"
+    end
+
+  end # describe "source header included" do
+
+  describe "source header excluded" do
+
+  	before do
+  	  @out_string = debug_me(file:nil,header:false)
+  	end
+
+    it "is empty" do
+      assert @out_string.empty?
+    end
+
+  end # describe "source header excluded" do
+
+  describe "works with local variable" do
+
+    it "supports a single variable" do
+      a,b,c = 1,2,3
+      out_string = debug_me(file:nil,header:false){:a}
+      assert out_string.include? "a -=> #{a}"
+      out_string.split("\n").size.must_equal 1
+    end
+
+    it "supports multible variables" do
+      a,b,c = 1,2,3
+      out_string = debug_me(file:nil,header:false){[:a, :b, :c]}
+      assert out_string.include? "a -=> #{a}"
+      assert out_string.include? "b -=> #{b}"
+      assert out_string.include? "c -=> #{c}"
+      out_string.split("\n").size.must_equal 3
+    end
+
+    it "shows all local variables" do
+      a,b,c = 1,2,3
+      out_string = debug_me(
+        file:nil,
+        header:false,
+        lvar: true,
+        ivar: false,
+        cvar: false,
+        cconst: false
+        ){}
+      assert out_string.include? "a -=> #{a}"
+      assert out_string.include? "b -=> #{b}"
+      assert out_string.include? "c -=> #{c}"
+      assert out_string.include? "out_string -=> "
+
+      out_string.split("\n").size.must_equal 4
+    end
+
+  end # describe "works with local variable" do
+
+  describe "works with instance variable" do
+
+    it "supports a single variable" do
+      @a,@b,@c = 1,2,3
+      out_string = debug_me(file:nil,header:false){:@a}
+      assert out_string.include? "@a -=> #{@a}"
+      out_string.split("\n").size.must_equal 1
+    end
+
+    it "supports multible variables" do
+      @a,@b,@c = 1,2,3
+      out_string = debug_me(file:nil,header:false){[:@a, :@b, :@c]}
+      assert out_string.include? "@a -=> #{@a}"
+      assert out_string.include? "@b -=> #{@b}"
+      assert out_string.include? "@c -=> #{@c}"
+      out_string.split("\n").size.must_equal 3
+    end
+
+    it "shows all instance variables" do
+      @a,@b,@c = 1,2,3
+      out_string = debug_me(
+        file:nil,
+        header:false,
+        lvar: false,
+        ivar: true,
+        cvar: false,
+        cconst: false
+        ){}
+      assert out_string.include? "@a -=> #{@a}"
+      assert out_string.include? "@b -=> #{@b}"
+      assert out_string.include? "@c -=> #{@c}"
+
+      out_string.include?("out_string -=> ").must_equal false
+      out_string.split("\n").size.must_equal instance_variables.size
+    end
+
+  end # describe "works with instance variable" do
+
+
+  describe "works with class variable" do
+
+    it "supports a single variable" do
+      @@a,@@b,@@c = 1,2,3
+      out_string = debug_me(file:nil,header:false){:@@a}
+      assert out_string.include? "@@a -=> #{@@a}"
+      out_string.split("\n").size.must_equal 1
+    end
+
+    it "supports multible variables" do
+      @@a,@@b,@@c = 1,2,3
+      out_string = debug_me(file:nil,header:false){[:@@a, :@@b, :@@c]}
+      assert out_string.include? "@@a -=> #{@@a}"
+      assert out_string.include? "@@b -=> #{@@b}"
+      assert out_string.include? "@@c -=> #{@@c}"
+      out_string.split("\n").size.must_equal 3
+    end
+
+    it "shows all class variables" do
+      @@a,@@b,@@c = 1,2,3
+      @d = 4
+      out_string = debug_me(
+        file:nil,
+        header:false,
+        lvar: false,
+        ivar: false,
+        cvar: true,
+        cconst: false
+        ){}
+
+      assert out_string.include? "@@a -=> #{@@a}"
+      assert out_string.include? "@@b -=> #{@@b}"
+      assert out_string.include? "@@c -=> #{@@c}"
+
+      out_string.include?("out_string -=> ").must_equal false
+      out_string.include?("@d -=> ").must_equal false
+
+      out_string.split("\n").size.must_equal self.class.class_variables.size
+    end
+
+  end # describe "works with class variable" do
+
+
+  describe "works with CONSTANTS" do
+
+    it "supports a single CONSTANT" do
+      A,B,C = 1,2,3
+      out_string = debug_me(file:nil,header:false){:A}
+      assert out_string.include? "A -=> #{A}"
+      out_string.split("\n").size.must_equal 1
+    end
+
+    it "supports multible CONSTANTS" do
+      A,B,C = 1,2,3
+      out_string = debug_me(file:nil,header:false){[:A, :B, :C]}
+      assert out_string.include? "A -=> #{A}"
+      assert out_string.include? "B -=> #{B}"
+      assert out_string.include? "C -=> #{C}"
+      out_string.split("\n").size.must_equal 3
+    end
+
+  end # describe "works with CONSTANTS" do
+
+
+  describe "works with class CONSTANTS" do
+
+    before do
+      @my_world_view = WorldView.new
+    end
+
+    it "supports a single class CONSTANT" do
+      out_string = debug_me(file:nil,header:false){'WorldView::A'}
+      assert out_string.include? "WorldView::A -=> #{WorldView::A}"
+      out_string.split("\n").size.must_equal 1
+    end
+
+    it "supports multible class CONSTANTS" do
+      out_string = debug_me(file:nil,header:false){[
+        'WorldView::A', 'WorldView::B', 'WorldView::C']}
+      assert out_string.include? "WorldView::A -=> #{WorldView::A}"
+      assert out_string.include? "WorldView::B -=> #{WorldView::B}"
+      assert out_string.include? "WorldView::C -=> #{WorldView::C}"
+      out_string.split("\n").size.must_equal 3
+    end
+
+    it "shows all class CONSTANTS" do
+      out_string = @my_world_view.my_constants
+
+      assert out_string.include? "A -=> #{WorldView::A}"
+      assert out_string.include? "B -=> #{WorldView::B}"
+      assert out_string.include? "C -=> #{WorldView::C}"
+      assert out_string.include? 'MY_CONSTANT -=> "Jesus"'
+
+      out_string.include?("out_string -=> ").must_equal false
+      out_string.include?("@d -=> ").must_equal false
+
+      out_string.split("\n").size.must_equal WorldView.constants.size
+    end
+
+  end # describe "works with class CONSTANTS" do
+
+
+
+end # describe DebugMe do

data/tests/world_view.rb

@@ -0,0 +1,31 @@
+class WorldView
+  MY_CONSTANT = 'Jesus'
+  A = 1
+  B = 2
+  C = 3
+  def initialize
+    @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,
+      cconst: true
+    ){}
+  end
+  def my_constants
+    debug_me(
+      file:nil,
+      header:false,
+      lvar: false,
+      ivar: false,
+      cvar: false,
+      cconst: true
+    ){}
+
+  end
+end # class WorldView

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug_me
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,8 @@ files:
 - lib/debug_me.rb
 - lib/debug_me/version.rb
 - rubygems.yml.asc
+- tests/debug_me_test.rb
+- tests/world_view.rb
 homepage: http://github.com/MadBomber/debug_me
 licenses:
 - You want it, its yours