Contents

## Method Log

Trace the history of an individual method in a git repository (experimental).

### Requirements

* Ruby >= v1.9.3 (due to requirements of the `rugged` gem)
* The [rugged](https://github.com/libgit2/rugged) Ruby gem (listed as dependency in gemspec)
* The [libgit2](https://github.com/libgit2/libgit2) C library (included as part of rugged gem)
* The [parser](https://github.com/whitequark/parser) Ruby gem (listed as dependency in gemspec)

### Install

    gem install method_log

### Run

    $ method_log <options> <method-signature>
    
    # options:
    --patch, -p:                                  Generate patch.
    --ruby-version, -r <s>:                       Parser Ruby version (18, 19, 20, 21) (default: current)
    --max-count, -n <i>:                          Limit the number of commits to output.
    --stop-at-latest-introduction-of-method, -s:  Stop at lastest introduction of method.
    --help, -h:                                   Show usage.
    
    # method-signature
    Uses the Ruby Index format e.g. Foo#bar, Bar::Baz#foo, Baz.foo.

### Todo

* Support for Rspec tests
* Default to looking for commits in current git branch
* Check what happens with merge commits
* Maybe add as new git command or extension to existing command e.g. `git log`
* Optimise search for method definitions:
  * First look in file where method was last defined
* Find "similar" method implementations e.g. by comparing ASTs of implementations

### Credits

Written by [James Mead](http://jamesmead.org) and the other members of [Go Free Range](http://gofreerange.com).

Thanks to Michael Feathers for some ideas in [delta-flora](https://github.com/michaelfeathers/delta-flora).

Thanks to [TICOSA](http://ticosa.org/) for giving me the impetus to do something about an idea I'd been kicking around for a while.

### License

Released under the [MIT License](https://github.com/freerange/method_log/blob/master/LICENSE).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
method_log-0.0.7	README.md