detective 0.0.0 → 0.1.0

data/README.rdoc

@@ -1,18 +1,74 @@
 = detective
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+Detective is a gem build by BadrIT (http://www.badrit.com/) to investigate the ruby source code.
+Check the examples below.
+
+== Motivation
+Tired of opening files of installed gems to know how the code is working?
+Not able to know who and where that function has been overrided?
+It's time to get help from a private Detective.
+Detective allows you show the source and find the location of some ruby method.
+
+== Examples
+View the source of a class method ...
+  require 'detective'
+  
+  Detective.view_source('ActiveRecord::Base.find_by_sql')
+  
+    def find_by_sql(sql)
+      connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
+    end
+
+View the source of an instance method ...
+
+  Detective.view_source('ActiveRecord::Base#update_attributes')
+
+    def update_attributes(attributes)
+      self.attributes = attributes
+      save
+    end
+
+View the source of an overrided method ...
+  ActiveRecord::Base.class_eval do
+    def update_attributes(attributes)
+      puts "updating attributes ..."
+      self.attributes = attributes
+      save
+    end
+  end
+  
+  Detective.view_source('ActiveRecord::Base#update_attributes')
+    
+    def update_attributes(attributes)
+      puts "updating attributes ..."
+      self.attributes = attributes
+      save
+    end
+
+Find the location of some source ...
+  Detective.get_location('ActiveRecord::Base#attributes')
+
+    location
+    /home/aseldawy/.gem/ruby/1.8/gems/activerecord-2.3.4/lib/active_record/base.rb
+    2752
+
+No luck with native methods ...
+  Detective.view_source('String#length')
+  
+    native method
+
+== How it works (advanced)
+The idea is to invoke the given method and trace the execution of the program.
+This allows us to know where is the definition of the method.
+Then with the help of RubyParser, we can extract its code from the file.
+The invoke of this method is made in a separate process so that it doesn't conflict with your program.
+This child process is killed before the method starts its execution so the method is not really invoked.
+
+For systems not supporting fork (like windows), the child process is replaced with a thread.
+This might make some problems because it is running in the same space of your own ruby program.
+We make our best to decrease the effect of this call by killing the thread before the method starts execution.
+However, given that Detective will be used while developing only, we can ignore this effect.
 
 == Copyright
 
-Copyright (c) 2009 Ahmed ElDawy. See LICENSE for details.
+Copyright (c) 2009 BadrIT. See LICENSE for details.

data/Rakefile

@@ -11,7 +11,8 @@ begin
     gem.homepage = "http://github.com/aseldawy/detective"
     gem.authors = ["Ahmed ElDawy"]
     gem.rubyforge_project = "detective"
-    gem.add_development_dependency "minitest", ">= 0"
+    gem.add_dependency('ruby_parser')
+
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/detective.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{detective}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ahmed ElDawy"]
+  s.date = %q{2009-11-20}
+  s.description = %q{A gem that allows you to view the source code of a method}
+  s.email = %q{ahmed.eldawy@badrit.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "detective.gemspec",
+     "lib/detective.rb",
+     "test/helper.rb",
+     "test/test_detective.rb"
+  ]
+  s.homepage = %q{http://github.com/aseldawy/detective}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{detective}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Find source code of ruby methods}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_detective.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 0"])
+    else
+      s.add_dependency(%q<ruby_parser>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby_parser>, [">= 0"])
+  end
+end
+

data/lib/detective.rb

@@ -0,0 +1,173 @@
+require 'ruby_parser'
+
+module Detective
+
+  ForkSupported = respond_to? :fork
+
+	def self.view_source(method)
+    location = get_location(method).strip.split /[\r\n]+/
+    case location.first
+      when 'native method' then return 'native method'
+      when 'error' then raise location[1..-1].join(' ')
+      when 'location' then
+      begin
+        filename, line_no = location[1,2] 
+        line_no = line_no.to_i
+        f = File.open filename
+        source = ""
+        file_line_no = 0
+        rp = RubyParser.new
+        f.each_line do |file_line|
+          file_line_no += 1
+          if file_line_no >= line_no
+            source << file_line
+            # Try to parse it to know whether the method is complete or not
+            rp.parse(source) && break rescue nil
+          end
+        end
+        f.close
+        return source
+      rescue
+        return "Cannot find source code"
+      end
+    end
+	end
+	
+	# Finds the location of a method in ruby source files
+	# You can pass a string like
+	# * 'Class.name' class method
+	# # 'String#size' instance method
+	def self.get_location(ruby_statement)
+    if ruby_statement.index('#')
+      # instance method
+      class_name, method_name = ruby_statement.split('#')
+      class_method = false
+    elsif ruby_statement.index('.')
+      class_name, method_name = ruby_statement.split('.')
+      class_method = true
+    else
+      raise "Invalid parameter"
+    end
+    the_klass = eval(class_name)
+    ForkSupported ? get_location_fork(the_klass, method_name, class_method) : get_location_thread(the_klass, method_name, class_method)
+  end
+  
+private
+
+  def self.get_location_thread(the_klass, method_name, class_method)
+    if class_method
+      raise "Invalid class method name #{method_name} for class #{the_klass}" unless the_klass.respond_to? method_name
+    else
+      raise "Invalid instance method name #{method_name} for class #{the_klass}" unless the_klass.instance_methods.include? method_name
+    end
+    result = ""
+    t = Thread.new do
+      # child process
+      detective_state = 0
+      # Get an instance of class Method that can be invoked using Method#call
+      the_method, args = get_method(the_klass, method_name, class_method)
+      set_trace_func(proc do |event, file, line, id, binding, classname|
+        if id == :call
+          detective_state = 1
+          return
+        end
+        return if detective_state == 0
+        if event == 'call'
+          result << "location" << "\r\n"
+          result << file << "\r\n"
+          result << line.to_s << "\r\n"
+          # Cancel debugging
+          set_trace_func nil
+          Thread.kill(Thread.current)
+        elsif event == 'c-call'
+          result << 'native method'
+          set_trace_func nil
+          Thread.kill(Thread.current)
+        end
+      end)
+
+      begin
+        the_method.call *args
+        # If the next line executed, this indicates an error because the method should be cancelled before called
+        result << "method called!" << "\r\n"
+      rescue Exception => e
+        result << "error" << "\r\n"
+        result << e.inspect << "\r\n"
+      end
+    end
+    t.join
+    result
+  end
+
+  def self.get_location_fork(the_klass, method_name, class_method)
+    f = open("|-", "w+")
+    if f == nil
+      # child process
+      detective_state = 0
+      # Get an instance of class Method that can be invoked using Method#call
+      the_method, args = get_method(the_klass, method_name, class_method)
+      set_trace_func(proc do |event, file, line, id, binding, classname|
+        if id == :call
+          detective_state = 1
+          return
+        end
+        return if detective_state == 0
+        if event == 'call'
+          puts "location"
+          puts file
+          puts line
+          set_trace_func nil
+          exit!
+        elsif event == 'c-call'
+          puts 'native method'
+          set_trace_func nil
+          exit!
+        end
+      end)
+      
+      begin
+        the_method.call *args
+        # If the next line executed, this indicates an error because the method should be cancelled before called
+        puts "method called!"
+      rescue => e
+        puts "error"
+        puts e.inspect
+      ensure
+        exit!
+      end
+    else
+      Process.wait
+      x = f.read
+#      puts x
+      return x
+    end
+  end
+  
+  def self.get_method(the_klass, method_name, class_method)
+    if class_method
+      the_method = the_klass.method(method_name)
+    else
+      # Create a new empty initialize method to bypass initialization
+      the_klass.class_eval do
+        alias old_initialize initialize
+        def initialize
+          # Bypass initialization
+        end
+      end
+      the_method = the_klass.new.method(method_name)
+      # Revert initialize method
+      the_klass.class_eval do
+        # under causes a warning
+#        undef initialize
+        alias initialize old_initialize
+      end
+    end
+    # check how many attributes are required
+    the_method_arity = the_method.arity
+    required_args = the_method_arity < 0 ? -the_method_arity-1 : the_method_arity
+    
+    # Return the method and its parameters
+    [the_method, Array.new(required_args)]
+  end
+
+end

data/test/helper.rb

@@ -1,11 +1,9 @@
 require 'rubygems'
-require 'minitest/unit'
+require 'test/unit'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'detective'
 
-class MiniTest::Unit::TestCase
+class Test::Unit::TestCase
 end
-
-MiniTest::Unit.autorun

data/test/test_detective.rb

@@ -1,7 +1,141 @@
 require 'helper'
 
-class TestDetective < MiniTest::Unit::TestCase
-  def test_something_for_real
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+class BadrIT; end
+
+class TestDetective < Test::Unit::TestCase
+  def test_simple_method
+  	BadrIT.class_eval do 
+  		def self.hello
+				puts "hello BadrIT"
+			end
+		end
+  
+    source = Detective.view_source('BadrIT.hello')
+    assert_equal 'def self.hello puts "hello BadrIT" end', source.gsub(/\s+/, ' ').strip
+  end
+  
+  def test_overrided_method
+  	def BadrIT.abc
+  		puts "BadrIT rulez!!"
+  	end
+  	
+    source = Detective.view_source('BadrIT.abc')
+  	assert_equal 'def BadrIT.abc puts "BadrIT rulez!!" end', source.gsub(/\s+/, ' ').strip
+
+  	def BadrIT.abc
+  		puts "BadrIT is the best!!"
+  	end
+  	
+    source = Detective.view_source('BadrIT.abc')
+  	assert_equal 'def BadrIT.abc puts "BadrIT is the best!!" end', source.gsub(/\s+/, ' ').strip
+  end
+  
+	def test_instance_method
+		BadrIT.class_eval do
+			def test
+				puts "testing"
+			end
+		end
+		
+		source = Detective.view_source('BadrIT#test')
+		assert_equal 'def test puts "testing" end', source.gsub(/\s+/, ' ').strip
+	end
+  
+  def test_method_with_args
+    BadrIT.class_eval do
+      def test(arg0)
+        puts "nothing here"
+      end
+    end
+    
+    source = Detective.view_source('BadrIT#test')
+    assert_equal 'def test(arg0) puts "nothing here" end', source.gsub(/\s+/, ' ').strip
+  end
+  
+  def test_method_with_optional_args
+    BadrIT.class_eval do
+      def test1(arg0, arg1="test", arg2="habal")
+        puts "nothing here"
+      end
+    end
+    
+    source = Detective.view_source('BadrIT#test1')
+    assert_equal 'def test1(arg0, arg1="test", arg2="habal") puts "nothing here" end', source.gsub(/\s+/, ' ').strip
+  end
+  
+  def test_method_with_variable_args
+    BadrIT.class_eval do
+      def test2(arg0, arg1="test", *args)
+        puts "nothing here"
+      end
+    end
+    
+    source = Detective.view_source('BadrIT#test2')
+    assert_equal 'def test2(arg0, arg1="test", *args) puts "nothing here" end', source.gsub(/\s+/, ' ').strip
+  end
+
+  def test_native_method
+    source = Detective.view_source('String#length')
+    assert_equal 'native method', source.gsub(/\s+/, ' ').strip
+  end
+
+  def test_native_method_with_args
+    source = Detective.view_source('String#sub')
+    assert_equal 'native method', source.gsub(/\s+/, ' ').strip
+  end
+
+  def test_undefined_method
+    assert_raises RuntimeError do
+      Detective.view_source('String#adfasdf')
+    end
+  end
+
+  def test_using_threads
+    fork_supported = Detective.const_get(:ForkSupported)
+    Detective.const_set(:ForkSupported, false)
+    BadrIT.class_eval do 
+      def self.noway
+        puts "Go away"
+      end
+    end
+  
+    source = Detective.view_source('BadrIT.noway')
+    assert_equal 'def self.noway puts "Go away" end', source.gsub(/\s+/, ' ').strip
+
+    Detective.const_set(:ForkSupported, fork_supported)
   end
+
+  def test_with_required_initializers
+    BadrIT.class_eval do 
+      def initialize(arg0, arg1, arg2)
+      end
+
+      def some_method
+        puts "me myself"
+      end
+    end
+  
+    source = Detective.view_source('BadrIT#some_method')
+    assert_equal 'def some_method puts "me myself" end', source.gsub(/\s+/, ' ').strip
+  end
+
+  def test_method_with_eval
+    eval %Q{
+    BadrIT.class_eval do 
+      def self.yaya
+        puts "yaya BadrIT"
+      end
+    end
+    }
+    
+    source = Detective.view_source('BadrIT.yaya')
+    assert_equal 'Cannot find source code', source.gsub(/\s+/, ' ').strip
+  end
+  
+  def test_invalid_method_name
+    assert_raises RuntimeError do
+      Detective.view_source('BadrIT')
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: detective
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ahmed ElDawy
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +02:00
+date: 2009-11-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: minitest
-  type: :development
+  name: ruby_parser
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -38,6 +38,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- detective.gemspec
 - lib/detective.rb
 - test/helper.rb
 - test/test_detective.rb