detective 0.1.0 → 0.2.0

data/README.rdoc

@@ -14,7 +14,8 @@ View the source of a class method ...
   require 'detective'
   
   Detective.view_source('ActiveRecord::Base.find_by_sql')
-  
+
+Result  
     def find_by_sql(sql)
       connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
     end
@@ -23,6 +24,7 @@ View the source of an instance method ...
 
   Detective.view_source('ActiveRecord::Base#update_attributes')
 
+Result
     def update_attributes(attributes)
       self.attributes = attributes
       save
@@ -39,6 +41,7 @@ View the source of an overrided method ...
   
   Detective.view_source('ActiveRecord::Base#update_attributes')
     
+Result
     def update_attributes(attributes)
       puts "updating attributes ..."
       self.attributes = attributes
@@ -48,13 +51,32 @@ View the source of an overrided method ...
 Find the location of some source ...
   Detective.get_location('ActiveRecord::Base#attributes')
 
+Result
     location
     /home/aseldawy/.gem/ruby/1.8/gems/activerecord-2.3.4/lib/active_record/base.rb
     2752
 
+(new) You can also find source code for modules ...
+  Detective.view_source('AuthenticatedSystem#current_user')
+  
+Result
+    def current_user
+      @current_user ||= (login_from_session || login_from_basic_auth || login_from_cookie) unless @current_user == false
+    end
+
+(new) You have an alternative output ...
+  Detective.view_source('AuthenticatedSystem#current_user', :rdoc)
+ 
+ Result
+    /home/aseldawy/aptana_studio/archiving_system/lib/authenticated_system.rb, line 11
+    11:    def current_user
+    12:      @current_user ||= (login_from_session || login_from_basic_auth || login_from_cookie) unless @current_user == false
+    13:    end
+
 No luck with native methods ...
   Detective.view_source('String#length')
-  
+
+Result
     native method
 
 == How it works (advanced)

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "detective"
     gem.summary = "Find source code of ruby methods"
-    gem.description = "A gem that allows you to view the source code of a method"
+    gem.description = "A ruby gem built by BadrIT (http://www.badrit.com/) that allows you to view the source code of a method"
     gem.email = "ahmed.eldawy@badrit.com"
     gem.homepage = "http://github.com/aseldawy/detective"
     gem.authors = ["Ahmed ElDawy"]

data/VERSION

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

data/detective.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{detective}
-  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 = ["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.date = %q{2009-11-21}
+  s.description = %q{A ruby gem built by BadrIT (http://www.badrit.com/) that allows you to view the source code of a method}
   s.email = %q{ahmed.eldawy@badrit.com}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/detective.rb

@@ -2,9 +2,14 @@ require 'ruby_parser'
 
 module Detective
 
-  ForkSupported = respond_to? :fork
+  begin
+    fork {exit!}
+    ForkSupported = true
+  rescue Exception
+    ForkSupported = false
+  end
 
-	def self.view_source(method)
+	def self.view_source(method, format=:plain)
     location = get_location(method).strip.split /[\r\n]+/
     case location.first
       when 'native method' then return 'native method'
@@ -15,19 +20,29 @@ module Detective
         line_no = line_no.to_i
         f = File.open filename
         source = ""
-        file_line_no = 0
+        output = case format
+          when :plain then ""
+          when :rdoc then "#{filename}, line #{line_no}" << "\r\n"
+          else ""
+        end
+        current_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
+        f.each_line do |current_line|
+          current_line_no += 1
+          if current_line_no >= line_no
+            output << case format
+              when :plain then current_line
+              when :rdoc then "#{current_line_no}:#{current_line}"
+              else current_line
+            end
+            source << current_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 output
+      rescue Exception => e
         return "Cannot find source code"
       end
     end
@@ -62,31 +77,31 @@ private
     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
+        # 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)
+
         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"
@@ -102,30 +117,30 @@ private
   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
+        # 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)
+      
         the_method.call *args
         # If the next line executed, this indicates an error because the method should be cancelled before called
         puts "method called!"
@@ -146,8 +161,11 @@ private
   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
+    elsif the_klass.is_a? Class
+      # Create an instance of the given class
+      # Create a new empty initialize method to bypass initialization ...
+      # because some classes require special attributes when created.
+      # Some other like ActiveRecord::Base does not allow to be instantiated at all
       the_klass.class_eval do
         alias old_initialize initialize
         def initialize
@@ -161,6 +179,11 @@ private
 #        undef initialize
         alias initialize old_initialize
       end
+    elsif the_klass.is_a? Module
+      # Crate any object and let it extends the given module
+      object = Object.new
+      object.extend the_klass
+      the_method = object.method(method_name)
     end
     # check how many attributes are required
     the_method_arity = the_method.arity

data/test/test_detective.rb

@@ -1,15 +1,15 @@
 require 'helper'
 
-class BadrIT; end
+class BadrIT
+  def self.hello
+    puts "hello BadrIT"
+  end
+end
+module IPhone; 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
@@ -137,5 +137,20 @@ class TestDetective < Test::Unit::TestCase
       Detective.view_source('BadrIT')
     end
   end
+  
+  def test_moudle_source
+    IPhone.module_eval do
+      def app_store
+        puts "app_store!"
+      end
+    end
+    
+    source = Detective.view_source('IPhone#app_store')
+    assert_equal 'def app_store puts "app_store!" end', source.gsub(/\s+/, ' ').strip 
+  end
 
+  def test_rdoc_format
+    source = Detective.view_source('BadrIT.hello', :rdoc)
+    assert_equal "#{__FILE__}, line 4 4: def self.hello 5: puts \"hello BadrIT\" 6: end", source.gsub(/\s+/, ' ').strip
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: detective
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ahmed ElDawy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 +02:00
+date: 2009-11-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: A gem that allows you to view the source code of a method
+description: A ruby gem built by BadrIT (http://www.badrit.com/) that allows you to view the source code of a method
 email: ahmed.eldawy@badrit.com
 executables: []