quick-debug 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in quick-debug.gemspec
+gemspec

data/README.md

@@ -0,0 +1,103 @@
+Quick - debug!
+============
+When debugging in Ruby, print statements are still often the best tool for the job. But how many times have you found yourself typing stuff like this over and over?
+
+```ruby
+def main
+  puts "========= in main"
+  movie_dirs.each do |movie_dir|
+    Find.find(movie_dir) do |fn|
+      if fn.is_movie?
+        parent_dir = File.dirname(fn)
+        movie = nil
+        if movie_dirs.include? parent_dir or parent_dir.has_another_movie(fn)
+          puts "========= in if movie_dirs..."
+          movie = get_movie fn
+          puts "========= movie: #{movie.inspect}"
+        else
+          movie = get_movie(fn, true)
+        end
+    .......
+```
+
+What if you could just do this instead?
+
+```ruby
+def main
+  D.bg :in
+  movie_dirs.each do |movie_dir|
+    Find.find(movie_dir) do |fn|
+      if fn.is_movie?
+        parent_dir = File.dirname(fn)
+        movie = nil
+        if movie_dirs.include? parent_dir or parent_dir.has_another_movie(fn)
+          movie = get_movie fn
+          D.bg(:in){'movie'}
+        else
+          movie = get_movie(fn, true)
+        end
+    .......
+```
+
+Now you can.
+
+Installation
+------------
+In your Gemfile, add:
+
+```
+gem 'quick-debug'
+```
+_or_ run this, then require the gem as such:
+
+```
+$ gem install quick-debug
+```
+```ruby
+require 'quick-debug'
+```
+For especially legacy/hostile environments, or if you want to use this _really_ quickly, you can directly require the `quick-debug.rb` file in your code - it has no dependencies. If you do this often, a symlink could come in really useful. For example:
+
+```
+$ sudo ln -s /Library/Ruby/Gems/1.8/gems/quick-debug-0.0.1/lib/quick-debug.rb /quick-debug
+```
+
+Then, from within your code:
+
+```ruby
+require '/quick-debug'
+def main
+  D.bg :in
+  movie_dirs.each do |movie_dir|
+  ....
+```
+
+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 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.
+
+```
+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
+
+```
+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'}`.
+
+### Happy Debugging!! ###

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/quick-debug.rb

@@ -0,0 +1,39 @@
+require "#{File.dirname(__FILE__)}/quick-debug/version"
+
+class D
+  @@logpath = '/tmp/quick-debug.txt'
+
+  def self.logpath= path
+    @@logpath = path
+  end
+
+  def self.bg(command = nil, &block)
+    puts eval_inspect(caller.first, command, &block)
+  end
+
+  def self.lg(command = nil, &block)
+    caller_method = caller.first
+    timestamp = Time.now.strftime("%a %H:%M:%S")
+    File.open(@@logpath, 'a+') do |f|
+      f.puts "[#{timestamp}] #{eval_inspect(caller_method, command, &block)}"
+    end
+  end
+
+  def self.str(command = nil, &block)
+    eval_inspect(caller.first, command, &block)
+  end
+
+  private
+
+  def self.eval_inspect(caller_method, command = nil, &block)
+    outputs = []
+    if command && [:in, :at].include?(command.to_sym)
+      outputs << "[#{caller_method}]"
+    end
+    if block
+      varname = block.call.to_s
+      outputs << "#{varname} ~> #{eval(varname, block).inspect}"
+    end
+    outputs.join(' ')
+  end
+end

data/lib/quick-debug/version.rb

@@ -0,0 +1,3 @@
+class D
+  VERSION = "0.0.1"
+end

data/quick-debug.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "quick-debug/version"
+
+Gem::Specification.new do |s|
+  s.name        = "quick-debug"
+  s.version     = D::VERSION
+  s.authors     = ["Suan-Aik Yeo"]
+  s.email       = ["yeosuanaik@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Quick print-based Ruby debugging}
+  s.description = %q{Debug your Ruby code with just a few keystrokes!}
+
+  s.rubyforge_project = "quick-debug"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: quick-debug
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Suan-Aik Yeo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Debug your Ruby code with just a few keystrokes!
+email: 
+- yeosuanaik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/quick-debug.rb
+- lib/quick-debug/version.rb
+- quick-debug.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: quick-debug
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Quick print-based Ruby debugging
+test_files: []
+