IHelp 0.4.0 - full text search

View and search object documentation from irb.

sudo gem install ihelp

Downloads: http://rubyforge.org/frs/?group_id=2597
Documentation: http://ihelp.rubyforge.org
Project page: http://rubyforge.org/projects/ihelp/
Screenshots:
http://ihelp.rubyforge.org/ihelp1.png
http://ihelp.rubyforge.org/ihelp2.png

REQUIREMENTS

NEW FEATURES

On a bit of a similar tack with Mauricio, I wrote a full-text search
over RI docs to IHelp. Being a good deal less hardcore than him, I
used Ferret to achieve the task.

I think we’ll merge the shared functionality some day, I’d rather roll
all the nifty backend stuff into RI and have IHelp be a user interface
to it.

QUICK USAGE

“How do I justify a string?”
ihelp ‘justifying strings’
ihelp ‘How do I justify a string?’ # watch out for noise words

“I need to read little-endian ints from a string”

String.help ‘little-endian int’

“Hmm, how does String#unpack work?”

String.help:unpack

“Okay, so now I have this Array of ints, what was the syntax of inject
again?”

ints.help:inject

“What is this object and what can i do with it?”

object.help

“Someone told me that I should look up Mutex#synchronize… but I
don’t have that loaded.”

help “Mutex#synchronize”

LOADING AUTOMATICALLY IN IRB

Add the following to your .irbrc:

Loading RI may take a second or two so let’s make it

snappier by loading in the background.

Thread.new do
require ‘ihelp’
end

If you don’t like the colors in the search results

IHelp.no_colors = true

Renderer to use, one of ‘ri’, ‘rubydoc’, ‘emacs’, ‘source’, ‘html’

default is ‘ri’

IHelp.renderer = ‘rubydoc’

Web browser to use with renderers ‘rubydoc’ and ‘html’

default is ‘firefox’

IHelp.web_browser = ‘konqueror’

Ilmari H. írta:

View and search object documentation from irb.

sudo gem install ihelp
gem install ihelp
Building native extensions. This could take a while…
No builder for extension ‘lib/ihelp_reindex.rb’
ERROR: While executing gem … (RuntimeError)
ERROR: Failed to build gem native extension.
Gem files will remain installed in
/usr/lib/ruby/gems/1.8/gems/ihelp-0.4.0 for inspection.
No builder for extension ‘lib/ihelp_reindex.rb’

– what can be the problem?

Hi,

On 11/17/06, Parragh S. [email protected] wrote:

/usr/lib/ruby/gems/1.8/gems/ihelp-0.4.0 for inspection.
No builder for extension ‘lib/ihelp_reindex.rb’

– what can be the problem?

Argh, the problem is me using an old version of RubyGems for testing.
I’m using gemspec #extensions to run the reindexing, but it appears to
have changed.

Thanks for noticing this, should be fixed in 0.4.1.

How can i unsubscribe??

Thanx.

Thanks for noticing this, should be fixed in 0.4.1.

Make that 0.4.2. Which is out now.

:From => “Ilmari H. [mailto:[email protected]]”

used Ferret to achieve the task.

ouch.
is ferret pure ruby? i have problems installing it in windows.

C:\temp>gem update
Updating installed gems…
Need to update 12 gems from http://gems.rubyforge.org

complete
Attempting remote update of ihelp
Install required dependency ferret? [Yn]
Building native extensions. This could take a while…

ERROR: While executing gem … (RuntimeError)
ERROR: Failed to build gem native extension.
Gem files will remain installed in
c:/ruby/lib/ruby/gems/1.8/gems/ferret-0.10.13
for inspection.

I think we’ll merge the shared functionality some day, I’d rather roll

am enjoying fri now. is it hard to link w fri?

thanks for the useful ihelp.
kind regards -botp

Ilmari H. írta:

Thanks for noticing this, should be fixed in 0.4.1.

Make that 0.4.2. Which is out now.
0.4.3 was it this morning:) But I get the following on my Ubuntu box:

require ‘ihelp’
/usr/lib/ruby/gems/1.8/gems/ihelp-0.4.3/lib/ihelp.rb:318: warning:
already initialized constant RI_ARGS
=> true

String.help:unpack

unrecognized option `–readline’

For help on options, try ‘ri --help’

–> and irb exits.

On 11/17/06, Peña, Botp [email protected] wrote:

:From => “Ilmari H. [mailto:[email protected]]”

used Ferret to achieve the task.

ouch.
is ferret pure ruby? i have problems installing it in windows.

Ack, good point. There however is a 0.10.9 windows binary and the
Linux version of that seems to work alright. Could you try installing
ferret-0.10.9-mswin32 and see if it works (as I don’t have Windows
handy |: )?

Just made a 0.4.3 gem without ferret in the gem dependency list.
Without ferret it doesn’t do text search, but works otherwise.

I think we’ll merge the shared functionality some day, I’d rather roll

am enjoying fri now. is it hard to link w fri?

I’ve no idea, probably not too hard? I’ll look into it over the weekend.

thanks for the useful ihelp.
kind regards -botp

cheers,

On 11/17/06, Parragh S. [email protected] wrote:

String.help:unpack

unrecognized option `–readline’

For help on options, try ‘ri --help’

–> and irb exits.

And I thought I was doing a good thing passing ARGV to RI…
Thanks for proving me wrong, disabled it in 0.4.4

On 11/17/06, Hugo R. Brandao [email protected] wrote:

How can i unsubscribe??

Thanx.

Please read:

http://www.ruby-lang.org/en/community/mailing-lists/manual-instructions/

http://www.ruby-lang.org/en/community/mailing-lists/

gnufied

Parragh S. írta:

Ilmari H. írta:

And I thought I was doing a good thing passing ARGV to RI…
Thanks for proving me wrong, disabled it in 0.4.4
I updatet – now it’s okay. But now irb opens the help text in the
pager – can I turn it off?

Oh, now I see:
a) either you pass them => they might conflict,
b) or you don’t => than no clever RI settings
– that’s a nice one;)

Ilmari H. írta:

And I thought I was doing a good thing passing ARGV to RI…
Thanks for proving me wrong, disabled it in 0.4.4
I updatet – now it’s okay. But now irb opens the help text in the pager
– can I turn it off?

On 11/19/06, Parragh S. [email protected] wrote:

b) or you don’t => than no clever RI settings
– that’s a nice one;)

A workaround would be setting ENV[“PAGER”] to cat

Or maybe I could pass only ENV[“RI”] and not merge it with ARGV (no
idea what I was thinking there) :]

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs