summaryrefslogtreecommitdiff
path: root/README.markdown
blob: 44382c260a4ea54985403955f34482691dfd24c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
method_source
=============

(C) John Mair (banisterfiend) 2010

_retrieve the sourcecode for a method_

*NOTE:* This is nothing fancy; it simply utilizes `Method#source_location`
in Ruby 1.9

`method_source` is a utility to return a method's sourcecode as a
Ruby string. Also returns `Proc` and `Lambda` sourcecode.

It is written in pure Ruby (no C).

`method_source` provides the `source` method 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: methods
----------------

    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

Limitations:
------------

* Only works with Ruby 1.9+ 
* 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.