Added support for producing latex code

.github/workflows/ci.yaml

@@ -69,9 +69,6 @@ jobs:
         mkdir ~/.config/fontconfig
         cp fonts/fonts.conf ~/.config/fontconfig
         fc-cache -f -v
-        fc-conflist
-        fc-match -s emoji
-        fc-list | grep -i emoji
 
     - name: Install mystery-o-matic
       run: |

mystery_o_matic/__main__.py

@@ -9,6 +9,7 @@
 
 from mystery_o_matic.output.html import produce_html_output
 from mystery_o_matic.output.text import produce_text_output
+from mystery_o_matic.output.latex import produce_tex_output
 from mystery_o_matic.echidna import create_outdir
 from mystery_o_matic.location import Locations, get_location_data
 from mystery_o_matic.weapons import get_available_weapons
@@ -109,7 +110,7 @@ def main() -> int:
     telegram_api_key = args.telegram_api_key
 
     # Check if the mode is valid
-    if mode not in ["html", "text"]:
+    if mode not in ["html", "text", "latex"]:
         print("Invalid mode", mode)
         print("Only html and text is accepted")
         return -1
@@ -185,6 +186,10 @@ def main() -> int:
         produce_html_output(
             static_dir, out_dir, ['en', 'es'], mystery, weapons_available, weapon_labels, locations, story_clue
         )
+    elif mode == "latex":
+        produce_tex_output(
+            static_dir, out_dir, ['en', 'es'], mystery, weapons_available, weapon_labels, locations, story_clue
+        )
     elif mode == "text":
         produce_text_output(
             static_dir,

mystery_o_matic/output/__init__.py

@@ -1,5 +1,4 @@
 from string import Template
 
-
 def create_template(str):
     return Template(str)

mystery_o_matic/output/latex/__init__.py

@@ -0,0 +1,148 @@
+from mystery_o_matic.output import create_template
+from mystery_o_matic.output.latex.utils import generate_latex_clue_table, generate_latex_weapons_table, get_bullet_list, get_enumeration_list, read_tex_template, create_tex_template, save_tex, get_char_name, get_emoji_name, replace_emojis
+from mystery_o_matic.clues import NoOneElseStatement
+
+def produce_tex_output(static_dir, out_dir, languages, mystery, weapons, weapon_labels, locations, story_clue):
+    intervals = mystery.get_intervals()
+    suspects = mystery.get_suspects()
+
+    names_html = {}
+    for i, char in enumerate(mystery.get_characters()):
+        names_html["CHAR" + str(i + 1)] = get_char_name(char)
+
+    names_html["SUS0"] = suspects[0].capitalize()
+    names_html["SUS1"] = suspects[1].capitalize()
+
+    names_txt = {}
+    for i, char in enumerate(mystery.get_characters()):
+        names_txt["CHAR" + str(i + 1)] = char.lower()
+
+    for room, name in locations.indices.items():
+        names_txt[room] = locations.names['en'][name]
+
+    final_locations_map = {}
+    for c, p in mystery.final_locations.items():
+        c = create_template(c).substitute(names_txt)
+        p = create_template(p).substitute(names_txt)
+        final_locations_map[c] = p
+
+    representations_map = {}
+    for l, r in locations.representations.items():
+        l = create_template("$" + l).substitute(names_txt)
+        representations_map[l] = r
+
+    # the weapons map will be computed reversing the location_weapons one
+    weapons_map = {}
+    for l, w in locations.weapon_locations.items():
+        l = create_template("$" + l).substitute(names_txt)
+        weapons_map[w] = l
+
+    for language in languages:
+
+        if language == "en":
+            names_html["NOBODY"] = "nobody"
+            names_txt["NOBODY"] = "nobody"
+        elif language == "es":
+            names_html["NOBODY"] = "nadie"
+            names_txt["NOBODY"] = "nadie"
+        else:
+            raise ValueError("Unknown language: " + language)
+
+        characters = list(map(lambda char: char.capitalize(), mystery.get_characters()))
+        introLocation = ", ".join(characters[:-1]) + " and " + characters[-1]
+        introLocation += locations.intro[language]
+
+        for room, name in locations.names[language].items():
+            if room not in locations.rindices:
+                continue # skip any missing place
+            index = locations.rindices[room]
+            names_html[index] = name + " (" + get_emoji_name(locations.representations[index]) + ")"
+        for weapon, label in weapon_labels[language].items():
+            if weapon not in weapons:
+                continue
+            if language == "es":
+                label = label.capitalize()
+            names_html[weapon.replace("$", "")] = label + " (" + get_emoji_name(weapons[weapon]) + ")"
+
+        #print(names_html)
+        bullets = []
+        for i, clue in enumerate(mystery.initial_clues):
+            clue = create_template(clue[language]).substitute(names_html)
+            bullets.append(clue)
+
+        sub_bullets = []
+        for clue in mystery.weapon_locations_clues:
+            clue = create_template(clue[language]).substitute(names_html)
+            sub_bullets.append(clue)
+
+        weapon_locations_bullets = mystery.weapon_locations_intro[language]
+        weapon_locations_bullets += get_bullet_list(sub_bullets, language)
+        bullets.append(weapon_locations_bullets)
+        bullets.append(mystery.weapon_locations_outro[language])
+
+        sub_bullets = []
+        for clue in mystery.final_locations_clues:
+            clue = create_template(clue[language]).substitute(names_html)
+            sub_bullets.append(clue)
+
+        final_locations_bullets = mystery.final_locations_intro[language]
+        final_locations_bullets += get_bullet_list(sub_bullets)
+        bullets.append(final_locations_bullets)
+        bullets.append(NoOneElseStatement().string()[language])
+
+        initial_clues = get_bullet_list(bullets)
+
+        additional_clues = []
+
+        for i, clue in enumerate(mystery.additional_clues):
+            clue = replace_emojis(create_template(clue[language]).substitute(names_html))
+            additional_clues.append(clue)
+
+        additional_clues_enumeration = get_enumeration_list(additional_clues)
+
+        #additional_clues_with_lies = []
+
+        #for i, clue in enumerate(mystery.additional_clues_with_lies):
+        #    additional_clues_with_lies.append(
+        #        create_template(clue[language]).substitute(names_html)
+        #    )
+
+        # populate the weapon options
+        weapons_options = []
+        for w in locations.weapon_locations.values():
+            # use the labels in the current language but the values in english
+            weapons_options.append((weapon_labels[language][w], weapon_labels["en"][w]))
+
+        #select_weapons = get_options_selector(weapons_options)
+
+        args = {}
+        args["introLocation"] = introLocation
+        args["initialClues"] = initial_clues
+        args["additionalClues"] = additional_clues_enumeration
+        tables = ""
+
+        for i in range(len(locations.weapon_locations.items())):
+            tables += generate_latex_clue_table(f"ROOM{i}REP", len(intervals), len(mystery.get_characters()), i == 0) + "\n"
+
+        args["cluesTables"] = tables
+        args["weaponsTable"] = generate_latex_weapons_table(len(weapons_options))
+
+        for i in range(len(mystery.get_characters())):
+            args[f"CHAR{i+1}"] = names_html[f"CHAR{i+1}"]
+
+        for room in locations.names[language]:
+            if room not in locations.rindices:
+                continue # skip any missing place
+            index = locations.rindices[room]
+            args[index + "REP"] = get_emoji_name(locations.representations[index])
+
+        for l, w in locations.weapon_locations.items():
+            args[l + "WEAPONREP"] = get_emoji_name(locations.representations[l]) + " " + get_emoji_name(weapons[w])
+
+        for (i, time) in enumerate(intervals):
+            args[f"TIME{i}"] = time
+
+        tex_template = read_tex_template(static_dir + f"/{language}/mystery.template.tex")
+        tex_source = tex_template.substitute(args)
+        tex_source = create_tex_template(tex_source).substitute(args)
+        save_tex(out_dir, language, tex_source)

mystery_o_matic/output/latex/utils.py

@@ -0,0 +1,118 @@
+from contextlib import suppress
+from os import makedirs
+from string import Template
+
+from emoji import demojize
+
+class TexTemplate(Template):
+    delimiter = "$$"
+
+def create_tex_template(str):
+    return TexTemplate(str)
+
+def read_tex_template(filename):
+    try:
+        with open(filename, "r", encoding='utf-8') as f:
+            template = create_tex_template(f.read())
+            return template
+    except FileNotFoundError:
+        raise ValueError(f"Template file not found: {filename}")
+    except UnicodeDecodeError:
+        raise ValueError(f"Template file has invalid encoding: {filename}")
+
+def get_bullet_list(elements, name=""):
+    r = "\\begin{itemize}\n"
+    for element in elements:
+        r += "\\item " + element + "\n"
+    r += "\\end{itemize}"
+    return r
+
+def get_enumeration_list(elements, name=""):
+    r = "\\begin{enumerate}\n"
+    for element in elements:
+        r += "\\item " + element + "\n"
+    r += "\\end{enumerate}"
+    return r
+
+def save_tex(outdir, language, tex):
+    output_dir = f"{outdir}/{language}"
+    with suppress(OSError):
+        makedirs(output_dir)
+
+    filename = f"{output_dir}/mystery.tex"
+    try:
+        with open(filename, "w", encoding='utf-8') as f:
+            f.write(tex)
+    except OSError as e:
+        raise RuntimeError(f"Failed to save LaTeX file: {e}")
+
+    return filename
+
+def get_char_name(name):
+    if name == "NOBODY":
+        return name
+    return name.capitalize()
+
+def get_emoji_name(emoji_char):
+    # Use emoji.demojize to get the name in the format ":emoji_name:"
+    emoji_name = demojize(emoji_char)
+    emoji_name = emoji_name.strip(":").replace("_", "-")
+    # Strip the colons to return just the canonical name
+    return "\\emoji{" + emoji_name + "}"
+
+def replace_emojis(text):
+    no_emojis = demojize(text).replace("(:", "(\\emoji{")
+    no_emojis = no_emojis.replace(":)", "})")
+    no_emojis = no_emojis.replace("_", "-")
+    return no_emojis
+
+def generate_latex_clue_table(name, num_columns, num_rows, include_header = True):
+    # Define the LaTeX column specifier string
+    column_spec = '|c|c|' + '|'.join(['>{\\centering}m{0.04\\paperwidth}' for _ in range(num_columns)]) + '|'
+
+    # Start building the LaTeX table code
+    latex_code = "\\begin{tabular}{" + column_spec + "}\n\\hline\n"
+
+    # First row with $$ROOM0REP and times
+
+    multirow_number = num_rows
+    if (include_header):
+        multirow_number += 1
+
+    latex_code += "\\multirow{ "+ str(multirow_number) + "}{*}{ $$" + name + " } "
+
+    if (include_header):
+        latex_code += "& \\emoji{mantelpiece-clock} & "
+        # Add the $$TIME elements in the first row
+        time_cells = [f"$$TIME{i}" for i in range(num_columns)]
+        latex_code += " & ".join(time_cells) + " \\tabularnewline\n"
+
+        # Add individual clines for each column from the second to the last
+        for col in range(2, num_columns + 2):
+            latex_code += f"\\cline{{{col}-{num_columns + 2}}} "
+        latex_code += "\n"
+
+    # Rows with $$CHAR1, $$CHAR2, $$CHAR3
+    for char_num in range(1, num_rows + 1):
+        latex_code += f" & $$CHAR{char_num} & " + " & ".join([""] * num_columns) + " \\tabularnewline\n"
+
+        # Add individual clines for each column in the current row
+        if (char_num < 3):
+            for col in range(2, num_columns + 2):
+                latex_code += f"\\cline{{{col}-{num_columns + 2}}} "
+            latex_code += "\n"
+
+    # End the table
+    latex_code += "\\hline\n\\end{tabular}\\\\\n"
+
+    return latex_code
+
+def generate_latex_weapons_table(number_weapons):
+    latex_code = '\\begin{tabular}{|>{\centering}p{0.172\paperwidth}|>{\centering}p{0.172\paperwidth}|>{\centering}p{0.172\paperwidth}|>{\centering}p{0.172\paperwidth}|}\n'
+    latex_code += "\\hline\n"
+    for i in range(number_weapons):
+        latex_code += f"$$ROOM{i}WEAPONREP & "
+
+    latex_code = latex_code[:-2] + " \\tabularnewline\n"
+    latex_code += "\\hline\n\\end{tabular}\n"
+    return latex_code

setup.py

@@ -17,6 +17,7 @@
         "mystery_o_matic.output",
         "mystery_o_matic.output.html",
         "mystery_o_matic.output.text",
+        "mystery_o_matic.output.latex",
     ],
     license="AGPL3",
     entry_points="""
@@ -29,6 +30,7 @@
         "pygraphviz",
         "networkx",
         "yattag",
+        "emoji",
         "python-telegram-bot",
     ],
     extras_require=extra_require,

static/en/mystery.template.tex

@@ -0,0 +1,31 @@
+\subsection*{\emoji{robot}Beep boop, a new mystery is up}
+
+$$introLocation
+Help them solve this mystery checking out these initial clues:
+$$initialClues
+
+\begin{center}
+    \includegraphics[height=0.15\paperheight]{locations_small}
+\par\end{center}
+
+\subsubsection*{\emoji{notebook}Detective’s Journal \& Clues}
+\noindent \begin{center}
+
+$$cluesTables
+
+$$weaponsTable
+
+\par\end{center}
+$$additionalClues
+\noindent\ovalbox{\begin{minipage}[t]{1\columnwidth - 2\fboxsep - 0.8pt}%
+\medskip{}
+
+\begin{center}
+\begin{tabular}{ccccc}
+The murderer was... &  & The weapon was... &  & Time of murder was...\tabularnewline
+ &  &  &  & \tabularnewline
+\cline{1-1} \cline{3-3} \cline{5-5}
+ &  &  &  & \tabularnewline
+\end{tabular}
+\par\end{center}%
+\end{minipage}}

static/es/mystery.template.tex

@@ -0,0 +1,31 @@
+\subsection*{\emoji{robot} beep boop, hay un nuevo misterio}
+
+$$introLocation
+Ayúdales a resolver este misterio revisando estas pistas iniciales:
+$$initialClues
+
+\begin{center}
+    \includegraphics[height=0.15\paperheight]{locations_small}
+\par\end{center}
+
+\subsubsection*{\emoji{notebook} Tu diario de detective y tus pistas}
+\noindent \begin{center}
+
+$$cluesTables
+
+$$weaponsTable
+
+\par\end{center}
+$$additionalClues
+\noindent\ovalbox{\begin{minipage}[t]{1\columnwidth - 2\fboxsep - 0.8pt}%
+\medskip{}
+
+\begin{center}
+\begin{tabular}{ccccc}
+The murderer was... &  & The weapon was... &  & Time of murder was...\tabularnewline
+ &  &  &  & \tabularnewline
+\cline{1-1} \cline{3-3} \cline{5-5}
+ &  &  &  & \tabularnewline
+\end{tabular}
+\par\end{center}%
+\end{minipage}}