method_source 0.4.1 → 0.6.0

data/README.markdown

@@ -50,7 +50,6 @@ Example: display method comments
 Limitations:
 ------------
 
-* Proc#source not available in Ruby 1.8
 * Occasional strange behaviour in Ruby 1.8
 * Cannot return source for C methods.
 * Cannot return source for dynamically defined methods.

data/Rakefile

@@ -7,7 +7,7 @@ require "#{direc}/lib/method_source/version"
 
 CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
 CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*.rbc",
               "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
 
 def apply_spec_defaults(s)
@@ -20,7 +20,10 @@ def apply_spec_defaults(s)
   s.description = s.summary
   s.require_path = 'lib'
   s.add_dependency("ruby_parser",">=2.0.5")
+
   s.add_development_dependency("bacon",">=1.1.0")
+  s.add_development_dependency("open4", "~> 1.0.1")
+
   s.homepage = "http://banisterfiend.wordpress.com"
   s.has_rdoc = 'yard'
   s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
@@ -33,10 +36,10 @@ end
 
 namespace :ruby do
   spec = Gem::Specification.new do |s|
-    apply_spec_defaults(s)        
+    apply_spec_defaults(s)
     s.platform = Gem::Platform::RUBY
   end
-  
+
   Rake::GemPackageTask.new(spec) do |pkg|
     pkg.need_zip = false
     pkg.need_tar = false

data/lib/method_source.rb

@@ -47,7 +47,7 @@ module MethodSource
   # @return [File] The opened source file
   def self.source_helper(source_location)
     return nil if !source_location.is_a?(Array)
-    
+
     file_name, line = source_location
     File.open(file_name) do |file|
       (line - 1).times { file.readline }
@@ -56,26 +56,26 @@ module MethodSource
       loop do
         val = file.readline
         code << val
-        
+
         return code if valid_expression?(code)
       end
-    end    
+    end
   end
-  
+
   # Helper method responsible for opening source file and buffering up
-  # the comments for a specified method. Defined here to avoid polluting 
+  # the comments for a specified method. Defined here to avoid polluting
   # `Method` class.
   # @param [Array] source_location The array returned by Method#source_location
   # @return [String] The comments up to the point of the method.
   def self.comment_helper(source_location)
     return nil if !source_location.is_a?(Array)
-    
+
     file_name, line = source_location
     File.open(file_name) do |file|
       buffer = ""
       (line - 1).times do
         line = file.readline
-        # Add any line that is a valid ruby comment, 
+        # Add any line that is a valid ruby comment,
         # but clear as soon as we hit a non comment line.
         if (line =~ /^\s*#/) || (line =~ /^\s*$/)
           buffer << line.lstrip
@@ -83,11 +83,11 @@ module MethodSource
           buffer.replace("")
         end
       end
-      
+
       buffer
     end
   end
-  
+
   # This module is to be included by `Method` and `UnboundMethod` and
   # provides the `#source` functionality
   module MethodExtensions
@@ -103,7 +103,7 @@ module MethodSource
 
         klass.class_eval do
           orig_source = instance_method(:source)
-          
+
           define_method(:source) do
             begin
               super
@@ -111,11 +111,11 @@ module MethodSource
               orig_source.bind(self).call
             end
           end
-          
-          end
+
         end
+      end
     end
-    
+
     # Return the sourcecode for the method as a string
     # (This functionality is only supported in Ruby 1.9 and above)
     # @return [String] The method sourcecode as a string
@@ -129,15 +129,15 @@ module MethodSource
     def source
       if respond_to?(:source_location)
         source = MethodSource.source_helper(source_location)
-        
+
         raise "Cannot locate source for this method: #{name}" if !source
       else
         raise "#{self.class}#source not supported by this Ruby version (#{RUBY_VERSION})"
       end
-      
+
       source
     end
-    
+
     # Return the comments associated with the method as a string.
     # (This functionality is only supported in Ruby 1.9 and above)
     # @return [String] The method's comments as a string
@@ -148,7 +148,7 @@ module MethodSource
     def comment
       if respond_to?(:source_location)
         comment = MethodSource.comment_helper(source_location)
-        
+
         raise "Cannot locate source for this method: #{name}" if !comment
       else
         raise "#{self.class}#comment not supported by this Ruby version (#{RUBY_VERSION})"
@@ -170,5 +170,7 @@ class UnboundMethod
 end
 
 class Proc
+  include MethodSource::SourceLocation::ProcExtensions
   include MethodSource::MethodExtensions
 end
+

data/lib/method_source/source_location.rb

@@ -4,14 +4,14 @@ module MethodSource
 
       def trace_func(event, file, line, id, binding, classname)
         return unless event == 'call'
-        set_trace_func nil 
-        
+        set_trace_func nil
+
         @file, @line = file, line
         raise :found
       end
 
       private :trace_func
-      
+
       # Return the source location of a method for Ruby 1.8.
       # @return [Array] A two element array. First element is the
       #   file, second element is the line in the file where the
@@ -19,16 +19,42 @@ module MethodSource
       def source_location
         if @file.nil?
           args =[*(1..(arity<-1 ? -arity-1 : arity ))]
-          
+
           set_trace_func method(:trace_func).to_proc
-          call *args rescue nil
-          set_trace_func nil 
+          call(*args) rescue nil
+          set_trace_func nil
           @file = File.expand_path(@file) if @file && File.exist?(File.expand_path(@file))
         end
         return [@file, @line] if File.exist?(@file.to_s)
       end
     end
 
+    module ProcExtensions
+
+      if defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/
+
+        # Return the source location for a Proc (Rubinius only)
+        # @return [Array] A two element array. First element is the
+        #   file, second element is the line in the file where the
+        #   proc definition is found.
+        def source_location
+          [block.file.to_s, block.line]
+        end
+
+      else
+
+        # Return the source location for a Proc (in implementations
+        # without Proc#source_location)
+        # @return [Array] A two element array. First element is the
+        #   file, second element is the line in the file where the
+        #   proc definition is found.
+        def source_location
+          self.to_s =~ /@(.*):(\d+)/
+          [$1, $2.to_i]
+        end
+      end
+    end
+
     module UnboundMethodExtensions
 
       # Return the source location of an instance method for Ruby 1.8.
@@ -57,7 +83,7 @@ module MethodSource
         when klass == NilClass
           return nil.method(name).source_location
         end
-        
+
         begin
           klass.allocate.method(name).source_location
         rescue TypeError

data/lib/method_source/version.rb

@@ -1,3 +1,3 @@
 module MethodSource
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

data/test/test.rb

@@ -2,16 +2,25 @@ direc = File.dirname(__FILE__)
 
 require 'rubygems'
 require 'bacon'
+require 'open4'
 require "#{direc}/../lib/method_source"
 require "#{direc}/test_helper"
 
 describe MethodSource do
 
+  describe "emitted warnings" do
+    it 'should emit no warnings' do
+      Open4.popen4 'ruby -I lib -rubygems -r"method_source" -W -e "exit"' do |pid,stdin,stdout,stderr|
+        stderr.read.empty?.should == true
+      end
+    end
+  end
+
   describe "source_location (testing 1.8 implementation)" do
     it 'should return correct source_location for a method' do
       method(:hello).source_location.first.should =~ /test_helper/
     end
-    
+
     it 'should not raise for immediate instance methods' do
       [Symbol, Fixnum, TrueClass, FalseClass, NilClass].each do |immediate_class|
         lambda { immediate_class.instance_method(:to_s).source_location }.should.not.raise
@@ -34,7 +43,7 @@ describe MethodSource do
     @lambda_source = "MyLambda = lambda { :lambda }\n"
     @proc_source = "MyProc = Proc.new { :proc }\n"
   end
-  
+
   it 'should define methods on Method and UnboundMethod and Proc' do
     Method.method_defined?(:source).should == true
     UnboundMethod.method_defined?(:source).should == true
@@ -57,36 +66,39 @@ describe MethodSource do
     it 'should return source for a singleton method' do
       $o.method(:hello).source.should == @hello_singleton_source
     end
-    
-    
+
+
     it 'should return a comment for method' do
       method(:hello).comment.should == @hello_comment
     end
 
-    it 'should raise for C methods' do
-      lambda { method(:puts).source }.should.raise RuntimeError
+
+    if !is_rbx?
+      it 'should raise for C methods' do
+        lambda { method(:puts).source }.should.raise RuntimeError
+      end
     end
   end
 
-  if RUBY_VERSION =~ /1.9/
+  # if RUBY_VERSION =~ /1.9/ || is_rbx?
     describe "Lambdas and Procs" do
       it 'should return source for proc' do
         MyProc.source.should == @proc_source
       end
-      
+
       it 'should return an empty string if there is no comment' do
         MyProc.comment.should == ''
       end
-      
+
       it 'should return source for lambda' do
         MyLambda.source.should == @lambda_source
       end
-      
+
       it 'should return comment for lambda' do
         MyLambda.comment.should == @lambda_comment
       end
-    end      
-  end
+    end
+  # end
   describe "Comment tests" do
     before do
       @comment1 = "# a\n# b\n"
@@ -107,13 +119,13 @@ describe MethodSource do
     it "should keep empty comment lines" do
       method(:comment_test3).comment.should == @comment3
     end
-    
+
     it "should ignore blank lines between comments" do
       method(:comment_test4).comment.should == @comment4
     end
 
     it "should align all comments to same indent level" do
       method(:comment_test5).comment.should == @comment5
-    end      
+    end
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,7 @@
+def is_rbx?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/
+end
+
 module M
   def hello; :hello_module; end
 end
@@ -6,7 +10,7 @@ $o = Object.new
 def $o.hello; :hello_singleton; end
 
 # A comment for hello
-  
+
   # It spans two lines and is indented by 2 spaces
 def hello; :hello; end
 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: method_source
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 +12:00
-default_executable: 
+date: 2011-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby_parser
@@ -25,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 5
         version: 2.0.5
   type: :runtime
   version_requirements: *id001
@@ -40,13 +31,20 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 0
         version: 1.1.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :development
+  version_requirements: *id003
 description: retrieve the sourcecode for a method
 email: jrmair@gmail.com
 executables: []
@@ -56,15 +54,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/method_source.rb
-- lib/method_source/version.rb
 - lib/method_source/source_location.rb
+- lib/method_source/version.rb
+- lib/method_source.rb
 - test/test.rb
 - test/test_helper.rb
 - README.markdown
 - Rakefile
 - .gemtest
-has_rdoc: yard
 homepage: http://banisterfiend.wordpress.com
 licenses: []
 
@@ -78,21 +75,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: retrieve the sourcecode for a method