X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=turbot%2Fhunt.py;h=c2e59e2be937c4577e7696f80b01fce51356e05d;hb=29c36d3057c5602c5a4b6fb0e48f454db01ddd9d;hp=a832f1db2693aed5efdc5016d24d2c6f7ccaac93;hpb=4db58774a54d2c8505ee61aff3019723b1b552eb;p=turbot diff --git a/turbot/hunt.py b/turbot/hunt.py index a832f1d..c2e59e2 100644 --- a/turbot/hunt.py +++ b/turbot/hunt.py @@ -1,6 +1,6 @@ from turbot.blocks import section_block, text_block, divider_block from turbot.round import round_blocks -from turbot.puzzle import puzzle_block, puzzle_matches_all +from turbot.puzzle import puzzle_blocks, puzzle_matches_all from turbot.channel import channel_url from boto3.dynamodb.conditions import Key @@ -23,19 +23,26 @@ def find_hunt_for_hunt_id(turb, hunt_id): else: return None -def quote_if_has_space(term): - if ' ' in term: - return '"{}"'.format(term) - else: - return term +def hunt_puzzles_for_hunt_id(turb, hunt_id): + """Return all puzzles that belong to the given hunt_id""" + + response = turb.table.query( + KeyConditionExpression=( + Key('hunt_id').eq(hunt_id) & + Key('SK').begins_with('puzzle-') + ) + ) -def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[]): + return response['Items'] + +def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[], + limit_to_rounds=None): """Generate Slack blocks for a hunt The hunt argument should be a dictionary as returned from the database. - Two optional arguments can be used to filter which puzzles to + Three optional arguments can be used to filter which puzzles to include in the result: puzzle_status: If either 'solved' or 'unsolved' only puzzles @@ -46,9 +53,16 @@ def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[]): search_terms: A list of search terms. Only puzzles that match all of these terms will be included in the result. A match will be considered on any of - puzzle title, round title, puzzle URL, or solution - string. Terms can include regular expression - syntax. + puzzle title, round title, puzzle URL, puzzle + state or solution string. Terms can include + regular expression syntax. + + limit_to_rounds: A list of rounds. If provided only the given + rounds will be included in the output. Note: + an empty list means to display only puzzles + assigned to no rounds, while an argument of + None means to display all puzzles with no + limit on the rounds. The return value can be used in a Slack command expecting blocks to provide all the details of a hunt, (puzzles, their state, @@ -60,13 +74,7 @@ def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[]): hunt_id = hunt['hunt_id'] channel_id = hunt['channel_id'] - response = turb.table.query( - KeyConditionExpression=( - Key('hunt_id').eq(hunt_id) & - Key('SK').begins_with('puzzle-') - ) - ) - puzzles = response['Items'] + puzzles = hunt_puzzles_for_hunt_id(turb, hunt_id) # Filter the set of puzzles according the the requested puzzle_status if puzzle_status in ('solved', 'unsolved'): @@ -86,15 +94,19 @@ def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[]): for round in puzzle['rounds']: rounds.add(round) - hunt_text = "*{} puzzles in hunt <{}|{}>".format( + hunt_text = "*{} puzzles in hunt <{}|{}>*".format( puzzle_status.capitalize(), channel_url(channel_id), name ) + if limit_to_rounds is not None: + hunt_text += " *in round{}: {}*".format( + "s" if len(limit_to_rounds) > 1 else "", + ", ".join(limit_to_rounds) if limit_to_rounds else "" + ) if search_terms: - quoted_terms = [quote_if_has_space(term) for term in search_terms] + quoted_terms = ['`{}`'.format(term) for term in search_terms] hunt_text += " matching {}".format(" AND ".join(quoted_terms)) - hunt_text += "*" blocks = [ section_block(text_block(hunt_text)), @@ -107,15 +119,28 @@ def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[]): # Construct blocks for each round for round in rounds: - blocks += round_blocks(round, puzzles) + if limit_to_rounds is not None and round not in limit_to_rounds: + continue + # If we're only displaying one round the round header is redundant + if limit_to_rounds and len(limit_to_rounds) == 1: + blocks += round_blocks(round, puzzles, omit_header=True) + else: + blocks += round_blocks(round, puzzles) + blocks.append(divider_block()) # Also blocks for any puzzles not in any round stray_puzzles = [puzzle for puzzle in puzzles if 'rounds' not in puzzle] - if len(stray_puzzles): + + # For this condition, either limit_to_rounds is None which + # means we definitely want to display these stray puzzles + # (since we are not limiting), _OR_ limit_to_rounds is not + # None but is a zero-length array, meaning we are limiting + # to rounds but specifically the round of unassigned puzzles + if len(stray_puzzles) and not limit_to_rounds: stray_text = "*Puzzles with no assigned round*" blocks.append(section_block(text_block(stray_text))) for puzzle in stray_puzzles: - blocks.append(puzzle_block(puzzle)) + blocks += puzzle_blocks(puzzle) blocks.append(divider_block())