quick-debug 0.0.4 → 0.1.0

data/README.md

@@ -24,7 +24,7 @@ What if you could just do this instead?
 
 ```ruby
 def main
-  D.bg :in
+  D.bg
   movie_dirs.each do |movie_dir|
     Find.find(movie_dir) do |fn|
       if fn.is_movie?
@@ -32,7 +32,7 @@ def main
         movie = nil
         if movie_dirs.include? parent_dir or parent_dir.has_another_movie(fn)
           movie = get_movie fn
-          D.bg(:in){'movie'}
+          D.bg{'movie'}
         else
           movie = get_movie(fn, true)
         end
@@ -67,7 +67,7 @@ Then, from within your code:
 ```ruby
 require '/quick-debug'
 def main
-  D.bg :in
+  D.bg
   movie_dirs.each do |movie_dir|
   ....
 ```
@@ -77,16 +77,10 @@ Usage
 ```
 D.bg{'@somevar'}
 ```
-prints `@somevar ~> <contents of @somevar.inspect>` to STDOUT. Any object can be passed in, but it must be surrounded by quotes or be made a symbol.
-
-```
-D.bg(:in){'@somevar'} or D.bg(:at){'@somevar'}
-```
-prints `[<caller filename, method, and line number>] @somevar ~> <contents of @somevar.inspect>` to STDOUT. If the block is omitted, only the caller method and line number will be printed.
+Prints `[<caller filename, method, and line number>] @somevar ~> <contents of @somevar.inspect>` to STDOUT. Any object can be passed in, but it must be surrounded by quotes or be made a symbol. If the block is omitted, only the caller method and line number will be printed.
 
 ```
 D.lg{'@somevar'}
-D.lg(:in){'@somevar'} or D.lg(:at){'@somevar'}
 ```
 Same as above, but prints to `/tmp/quick-debug.txt` instead. A short timestamp is also printed at the start of each line. To change the output filepath, do
 
@@ -96,7 +90,6 @@ D.logpath = '</some/path/log.txt>'
 
 ```
 D.str{'@somevar'}
-D.str(:in){'@somevar'} or D.str(:at){'@somevar'}
 ```
 The above methods just return the deubg output as a string, rather than printing them anywhere. This can be very useful if you need to use your own logging framework, for example: `logger.debug D.str{'@somevar'}`.
 
@@ -109,4 +102,10 @@ D.enable
 ```
 to re-enable them. It accepts the same options.
 
+```
+D.bg(:force){'@somevar'}
+D.lg(:force){'@somevar'}
+```
+The debug methods accept a `:force` argument, which will cause those calls to run even though that output location been disabled.
+
 ### Happy Debugging!! ###

data/lib/quick-debug.rb

@@ -29,29 +29,26 @@ class D
   end
 
   def self.bg(command = nil, &block)
-    return if not @@active[:bg]
-    puts eval_inspect(caller.first, command, &block)
+    return if !@@active[:bg] && command != :force
+    puts eval_inspect(caller.first, &block)
   end
 
   def self.lg(command = nil, &block)
-    return if not @@active[:lg]
+    return if !@@active[:lg] && command != :force
     timestamp = Time.now.strftime("%a %H:%M:%S")
     File.open(@@logpath, 'a+') do |f|
-      f.puts "[#{timestamp}] #{eval_inspect(caller.first, command, &block)}"
+      f.puts "[#{timestamp}] #{eval_inspect(caller.first, &block)}"
     end
   end
 
   def self.str(command = nil, &block)
-    eval_inspect(caller.first, command, &block)
+    eval_inspect(caller.first, &block)
   end
 
   private
 
-  def self.eval_inspect(caller_string, command = nil, &block)
-    outputs = []
-    if command && [:in, :at].include?(command.to_sym)
-      outputs << "[#{strip_filepath caller_string}]"
-    end
+  def self.eval_inspect(caller_string, &block)
+    outputs = ["[#{strip_filepath caller_string}]"]
     if block
       varname = block.call.to_s
       outputs << "#{varname} ~> #{PP.pp eval(varname, block), ''}"

data/lib/quick-debug/version.rb

@@ -1,3 +1,3 @@
 class D
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quick-debug
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Suan-Aik Yeo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-05 00:00:00 Z
+date: 2013-01-18 00:00:00 Z
 dependencies: []
 
 description: Debug your Ruby code with just a few keystrokes!