method_source 0.3.4 → 0.3.5

data/README.markdown

@@ -1,63 +1,63 @@
-method_source
-=============
-
-(C) John Mair (banisterfiend) 2011
-
-_retrieve the sourcecode for a method_
-
-*NOTE:* This simply utilizes `Method#source_location`; it
- does not access the live AST.
-
-`method_source` is a utility to return a method's sourcecode as a
-Ruby string. Also returns `Proc` and `Lambda` sourcecode.
-
-Method comments can also be extracted using the `comment` method.
-
-It is written in pure Ruby (no C).
-
-* Some Ruby 1.8 support now available. 
-
-`method_source` provides the `source` and `comment` methods to the `Method` and
-`UnboundMethod` and `Proc` classes.
-
-* Install the [gem](https://rubygems.org/gems/method_source): `gem install method_source`
-* Read the [documentation](http://rdoc.info/github/banister/method_source/master/file/README.markdown)
-* See the [source code](http://github.com/banister/method_source)
-
-Example: display method source
-------------------------------
-
-    Set.instance_method(:merge).source.display
-    # =>
-    def merge(enum)
-      if enum.instance_of?(self.class)
-        @hash.update(enum.instance_variable_get(:@hash))
-      else
-        do_with_enum(enum) { |o| add(o) }
-      end
-
-      self
-    end
-
-Example: display method comments
---------------------------------
-
-    Set.instance_method(:merge).comment.display
-    # =>
-    # Merges the elements of the given enumerable object to the set and
-    # returns self.
-
-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.
-
-Special Thanks
---------------
-
-[Adam Sanderson](https://github.com/adamsanderson) for `comment` functionality.
-
-[Dmitry Elastic](https://github.com/dmitryelastic) for the brilliant Ruby 1.8 `source_location` hack.
+method_source
+=============
+
+(C) John Mair (banisterfiend) 2011
+
+_retrieve the sourcecode for a method_
+
+*NOTE:* This simply utilizes `Method#source_location`; it
+ does not access the live AST.
+
+`method_source` is a utility to return a method's sourcecode as a
+Ruby string. Also returns `Proc` and `Lambda` sourcecode.
+
+Method comments can also be extracted using the `comment` method.
+
+It is written in pure Ruby (no C).
+
+* Some Ruby 1.8 support now available. 
+
+`method_source` provides the `source` and `comment` methods to the `Method` and
+`UnboundMethod` and `Proc` classes.
+
+* Install the [gem](https://rubygems.org/gems/method_source): `gem install method_source`
+* Read the [documentation](http://rdoc.info/github/banister/method_source/master/file/README.markdown)
+* See the [source code](http://github.com/banister/method_source)
+
+Example: display method source
+------------------------------
+
+    Set.instance_method(:merge).source.display
+    # =>
+    def merge(enum)
+      if enum.instance_of?(self.class)
+        @hash.update(enum.instance_variable_get(:@hash))
+      else
+        do_with_enum(enum) { |o| add(o) }
+      end
+
+      self
+    end
+
+Example: display method comments
+--------------------------------
+
+    Set.instance_method(:merge).comment.display
+    # =>
+    # Merges the elements of the given enumerable object to the set and
+    # returns self.
+
+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.
+
+Special Thanks
+--------------
+
+[Adam Sanderson](https://github.com/adamsanderson) for `comment` functionality.
+
+[Dmitry Elastic](https://github.com/dmitryelastic) for the brilliant Ruby 1.8 `source_location` hack.

data/Rakefile

@@ -1,59 +1,59 @@
-dlext = Config::CONFIG['DLEXT']
-direc = File.dirname(__FILE__)
-
-require 'rake/clean'
-require 'rake/gempackagetask'
-require "#{direc}/lib/method_source/version"
-
-CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
-CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
-              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
-
-def apply_spec_defaults(s)
-  s.name = "method_source"
-  s.summary = "retrieve the sourcecode for a method"
-  s.version = MethodSource::VERSION
-  s.date = Time.now.strftime '%Y-%m-%d'
-  s.author = "John Mair (banisterfiend)"
-  s.email = 'jrmair@gmail.com'
-  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.homepage = "http://banisterfiend.wordpress.com"
-  s.has_rdoc = 'yard'
-  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
-                     "test/*.rb", "CHANGELOG", "README.markdown", "Rakefile", ".gemtest"]
-end
-
-task :test do
-  sh "bacon -k #{direc}/test/test.rb"
-end
-
-namespace :ruby do
-  spec = Gem::Specification.new do |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
-  end
-end
-
-desc "build all platform gems at once"
-task :gems => [:rmgems, "ruby:gem"]
-
-desc "remove all platform gems"
-task :rmgems => ["ruby:clobber_package"]
-
-desc "build and push latest gems"
-task :pushgems => :gems do
-  chdir("#{direc}/pkg") do
-    Dir["*.gem"].each do |gemfile|
-      sh "gem push #{gemfile}"
-    end
-  end
-end
+dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{direc}/lib/method_source/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+
+def apply_spec_defaults(s)
+  s.name = "method_source"
+  s.summary = "retrieve the sourcecode for a method"
+  s.version = MethodSource::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  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.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = 'yard'
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+                     "test/*.rb", "CHANGELOG", "README.markdown", "Rakefile", ".gemtest"]
+end
+
+task :test do
+  sh "bacon -k #{direc}/test/test.rb"
+end
+
+namespace :ruby do
+  spec = Gem::Specification.new do |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
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:rmgems, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{direc}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end

data/lib/method_source.rb

@@ -1,150 +1,174 @@
-# (C) John Mair (banisterfiend) 2010
-# MIT License
-
-direc = File.dirname(__FILE__)
-
-require "#{direc}/method_source/version"
-require "#{direc}/method_source/source_location"
-
-module MethodSource
-
-  if RUBY_VERSION =~ /1.9/
-    require 'ripper'
-
-    # Determine if a string of code is a valid Ruby expression.
-    # Ruby 1.9 uses Ripper, Ruby 1.8 uses RubyParser.
-    # @param [String] code The code to validate.
-    # @return [Boolean] Whether or not the code is a valid Ruby expression.
-    # @example
-    #   valid_expression?("class Hello") #=> false
-    #   valid_expression?("class Hello; end") #=> true
-    def self.valid_expression?(code)
-      !!Ripper::SexpBuilder.new(code).parse
-    end
-
-  else
-    require 'ruby_parser'
-
-    # Determine if a string of code is a valid Ruby expression.
-    # Ruby 1.9 uses Ripper, Ruby 1.8 uses RubyParser.
-    # @param [String] code The code to validate.
-    # @return [Boolean] Whether or not the code is a valid Ruby expression.
-    # @example
-    #   valid_expression?("class Hello") #=> false
-    #   valid_expression?("class Hello; end") #=> true
-    def self.valid_expression?(code)
-      RubyParser.new.parse(code)
-    rescue Racc::ParseError, SyntaxError
-      false
-    else
-      true
-    end
-  end
-
-  # Helper method responsible for extracting method body.
-  # Defined here to avoid polluting `Method` class.
-  # @param [Array] source_location The array returned by Method#source_location
-  # @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 }
-
-      code = ""
-      loop do
-        val = file.readline
-        code << val
-        
-        return code if valid_expression?(code)
-      end
-    end    
-  end
-  
-  # Helper method responsible for opening source file and buffering up
-  # 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, 
-        # but clear as soon as we hit a non comment line.
-        if (line =~ /^\s*#/) || (line =~ /^\s*$/)
-          buffer << line.lstrip
-        else
-          buffer.replace("")
-        end
-      end
-      
-      buffer
-    end
-  end
-  
-  # This module is to be included by `Method` and `UnboundMethod` and
-  # provides the `#source` functionality
-  module MethodExtensions
-    
-    # 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
-    # @example
-    #  Set.instance_method(:clear).source.display
-    #  =>
-    #     def clear
-    #       @hash.clear
-    #       self
-    #     end
-    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
-    # @example
-    #  Set.instance_method(:clear).comment.display
-    #  =>
-    #     # Removes all elements and returns self.
-    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})"
-      end
-
-      comment
-    end
-  end
-end
-
-class Method
-  include MethodSource::SourceLocation::MethodExtensions
-  include MethodSource::MethodExtensions
-end
-
-class UnboundMethod
-  include MethodSource::SourceLocation::UnboundMethodExtensions
-  include MethodSource::MethodExtensions
-end
-
-class Proc
-  include MethodSource::MethodExtensions
-end
+# (C) John Mair (banisterfiend) 2010
+# MIT License
+
+direc = File.dirname(__FILE__)
+
+require "#{direc}/method_source/version"
+require "#{direc}/method_source/source_location"
+
+module MethodSource
+
+  if RUBY_VERSION =~ /1.9/
+    require 'ripper'
+
+    # Determine if a string of code is a valid Ruby expression.
+    # Ruby 1.9 uses Ripper, Ruby 1.8 uses RubyParser.
+    # @param [String] code The code to validate.
+    # @return [Boolean] Whether or not the code is a valid Ruby expression.
+    # @example
+    #   valid_expression?("class Hello") #=> false
+    #   valid_expression?("class Hello; end") #=> true
+    def self.valid_expression?(code)
+      !!Ripper::SexpBuilder.new(code).parse
+    end
+
+  else
+    require 'ruby_parser'
+
+    # Determine if a string of code is a valid Ruby expression.
+    # Ruby 1.9 uses Ripper, Ruby 1.8 uses RubyParser.
+    # @param [String] code The code to validate.
+    # @return [Boolean] Whether or not the code is a valid Ruby expression.
+    # @example
+    #   valid_expression?("class Hello") #=> false
+    #   valid_expression?("class Hello; end") #=> true
+    def self.valid_expression?(code)
+      RubyParser.new.parse(code)
+    rescue Racc::ParseError, SyntaxError
+      false
+    else
+      true
+    end
+  end
+
+  # Helper method responsible for extracting method body.
+  # Defined here to avoid polluting `Method` class.
+  # @param [Array] source_location The array returned by Method#source_location
+  # @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 }
+
+      code = ""
+      loop do
+        val = file.readline
+        code << val
+        
+        return code if valid_expression?(code)
+      end
+    end    
+  end
+  
+  # Helper method responsible for opening source file and buffering up
+  # 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, 
+        # but clear as soon as we hit a non comment line.
+        if (line =~ /^\s*#/) || (line =~ /^\s*$/)
+          buffer << line.lstrip
+        else
+          buffer.replace("")
+        end
+      end
+      
+      buffer
+    end
+  end
+  
+  # This module is to be included by `Method` and `UnboundMethod` and
+  # provides the `#source` functionality
+  module MethodExtensions
+
+    # We use the included hook to patch Method#source on rubinius.
+    # We need to use the included hook as Rubinius defines a `source`
+    # on Method so including a module will have no effect (as it's
+    # higher up the MRO).
+    # @param [Class] klass The class that includes the module.
+    def self.included(klass)
+      if klass.method_defined?(:source) && Object.const_defined?(:RUBY_ENGINE) &&
+          RUBY_ENGINE =~ /rbx/
+
+        klass.class_eval do
+          orig_source = instance_method(:source)
+          
+          define_method(:source) do
+            begin
+              super
+            rescue
+              orig_source.bind(self).call
+            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
+    # @example
+    #  Set.instance_method(:clear).source.display
+    #  =>
+    #     def clear
+    #       @hash.clear
+    #       self
+    #     end
+    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
+    # @example
+    #  Set.instance_method(:clear).comment.display
+    #  =>
+    #     # Removes all elements and returns self.
+    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})"
+      end
+
+      comment
+    end
+  end
+end
+
+class Method
+  include MethodSource::SourceLocation::MethodExtensions
+  include MethodSource::MethodExtensions
+end
+
+class UnboundMethod
+  include MethodSource::SourceLocation::UnboundMethodExtensions
+  include MethodSource::MethodExtensions
+end
+
+class Proc
+  include MethodSource::MethodExtensions
+end

data/lib/method_source/source_location.rb

@@ -1,60 +1,60 @@
-module MethodSource
-  module SourceLocation
-    module MethodExtensions
-
-      def trace_func(event, file, line, id, binding, classname)
-        return unless event == 'call'
-        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
-      #   method definition is found.
-      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 
-          @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 UnboundMethodExtensions
-
-      # Return the source location of an instance 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
-      #   method definition is found.
-      def source_location
-        klass = case owner
-                when Class
-                  owner
-                when Module
-                  method_owner = owner
-                  Class.new { include(method_owner) }
-                end
-
-        begin
-          klass.allocate.method(name).source_location
-        rescue TypeError
-
-          # Assume we are dealing with a Singleton Class:
-          # 1. Get the instance object
-          # 2. Forward the source_location lookup to the instance
-          instance ||= ObjectSpace.each_object(owner).first
-          instance.method(name).source_location
-        end
-      end
-    end
-  end
-end
+module MethodSource
+  module SourceLocation
+    module MethodExtensions
+
+      def trace_func(event, file, line, id, binding, classname)
+        return unless event == 'call'
+        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
+      #   method definition is found.
+      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 
+          @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 UnboundMethodExtensions
+
+      # Return the source location of an instance 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
+      #   method definition is found.
+      def source_location
+        klass = case owner
+                when Class
+                  owner
+                when Module
+                  method_owner = owner
+                  Class.new { include(method_owner) }
+                end
+
+        begin
+          klass.allocate.method(name).source_location
+        rescue TypeError
+
+          # Assume we are dealing with a Singleton Class:
+          # 1. Get the instance object
+          # 2. Forward the source_location lookup to the instance
+          instance ||= ObjectSpace.each_object(owner).first
+          instance.method(name).source_location
+        end
+      end
+    end
+  end
+end

data/lib/method_source/version.rb

@@ -1,3 +1,3 @@
-module MethodSource
-  VERSION = "0.3.4"
-end
+module MethodSource
+  VERSION = "0.3.5"
+end

data/test/test.rb

@@ -1,100 +1,100 @@
-direc = File.dirname(__FILE__)
-
-require 'bacon'
-require "#{direc}/../lib/method_source"
-require "#{direc}/test_helper"
-
-describe MethodSource do
-
-  before do
-    @hello_module_source = "  def hello; :hello_module; end\n"
-    @hello_singleton_source = "def $o.hello; :hello_singleton; end\n"
-    @hello_source = "def hello; :hello; end\n"
-    @hello_comment = "# A comment for hello\n# It spans two lines and is indented by 2 spaces\n"
-    @lambda_comment = "# This is a comment for MyLambda\n"
-    @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
-    Proc.method_defined?(:source).should == true
-  end
-
-  describe "Methods" do
-    it 'should return source for method' do
-      method(:hello).source.should == @hello_source
-    end
-
-    it 'should return source for a method defined in a module' do
-      M.instance_method(:hello).source.should == @hello_module_source
-    end
-
-    it 'should return source for a singleton method as an instance method' do
-      class << $o; self; end.instance_method(:hello).source.should == @hello_singleton_source
-    end
-
-    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
-    end
-  end
-
-  if RUBY_VERSION =~ /1.9/
-    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
-  describe "Comment tests" do
-    before do
-      @comment1 = "# a\n# b\n"
-      @comment2 = "# a\n# b\n"
-      @comment3 = "# a\n#\n# b\n"
-      @comment4 = "# a\n# b\n"
-      @comment5 = "# a\n# b\n# c\n# d\n"
-    end
-
-    it "should correctly extract multi-line comments" do
-      method(:comment_test1).comment.should == @comment1
-    end
-
-    it "should correctly strip leading whitespace before comments" do
-      method(:comment_test2).comment.should == @comment2
-    end
-
-    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
+direc = File.dirname(__FILE__)
+
+require 'bacon'
+require "#{direc}/../lib/method_source"
+require "#{direc}/test_helper"
+
+describe MethodSource do
+
+  before do
+    @hello_module_source = "  def hello; :hello_module; end\n"
+    @hello_singleton_source = "def $o.hello; :hello_singleton; end\n"
+    @hello_source = "def hello; :hello; end\n"
+    @hello_comment = "# A comment for hello\n# It spans two lines and is indented by 2 spaces\n"
+    @lambda_comment = "# This is a comment for MyLambda\n"
+    @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
+    Proc.method_defined?(:source).should == true
+  end
+
+  describe "Methods" do
+    it 'should return source for method' do
+      method(:hello).source.should == @hello_source
+    end
+
+    it 'should return source for a method defined in a module' do
+      M.instance_method(:hello).source.should == @hello_module_source
+    end
+
+    it 'should return source for a singleton method as an instance method' do
+      class << $o; self; end.instance_method(:hello).source.should == @hello_singleton_source
+    end
+
+    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
+    end
+  end
+
+  if RUBY_VERSION =~ /1.9/
+    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
+  describe "Comment tests" do
+    before do
+      @comment1 = "# a\n# b\n"
+      @comment2 = "# a\n# b\n"
+      @comment3 = "# a\n#\n# b\n"
+      @comment4 = "# a\n# b\n"
+      @comment5 = "# a\n# b\n# c\n# d\n"
+    end
+
+    it "should correctly extract multi-line comments" do
+      method(:comment_test1).comment.should == @comment1
+    end
+
+    it "should correctly strip leading whitespace before comments" do
+      method(:comment_test2).comment.should == @comment2
+    end
+
+    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

data/test/test_helper.rb

@@ -1,41 +1,41 @@
-module M
-  def hello; :hello_module; end
-end
-
-$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
-
-# a
-# b
-def comment_test1; end
-
- # a
- # b
-def comment_test2; end
-
-# a
-#
-# b
-def comment_test3; end
-
-# a
-
-# b
-def comment_test4; end
-
-
-# a
-  # b
-    # c
-# d
-def comment_test5; end
-
-# This is a comment for MyLambda
-MyLambda = lambda { :lambda }
-MyProc = Proc.new { :proc }
-
+module M
+  def hello; :hello_module; end
+end
+
+$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
+
+# a
+# b
+def comment_test1; end
+
+ # a
+ # b
+def comment_test2; end
+
+# a
+#
+# b
+def comment_test3; end
+
+# a
+
+# b
+def comment_test4; end
+
+
+# a
+  # b
+    # c
+# d
+def comment_test5; end
+
+# This is a comment for MyLambda
+MyLambda = lambda { :lambda }
+MyProc = Proc.new { :proc }
+

metadata

@@ -1,48 +1,64 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: method_source
-version: !ruby/object:Gem::Version
-  version: 0.3.4
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 5
+  version: 0.3.5
 platform: ruby
-authors:
+authors: 
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-28 00:00:00.000000000 +13:00
+
+date: 2011-03-05 00:00:00 +13:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: ruby_parser
-  requirement: &17300892 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 5
         version: 2.0.5
   type: :runtime
-  prerelease: false
-  version_requirements: *17300892
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bacon
-  requirement: &17300544 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
   type: :development
-  prerelease: false
-  version_requirements: *17300544
+  version_requirements: *id002
 description: retrieve the sourcecode for a method
 email: jrmair@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- lib/method_source/source_location.rb
-- lib/method_source/version.rb
+
+files: 
 - lib/method_source.rb
+- lib/method_source/version.rb
+- lib/method_source/source_location.rb
 - test/test.rb
 - test/test_helper.rb
 - README.markdown
@@ -51,26 +67,34 @@ files:
 has_rdoc: true
 homepage: http://banisterfiend.wordpress.com
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: retrieve the sourcecode for a method
 test_files: []
+