Use common code for setting the channel topic and description

[turbot] / turbot / puzzle.py

diff --git a/turbot/puzzle.py b/turbot/puzzle.py
index abfe60b505308874109938f48f234cc2791c19a0..b9aa1ec40bcc44acaa2238123a2f052d04c92184 100644 (file)
--- a/turbot/puzzle.py
+++ b/turbot/puzzle.py
@@ -249,8 +249,6 @@ def puzzle_channel_topic(puzzle):
     if puzzle['status'] == 'solved':
         topic += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
 
-    topic += puzzle['name']
-
     links = []
 
     url = puzzle.get('url', None)
@@ -262,7 +260,7 @@ def puzzle_channel_topic(puzzle):
         links.append("<{}|Sheet>".format(sheet_url))
 
     if len(links):
-        topic += "({})".format(', '.join(links))
+        topic += "({}) ".format(', '.join(links))
 
     tags = puzzle.get('tags', [])
     if tags:
@@ -274,6 +272,42 @@ def puzzle_channel_topic(puzzle):
 
     return topic
 
+def puzzle_channel_description(puzzle):
+    """Compute the channel description for a puzzle"""
+
+    url = puzzle.get('url', None)
+    sheet_url = puzzle.get('sheet_url', None)
+    tags = puzzle.get('tags', [])
+    state = puzzle.get('state', None)
+
+    description = (
+        "Discussion to solve the puzzle \"{}\".\n".format(puzzle['name'])
+    )
+
+    if url:
+        description += "See the <{}|Original puzzle>\n".format(url)
+
+    if sheet_url:
+        description += (
+            "Actual solving work takes place in the "
+            + "<{}|shared spreadsheet>\n".format(sheet_url)
+        )
+
+    if tags:
+        description += "This puzzle has the following tags: {}\n".format(
+            " ".join(["`{}`".format(t) for t in tags]))
+
+    if state:
+        description += "This puzzle has a state of: {}\n".format(state)
+
+    description += (
+        "You can see a summary of this information at any point "
+        + "by issuing the `/puzzle` command and you can edit any of "
+        + "this information by issuing the `/edit` command"
+    )
+
+    return description
+
 def puzzle_channel_name(puzzle):
     """Compute the channel name for a puzzle"""
 
@@ -327,6 +361,17 @@ def puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=None):
         turb.slack_client.conversations_setTopic(channel=channel_id,
                                                  topic=channel_topic)
 
+    # Compute the channel description and set it if it has changed
+    channel_description = puzzle_channel_description(puzzle)
+
+    old_channel_description = None
+    if old_puzzle:
+        old_channel_description = puzzle_channel_description(old_puzzle)
+
+    if channel_description != old_channel_description:
+        turb.slack_client.conversations_setPurpose(channel=channel_id,
+                                                   purpose=channel_description)
+
     # Compute the sheet name and set it if it has changed
     sheet_name = puzzle_sheet_name(puzzle)
 
@@ -357,4 +402,7 @@ def puzzle_copy(old_puzzle):
     if 'tags' in old_puzzle:
         new_puzzle['tags'] = old_puzzle['tags'].copy()
 
+    if 'solution' in old_puzzle:
+        new_puzzle['solution'] = old_puzzle['solution'].copy()
+
     return new_puzzle