defly 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew Liu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# defly
+
+A ruby debugging tool.  Easy way to trace function calls and variables.
+
+## Install
+
+Just `gem install defly`.
+
+## Sample Usage
+
+### Input
+
+```ruby
+require 'defly'
+class Warrior
+  attr_accessor :hp, :mp
+
+  def sleep
+    self.hp += 10
+    self.mp += 2
+  end
+end
+
+Warrior.new.trace([:hp, :hp=, :mp, :mp=], [:@hp, :@mp]) do |warrior|
+  warrior.hp = 10
+  warrior.mp = 20
+  warrior.sleep
+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'
+        @hp = 10 # undefined
+        @mp = nil # undefined
+    >>>>> 10
+    <<<<< Warrior#mp=(20) # (irb):13: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
+    >>>>> 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>
+
+
+## Copyright
+
+Copyright (c) 2011 Andrew Liu. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "defly"
+  gem.homepage = "http://github.com/eggegg/defly"
+  gem.license = "MIT"
+  gem.summary = %Q{Debug and trace tool for Ruby}
+  gem.description = %Q{Trace methods and instance variables with ease!}
+  gem.email = "andrewliu33@gmail.com"
+  gem.authors = ["Andrew Liu"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "defly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/defly.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{defly}
+  s.version = "0.1.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.description = %q{Trace methods and instance variables with ease!}
+  s.email = %q{andrewliu33@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "defly.gemspec",
+    "lib/defly.rb",
+    "lib/tracable.rb",
+    "test/helper.rb",
+    "test/test_defly.rb"
+  ]
+  s.homepage = %q{http://github.com/eggegg/defly}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Debug and trace tool for Ruby}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      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<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<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
+end
+

data/lib/defly.rb

@@ -0,0 +1,6 @@
+require 'tracable'
+
+module Defly
+end
+
+Object.send(:include, Defly::Tracable)

data/lib/tracable.rb

@@ -0,0 +1,93 @@
+module Defly
+  module Tracable
+    def trace(methods, variables, &block)
+      trace_method!(methods)
+      trace_variable!(variables)
+      yield self
+      untrace!
+      
+      self
+    end
+    
+    def trace_method!(methods)
+      @defly_methods ||= []
+      
+      methods = public_methods(false) if methods.size == 0
+      methods.map! {|m| m.to_sym }
+      methods -= @defly_methods
+      @defly_methods |= methods
+      
+      STDERR << "Tracing #{methods.join(', ')} on #{self.class} instance\n"
+      
+      methods.each do |m|
+        eigenclass.class_eval <<-RUBY, __FILE__, __LINE__
+          def #{m}(*args, &block)
+            @__defly_level ||= 0
+            indent = '    ' * @__defly_level
+            
+            begin
+              STDERR << "\#{indent}<<<<< #{self.class}##{m}(\#{args.join(', ')}) # \#{caller[0]}\n"
+              @__defly_level += 1
+              result = super
+              @__defly_level -= 1
+              defly_check_var(indent) if defined? defly_check_var
+              STDERR << "\#{indent}>>>>> \#{result}\n"
+              result
+            rescue
+              STDERR << "#{m}: \#{$!.class}: \#{$!.message}\n"
+              raise
+            end
+          end
+        RUBY
+      end
+    end
+    
+    def trace_variable!(variables)
+      @defly_variables ||= []
+      
+      variables = instance_variables if variables.size == 0
+      variables.map! {|v| v.to_sym }
+      variables -= @defly_variables
+      @defly_variables |= variables
+      
+      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
+        eigenclass.class_eval <<-RUBY, __FILE__, __LINE__
+          def defly_check_var(indent)
+            @__defly ||= {}
+            
+            var_list = defly_check_var_list
+            var_list.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
+              else
+                STDERR << "    \#{indent}\#{v.to_s} = \#{new_val.inspect} # undefined\n"
+              end
+              @__defly[v] = new_val
+            end
+          end
+        RUBY
+      end
+    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
+      end
+    end
+    
+    def eigenclass
+      class << self; self; end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'defly'
+
+class Test::Unit::TestCase
+end

data/test/test_defly.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestDefly < Test::Unit::TestCase
+  should "properly trace" do
+    class C
+      attr_accessor :a
+      
+      def b c
+        self.a = c
+        @a = 10
+      end
+    end
+    
+    C.new.trace([:a, :a=, :b], [:@a]) do |d|
+      d.a = 10
+      d.a = 20
+      d.b 40
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: defly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-01 00:00:00.000000000 +08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2156047920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156047920
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156046920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156046920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2156046080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2156046080
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2156045280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156045280
+description: Trace methods and instance variables with ease!
+email: andrewliu33@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- defly.gemspec
+- lib/defly.rb
+- lib/tracable.rb
+- test/helper.rb
+- test/test_defly.rb
+has_rdoc: true
+homepage: http://github.com/eggegg/defly
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1991178412336427869
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Debug and trace tool for Ruby
+test_files: []