From 52ef85631d136a4ff31c0f4c2587b19db3daf512 Mon Sep 17 00:00:00 2001 From: John Mair Date: Mon, 28 Feb 2011 03:40:47 +1300 Subject: version 0.3.0, some ruby 1.8 support --- README.markdown | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index bc42a82..bb1c83d 100644 --- a/README.markdown +++ b/README.markdown @@ -1,11 +1,11 @@ method_source ============= -(C) John Mair (banisterfiend) 2010 +(C) John Mair (banisterfiend) 2011 _retrieve the sourcecode for a method_ -*NOTE:* This simply utilizes `Method#source_location` in Ruby 1.9; it +*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 @@ -15,6 +15,8 @@ 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. @@ -48,19 +50,14 @@ Example: display method comments Limitations: ------------ -* Only works with Ruby 1.9+ +* 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. -Possible Applications: ----------------------- - -* Combine with [RubyParser](https://github.com/seattlerb/ruby_parser) - for extra fun. - - 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. -- cgit v1.2.1