NoisyKarma: First commit.
Valentin Lorentz
parent
8ce26f17c3
commit
71daf9e721
|
|
@ -0,0 +1 @@
|
|||
Insert a description of your plugin here, with any notes, etc. about using it.
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
###
|
||||
# Copyright (c) 2013, Valentin Lorentz
|
||||
# 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.
|
||||
|
||||
###
|
||||
|
||||
"""
|
||||
Add a description of the plugin (to be presented to the user inside the wizard)
|
||||
here. This should describe *what* the plugin does.
|
||||
"""
|
||||
|
||||
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__ = ""
|
||||
|
||||
# XXX Replace this with an appropriate author or supybot.Author instance.
|
||||
__author__ = supybot.authors.unknown
|
||||
|
||||
# This is a dictionary mapping supybot.Author instances to lists of
|
||||
# contributions.
|
||||
__contributors__ = {}
|
||||
|
||||
# This is a url where the most recent plugin package can be downloaded.
|
||||
__url__ = '' # 'http://supybot.com/Members/yourname/NoisyKarma/download'
|
||||
|
||||
from . import config
|
||||
from . import plugin
|
||||
from imp import reload
|
||||
# In case we're being reloaded.
|
||||
reload(config)
|
||||
reload(plugin)
|
||||
# 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:
|
||||
from . import test
|
||||
|
||||
Class = plugin.Class
|
||||
configure = config.configure
|
||||
|
||||
|
||||
# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
###
|
||||
# Copyright (c) 2013, Valentin Lorentz
|
||||
# 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 json
|
||||
import supybot.conf as conf
|
||||
import supybot.registry as registry
|
||||
try:
|
||||
from supybot.i18n import PluginInternationalization
|
||||
_ = PluginInternationalization('NoisyKarma')
|
||||
except:
|
||||
# Placeholder that allows to run the plugin on a bot
|
||||
# without the i18n module
|
||||
_ = lambda x:x
|
||||
|
||||
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('NoisyKarma', True)
|
||||
|
||||
def value_validator(value):
|
||||
if not isinstance(value, list):
|
||||
return _('Dict key must be a list')
|
||||
for subvalue in value:
|
||||
if not isinstance(subvalue, dict):
|
||||
return _('List items must be dicts.')
|
||||
if set(value.keys()) != {'action', 'message'}:
|
||||
return _('List items must be dicts with "action" and "message" '
|
||||
'as keys.')
|
||||
return None
|
||||
|
||||
class KarmaMessages(registry.Json):
|
||||
def set(self, v):
|
||||
try:
|
||||
data = json.loads(v)
|
||||
except ValueError:
|
||||
self.error(_('Value must be json data.'))
|
||||
return
|
||||
if not isinstance(data, dict):
|
||||
self.error(_('Value must be a json dict.'))
|
||||
return
|
||||
if any(map(lambda x:not isinstance(x, int), data.keys())):
|
||||
self.error(_('Dict keys must be integers.'))
|
||||
return
|
||||
if any(map(lambda x:x<=0, data.keys())):
|
||||
self.error(_('Dict keys must be non-negative integers.'))
|
||||
return
|
||||
errors = list(filter(bool, map(value_validator, data.values())))
|
||||
if errors:
|
||||
self.error(errors[0])
|
||||
return
|
||||
self.setValue(data)
|
||||
|
||||
NoisyKarma = conf.registerPlugin('NoisyKarma')
|
||||
# This is where your configuration variables (if any) should go. For example:
|
||||
# conf.registerGlobalValue(NoisyKarma, 'someConfigVariableName',
|
||||
# registry.Boolean(False, _("""Help for someConfigVariableName.""")))
|
||||
conf.registerGroup(NoisyKarma, 'messages')
|
||||
conf.registerChannelValue(NoisyKarma.messages, 'positive',
|
||||
KarmaMessages({}, _("""Messages shown for things with positive karma.
|
||||
For a given karma, the message with the closest key to the karma will
|
||||
be selected, among messages with a key greater than the karma.""")))
|
||||
conf.registerChannelValue(NoisyKarma.messages, 'negative',
|
||||
KarmaMessages({}, _("""Messages shown for things with negative karma.
|
||||
For a given absolute karma, the message with the closest key to the
|
||||
karma will be selected, among messages with an absolute key greater
|
||||
than the absolute karma""")))
|
||||
|
||||
|
||||
# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:
|
||||
|
|
@ -0,0 +1 @@
|
|||
# Stub so local is a module, used for third-party modules
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
###
|
||||
# Copyright (c) 2013, Valentin Lorentz
|
||||
# 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.utils as utils
|
||||
from supybot.commands import *
|
||||
import supybot.plugins as plugins
|
||||
import supybot.ircutils as ircutils
|
||||
import supybot.callbacks as callbacks
|
||||
try:
|
||||
from supybot.i18n import PluginInternationalization
|
||||
_ = PluginInternationalization('NoisyKarma')
|
||||
except:
|
||||
# Placeholder that allows to run the plugin on a bot
|
||||
# without the i18n module
|
||||
_ = lambda x:x
|
||||
|
||||
class NoisyKarma(callbacks.Plugin):
|
||||
"""Add the help for "@plugin help NoisyKarma" here
|
||||
This should describe *how* to use this plugin."""
|
||||
|
||||
def doPrivmsg(self, irc, msg):
|
||||
Karma = irc.getCallback('Karma')
|
||||
channel = msg.args[0]
|
||||
if Karma and not msg.addressed and not msg.repliedTo and \
|
||||
irc.isChannel(channel):
|
||||
(L, neutrals) = Karma.db.gets(channel, msg.args[1].split(' '))
|
||||
if not L:
|
||||
return
|
||||
(thing, karma) = L[0] if abs(L[0][1]) > abs(L[-1][1]) else L[-1]
|
||||
if karma > 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.positive
|
||||
elif karma < 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.negative
|
||||
karma = -karma
|
||||
else:
|
||||
return
|
||||
registry_value = registry_value.get(channel)
|
||||
last_key = 0
|
||||
last_value = None
|
||||
for key, value in sorted(registry_value().items(), key=lambda x:x[0]):
|
||||
if int(key) > karma:
|
||||
break
|
||||
(last_key, last_value) = (key, value)
|
||||
if last_key == 0:
|
||||
return
|
||||
msg = last_value['message']
|
||||
try:
|
||||
msg %= thing
|
||||
except TypeError:
|
||||
pass
|
||||
irc.reply(msg, action=last_value['action'], prefixNick=False)
|
||||
|
||||
@wrap(['channel', 'int', getopts({'action': ''}), 'text'])
|
||||
def add(self, irc, msg, args, channel, karma, tuple_optlist, message):
|
||||
"""[<channel>] <min karma> [--action] <msg>
|
||||
|
||||
Adds a new <msg> to be triggered when a thing with a positive
|
||||
(respectively negative) karma greater than (resp. lower than)
|
||||
<min karma> is saw on the <channel>."""
|
||||
optlist = {}
|
||||
for key, value in tuple_optlist:
|
||||
optlist.update({key: value})
|
||||
if karma > 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.positive
|
||||
elif karma < 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.negative
|
||||
karma = -karma
|
||||
else:
|
||||
irc.error(_('Karma cannot be null.', Raise=True))
|
||||
registry_value = registry_value.get(channel)
|
||||
with registry_value.editable() as rv:
|
||||
rv[karma] = {'action': 'action' in optlist, 'message': message}
|
||||
irc.replySuccess()
|
||||
|
||||
@wrap(['channel', 'int'])
|
||||
def remove(self, irc, msg, args, channel, tuple_optlist, karma):
|
||||
"""[<channel>] <min karma>
|
||||
|
||||
Removes the message associated with <thing> and <min karma>."""
|
||||
optlist = {}
|
||||
for key, value in tuple_optlist:
|
||||
optlist.update({key: value})
|
||||
if karma > 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.positive
|
||||
elif karma < 0:
|
||||
registry_value = conf.supybot.plugins.NoisyKarma.messages.negative
|
||||
karma = -karma
|
||||
else:
|
||||
irc.error(_('Karma cannot be null.', Raise=True))
|
||||
registry_value = registry_value.get(channel)
|
||||
with registry_value.editable() as rv:
|
||||
del rv[karma]
|
||||
irc.replySuccess()
|
||||
|
||||
|
||||
Class = NoisyKarma
|
||||
|
||||
|
||||
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
###
|
||||
# Copyright (c) 2013, Valentin Lorentz
|
||||
# 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
|
||||
from supybot.test import *
|
||||
|
||||
class NoisyKarmaTestCase(ChannelPluginTestCase):
|
||||
plugins = ('NoisyKarma', 'Karma')
|
||||
|
||||
def setUp(self):
|
||||
super(NoisyKarmaTestCase, self).setUp()
|
||||
conf.supybot.plugins.NoisyKarma.messages.positive.get(self.channel).set('{}')
|
||||
conf.supybot.plugins.NoisyKarma.messages.negative.get(self.channel).set('{}')
|
||||
|
||||
def testPositive(self):
|
||||
self.assertSnarfNoResponse('foo')
|
||||
self.assertNotError('noisykarma add 2 Interesting, %s.')
|
||||
self.assertNotError('noisykarma add 4 %s is cool!')
|
||||
self.assertSnarfNoResponse('foo')
|
||||
self.assertNoResponse('foo++')
|
||||
self.assertSnarfNoResponse('foo')
|
||||
self.assertNoResponse('foo++')
|
||||
self.assertSnarfResponse('foo', 'Interesting, foo.')
|
||||
self.assertNoResponse('foo++')
|
||||
self.assertSnarfResponse('foo', 'Interesting, foo.')
|
||||
self.assertNoResponse('foo++')
|
||||
self.assertSnarfResponse('foo', 'foo is cool!')
|
||||
self.assertNoResponse('foo++')
|
||||
self.assertSnarfResponse('foo', 'foo is cool!')
|
||||
self.assertNoResponse('foo--')
|
||||
self.assertSnarfResponse('foo', 'foo is cool!')
|
||||
self.assertNoResponse('foo--')
|
||||
self.assertSnarfResponse('foo', 'Interesting, foo.')
|
||||
|
||||
def testNegative(self):
|
||||
self.assertNotError('noisykarma add -2 Eww, %s.')
|
||||
self.assertNotError('noisykarma add -4 Oh no, not %s!')
|
||||
self.assertSnarfNoResponse('bar')
|
||||
self.assertNoResponse('bar--')
|
||||
self.assertSnarfNoResponse('bar')
|
||||
self.assertNoResponse('bar--')
|
||||
self.assertSnarfResponse('bar', 'Eww, bar.')
|
||||
self.assertNoResponse('bar--')
|
||||
self.assertSnarfResponse('bar', 'Eww, bar.')
|
||||
self.assertNoResponse('bar--')
|
||||
self.assertSnarfResponse('bar', 'Oh no, not bar!')
|
||||
|
||||
def testAction(self):
|
||||
self.assertNotError('noisykarma add -2 --action doesn\'t like %s.')
|
||||
self.assertSnarfNoResponse('baz')
|
||||
self.assertNoResponse('baz--')
|
||||
self.assertSnarfNoResponse('baz')
|
||||
self.assertNoResponse('baz--')
|
||||
self.assertSnarfResponse('baz', '\x01ACTION doesn\'t like baz.\x01')
|
||||
|
||||
def testOverwrite(self):
|
||||
self.assertNotError('noisykarma add -2 --action doesn\'t like %s.')
|
||||
self.assertSnarfNoResponse('qux')
|
||||
self.assertNoResponse('qux--')
|
||||
self.assertSnarfNoResponse('qux')
|
||||
self.assertNoResponse('qux--')
|
||||
self.assertSnarfResponse('qux', '\x01ACTION doesn\'t like qux.\x01')
|
||||
self.assertNotError('noisykarma add -2 Eww, %s.')
|
||||
self.assertNoResponse('qux--')
|
||||
self.assertSnarfResponse('qux', 'Eww, qux.')
|
||||
|
||||
|
||||
# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:
|
||||
Loading…
Reference in New Issue