summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorJohn Mair <jrmair@gmail.com>2011-02-28 03:40:47 +1300
committerJohn Mair <jrmair@gmail.com>2011-02-28 03:40:47 +1300
commit52ef85631d136a4ff31c0f4c2587b19db3daf512 (patch)
treefcad597e22e22a576fd6ac74b878e89785012d67 /README.markdown
parent8f6b36637263a79ae4ac96ec734b1851614a4e19 (diff)
downloadmethod_source-dev.tar.gz
version 0.3.0, some ruby 1.8 supportdev
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown17
1 files changed, 7 insertions, 10 deletions
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.