Add state string to list of puzzle attributes matched in searching

[turbot] / turbot / puzzle.py

diff --git a/turbot/puzzle.py b/turbot/puzzle.py
index 9f9b1c600b4002a5afa661cdf1d4c9b930639fd0..7db006b9b237702289a41125e81a4e169e0674d3 100644 (file)
--- a/turbot/puzzle.py
+++ b/turbot/puzzle.py
@@ -1,4 +1,7 @@
+from turbot.blocks import section_block, text_block
+from turbot.channel import channel_url
 from boto3.dynamodb.conditions import Key
+import re
 
 def find_puzzle_for_url(turb, hunt_id, url):
     """Given a hunt_id and URL, return the puzzle with that URL
@@ -20,3 +23,97 @@ def find_puzzle_for_url(turb, hunt_id, url):
         return None
 
     return response['Items'][0]
+
+def puzzle_block(puzzle):
+    """Generate Slack blocks for a puzzle
+
+    The puzzle argument should be a dictionary as returned from the
+    database. The return value can be used in a Slack command
+    expecting blocks to provide all the details of a puzzle, (its
+    state, solution, links to channel and sheet, etc.).
+    """
+
+    name = puzzle['name']
+    status = puzzle['status']
+    solution = puzzle['solution']
+    channel_id = puzzle['channel_id']
+    url = puzzle.get('url', None)
+    sheet_url = puzzle.get('sheet_url', None)
+    state = puzzle.get('state', None)
+    status_emoji = ''
+    solution_str = ''
+
+    if status == 'solved':
+        status_emoji = ":ballot_box_with_check:"
+    else:
+        status_emoji = ":white_square:"
+
+    if len(solution):
+        solution_str = "*`" + '`, `'.join(solution) + "`*"
+
+    links = []
+    if url:
+        links.append("<{}|Puzzle>".format(url))
+    if sheet_url:
+        links.append("<{}|Sheet>".format(sheet_url))
+
+    state_str = ''
+    if state:
+        state_str = "\n{}".format(state)
+
+    puzzle_text = "{}{} <{}|{}> ({}){}".format(
+        status_emoji, solution_str,
+        channel_url(channel_id), name,
+        ', '.join(links), state_str
+    )
+
+    return section_block(text_block(puzzle_text))
+
+def puzzle_matches_one(puzzle, pattern):
+    """Returns True if this puzzle matches the given string (regexp)
+
+    A match will be considered on any of puzzle title, round title,
+    puzzle URL, puzzle state, or solution string. The string can
+    include regular expression syntax. Matching is case insensitive.
+    """
+
+    p = re.compile('.*'+pattern+'.*', re.IGNORECASE)
+
+    if p.match(puzzle['name']):
+        return True
+
+    if 'rounds' in puzzle:
+        for round in puzzle['rounds']:
+            if p.match(round):
+                return True
+
+    if 'url' in puzzle:
+        if p.match(puzzle['url']):
+            return True
+
+    if 'state' in puzzle:
+        if p.match(puzzle['state']):
+            return True
+
+    if 'solution' in puzzle:
+        for solution in puzzle['solution']:
+            if p.match(solution):
+                return True
+
+    return False
+
+def puzzle_matches_all(puzzle, patterns):
+    """Returns True if this puzzle matches all of the given list of patterns
+
+    A match will be considered on any of puzzle title, round title,
+    puzzle URL, puzzle state, or solution string. All patterns must
+    match the puzzle somewhere, (that is, there is an implicit logical
+    AND between patterns). Patterns can include regular expression
+    syntax. Matching is case insensitive.
+    """
+
+    for pattern in patterns:
+        if not puzzle_matches_one(puzzle, pattern):
+            return False
+
+    return True