defly 0.1.0 → 0.2.0

data/Gemfile

@@ -3,6 +3,8 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
+gem "rib"
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
       rake
     rake (0.9.2)
     rcov (0.9.9)
+    rib (0.9.2)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -17,4 +18,5 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
   rcov
+  rib
   shoulda

data/README.md

@@ -6,12 +6,19 @@ A ruby debugging tool.  Easy way to trace function calls and variables.
 
 Just `gem install defly`.
 
-## Sample Usage
+## Feature
+* Trace method calls: including arguments and return values
+* Trace variable changes
+* Showing source code when NoMethodError is thrown
+* Opening a shell when a particular error occurred
+
+## Tracing method and instance variables
 
 ### Input
 
 ```ruby
 require 'defly'
+
 class Warrior
   attr_accessor :hp, :mp
 
@@ -21,7 +28,8 @@ class Warrior
   end
 end
 
-Warrior.new.trace([:hp, :hp=, :mp, :mp=], [:@hp, :@mp]) do |warrior|
+Warrior.debug!
+Warrior.new.trace([:hp, :hp=, :mp, :mp=, :sleep], [:@hp, :@mp]) do |warrior|
   warrior.hp = 10
   warrior.mp = 20
   warrior.sleep
@@ -30,30 +38,72 @@ end
 
 ### Output (Run on IRB)
 
-    Tracing hp, hp=, mp, mp= on Warrior instance
-    Tracing @hp, @mp  on Warrior instance
-    <<<<< Warrior#hp=(10) # (irb):12:in `block in irb_binding'
+    Tracing hp, hp=, mp, mp=, sleep on Warrior instance
+    Tracing @hp, @mp on Warrior instance
+    <<<<< Warrior#hp=(10) # (irb):14:in `block in irb_binding'
         @hp = 10 # undefined
         @mp = nil # undefined
     >>>>> 10
-    <<<<< Warrior#mp=(20) # (irb):13:in `block in irb_binding'
+    <<<<< Warrior#mp=(20) # (irb):15:in `block in irb_binding'
         @mp = 20 # undefined
     >>>>> 20
-    <<<<< Warrior#hp() # (irb):6:in `sleep'
-    >>>>> 10
-    <<<<< Warrior#hp=(20) # (irb):6:in `sleep'
-        @hp = 20 # 10 -> 20
-    >>>>> 20
-    <<<<< Warrior#mp() # (irb):7:in `sleep'
-    >>>>> 20
-    <<<<< Warrior#mp=(22) # (irb):7:in `sleep'
-        @mp = 22 # 20 -> 22
+    <<<<< Warrior#sleep() # (irb):16:in `block in irb_binding'
+        <<<<< Warrior#hp() # (irb):7:in `sleep'
+        >>>>> 10
+        <<<<< Warrior#hp=(20) # (irb):7:in `sleep'
+            @hp = 20 # 10 -> 20
+        >>>>> 20
+        <<<<< Warrior#mp() # (irb):8:in `sleep'
+        >>>>> 20
+        <<<<< Warrior#mp=(22) # (irb):8:in `sleep'
+            @mp = 22 # 20 -> 22
+        >>>>> 22
     >>>>> 22
-    => #<Warrior:0x00000100987488 @defly_methods=[:hp, :hp=, :mp, :mp=], @defly_variables=[:@hp, :@mp], @__defly_level=0, @hp=20, @__defly={:@hp=>20, :@mp=>22}, @mp=22>
 
+## Better Error Message
+
+### NoMethodError
+
+Showing the exact code and the position of the error.
+
+```ruby
+irb(main):001:0> require 'defly'
+=> true
+irb(main):002:0> require 'bug'
+NoMethodError: undefined method `is_annoying' for "debugging":String
+bug.rb:1> "debugging".<<is_annoying>>
+	from /Users/eggegg/bug.rb:1:in `<top (required)>'
+	...
+```
+
+## Inspecting error
+
+### Input
+
+```ruby
+class Rocket
+  def launch
+    @reason = "Bugs invasion"
+    raise "Engine Fail"
+  end
+end
+
+Rocket.debug!
+rocket = Rocket.new
+rocket.watch_error "Engine Fail"
+rocket.launch
+```
+
+### Output
+
+    >>>>> Error received:
+    "Engine Fail"
+    >>>>>
+    #<Rocket:0(0)>> @reason
+    => "Bugs invasion"
+    #<Rocket:0(0)>>
 
 ## Copyright
 
 Copyright (c) 2011 Andrew Liu. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/defly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{defly}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Liu"]
-  s.date = %q{2011-08-01}
+  s.date = %q{2011-08-26}
   s.description = %q{Trace methods and instance variables with ease!}
   s.email = %q{andrewliu33@gmail.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,9 @@ Gem::Specification.new do |s|
     "VERSION",
     "defly.gemspec",
     "lib/defly.rb",
+    "lib/inspectable.rb",
     "lib/tracable.rb",
+    "lib/whinable.rb",
     "test/helper.rb",
     "test/test_defly.rb"
   ]
@@ -40,17 +42,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rib>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<rib>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rib>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

data/lib/defly.rb

@@ -1,6 +1,15 @@
 require 'tracable'
+require 'whinable'
+require 'inspectable'
 
 module Defly
 end
 
-Object.send(:include, Defly::Tracable)
+class Class
+  def debug!
+    self.send(:include, Defly::Inspectable)
+    self.send(:include, Defly::Tracable)
+  end
+end
+
+NoMethodError.send(:include, Defly::Whinable)

data/lib/inspectable.rb

@@ -0,0 +1,26 @@
+require 'rib/core'
+require 'rib/more'
+
+module Defly
+  module Inspectable
+    def watch_error error
+      @__defly_watch ||= []
+      @__defly_watch << error
+    end
+    
+    def raise error
+      @__defly_watch ||= []
+      
+      if @__defly_watch.include? error.class or @__defly_watch.include? error
+        puts ">>>>> Error received:"
+        p error
+        puts ">>>>> "
+        
+        Rib.enable_anchor do
+          Rib.anchor self
+        end
+      end
+      super
+    end
+  end
+end

data/lib/tracable.rb

@@ -10,12 +10,12 @@ module Defly
     end
     
     def trace_method!(methods)
-      @defly_methods ||= []
+      @__defly_methods ||= []
       
       methods = public_methods(false) if methods.size == 0
       methods.map! {|m| m.to_sym }
-      methods -= @defly_methods
-      @defly_methods |= methods
+      methods -= @__defly_methods
+      @__defly_methods |= methods
       
       STDERR << "Tracing #{methods.join(', ')} on #{self.class} instance\n"
       
@@ -30,7 +30,7 @@ module Defly
               @__defly_level += 1
               result = super
               @__defly_level -= 1
-              defly_check_var(indent) if defined? defly_check_var
+              __defly_check_var(indent) if defined? __defly_check_var
               STDERR << "\#{indent}>>>>> \#{result}\n"
               result
             rescue
@@ -43,37 +43,28 @@ module Defly
     end
     
     def trace_variable!(variables)
-      @defly_variables ||= []
+      @__defly_variables ||= []
       
       variables = instance_variables if variables.size == 0
       variables.map! {|v| v.to_sym }
-      variables -= @defly_variables
-      @defly_variables |= variables
+      variables -= @__defly_variables
+      @__defly_variables |= variables
       
-      STDERR << "Tracing #{variables.join(', ')}  on #{self.class} instance\n"
+      STDERR << "Tracing #{variables.join(', ')} on #{self.class} instance\n"
       
-      eigenclass.remove_method :defly_check_var_list if eigenclass.instance_methods.include? :defly_check_var_list
-      
-      eigenclass.class_eval <<-RUBY, __FILE__, __LINE__
-        def defly_check_var_list
-          [#{@defly_variables.map(&:inspect).join(', ')}]
-        end
-      RUBY
-      
-      unless eigenclass.instance_methods.include? :defly_check_var
+      unless eigenclass.instance_methods.include? :__defly_check_var
         eigenclass.class_eval <<-RUBY, __FILE__, __LINE__
-          def defly_check_var(indent)
-            @__defly ||= {}
+          def __defly_check_var(indent)
+            @__defly_varmap ||= {}
             
-            var_list = defly_check_var_list
-            var_list.each do |v|
+            @__defly_variables.each do |v|
               new_val = instance_variable_get(v)
-              if @__defly[v]
-                STDERR << "    \#{indent}\#{v.to_s} = \#{new_val.inspect} # \#{@__defly[v].inspect} -> \#{new_val.inspect}\n" unless @__defly[v] == new_val
+              if @__defly_varmap[v]
+                STDERR << "    \#{indent}\#{v.to_s} = \#{new_val.inspect} # \#{@__defly_varmap[v].inspect} -> \#{new_val.inspect}\n" unless @__defly_varmap[v] == new_val
               else
                 STDERR << "    \#{indent}\#{v.to_s} = \#{new_val.inspect} # undefined\n"
               end
-              @__defly[v] = new_val
+              @__defly_varmap[v] = new_val
             end
           end
         RUBY
@@ -81,8 +72,8 @@ module Defly
     end
     
     def untrace!
-      [:defly_check_var_list, :defly_check_var].concat(@defly_methods) do |m|
-        eigenclass.remove_method(m) if eigenclass.instance_methods.include? m
+      [:__defly_check_var].concat(@__defly_methods).each do |m|
+        eigenclass.send(:remove_method, m) if eigenclass.instance_methods.include? m
       end
     end
     
@@ -90,4 +81,4 @@ module Defly
       class << self; self; end
     end
   end
-end
+end

data/lib/whinable.rb

@@ -0,0 +1,19 @@
+module Defly
+  module Whinable
+    def to_s
+      orig_message = super
+      position = backtrace[0]
+      message = ""
+      missing_method = name.to_s
+      
+      unless /^\(.*\):.*/ =~ position # skipping irb
+        file, line, other = position.split(':')        
+        code = IO.readlines(file)[line.to_i - 1].chomp
+        code.gsub!(/(#{missing_method})/, '<<\1>>')
+        message = "#{file.split('/')[-1]}:#{line}> #{code}"
+      end
+      
+      "#{orig_message}\n#{message}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-01 00:00:00.000000000 +08:00
+date: 2011-08-26 00:00:00.000000000 +08:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rib
+  requirement: &2153950820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153950820
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2156047920 !ruby/object:Gem::Requirement
+  requirement: &2153949880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156047920
+  version_requirements: *2153949880
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156046920 !ruby/object:Gem::Requirement
+  requirement: &2153948960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156046920
+  version_requirements: *2153948960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156046080 !ruby/object:Gem::Requirement
+  requirement: &2153947960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +55,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2156046080
+  version_requirements: *2153947960
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156045280 !ruby/object:Gem::Requirement
+  requirement: &2153946880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156045280
+  version_requirements: *2153946880
 description: Trace methods and instance variables with ease!
 email: andrewliu33@gmail.com
 executables: []
@@ -73,7 +84,9 @@ files:
 - VERSION
 - defly.gemspec
 - lib/defly.rb
+- lib/inspectable.rb
 - lib/tracable.rb
+- lib/whinable.rb
 - test/helper.rb
 - test/test_defly.rb
 has_rdoc: true
@@ -92,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1991178412336427869
+      hash: -1635137758272325934
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: