rename Quest.rookgaard to is_rookgaard_quest

Author: Galarzaa90

CHANGELOG.md

@@ -0,0 +1 @@
+::: tibiawikisql.models.book

docs/api/models/book.md

@@ -125,6 +125,7 @@ nav:
         - Package Index: api/models/index.md
         - Base: api/models/base.md
         - Achievement: api/models/achievement.md
+        - Book: api/models/book.md
         - Charm: api/models/charm.md
         - Creature: api/models/creature.md
         - House: api/models/house.md

mkdocs.yaml

@@ -305,7 +305,7 @@ class Book(WikiEntry, WithStatus, WithVersion, RowModel, table=BookTable):
 
     name: str
     """The name of the book."""
-    book_type: str | None = None
+    book_type: str
     """The type of item this book can be found in."""
     item_id: int | None = None
     """The ID of the item this book is written in."""
@@ -327,8 +327,8 @@ def insert(self, conn: Connection | Cursor) -> None:
             super().insert(conn)
             return
 
-        book_table = Table(self.table.__tablename__)
-        item_table = Table(ItemTable.__tablename__)
+        book_table = self.table.__table__
+        item_table = ItemTable.__table__
 
         q = (
             Query.into(book_table)

tibiawikisql/models/item.py

@@ -167,7 +167,7 @@ class Quest(WikiEntry, WithStatus, WithVersion, RowModel, table=QuestTable):
     """The name of the quest."""
     location: str | None
     """The location of the quest."""
-    rookgaard: bool
+    is_rookgaard_quest: bool
     """Whether this quest is in Rookgaard or not."""
     is_premium: bool
     """Whether this quest requires a Premium account or not."""

tibiawikisql/models/quest.py

@@ -1,8 +1,7 @@
 import re
-from typing import Any, ClassVar
+from typing import Any, ClassVar, TYPE_CHECKING
 
 import mwparserfromhell
-from mwparserfromhell.nodes import Template
 
 import tibiawikisql.schema
 from tibiawikisql.api import Article
@@ -26,6 +25,9 @@
     strip_code,
 )
 
+if TYPE_CHECKING:
+    from mwparserfromhell.nodes import Template
+
 
 def parse_maximum_damage(value: str) -> dict[str, int]:
     """Parse the maximum damage template from TibiaWiki.

tibiawikisql/parsers/creature.py

@@ -7,23 +7,19 @@
 from tibiawikisql.models.quest import ItemReward, Quest, QuestCreature, QuestDanger, QuestReward
 from tibiawikisql.parsers.base import AttributeParser
 from tibiawikisql.parsers import BaseParser
-import tibiawikisql.schema
+from tibiawikisql.schema import QuestTable
 from tibiawikisql.utils import clean_links, parse_boolean, parse_integer
 
 link_pattern = re.compile(r"\[\[([^|\]]+)")
 
 
-def parse_links(value):
+def parse_links(value: str) -> list[str]:
     """Find all the links in a string and returns a list of them.
 
-    Parameters
-    ----------
-    value: :class:`str`
-        A string containing links.
+    Args:
+        value: A string containing links.
 
-    Returns
-    -------
-    list(:class:`str`):
+    Returns:
         The links found in the string.
 
     """
@@ -34,12 +30,12 @@ class QuestParser(BaseParser):
     """Parser for quests."""
 
     model = Quest
-    table = tibiawikisql.schema.QuestTable
+    table = QuestTable
     template_name = "Infobox_Quest"
     attribute_map: ClassVar = {
         "name": AttributeParser.required("name", html.unescape),
         "location": AttributeParser.optional("location", clean_links),
-        "rookgaard": AttributeParser.optional("rookgaardquest", parse_boolean, False),
+        "is_rookgaard_quest": AttributeParser.optional("rookgaardquest", parse_boolean, False),
         "type": AttributeParser.optional("type"),
         "quest_log": AttributeParser.optional("log", parse_boolean),
         "legend": AttributeParser.optional("legend", clean_links),

tibiawikisql/parsers/quest.py

@@ -207,7 +207,7 @@ class BookTable(Table):
     article_id = Column(Integer, primary_key=True)
     title = Column(Text, unique=True)
     name = Column(Text)
-    book_type = Column(Text)
+    book_type = Column(Text, nullable=False)
     item_id = Column(ForeignKey(Integer, "item", "article_id"), index=True)
     location = Column(Text)
     blurb = Column(Text)
@@ -548,7 +548,7 @@ class QuestTable(Table):
     title = Column(Text, no_case=True, unique=True)
     name = Column(Text, index=True, no_case=True)
     location = Column(Text)
-    rookgaard = Column(Boolean, default=False)
+    is_rookgaard_quest = Column(Boolean, default=False)
     type = Column(Text, default="quest", index=True)
     quest_log = Column(Boolean, default=False)
     legend = Column(Text)

tibiawikisql/schema.py

@@ -9,7 +9,8 @@
 from starlette.responses import JSONResponse
 
 from tibiawikisql.api import WikiClient
-from tibiawikisql.models import Achievement, Charm, Creature, House, Imbuement, Item, Key, Mount, Npc, Outfit, Quest, \
+from tibiawikisql.models import Achievement, Book, Charm, Creature, House, Imbuement, Item, Key, Mount, Npc, Outfit, \
+    Quest, \
     Spell, \
     Update, \
     World
@@ -82,6 +83,14 @@ def get_wiki_achievement(
         return None
     return AchievementParser.from_article(article)
 
+@db_router.get("/books/{title}")
+def get_book(
+        conn: Conn,
+        title: str,
+) -> Book | None:
+    return Book.get_by_title(conn, title)
+
+
 
 @db_router.get("/charms/{title}")
 def get_charm(