Added Topic in the new plugin format.

plugins/Topic/README.txt

@@ -0,0 +1 @@
+Insert a description of your plugin here, with any notes, etc. about using it.

plugins/Topic/__init__.py

@@ -0,0 +1,60 @@
+###
+# Copyright (c) 2005, Jeremiah Fincher
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+"""
+Provides commands for manipulating channel topics.
+"""
+
+import supybot
+import supybot.world as world
+
+# Use this for the version of this plugin.  You may wish to put a CVS keyword
+# in here if you're keeping the plugin in CVS or some similar system.
+__version__ = "%%VERSION%%"
+
+__author__ = supybot.authors.jemfinch
+
+# This is a dictionary mapping supybot.Author instances to lists of
+# contributions.
+__contributors__ = {}
+
+import config
+import plugin
+reload(plugin) # In case we're being reloaded.
+# Add more reloads here if you add third-party modules and want them to be
+# reloaded when this plugin is reloaded.  Don't forget to import them as well!
+
+if world.testing:
+    import test
+
+Class = plugin.Class
+configure = config.configure
+
+
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:

plugins/Topic/config.py

@@ -0,0 +1,73 @@
+###
+# Copyright (c) 2005, Jeremiah Fincher
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+import supybot.conf as conf
+import supybot.registry as registry
+
+def configure(advanced):
+    # This will be called by supybot to configure this module.  advanced is
+    # a bool that specifies whether the user identified himself as an advanced
+    # user or not.  You should effect your configuration by manipulating the
+    # registry as appropriate.
+    from supybot.questions import expect, anything, something, yn
+    conf.registerPlugin('Topic', True)
+
+
+class TopicFormat(registry.String):
+    "Value must include $topic, otherwise the actual topic would be left out."
+    def setValue(self, v):
+        if '$topic' in v or '${topic}' in v:
+            registry.String.setValue(self, v)
+        else:
+            self.error()
+
+Topic = conf.registerPlugin('Topic')
+conf.registerChannelValue(Topic, 'separator',
+    registry.StringSurroundedBySpaces(' || ', """Determines what separator is
+    used between individually added topics in the channel topic."""))
+conf.registerChannelValue(Topic, 'format',
+    TopicFormat('$topic ($nick)', """Determines what format is used to add
+    topics in the topic.  All the standard substitutes apply, in addiction to
+    "$topic" for the topic itself."""))
+conf.registerChannelValue(Topic, 'recognizeTopiclen',
+    registry.Boolean(True, """Determines whether the bot will recognize the
+    TOPICLEN value sent to it by the server and thus refuse to send TOPICs
+    longer than the TOPICLEN.  These topics are likely to be truncated by the
+    server anyway, so this defaults to True."""))
+conf.registerChannelValue(Topic, 'default',
+    registry.String('', """Determines what the default topic for the channel
+    is.  This is used by the default command to set this topic."""))
+conf.registerGroup(Topic, 'undo')
+conf.registerChannelValue(Topic.undo, 'max',
+    registry.NonNegativeInteger(10, """Determines the number of previous
+    topics to keep around in case the undo command is called."""))
+
+
+
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78

plugins/Topic/plugin.py

@@ -0,0 +1,427 @@
+###
+# Copyright (c) 2002-2004, Jeremiah Fincher
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+import re
+import random
+
+import supybot.conf as conf
+import supybot.utils as utils
+from supybot.commands import *
+import supybot.ircmsgs as ircmsgs
+import supybot.plugins as plugins
+import supybot.ircutils as ircutils
+import supybot.callbacks as callbacks
+
+def canChangeTopic(irc, msg, args, state):
+    assert not state.channel
+    callConverter('channel', irc, msg, args, state)
+    callConverter('inChannel', irc, msg, args, state)
+    if state.channel not in irc.state.channels:
+        irc.error(format('I\'m not currently in %s.', state.channel),Raise=True)
+    c = irc.state.channels[state.channel]
+    if irc.nick not in c.ops and 't' in c.modes:
+        irc.error(format('I can\'t change the topic, I\'m not opped '
+                         'and %s is +t.', state.channel), Raise=True)
+
+def getTopic(irc, msg, args, state, format=True):
+    separator = state.cb.registryValue('separator', state.channel)
+    if separator in args[0]:
+        irc.errorInvalid('topic', args[0],
+                         format('The topic must not include %s.', separator))
+    topic = args.pop(0)
+    if format:
+        env = {'topic': topic}
+        formatter = state.cb.registryValue('format', state.channel)
+        topic = ircutils.standardSubstitute(irc, msg, formatter, env)
+    state.args.append(topic)
+
+def getTopicNumber(irc, msg, args, state):
+    def error(s):
+        irc.errorInvalid('topic number', s)
+    try:
+        n = int(args[0])
+        if not n:
+            raise ValueError
+    except ValueError:
+        error(args[0])
+    if n > 0:
+        n -= 1
+    topic = irc.state.getTopic(state.channel)
+    separator = state.cb.registryValue('separator', state.channel)
+    topics = splitTopic(topic, separator)
+    if not topics:
+        irc.error(format('There are no topics in %s.', state.channel),
+                  Raise=True)
+    try:
+        topics[n]
+    except IndexError:
+        error(str(n))
+    del args[0]
+    while n < 0:
+        n += len(topics)
+    state.args.append(n)
+
+addConverter('topic', getTopic)
+addConverter('topicNumber', getTopicNumber)
+addConverter('canChangeTopic', canChangeTopic)
+
+def splitTopic(topic, separator):
+    return filter(None, topic.split(separator))
+
+class Topic(callbacks.Privmsg):
+    def __init__(self, irc):
+        self.__parent = super(Topic, self)
+        self.__parent.__init__(irc)
+        self.undos = ircutils.IrcDict()
+        self.redos = ircutils.IrcDict()
+        self.lastTopics = ircutils.IrcDict()
+        self.watchingFor332 = ircutils.IrcSet()
+
+    def _splitTopic(self, topic, channel):
+        separator = self.registryValue('separator', channel)
+        return splitTopic(topic, separator)
+
+    def _joinTopic(self, channel, topics):
+        separator = self.registryValue('separator', channel)
+        return separator.join(topics)
+
+    def _addUndo(self, channel, topics):
+        stack = self.undos.setdefault(channel, [])
+        stack.append(topics)
+        maxLen = self.registryValue('undo.max', channel)
+        del stack[:len(stack)-maxLen]
+
+    def _addRedo(self, channel, topics):
+        stack = self.redos.setdefault(channel, [])
+        stack.append(topics)
+        maxLen = self.registryValue('undo.max', channel)
+        del stack[:len(stack)-maxLen]
+
+    def _getUndo(self, channel):
+        try:
+            return self.undos[channel].pop()
+        except (KeyError, IndexError):
+            return None
+
+    def _getRedo(self, channel):
+        try:
+            return self.redos[channel].pop()
+        except (KeyError, IndexError):
+            return None
+
+    def _sendTopics(self, irc, channel, topics, isDo=False):
+        topics = [s for s in topics if s and not s.isspace()]
+        self.lastTopics[channel] = topics
+        newTopic = self._joinTopic(channel, topics)
+        try:
+            maxLen = irc.state.supported['topiclen']
+            if len(newTopic) > maxLen:
+                if self.registryValue('recognizeTopiclen', channel):
+                    irc.error(format('That topic is too long for this server '
+                                     '(maximum length: %s).', maxLen),
+                              Raise=True)
+        except KeyError:
+            pass
+        self._addUndo(channel, topics)
+        if not isDo and channel in self.redos:
+            del self.redos[channel]
+        irc.queueMsg(ircmsgs.topic(channel, newTopic))
+        irc.noReply()
+
+    def doJoin(self, irc, msg):
+        if ircutils.strEqual(msg.nick, irc.nick):
+            # We're joining a channel, let's watch for the topic.
+            self.watchingFor332.add(msg.args[0])
+
+    def do332(self, irc, msg):
+        if msg.args[1] in self.watchingFor332:
+            self.watchingFor332.remove(msg.args[1])
+
+    def topic(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Returns the topic for <channel>.  <channel> is only necessary if the
+        message isn't sent in the channel itself.
+        """
+        topic = irc.state.channels[channel].topic
+        irc.reply(topic)
+    topic = wrap(topic, ['inChannel'])
+
+    def add(self, irc, msg, args, channel, topic):
+        """[<channel>] <topic>
+
+        Adds <topic> to the topics for <channel>.  <channel> is only necessary
+        if the message isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        topics.append(topic)
+        self._sendTopics(irc, channel, topics)
+    add = wrap(add, ['canChangeTopic', rest('topic')])
+
+    def replace(self, irc, msg, args, channel, i, topic):
+        """[<channel>] <number> <topic>
+
+        Replaces topic <number> with <topic>.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        topics[i] = topic
+        self._sendTopics(irc, channel, topics)
+    replace = wrap(replace, ['canChangeTopic', 'topicNumber', rest('topic')])
+
+    def insert(self, irc, msg, args, channel, topic):
+        """[<channel>] <topic>
+
+        Adds <topic> to the topics for <channel> at the beginning of the topics
+        currently on <channel>.  <channel> is only necessary if the message
+        isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        topics.insert(0, topic)
+        self._sendTopics(irc, channel, topics)
+    insert = wrap(insert, ['canChangeTopic', rest('topic')])
+
+    def shuffle(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Shuffles the topics in <channel>.  <channel> is only necessary if the
+        message isn't sent in the channel itself.
+        """
+        newtopic = irc.state.getTopic(channel)
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        if len(topics) == 0 or len(topics) == 1:
+            irc.error('I can\'t shuffle 1 or fewer topics.', Raise=True)
+        elif len(topics) == 2:
+            topics.reverse()
+        else:
+            original = topics[:]
+            while topics == original:
+                random.shuffle(topics)
+        self._sendTopics(irc, channel, topics)
+    shuffle = wrap(shuffle, ['canChangeTopic'])
+
+    def reorder(self, irc, msg, args, channel, numbers):
+        """[<channel>] <number> [<number> ...]
+
+        Reorders the topics from <channel> in the order of the specified
+        <number> arguments.  <number> is a one-based index into the topics.
+        <channel> is only necessary if the message isn't sent in the channel
+        itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        num = len(topics)
+        if num == 0 or num == 1:
+            irc.error('I cannot reorder 1 or fewer topics.', Raise=True)
+        if len(numbers) != num:
+            irc.error('All topic numbers must be specified.', Raise=True)
+        if sorted(numbers) != range(num):
+            irc.error('Duplicate topic numbers cannot be specified.')
+            return
+        newtopics = [topics[i] for i in numbers]
+        self._sendTopics(irc, channel, newtopics)
+    reorder = wrap(reorder, ['canChangeTopic', many('topicNumber')])
+
+    def list(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Returns a list of the topics in <channel>, prefixed by their indexes.
+        Mostly useful for topic reordering.  <channel> is only necessary if the
+        message isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        L = []
+        for (i, t) in enumerate(topics):
+            L.append(format('%s: %s', i+1, utils.str.ellipsisify(t, 30)))
+        s = utils.str.commaAndify(L)
+        irc.reply(s)
+    list = wrap(list, ['inChannel'])
+
+    def get(self, irc, msg, args, channel, number):
+        """[<channel>] <number>
+
+        Returns topic number <number> from <channel>.  <number> is a one-based
+        index into the topics.  <channel> is only necessary if the message
+        isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        irc.reply(topics[number])
+    get = wrap(get, ['inChannel', 'topicNumber'])
+
+    def change(self, irc, msg, args, channel, number, replacer):
+        """[<channel>] <number> <regexp>
+
+        Changes the topic number <number> on <channel> according to the regular
+        expression <regexp>.  <number> is the one-based index into the topics;
+        <regexp> is a regular expression of the form
+        s/regexp/replacement/flags.  <channel> is only necessary if the message
+        isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        topics[number] = replacer(topics[number])
+        self._sendTopics(irc, channel, topics)
+    change = wrap(change, ['canChangeTopic', 'topicNumber', 'regexpReplacer'])
+
+    def set(self, irc, msg, args, channel, number, topic):
+        """[<channel>] [<number>] <topic>
+
+        Sets the topic <number> to be <text>.  If no <number> is given, this
+        sets the entire topic.  <channel> is only necessary if the message
+        isn't sent in the channel itself.
+        """
+        if number:
+            topics = self._splitTopic(irc.state.getTopic(channel), channel)
+            topics[number] = topic
+        else:
+            topics = [topic]
+        self._sendTopics(irc, channel, topics)
+    set = wrap(set, ['canChangeTopic',
+                     optional('topicNumber', 0),
+                     rest(('topic', False))])
+
+    def remove(self, irc, msg, args, channel, number):
+        """[<channel>] <number>
+
+        Removes topic <number> from the topic for <channel>  Topics are
+        numbered starting from 1; you can also use negative indexes to refer
+        to topics starting the from the end of the topic.  <channel> is only
+        necessary if the message isn't sent in the channel itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        topic = topics.pop(number)
+        self._sendTopics(irc, channel, topics)
+    remove = wrap(remove, ['canChangeTopic', 'topicNumber'])
+
+    def lock(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Locks the topic (sets the mode +t) in <channel>.  <channel> is only
+        necessary if the message isn't sent in the channel itself.
+        """
+        irc.queueMsg(ircmsgs.mode(channel, '+t'))
+        irc.noReply()
+    lock = wrap(lock, ['channel', ('haveOp', 'lock the topic')])
+
+    def unlock(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Locks the topic (sets the mode +t) in <channel>.  <channel> is only
+        necessary if the message isn't sent in the channel itself.
+        """
+        irc.queueMsg(ircmsgs.mode(channel, '-t'))
+        irc.noReply()
+    unlock = wrap(unlock, ['channel', ('haveOp', 'unlock the topic')])
+
+    def restore(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Restores the topic to the last topic set by the bot.  <channel> is only
+        necessary if the message isn't sent in the channel itself.
+        """
+        try:
+            topics = self.lastTopics[channel]
+        except KeyError:
+            irc.error(format('I haven\'t yet set the topic in %s.', channel))
+            return
+        self._sendTopics(irc, channel, topics)
+    restore = wrap(restore, ['canChangeTopic'])
+
+    def undo(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Restores the topic to the one previous to the last topic command that
+        set it.  <channel> is only necessary if the message isn't sent in the
+        channel itself.
+        """
+        self._addRedo(channel, self._getUndo(channel)) # current topic.
+        topics = self._getUndo(channel) # This is the topic list we want.
+        if topics is not None:
+            self._sendTopics(irc, channel, topics, isDo=True)
+        else:
+            irc.error(format('There are no more undos for %s.', channel))
+    undo = wrap(undo, ['canChangetopic'])
+
+    def redo(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Undoes the last undo.  <channel> is only necessary if the message isn't
+        sent in the channel itself.
+        """
+        topics = self._getRedo(channel)
+        if topics is not None:
+            self._sendTopics(irc, channel, topics, isDo=True)
+        else:
+            irc.error(format('There are no redos for %s.', channel))
+    redo = wrap(redo, ['canChangeTopic'])
+
+    def swap(self, irc, msg, args, channel, first, second):
+        """[<channel>] <first topic number> <second topic number>
+
+        Swaps the order of the first topic number and the second topic number.
+        <channel> is only necessary if the message isn't sent in the channel
+        itself.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        if first == second:
+            irc.error('I refuse to swap the same topic with itself.')
+            return
+        t = topics[first]
+        topics[first] = topics[second]
+        topics[second] = t
+        self._sendTopics(irc, channel, topics)
+    swap = wrap(swap, ['canChangeTopic', 'topicNumber', 'topicNumber'])
+
+    def default(self, irc, msg, args, channel):
+        """[<channel>]
+
+        Sets the topic in <channel> to the default topic for <channel>.  The
+        default topic for a channel may be configured via the configuration
+        variable supybot.plugins.Topic.default.
+        """
+        topic = self.registryValue('default', channel)
+        if topic:
+            self._sendTopics(irc, channel, [topic])
+        else:
+            irc.error(format('There is no default topic configured for %s.',
+                             channel))
+    default = wrap(default, ['canChangeTopic'])
+
+    def separator(self, irc, msg, args, channel, separator):
+        """[<channel>] <separator>
+
+        Sets the topic separator for <channel> to <separator>  Converts the
+        current topic appropriately.
+        """
+        topics = self._splitTopic(irc.state.getTopic(channel), channel)
+        self.setRegistryValue('separator', separator, channel)
+        self._sendTopics(irc, channel, topics)
+    separator = wrap(separator, ['canChangeTopic', 'something'])
+
+Class = Topic
+
+
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:

plugins/Topic/test.py

@@ -0,0 +1,226 @@
+###
+# Copyright (c) 2002-2004, Jeremiah Fincher
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+from supybot.test import *
+
+class TopicTestCase(ChannelPluginTestCase):
+    plugins = ('Topic',)
+    def testRemove(self):
+        self.assertError('topic remove 1')
+        _ = self.getMsg('topic add foo')
+        _ = self.getMsg('topic add bar')
+        _ = self.getMsg('topic add baz')
+        self.assertError('topic remove 0')
+        self.assertNotError('topic remove 3')
+        self.assertNotError('topic remove 2')
+        self.assertNotError('topic remove 1')
+        self.assertError('topic remove 1')
+
+    def testReplace(self):
+        _ = self.getMsg('topic add foo')
+        _ = self.getMsg('topic add bar')
+        _ = self.getMsg('topic add baz')
+        self.assertRegexp('topic replace 1 oof', 'oof.*bar.*baz')
+        self.assertRegexp('topic replace -1 zab', 'oof.*bar.*zab')
+        self.assertRegexp('topic replace 2 lorem ipsum',
+                          'oof.*lorem ipsum.*zab')
+        self.assertRegexp('topic replace 2 rab', 'oof.*rab.*zab')
+        
+    def testGet(self):
+        self.assertError('topic get 1')
+        _ = self.getMsg('topic add foo')
+        _ = self.getMsg('topic add bar')
+        _ = self.getMsg('topic add baz')
+        self.assertRegexp('topic get 1', '^foo')
+        self.assertError('topic get 0')
+
+    def testAdd(self):
+        self.assertError('topic add #floorgle')
+        m = self.getMsg('topic add foo')
+        self.assertEqual(m.command, 'TOPIC')
+        self.assertEqual(m.args[0], self.channel)
+        self.assertEqual(m.args[1], 'foo (test)')
+        m = self.getMsg('topic add bar')
+        self.assertEqual(m.command, 'TOPIC')
+        self.assertEqual(m.args[0], self.channel)
+        self.assertEqual(m.args[1], 'foo (test) || bar (test)')
+
+    def testInsert(self):
+        m = self.getMsg('topic add foo')
+        self.assertEqual(m.args[1], 'foo (test)')
+        m = self.getMsg('topic insert bar')
+        self.assertEqual(m.args[1], 'bar (test) || foo (test)')
+
+    def testChange(self):
+        _ = self.getMsg('topic add foo')
+        _ = self.getMsg('topic add bar')
+        _ = self.getMsg('topic add baz')
+        self.assertRegexp('topic change -1 s/baz/biff/',
+                          r'foo.*bar.*biff')
+        self.assertRegexp('topic change 2 s/bar/baz/',
+                          r'foo.*baz.*biff')
+        self.assertRegexp('topic change 1 s/foo/bar/',
+                          r'bar.*baz.*biff')
+        self.assertRegexp('topic change -2 s/baz/bazz/',
+                          r'bar.*bazz.*biff')
+        self.assertError('topic change 0 s/baz/biff/')
+
+    def testConfig(self):
+        try:
+            original = conf.supybot.plugins.Topic.separator()
+            conf.supybot.plugins.Topic.separator.setValue(' <==> ')
+            _ = self.getMsg('topic add foo')
+            m = self.getMsg('topic add bar')
+            self.failUnless('<==>' in m.args[1])
+        finally:
+            conf.supybot.plugins.Topic.separator.setValue(original)
+
+    def testReorder(self):
+        _ = self.getMsg('topic add foo')
+        _ = self.getMsg('topic add bar')
+        _ = self.getMsg('topic add baz')
+        self.assertRegexp('topic reorder 2 1 3', r'bar.*foo.*baz')
+        self.assertRegexp('topic reorder 3 -2 1', r'baz.*foo.*bar')
+        self.assertError('topic reorder 0 1 2')
+        self.assertError('topic reorder 1 -2 2')
+        self.assertError('topic reorder 1 2')
+        self.assertError('topic reorder 2 3 4')
+        self.assertError('topic reorder 1 2 2')
+        self.assertError('topic reorder 1 1 2 3')
+        _ = self.getMsg('topic remove 1')
+        _ = self.getMsg('topic remove 1')
+        self.assertError('topic reorder 1')
+        _ = self.getMsg('topic remove 1')
+        self.assertError('topic reorder 0')
+
+    def testList(self):
+        _ = self.getMsg('topic add foo')
+        self.assertRegexp('topic list', '1: foo')
+        _ = self.getMsg('topic add bar')
+        self.assertRegexp('topic list', '1: foo .*2: bar')
+        _ = self.getMsg('topic add baz')
+        self.assertRegexp('topic list', '1: foo .* 2: bar .* and 3: baz')
+
+    def testSet(self):
+        _ = self.getMsg('topic add foo')
+        self.assertRegexp('topic set -1 bar', 'bar')
+        self.assertNotRegexp('topic set -1 baz', 'bar')
+        self.assertResponse('topic set foo bar baz', 'foo bar baz')
+
+    def testUndo(self):
+        try:
+            original = conf.supybot.plugins.Topic.format()
+            conf.supybot.plugins.Topic.format.setValue('$topic')
+            self.assertResponse('topic set ""', '')
+            self.assertResponse('topic add foo', 'foo')
+            self.assertResponse('topic add bar', 'foo || bar')
+            self.assertResponse('topic add baz', 'foo || bar || baz')
+            self.assertResponse('topic undo', 'foo || bar')
+            self.assertResponse('topic undo', 'foo')
+            self.assertResponse('topic undo', '')
+        finally:
+            conf.supybot.plugins.Topic.format.setValue(original)
+
+    def testUndoRedo(self):
+        try:
+            original = conf.supybot.plugins.Topic.format()
+            conf.supybot.plugins.Topic.format.setValue('$topic')
+            self.assertResponse('topic set ""', '')
+            self.assertResponse('topic add foo', 'foo')
+            self.assertResponse('topic add bar', 'foo || bar')
+            self.assertResponse('topic add baz', 'foo || bar || baz')
+            self.assertResponse('topic undo', 'foo || bar')
+            self.assertResponse('topic undo', 'foo')
+            self.assertResponse('topic undo', '')
+            self.assertResponse('topic redo', 'foo')
+            self.assertResponse('topic redo', 'foo || bar')
+            self.assertResponse('topic redo', 'foo || bar || baz')
+            self.assertResponse('topic undo', 'foo || bar')
+            self.assertResponse('topic undo', 'foo')
+            self.assertResponse('topic redo', 'foo || bar')
+            self.assertResponse('topic undo', 'foo')
+            self.assertResponse('topic redo', 'foo || bar')
+        finally:
+            conf.supybot.plugins.Topic.format.setValue(original)
+
+    def testSwap(self):
+        original = conf.supybot.plugins.Topic.format()
+        try:
+            conf.supybot.plugins.Topic.format.setValue('$topic')
+            self.assertResponse('topic set ""', '')
+            self.assertResponse('topic add foo', 'foo')
+            self.assertResponse('topic add bar', 'foo || bar')
+            self.assertResponse('topic add baz', 'foo || bar || baz')
+            self.assertResponse('topic swap 1 2', 'bar || foo || baz')
+            self.assertResponse('topic swap 1 -1', 'baz || foo || bar')
+            self.assertError('topic swap -1 -1')
+            self.assertError('topic swap 2 -2')
+            self.assertError('topic swap 1 -3')
+            self.assertError('topic swap -2 2')
+            self.assertError('topic swap -3 1')
+        finally:
+            conf.supybot.plugins.Topic.format.setValue(original)
+            
+    def testDefault(self):
+        self.assertError('topic default')
+        try:
+            original = conf.supybot.plugins.Topic.default()
+            conf.supybot.plugins.Topic.default.setValue('foo bar baz')
+            self.assertResponse('topic default', 'foo bar baz')
+        finally:
+            conf.supybot.plugins.Topic.default.setValue(original)
+
+    def testTopic(self):
+        original = conf.supybot.plugins.Topic.format()
+        try:
+            conf.supybot.plugins.Topic.format.setValue('$topic')
+            self.assertError('topic addd') # Error to send too many args.
+            self.assertResponse('topic add foo', 'foo')
+            self.assertResponse('topic add bar', 'foo || bar')
+            self.assertResponse('topic', 'foo || bar')
+        finally:
+            conf.supybot.plugins.Topic.format.setValue(original)
+
+    def testSeparator(self):
+        original = conf.supybot.plugins.Topic.format()
+        try:
+            conf.supybot.plugins.Topic.format.setValue('$topic')
+            self.assertResponse('topic add foo', 'foo')
+            self.assertResponse('topic add bar', 'foo || bar')
+            self.assertResponse('topic add baz', 'foo || bar || baz')
+            self.assertResponse('topic separator |', 'foo | bar | baz')
+            self.assertResponse('topic separator ::', 'foo :: bar :: baz')
+            self.assertResponse('topic separator ||', 'foo || bar || baz')
+        finally:
+            conf.supybot.plugins.Topic.format.setValue(original)
+            
+        
+
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
+

setup.py

@@ -48,6 +48,7 @@ plugins = [
     'Scheduler',
     'ShrinkUrl',
     'Status',
+    'Topic',
     'User',
     'Utilities',
     'Web',