Start working on stories plugin

Author: eriknyquist

nedry/builtin_plugins/__init__.py

@@ -3,5 +3,6 @@
 from nedry.builtin_plugins.mock import Mocking
 from nedry.builtin_plugins.schedule import Schedule
 from nedry.builtin_plugins.trivia import Trivia
+from nedry.builtin_plugins.stories import Stories
 
-builtin_plugin_modules = [KnockKnockJokes, Wikipedia, Mocking, Schedule, Trivia]
+builtin_plugin_modules = [KnockKnockJokes, Wikipedia, Mocking, Schedule, Trivia, Stories]

nedry/builtin_plugins/stories.py

@@ -0,0 +1,167 @@
+import os
+
+from nedry.plugin import PluginModule
+from nedry import utils
+
+PROMPTS_FILE = os.path.join(os.path.dirname(__file__), "writing_prompts.txt")
+
+STORY_HELPTEXT = """
+{0} new|add|show|stop [optional story contribution text]
+
+Interact with the story being written on the current discord channel.
+
+The first argument to this command may be one of 4 operations:
+
+new - Start a new story in this channel.
+
+add - Contribute the next part of the story being written on this channel.
+      [optional story contribution text] should be replaced with your desired
+      text for the next part of the story.
+
+show - Show the current story as written so far.
+
+stop - Stop the story writing session, and show the story as written so far.
+
+Examples:
+
+@BotName !story new                            (Start a new story)
+@BotName !story add And then he fell down...   (Contribute to the current story)
+@BotName !story show                           (Show the story as written so far)
+@BotName !story stop                           (Stop the story)
+"""
+
+stories_by_channel = {}
+
+
+class StoryContribution(object):
+    """
+    Represents a story contribution by a specific discord user in a specific channel
+    """
+    def __init__(self, discord_user, text):
+        self.discord_user = discord_user
+        self.text = text
+
+
+class StorySession(object):
+    """
+    Represents a single story written by multiple discord users in a single channel
+    """
+    def __init__(self, prompt):
+        self.prompt = prompt
+        self.contributions = []
+
+    def add_contribution(self, contribution):
+        self.contributions.append(contribution)
+
+    def dump_story(self):
+        ret = ""
+        lines = [self.prompt] + [x.text for x in self.contributions]
+        for c in lines:
+            text = c.strip()
+            if text[-1] not in ['.', '?', '!', ':', ';', '-']:
+                text += '.'
+
+            ret += text + ' '
+
+        return ret
+
+
+def _handle_new_op(cmd_word, proc, message):
+    if message.channel.id in stories_by_channel:
+        return proc.usage_msg(f"{message.author.mention} Story already in progress in this channel, "
+                              f"stop the current story before starting a new one.", cmd_word)
+
+    prompt = utils.random_line_from_file(PROMPTS_FILE)
+    session = StorySession(prompt)
+    stories_by_channel[message.channel.id] = session
+
+    mention = ""
+    if hasattr(message.channel, 'mention'):
+        mention = message.channel.mention
+    else:
+        mention = message.author.mention
+
+    return (f"{mention} Let's write a story! I will start you off with a prompt, "
+            f"and you can add to the story using the '!story add' command.\n\n"
+            f"Here is your prompt:\n```{prompt}```")
+
+def _handle_add_op(cmd_word, proc, message, text):
+    if message.channel.id not in stories_by_channel:
+        return proc.usage_msg(f"{message.author.mention} No story is in progress on this channel, "
+                              f"you must start a new one before adding to it", cmd_word)
+
+    if text == '':
+        return proc.usage_msg(f"{message.author.mention} Please provide some text for the story.",
+                              cmd_word)
+
+    session = stories_by_channel[message.channel.id]
+    session.add_contribution(StoryContribution(message.author, text))
+
+    return f"{message.author.mention} Got it, thank you for your story contribution!"
+
+def _handle_show_op(cmd_word, proc, message):
+    if message.channel.id not in stories_by_channel:
+        return proc.usage_msg(f"{message.author.mention} No story is in progress on this channel.",
+                              cmd_word)
+
+    session = stories_by_channel[message.channel.id]
+
+    return f"{message.author.mention} Here is the story so far:\n```{session.dump_story()}```"
+
+def _handle_stop_op(cmd_word, proc, message):
+    if message.channel.id not in stories_by_channel:
+        return proc.usage_msg(f"{message.author.mention} No story is in progress on this channel.",
+                              cmd_word)
+
+    session = stories_by_channel[message.channel.id]
+    story = session.dump_story()
+    del stories_by_channel[message.channel.id]
+
+    return f"{message.author.mention} OK, story stopped. Here is your story:\n```{story}```"
+
+def story_command_handler(cmd_word, args, message, proc, config, twitch_monitor):
+    args = args.split()
+    if len(args) == 0:
+        return proc.usage_msg(f"{message.author.mention} Command requires more information.", cmd_word)
+
+    op = args[0].strip().lower()
+    if op not in ['new', 'add', 'stop', 'show']:
+        return proc.usage_msg(f"{message.author.mention} Unrecognized operation.", cmd_word)
+
+    if 'new' == op:
+        return _handle_new_op(cmd_word, proc, message)
+    elif 'add' == op:
+        return _handle_add_op(cmd_word, proc, message, ' '.join(args[1:]).strip())
+    elif 'show' == op:
+        return _handle_show_op(cmd_word, proc, message)
+    elif 'stop' == op:
+        return _handle_stop_op(cmd_word, proc, message)
+
+
+class Stories(PluginModule):
+    """
+    Plugin for writing prompts and collaborative story writing.
+    """
+    plugin_name = "stories"
+    plugin_version = "1.0.0"
+    plugin_short_description = "Writing prompts and collaborative story writing"
+    plugin_long_description = """
+    Provides a random writing prompt, and collects story fragments from discord users
+    to collaboritvely write a story.
+
+    Commands added:
+
+    !story (see !help story)
+    """
+
+    def open(self):
+        """
+        Enables plugin operation; subscribe to events and/or initialize things here
+        """
+        self.discord_bot.add_command("story", story_command_handler, False, STORY_HELPTEXT)
+
+    def close(self):
+        """
+        Disables plugin operation; unsubscribe from events and/or tear down things here
+        """
+        self.discord_bot.remove_command("story")

nedry/utils.py

@@ -1,3 +1,4 @@
+import random
 import datetime
 import zoneinfo
 
@@ -149,3 +150,34 @@ def list_to_english(words):
         return "%s and %s" % (words[0], words[1])
     else:
         return ", ".join(words[:-1]) + " and " + words[-1]
+
+def random_line_from_file(filename):
+    ret = b""
+    with open(filename, "rb") as fh:
+        fh.seek(0, 2)     # Seek to the end of the file
+        fsize = fh.tell() # Get file size
+
+        # Seek to random file offset
+        offs = int((fsize - 1) * random.random())
+        fh.seek(offs, 0)
+
+        # Keep reading single chars backwards until we see a newline
+        while True:
+            if fh.tell() == 0:
+                # Reached the beginning of the file
+                break
+
+            ch = fh.read(1)
+
+            if ch == b'\n':
+                break
+
+            fh.seek(-2, 1)
+
+        # Now, keep reading single chars until EOF or until the next newline
+        ch = fh.read(1)
+        while ch not in [b'\n', b'']:
+            ret += ch
+            ch = fh.read(1)
+
+        return ret.decode("utf-8")