What Do You Want From Your Ruby Gem Search Tool?

by Tony Stubblebine

I want to be able to read the documentation, that's what.

I can never make heads or tails of a module until I get past the title and summary and into the actual documentation. That's where you learn that the 'simple to use framework for foo' is only 5% completed or that the code was written for your peers on Mars, or, sometimes, that you've found that rare piece of software that's going to make your life easier.

So I created GemJack.com, a site with rdoc documentation for every ruby gems. Itch scratched.

I'd like to do more, like real search (CTRL-F for now), comments, RSS, and download stats. What would you want to see?

9 Comments

topfunky
2006-05-18 17:08:40
Simple and relevant. I'm looking forward to the simple search enhancements.
jonbaer
2006-05-18 19:54:44
Very helpful .. thanks. It would be great to see some type of lookup API come from this that an IDE like TextMate could take advantage of (or pipe to).
pate
2006-05-18 21:02:21
An API would be great.


A rating system would be cool.


A set of simple metrics/info (dependecies, #downloads, etc.) would be interesting.


Thanks for doing this much.

Sebastian Gräßl
2006-05-19 02:22:26
Categories or tags, are the most effective way to setup a search. The Projects tree on Rubyforge isn't really helpful
@topfunky: a bundle for textmate is no problem i think. if you would give me some more inspiration i can start this weekend. :)
DeeJay
2006-05-19 03:27:20

Potentially very useful, if you can commit to maintaining it.


But..


Coverage is not complete. rake and rspec are missing, to name
just two that I have looked for.


How do you decide what to include and what to leave out?


DJ

Tony Stubblebine
2006-05-19 10:51:48
DJ:


Good point... it's an automated update based on the gems repository - which isn't to say that it's perfect and reliable yet. But I think it'll get there and that it won't require manual updating. Will get rake up there shortly.

Brian Cooke
2006-05-23 10:39:33

This sounds a lot like what I use search.cpan.org for on the Perl side.


In addition to reading the docs with it, I also use the full file navigation functionality, which lets me navigate the distribution's directory structure and look inside the various files. Especially handy for reading full source code. I'd love to see that included here.

Alex
2007-04-16 11:16:37
works
Dave
2008-02-27 04:46:27
http://gemjack.com/ truly rocks as a great source for ruby code, very nice job. I've tried using ruby for my site, but ended with more errors than I started with so I switched to php.