Merge lp:~max-rabkin/ibid/helpful-help into lp:~ibid-core/ibid/old-trunk-1.6

[Max Rabkin]

[Max Rabkin (max-rabkin)]

Suggestions for alternative syntaxes if you have them, please.

[Stefano Rivera (stefanor)]

Can't complain

review: Approve

[Michael Gorven (mgorven)]

Nice
 review approve

review: Approve

[Jonathan Hitchcock (vhata)]

This is cool, although I think it's just a first step towards properly helpful help.

Let's get this in, and then think about how to improve it more?

Approve.

review: Approve

=== modified file 'ibid/plugins/help.py'
--- ibid/plugins/help.py	2009-12-30 15:12:15 +0000
+++ ibid/plugins/help.py	2010-01-06 23:10:22 +0000
@@ -1,4 +1,5 @@
 import inspect
+import sys
 
 import ibid
 from ibid.plugins import Processor, match
@@ -7,7 +8,7 @@
 help = {'help': u'Provides help and usage information about plugins.'}
 
 class Help(Processor):
-    u"""features
+    u"""features [for <word>]
     help [<feature>]
     usage <feature>"""
     feature = 'help'
@@ -64,4 +65,36 @@
         else:
             event.addresponse(u"I don't know how to use %s either", feature)
 
+    @match(r'^features\s+(?:for|with)\s+(.*)$')
+    def search (self, event, phrase):
+        features = map(unicode, self._search(phrase))
+        features.sort()
+        if len(features) == 0:
+            event.addresponse(u"I couldn't find that feature.")
+        elif len(features) == 1:
+            event.addresponse(
+                u'The "%s" feature might be what you\'re looking for.',
+                features[0])
+        else:
+            event.addresponse(u"Are you looking for %s?",
+                            human_join(features, conjunction='or'))
+
+    def _search (self, phrase):
+        phrase = phrase.lower()
+        matches = set()
+        processor_modules = set()
+        for processor in ibid.processors:
+            if (hasattr(processor, 'feature') and processor.__doc__ and
+                phrase in processor.__doc__.lower()):
+                matches.add(processor.feature)
+            processor_modules.add(sys.modules[processor.__module__])
+
+        for module in processor_modules:
+            if hasattr(module, 'help'):
+                for feature, help in module.help.iteritems():
+                    if phrase in feature or phrase in help.lower():
+                        matches.add(feature)
+
+        return matches
+
 # vi: set et sta sw=4 ts=4: