Complete refactor of foods.py to amke adding new foods easier

Author: linuxdaemon

plugins/foods.py

@@ -3,41 +3,49 @@
 import json
 import os
 import re
+from collections import namedtuple, defaultdict
+from itertools import chain
 
 from cloudbot import hook
 from cloudbot.util import textgen
 
 nick_re = re.compile("^[A-Za-z0-9_|.\-\]\[\{\}\*\`]*$", re.I)
 
-sandwich_data = {}
-taco_data = {}
-coffee_data = {}
-noodles_data = {}
-muffin_data = {}
-scone_data = {}
-rice_data = {}
-tea_data = {}
-keto_data = {}
-beer_data = {}
-cheese_data = {}
-pancake_data = {}
-chicken_data = {}
-icecream_data = {}
-brekkie_data = {}
-doobie_data = {}
-pizza_data = {}
-chocolate_data = {}
-pasta_data = {}
-nugget_data = {}
-cereal_data = {}
-pie_data = {}
-sushi_data = {}
-steak_data = {}
-milkshake_data = {}
-kebab_data = {}
-cake_data = {}
-potato_data = {}
-cookie_data = {}
+BasicFood = namedtuple('BasicFood', "name commands datafile unitname")
+
+BASIC_FOOD = (
+    BasicFood("sandwich", "sandwich", "sandwich.json", "a potato"),
+    BasicFood("taco", "taco", "taco.json", "a taco"),
+    BasicFood("coffee", "coffee", "coffee.json", "coffee"),
+    BasicFood("noodles", "noodles", "noodles.json", "noodles"),
+    BasicFood("muffin", "muffin", "muffin.json", "a muffin"),
+    BasicFood("scone", "scone", "scone.json", "a scone"),
+    BasicFood("rice", "rice", "rice.json", "rice"),
+    BasicFood("tea", "tea", "tea.json", "tea"),
+    BasicFood("keto", "keto", "keto.json", "food"),
+    BasicFood("beer", "beer", "beer.json", "beer"),
+    BasicFood("cheese", "cheese", "cheese.json", "cheese"),
+    BasicFood("pancake", "pancake", "pancake.json", "pancakes"),
+    BasicFood("chicken", "chicken", "chicken.json", "chicken"),
+    BasicFood("nugget", "nugget", "nugget.json", "nuggets"),
+    BasicFood("pie", "pie", "pie.json", "pie"),
+    BasicFood("brekkie", ["brekkie", "brekky"], "brekkie.json", "brekkie"),
+    BasicFood("icecream", "icecream", "icecream.json", "icecream"),
+    BasicFood("doobie", "doobie", "doobie.json", "a doobie"),
+    BasicFood("pizza", "pizza", "pizza.json", "pizza"),
+    BasicFood("chocolate", "chocolate", "chocolate.json", "chocolate"),
+    BasicFood("pasta", "pasta", "pasta.json", "pasta"),
+    BasicFood("cereal", "cereal", "cereal.json", "cereal"),
+    BasicFood("sushi", "sushi", "sushi.json", "sushi"),
+    BasicFood("steak", "steak", "steak.json", "a nice steak dinner"),
+    BasicFood("milkshake", "milkshake", "milkshake.json", "a milkshake"),
+    BasicFood("kebab", "kebab", "kebab.json", "a kebab"),
+    BasicFood("cake", "cake", "cake.json", "a cake"),
+    BasicFood("potato", "potato", "potato.json", "a potato"),
+    BasicFood("cookie", "cookie", "cookies.json", "a cookie"),
+)
+
+basic_food_data = defaultdict(dict)
 
 
 def is_valid(target):
@@ -59,36 +67,10 @@ def load_foods(bot):
     """
     :type bot: cloudbot.bot.CloudBot
     """
+    basic_food_data.clear()
 
-    load_template_data(bot, "sandwich.json", sandwich_data)
-    load_template_data(bot, "taco.json", taco_data)
-    load_template_data(bot, "coffee.json", coffee_data)
-    load_template_data(bot, "noodles.json", noodles_data)
-    load_template_data(bot, "muffin.json", muffin_data)
-    load_template_data(bot, "scone.json", scone_data)
-    load_template_data(bot, "rice.json", rice_data)
-    load_template_data(bot, "tea.json", tea_data)
-    load_template_data(bot, "keto.json", keto_data)
-    load_template_data(bot, "beer.json", beer_data)
-    load_template_data(bot, "cheese.json", cheese_data)
-    load_template_data(bot, "pancake.json", pancake_data)
-    load_template_data(bot, "chicken.json", chicken_data)
-    load_template_data(bot, "nugget.json", nugget_data)
-    load_template_data(bot, "pie.json", pie_data)
-    load_template_data(bot, "brekkie.json", brekkie_data)
-    load_template_data(bot, "icecream.json", icecream_data)
-    load_template_data(bot, "doobie.json", doobie_data)
-    load_template_data(bot, "pizza.json", pizza_data)
-    load_template_data(bot, "chocolate.json", chocolate_data)
-    load_template_data(bot, "pasta.json", pasta_data)
-    load_template_data(bot, "cereal.json", cereal_data)
-    load_template_data(bot, "sushi.json", sushi_data)
-    load_template_data(bot, "steak.json", steak_data)
-    load_template_data(bot, "milkshake.json", milkshake_data)
-    load_template_data(bot, "kebab.json", kebab_data)
-    load_template_data(bot, "cake.json", cake_data)
-    load_template_data(bot, "potato.json", potato_data)
-    load_template_data(bot, "cookies.json", cookie_data)
+    for food in BASIC_FOOD:
+        load_template_data(bot, food.datafile, basic_food_data[food.name])
 
 
 def basic_format(text, data, food_type, **kwargs):
@@ -105,208 +87,22 @@ def basic_format(text, data, food_type, **kwargs):
     return generator.generate_string()
 
 
-@asyncio.coroutine
-@hook.command
-def potato(text, action):
-    """<user> - makes <user> a tasty little potato"""
-    # Kept for posterity
-    # <Luke> Hey guys, any good ideas for plugins?
-    # <User> I don't know, something that lists every potato known to man?
-    # <Luke> BRILLIANT
-    action(basic_format(text, potato_data, "a potato"))
-
-
-@asyncio.coroutine
-@hook.command
-def cake(text, action):
-    """<user> - gives <user> an awesome cake"""
-    action(basic_format(text, cake_data, "a cake"))
-
-
-@asyncio.coroutine
-@hook.command
-def cookie(text, action):
-    """<user> - gives <user> a cookie"""
-    action(basic_format(text, cookie_data, "a cookie"))
-
-
-@asyncio.coroutine
-@hook.command
-def sandwich(text, action):
-    """<user> - give a tasty sandwich to <user>"""
-    action(basic_format(text, sandwich_data, "a sandwich"))
-
-
-@asyncio.coroutine
-@hook.command
-def taco(text, action):
-    """<user> - give a taco to <user>"""
-    action(basic_format(text, taco_data, "a taco"))
-
-
-@asyncio.coroutine
-@hook.command
-def coffee(text, action):
-    """<user> - give coffee to <user>"""
-    action(basic_format(text, coffee_data, "coffee"))
-
-
-@asyncio.coroutine
-@hook.command
-def noodles(text, action):
-    """<user> - give noodles to <user>"""
-    action(basic_format(text, noodles_data, "noodles"))
-
-
-@asyncio.coroutine
-@hook.command
-def muffin(text, action):
-    """<user> - give muffin to <user>"""
-    action(basic_format(text, muffin_data, "a muffin"))
-
-
-@asyncio.coroutine
-@hook.command
-def scone(text, action):
-    """<user> - give scone to <user>"""
-    action(basic_format(text, scone_data, "a scone"))
+def make_cmd_list(value):
+    if isinstance(value, str):
+        value = [value]
+    return value
 
 
 @asyncio.coroutine
-@hook.command
-def rice(text, action):
-    """<user> - give rice to <user>"""
-    action(basic_format(text, rice_data, "rice"))
-
-
-@asyncio.coroutine
-@hook.command
-def tea(text, action):
-    """<user> - give tea to <user>"""
-    action(basic_format(text, tea_data, "tea"))
-
-
-@asyncio.coroutine
-@hook.command
-def keto(text, action):
-    """<user> - give keto food to <user>"""
-    action(basic_format(text, keto_data, "food"))
-
-
-@asyncio.coroutine
-@hook.command
-def beer(text, action):
-    """<user> - give beer to <user>"""
-    action(basic_format(text, beer_data, "beer"))
-
-
-@asyncio.coroutine
-@hook.command
-def cheese(text, action):
-    """<user> - give cheese to <user>"""
-    action(basic_format(text, cheese_data, "cheese"))
-
-
-@asyncio.coroutine
-@hook.command
-def pancake(text, action):
-    """<user> - give pancakes to <user>"""
-    action(basic_format(text, pancake_data, "pancakes"))
-
-
-@asyncio.coroutine
-@hook.command
-def chicken(text, action):
-    """<user> - give chicken to <user>"""
-    action(basic_format(text, chicken_data, "chicken"))
-
-
-@asyncio.coroutine
-@hook.command
-def nugget(text, action):
-    """<user> - give nuggets to <user>"""
-    action(basic_format(text, nugget_data, "nuggets"))
-
-
-@asyncio.coroutine
-@hook.command
-def pie(text, action):
-    """<user> - give pie to <user>"""
-    action(basic_format(text, pie_data, "pie"))
-
-
-@asyncio.coroutine
-@hook.command
-def icecream(text, action):
-    """<user> - give icecream to <user>"""
-    action(basic_format(text, icecream_data, "icecream"))
-
-
-@asyncio.coroutine
-@hook.command("brekky", "brekkie")
-def brekkie(text, action):
-    """<user> - give brekkie to <user>"""
-    action(basic_format(text, brekkie_data, "brekkie"))
-
-
-@asyncio.coroutine
-@hook.command("doobie")
-def doobie(text, action):
-    """<user> - pass the doobie to <user>"""
-    action(basic_format(text, doobie_data, "a doobie"))
-
-
-@asyncio.coroutine
-@hook.command("pizza")
-def pizza(text, action):
-    """<user> - give pizza to <user>"""
-    action(basic_format(text, pizza_data, "pizza"))
-
-
-@asyncio.coroutine
-@hook.command("chocolate")
-def chocolate(text, action):
-    """<user> - give chocolate to <user>"""
-    action(basic_format(text, chocolate_data, "chocolate"))
-
-
-@asyncio.coroutine
-@hook.command
-def pasta(text, action):
-    """<user> - give pasta to <user>"""
-    action(basic_format(text, pasta_data, "pasta"))
-
-
-@asyncio.coroutine
-@hook.command
-def cereal(text, action):
-    """<user> - give cereal to <user>"""
-    action(basic_format(text, cereal_data, "cereal"))
-
-
-@asyncio.coroutine
-@hook.command
-def sushi(text, action):
-    """<user> - give sushi to <user>"""
-    action(basic_format(text, sushi_data, "sushi"))
-
-
-@asyncio.coroutine
-@hook.command
-def steak(text, action):
-    """<user> - give a steak dinner to <user>"""
-    action(basic_format(text, steak_data, "a nice steak dinner"))
-
-
-@asyncio.coroutine
-@hook.command
-def milkshake(text, action):
-    """<user> - give a milkshake to <user>"""
-    action(basic_format(text, milkshake_data, "a milkshake"))
-
-
-@asyncio.coroutine
-@hook.command
-def kebab(text, action):
-    """<user> - give a kebab to <user>"""
-    action(basic_format(text, kebab_data, "a delicious kebab"))
+@hook.command(*chain.from_iterable(make_cmd_list(food.commands) for food in BASIC_FOOD))
+def basic_food(text, triggered_command, action):
+    # Find the first food in BASIC_FOOD that matches the triggered command
+    for food in BASIC_FOOD:
+        cmd_list = make_cmd_list(food.commands)
+        if triggered_command in cmd_list or any(cmd.startswith(triggered_command) for cmd in cmd_list):
+            break
+    else:
+        # The triggered command didn't match any loaded foods, WTF!?!?
+        return "{} matched an unknown food in foods.py. Congrats! You found a bug! " \
+               "Please report this right away.".format(triggered_command)
+    action(basic_format(text, basic_food_data[food.name], food.unitname))