WIP add ItemZone

[matrix-shop-bot.git] / matrix_shop_bot / db.py

diff --git a/matrix_shop_bot/db.py b/matrix_shop_bot/db.py
index 186350acfd606f2fd1c5d03da8f25e931341b040..464e8f165c472bd8508ff166b104de5fe4e895b9 100644 (file)
--- a/matrix_shop_bot/db.py
+++ b/matrix_shop_bot/db.py
@@ -4,7 +4,7 @@ from datetime import datetime as dt
 from decimal import Decimal
 from typing import List
 
 from decimal import Decimal
 from typing import List
 

-from sqlmodel import Field, Session, SQLModel, create_engine, select, text, Relationship
+from sqlmodel import Field, Session, SQLModel, create_engine, select, text, Relationship, func

 
 from sqlite3 import IntegrityError
 
 
 from sqlite3 import IntegrityError
 


@@ -17,7 +17,6 @@ def today():
 
 
 logger = logging.getLogger(__name__)
 
 
 logger = logging.getLogger(__name__)

-logging.basicConfig(filename=f'{MODULE}.log', encoding='utf-8', level=logging.DEBUG)

 
 class ItemStoreLink(SQLModel, table=True):
     item_id: int | None = Field(default=None, foreign_key="item.id", primary_key=True)
 
 class ItemStoreLink(SQLModel, table=True):
     item_id: int | None = Field(default=None, foreign_key="item.id", primary_key=True)


@@ -25,6 +24,7 @@ class ItemStoreLink(SQLModel, table=True):
 
 
 class Item(SQLModel, table=True):
 
 
 class Item(SQLModel, table=True):

+    '''An item to shop for.'''

     id: int | None = Field(default=None, primary_key=True)
     name: str = Field(default=None, unique=True)
     price: Decimal | None = Field(decimal_places=2)
     id: int | None = Field(default=None, primary_key=True)
     name: str = Field(default=None, unique=True)
     price: Decimal | None = Field(decimal_places=2)


@@ -33,10 +33,22 @@ class Item(SQLModel, table=True):
     def __str__(self):
         return f'{self.name} (#{self.id})'
 
     def __str__(self):
         return f'{self.name} (#{self.id})'
 

+class ItemZone(SQLModel, table=True):
+    '''Where an item is usually found.
+
+    Matched only by loose text matching, since items come and go, over time.
+    '''
+    id: int | None = Field(default=None, primary_key=True)
+    name: str = Field(default=None, unique=True)  # milk
+    zone: str = Field(default=None, unique=False) # dairy section
+
+

 class PreferStore(SQLModel, table=True):
 class PreferStore(SQLModel, table=True):

+    '''Tracks which store we are shopping at, at the moment.'''

     store_id: int | None = Field(default=None, foreign_key="store.id", primary_key=True)
 
 class Store(SQLModel, table=True):
     store_id: int | None = Field(default=None, foreign_key="store.id", primary_key=True)
 
 class Store(SQLModel, table=True):

+    '''A place to shop at.'''

     id: int | None = Field(default=None, primary_key=True)
     name: str = Field(default=None, unique=True)
     shopping_list: list["Item"] = Relationship(back_populates="stores", link_model=ItemStoreLink)
     id: int | None = Field(default=None, primary_key=True)
     name: str = Field(default=None, unique=True)
     shopping_list: list["Item"] = Relationship(back_populates="stores", link_model=ItemStoreLink)


@@ -44,17 +56,38 @@ class Store(SQLModel, table=True):
     def __str__(self):
         return f'{self.name} (#{self.id})'
 
     def __str__(self):
         return f'{self.name} (#{self.id})'
 

-# May get used later...
-#class PurchaseRecord(SQLModel, table=True):
-#    id: int | None = Field(default=None, primary_key=True)
-#    name: str = Field(default=None, unique=True)
-#    price: Decimal | None = Field(decimal_places=2)
-#    store: Store = Relationship(back_populates="purchase_history")
-#    purchase_date: dt | None = Field(default=None)
+    def get_pretty_shopping_list(self) -> List[str]:
+        results = []
+        results.append(f' ## {self.name}')
+        items = self.shopping_list
+        if not items:
+            results.append(f'-- Nothing to shop for at {self.name} --')
+        else:
+            for item in items:
+                if(item.purchase_date):
+                    results.append(f' - [x] {item}')
+                else:
+                    results.append(f' - [ ] {item}')
+        return results
+
+
+class PurchaseRecord(SQLModel, table=True):
+    '''Tracks when and where items were purchased.'''
+    id: int | None = Field(default=None, primary_key=True)
+    name: str = Field(default=None)
+    price: Decimal | None = Field(decimal_places=2)
+    store: str | None = Field(default=None)
+    purchase_date: dt | None = Field(default=None)
+    def __str__(self):
+        date = self.purchase_date.strftime(DATE_FORMAT)
+        return f'Bought {self.name} at {self.store} on {date}'

 
 def _get_with_id(cls, item_id):
     return select(cls).where(cls.id == item_id)
 
 
 def _get_with_id(cls, item_id):
     return select(cls).where(cls.id == item_id)
 

+def _get_with_name(cls, name):
+    return select(cls).where(func.lower(cls.name) == func.lower(name))
+

 
 class Data():
     def __init__(self, db_file=None):
 
 class Data():
     def __init__(self, db_file=None):


@@ -62,6 +95,7 @@ class Data():
             db_file = os.path.join(os.environ.get('MATRIX_DATA_DIR', ''), f'{MODULE}.db')
 
         self.file = db_file
             db_file = os.path.join(os.environ.get('MATRIX_DATA_DIR', ''), f'{MODULE}.db')
 
         self.file = db_file

+        logger.debug(f'Shop bot is using db file {self.file}')

         self.engine = self.get_engine()
         self.last_store_id = None
 
         self.engine = self.get_engine()
         self.last_store_id = None
 


@@ -114,6 +148,19 @@ class Data():
         self.assign_store(item_id, store_id)
         return store_id
 
         self.assign_store(item_id, store_id)
         return store_id
 

+    def assign_zone(self, item_name, zone_name):
+        item_id = -1
+        with Session(self.engine) as session:
+            try:
+                new = ItemZone(name=item_name)
+                new.zone = zone_name
+                session.add(new)
+                session.commit()
+                item_id = new.id
+            except:
+                pass # Already assigned
+        return item_id
+

     def assign_store(self, item_id, store_id):
         self._set_pref_store_id(store_id)
 
     def assign_store(self, item_id, store_id):
         self._set_pref_store_id(store_id)
 


@@ -127,32 +174,55 @@ class Data():
                 pass # Already assigned
         return ['Success']
 
                 pass # Already assigned
         return ['Success']
 

+    def list_purchases(self, store_name):
+        with Session(self.engine) as session:
+            cmd = select(PurchaseRecord).where(func.lower(PurchaseRecord.store) == func.lower(store_name))
+            records = session.exec(cmd).all()
+            return records

 
     def purchase_items(self, item_ids):
         results = []
         with Session(self.engine) as session:
 
     def purchase_items(self, item_ids):
         results = []
         with Session(self.engine) as session:

+            # Mark items as purchased

             for item_id in item_ids.split(' '):
                 item = session.exec(_get_with_id(Item, item_id)).first()
                 if item:
                     item.purchase_date = dt.today()
             for item_id in item_ids.split(' '):
                 item = session.exec(_get_with_id(Item, item_id)).first()
                 if item:
                     item.purchase_date = dt.today()

-                results.append(str(item))
+                
+                # Track purchase history (locally only!)
+                # to generate recommended shopping lists
+                record = PurchaseRecord()
+                record.name = item.name
+                record.price = item.price
+                record.purchase_date = item.purchase_date
+
+                shopping_at = self._get_pref_store_id() # We bought it here
+                cmd = select(Store).where(Store.id == shopping_at)
+                store = session.exec(cmd).one()
+                record.store = store.name
+                session.add(record)
+
+                results.append(str(record))
+                # results.append(str(item))
+

             session.commit()
         return results
 
             session.commit()
         return results
 

-    def purchase_item(self, item_id):
-        with Session(self.engine) as session:
-            item = session.exec(_get_with_id(Item, item_id)).first()
-            item.purchase_date = dt.today()
-            session.commit()
-        return ['Success']

 
 

-    def clear_list(self, store_id, clear_all=False):
+    def clear_list(self, store_name, clear_all=False):
+        results = []

         with Session(self.engine) as session:
         with Session(self.engine) as session:

-            store = session.exec(_get_with_id(Store, store_id)).first()
+            store = session.exec(_get_with_name(Store, store_name)).first()
+            if not store:
+                return [f'Store {store_name} not found.']
+

             for item in store.shopping_list:
                 if clear_all or item.purchase_date:
                     session.delete(item)
             for item in store.shopping_list:
                 if clear_all or item.purchase_date:
                     session.delete(item)

+

             session.commit()
             session.commit()

+            results = store.get_pretty_shopping_list()
+        return results

 
     def get_stores(self):
         with Session(self.engine) as session:
 
     def get_stores(self):
         with Session(self.engine) as session:


@@ -170,34 +240,22 @@ class Data():
                 return [f'No unsorted items!']
             return items
 
                 return [f'No unsorted items!']
             return items
 

-
-    def get_shopping_list_for_store(self, store_id) -> List[str]:
-        self._set_pref_store_id(store_id)
-        return self.get_shopping_list(store_id)
-

     def get_last_shopping_list(self) -> List[str]:
         store_id = self._get_pref_store_id()
     def get_last_shopping_list(self) -> List[str]:
         store_id = self._get_pref_store_id()

-        return self.get_shopping_list(store_id)
+        with Session(self.engine) as session:
+            store = session.exec(_get_with_id(Store, store_id)).first()
+            if store:
+                return store.get_pretty_shopping_list()
+        return [f'Last shopping list store not found.']

 
 

-    def get_shopping_list(self, store_id) -> List[str]:
-        results = []
+    def get_shopping_list(self, store_name) -> List[str]:
+        retsults = []

         with Session(self.engine) as session:
         with Session(self.engine) as session:

-            cmd = select(Store).where(Store.id == store_id)
-            store = session.exec(cmd).first()
+            store = session.exec(_get_with_name(Store, store_name)).first()

             if not store:
             if not store:

-                return [f'Store {store_id} not found.']
-
-            results.append(f' ## {store.name}')
-
-            items = store.shopping_list
-            if not items:
-                results.append(f'-- Nothing to shop for at {store.name} --')
-            else:
-                for item in items:
-                    if(item.purchase_date):
-                        results.append(f' - [x] {item}')
-                    else:
-                        results.append(f' - [ ] {item}')
+                return [f'Store {store_name} not found.']
+            results = store.get_pretty_shopping_list()
+        self._set_pref_store_id(store.id)

         return results
 
     def remove_item(self, item_id):
         return results
 
     def remove_item(self, item_id):