Merge lp:~ricardokirkner/lalita/character_command into lp:lalita

[Ricardo Kirkner]

fixes bug # 363402

[lp:~ricardokirkner/lalita/character_command]

137. By Ricardo Kirkner on 2010-03-06

fixed documentation regarding running code from source directly

[Guillermo Gonzalez (verterok)]

+1

review: Approve

=== modified file 'lalita.cfg.sample'
--- lalita.cfg.sample	2010-02-21 23:17:33 +0000
+++ lalita.cfg.sample	2010-03-06 20:14:15 +0000
@@ -4,6 +4,10 @@
 # License: GPL v3
 # For further info, see LICENSE file
 
+# Global Configuration Settings
+command_char = '@'
+
+# Servers Configuration Settings
 servers = {
         'localhost': dict (
             encoding='utf8',

=== modified file 'lalita/core/tests/test_events.py'
--- lalita/core/tests/test_events.py	2010-01-17 19:03:28 +0000
+++ lalita/core/tests/test_events.py	2010-03-06 20:14:15 +0000
@@ -152,6 +152,24 @@
         self.check_pushed(events.PUBLIC_MESSAGE, "user", "chnl", "blah")
         return self.deferred
 
+    def test_privmsg_command_char(self):
+        '''Calling bot.privmsg with custom command char'''
+        # set up command char config
+        _COMMAND_CHAR = ircbot.COMMAND_CHAR
+
+        # set custom command char
+        config = type('config', (object,), {'command_char': '!'})
+        ircbot.set_global_configuration(config)
+
+        # call command and test
+        bot.privmsg("user", "chnl", "!cmd foo")
+        self.check_pushed(events.COMMAND, "user", "chnl", "cmd", "foo")
+
+        # cleanup
+        ircbot.COMMAND_CHAR = _COMMAND_CHAR
+
+        return self.deferred
+
     def test_action(self):
         '''Calling bot.action'''
         bot.action("user!foo!bar", "chnl", "blah")

=== modified file 'lalita/core/tests/test_ircbot.py'
--- lalita/core/tests/test_ircbot.py	2010-02-14 00:24:46 +0000
+++ lalita/core/tests/test_ircbot.py	2010-03-06 20:14:15 +0000
@@ -113,3 +113,12 @@
         self.bot.load_channel_plugins("#testchn3")
         self.assertEqual(self.results, [])
 
+    def test_set_global_configuration(self):
+        _COMMAND_CHAR = ircbot.COMMAND_CHAR
+
+        config = type('config', (object,), {'command_char': '!'})
+        ircbot.set_global_configuration(config)
+        self.assertEqual(ircbot.COMMAND_CHAR, '!')
+
+        ircbot.COMMAND_CHAR = _COMMAND_CHAR
+

=== modified file 'lalita/ircbot.py'
--- lalita/ircbot.py	2010-02-20 15:02:51 +0000
+++ lalita/ircbot.py	2010-03-06 20:14:15 +0000
@@ -20,6 +20,8 @@
 # local imports
 from lalita import dispatcher, events
 
+COMMAND_CHAR = '@'
+
 LOG_LEVELS = {
     "debug": logging.DEBUG,
     "info": logging.INFO,
@@ -151,7 +153,7 @@
             if msg[0] in (":", " ", ","):
                 msg = msg[1:].strip()
                 self.dispatcher.push(events.TALKED_TO_ME, user, channel, msg)
-        elif msg[0] == '@':
+        elif msg[0] == COMMAND_CHAR:
             args = msg.split()
             command = args.pop(0)[1:]
             self.dispatcher.push(events.COMMAND, user, channel, command, *args)
@@ -293,6 +295,10 @@
         start_manhole(**manhole_opts)
     reactor.run()
 
+def set_global_configuration(config):
+    global COMMAND_CHAR
+    COMMAND_CHAR = config.command_char
+
 
 if __name__ == '__main__':
     msg = """
@@ -430,4 +436,5 @@
     else:
         manhole_opts = None
 
+    set_global_configuration(config)
     main(to_use, plugins_loglvl, manhole_opts=manhole_opts)