import turbot.sheets
import re
-def find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id):
+def find_puzzle_for_sort_key(turb, hunt_id, sort_key):
"""Given a hunt_id and puzzle_id, return that puzzle
Returns None if no puzzle with the given hunt_id and puzzle_id
response = turb.table.get_item(
Key={
'hunt_id': hunt_id,
- 'SK': 'puzzle-{}'.format(puzzle_id)
+ 'SK': sort_key,
})
if 'Item' in response:
url = puzzle.get('url', None)
sheet_url = puzzle.get('sheet_url', None)
state = puzzle.get('state', None)
+ tags = puzzle.get('tags', [])
status_emoji = ''
solution_str = ''
state_str = ''
if state:
- state_str = "\n{}".format(state)
+ state_str = " State: {}".format(state)
+
+ tags_str = ''
+ if tags:
+ tags_str = " Tags: "+" ".join(["`{}`".format(tag) for tag in tags])
+
+ extra_str = ''
+ if state_str or tags_str:
+ extra_str = "\n{}{}".format(tags_str, state_str)
rounds_str = ''
if include_rounds and 'rounds' in puzzle:
", ".join(rounds)
)
- puzzle_text = "{}{} {}<{}|{}> ({}){}{}".format(
- status_emoji, solution_str,
+ puzzle_text = "{} {}<{}|{}> {} ({}){}{}".format(
+ status_emoji,
meta_str,
channel_url(channel_id), name,
+ solution_str,
', '.join(links), rounds_str,
- state_str
+ extra_str
)
# Combining hunt ID and puzzle ID together here is safe because
- # both IDs are restricted to not contain a hyphen, (see
+ # hunt_id is restricted to not contain a hyphen, (see
# valid_id_re in interaction.py)
- hunt_and_puzzle = "{}-{}".format(puzzle['hunt_id'], puzzle['puzzle_id'])
+ hunt_and_sort_key = "{}-{}".format(puzzle['hunt_id'], puzzle['SK'])
return [
accessory_block(
section_block(text_block(puzzle_text)),
- button_block("✏", "edit_puzzle", hunt_and_puzzle)
+ button_block("✏", "edit_puzzle", hunt_and_sort_key)
)
]
"""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.
+ puzzle URL, puzzle state, puzzle type, tags, or solution
+ string. The string can include regular expression syntax. Matching
+ is case insensitive.
"""
p = re.compile('.*'+pattern+'.*', re.IGNORECASE)
if p.match(puzzle['state']):
return True
+ if 'type' in puzzle:
+ if p.match(puzzle['type']):
+ return True
+
if 'solution' in puzzle:
for solution in puzzle['solution']:
if p.match(solution):
return True
+ if 'tags' in puzzle:
+ for tag in puzzle['tags']:
+ if p.match(tag):
+ 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.
+ puzzle URL, puzzle state, puzzle types, tags, 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:
def puzzle_id_from_name(name):
return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
+def puzzle_sort_key(puzzle):
+ """Return an appropriate sort key for a puzzle in the database
+
+ The sort key must start with "puzzle-" to distinguish puzzle items
+ in the database from all non-puzzle items. After that, though, the
+ only requirements are that each puzzle have a unique key and they
+ give us the ordering we want. And for ordering, we want meta puzzles
+ before non-meta puzzles and then alphabetical order by name within
+ each of those groups.
+
+ So puting a "-meta-" prefix in front of the puzzle ID does the trick.
+ """
+
+ return "puzzle-{}{}".format(
+ "-meta-" if puzzle['type'] == "meta" else "",
+ puzzle['puzzle_id']
+ )
+
def puzzle_channel_topic(puzzle):
"""Compute the channel topic for a puzzle"""
if len(links):
topic += "({})".format(', '.join(links))
+ tags = puzzle.get('tags', [])
+ if tags:
+ topic += " {}".format(" ".join(["`{}`".format(t) for t in tags]))
+
state = puzzle.get('state', None)
if state:
topic += " {}".format(state)
channel=channel_id,
name=channel_name
)
+
+# A copy deep enough to work for puzzle_update_channel_and_sheet above
+def puzzle_copy(old_puzzle):
+ new_puzzle = old_puzzle.copy()
+
+ if 'tags' in old_puzzle:
+ new_puzzle['tags'] = old_puzzle['tags'].copy()
+
+ return new_puzzle
projects / turbot / blobdiff