README.md in method_log-0.1.1 vs README.md in method_log-0.2.0
- old
+ new
@@ -2,35 +2,31 @@
Trace the history of an individual method in a git repository (experimental).
### Requirements
-* Ruby >= v1.9.3 (due to requirements of the `rugged` gem)
+* Ruby >= v2.0.0 (due to requirements of the `parser` gem); although parsing of source code for Ruby >= v1.8 is possible
* 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.
+#### Display the commit history for a single method
-### Todo
+ $ method_log [options] <method-signature>
-* Support for Rspec tests
+#### Build a parallel git repository of method definitions
+
+ $ build_methods_repo [options] <source-repo-path> <target-repo-path>
+
+### To Do
+
+* Parsing 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`
* Find "similar" method implementations e.g. by comparing ASTs of implementations