App: Add address bar typeahead

[skip ci]

Author: khemarato

scripts/gdrive.py

@@ -92,50 +92,54 @@ def FOLDERS_DATA() -> dict[str, dict[str, str]]:
     FOLDERS_DATA.ret = json.loads(FOLDERS_DATA_FILE.read_text())
   return FOLDERS_DATA.ret
 
-def course_input_completer_factory() -> Callable[[str, int], str]:
-  gfolders: dict[str, dict[str, str]]
+def get_course_suggestions(so_far: str) -> list[str]:
   gfolders = FOLDERS_DATA()
-  suggestions_cache: dict[str, list[str]]
-  suggestions_cache = dict()
-  subfolders_cache = dict()
-  def _ret(so_far: str, suggestion_idx: int) -> str:
+  if '/' not in so_far:
+    return [
+      course_name for course_name in gfolders.keys()
+      if course_name and course_name.startswith(so_far)
+    ]
+  
+  parts = so_far.split('/')
+  course = parts[0]
+  if course not in gfolders:
+    return []
+  
+  links = gfolders[course]
+  flink = links['private'] or links['public']
+  fid = folderlink_to_id(flink)
+  pidx = 1
+  prefix = course
+  while True:
+    subfolders = gcache.get_subfolders(fid)
+    q = parts[pidx].lower()
+    matches = [f for f in subfolders if q in f['name'].lower()]
+    
+    if len(parts) <= pidx + 1:
+      # We are at the last part, return matches
+      ret = []
+      for f in matches:
+        # Check if it has subfolders to add trailing slash
+        has_children = len(gcache.get_subfolders(f['id'])) > 0
+        ret.append(f"{prefix}/{f['name']}{'/' if has_children else ''}")
+      return ret
+    
+    if len(matches) != 1:
+      return []
+    
+    fid = matches[0]['id']
+    prefix = f"{prefix}/{matches[0]['name']}"
+    pidx += 1
+
+def course_input_completer_factory() -> Callable[[str, int], str | None]:
+  suggestions_cache: dict[str, list[str]] = {}
+  def _ret(so_far: str, suggestion_idx: int) -> str | None:
     if so_far not in suggestions_cache:
-      if '/' not in so_far:
-        suggestions_cache[so_far] = [
-          course_name for course_name in gfolders.keys()
-          if course_name and course_name.startswith(so_far)
-        ]
-      else:
-        parts = so_far.split('/')
-        course = parts[0]
-        if course not in gfolders:
-          suggestions_cache[so_far] = []
-        else:
-          links = gfolders[course]
-          flink = links['private'] or links['public']
-          fid = folderlink_to_id(flink)
-          pidx = 1
-          prefix = course
-          while True:
-            if fid in subfolders_cache:
-              subfolders = subfolders_cache[fid]
-            else:
-              subfolders = gcache.get_subfolders(fid)
-              subfolders_cache[fid] = subfolders
-            matches = [f for f in subfolders if parts[pidx].lower() in f['name'].lower()]
-            for f in matches:
-              if f['id'] not in subfolders_cache:
-                subfolders_cache[f['id']] = gcache.get_subfolders(f['id'])
-            if len(parts) <= pidx + 1:
-              suggestions_cache[so_far] = [f"{prefix}/{f['name']}{'/' if subfolders_cache[f['id']] else ''}" for f in matches]
-              break
-            if len(matches) != 1: # Don't know which, so we better run
-              suggestions_cache[so_far] = []
-              break
-            fid = matches[0]['id']
-            prefix = f"{prefix}/{matches[0]['name']}"
-            pidx += 1
-    return suggestions_cache[so_far][suggestion_idx]
+      suggestions_cache[so_far] = get_course_suggestions(so_far)
+    
+    if suggestion_idx < len(suggestions_cache[so_far]):
+      return suggestions_cache[so_far][suggestion_idx]
+    return None
 
   return _ret
 

scripts/gdrive_app.py

@@ -8,7 +8,7 @@
 from PySide6.QtWidgets import (QApplication, QMainWindow, QWidget, QVBoxLayout,
                                QHBoxLayout, QListWidget, QListWidgetItem,
                                QPushButton, QLineEdit, QSplitter, QMessageBox,
-                               QListView, QMenu, QProgressDialog)
+                               QListView, QMenu, QProgressDialog, QCompleter)
 from PySide6.QtCore import Qt, QSize
 from PySide6.QtGui import QIcon, QPixmap, QShortcut, QKeySequence
 
@@ -18,7 +18,7 @@
 
 
 from PySide6.QtSvg import QSvgRenderer
-from PySide6.QtCore import QByteArray, Qt, QRunnable, Signal, QThreadPool, Slot, QTimer, QThread
+from PySide6.QtCore import QByteArray, Qt, QRunnable, Signal, QThreadPool, Slot, QTimer, QThread, QStringListModel
 from PySide6.QtGui import QPainter, QImage
 
 from collections import OrderedDict
@@ -303,6 +303,15 @@ def init_ui(self):
         self.address_bar = QLineEdit()
         self.address_bar.returnPressed.connect(self.on_address_bar_return)
 
+        self.completer = QCompleter()
+        self.completer_model = QStringListModel()
+        self.completer.setModel(self.completer_model)
+        self.completer.setCaseSensitivity(Qt.CaseInsensitive)
+        self.completer.setCompletionMode(QCompleter.PopupCompletion)
+        self.completer.setFilterMode(Qt.MatchContains)
+        self.address_bar.setCompleter(self.completer)
+        self.address_bar.textEdited.connect(self.update_completer)
+        
         top_bar.addWidget(self.back_btn)
         top_bar.addWidget(self.fwd_btn)
         top_bar.addWidget(self.address_bar)
@@ -463,6 +472,13 @@ def on_address_bar_return(self):
         except Exception as e:
             QMessageBox.critical(self, "Error", f"An error occurred: {e}")
 
+    def update_completer(self, text):
+        if not text or not self.gcache:
+            return
+        import gdrive
+        suggestions = gdrive.get_course_suggestions(text)
+        self.completer_model.setStringList(suggestions)
+
     def populate_files(self, items: List[Dict[str, Any]]):
         if hasattr(self, 'current_cancel_flag'):
             self.current_cancel_flag[0] = True

scripts/test_fixtures/drive.sqlite

@@ -605,6 +605,54 @@ def test_handle_close_pair_decision_same_tag_folder(test_db):
                     args, _ = mock_move.call_args
                     assert args[0] == file_b['id']
 
+def test_get_course_suggestions_top_level():
+    mock_folders = {
+        'course1': {'public': 'link1', 'private': 'link2'},
+        'course2': {'public': 'link3', 'private': 'link4'},
+    }
+    with mock.patch('gdrive.FOLDERS_DATA', return_value=mock_folders):
+        suggestions = gdrive.get_course_suggestions('course')
+        assert set(suggestions) == {'course1', 'course2'}
+        
+        suggestions = gdrive.get_course_suggestions('course1')
+        assert suggestions == ['course1']
+
+def test_get_course_suggestions_subfolders(test_db):
+    mock_folders = {
+        'course1': {'public': 'pub1', 'private': 'priv1'},
+    }
+    
+    # Mock folderlink_to_id
+    with mock.patch('gdrive.folderlink_to_id', return_value='priv1_id'), \
+         mock.patch('gdrive.FOLDERS_DATA', return_value=mock_folders), \
+         mock.patch('gdrive.gcache', test_db):
+        
+        # Inject items into test_db
+        with test_db._lock:
+            sql = "INSERT INTO drive_items (id, version, name, mime_type, parent_id, modified_time, owner) VALUES (?, ?, ?, ?, ?, ?, 1)"
+            now = '2024-01-01T00:00:00Z'
+            test_db.cursor.execute(sql, ('priv1_id', 1, 'Course 1', 'application/vnd.google-apps.folder', 'root', now))
+            test_db.cursor.execute(sql, ('sub1_id', 1, 'Sub Folder 1', 'application/vnd.google-apps.folder', 'priv1_id', now))
+            test_db.cursor.execute(sql, ('sub2_id', 1, 'Another Sub', 'application/vnd.google-apps.folder', 'priv1_id', now))
+            test_db.cursor.execute(sql, ('subsub1_id', 1, 'Nested One', 'application/vnd.google-apps.folder', 'sub1_id', now))
+            test_db.conn.commit()
+
+        # course1/ -> matches subfolders of priv1_id
+        suggestions = gdrive.get_course_suggestions('course1/')
+        assert 'course1/Sub Folder 1/' in suggestions
+        assert 'course1/Another Sub' in suggestions
+
+        # course1/sub -> matches Sub Folder 1 (Another Sub doesn't contain "sub")
+        # Wait, q in f['name'].lower()
+        # "Sub Folder 1" contains "sub"
+        # "Another Sub" contains "sub"
+        suggestions = gdrive.get_course_suggestions('course1/sub')
+        assert set(suggestions) == {'course1/Sub Folder 1/', 'course1/Another Sub'}
+        
+        # course1/Sub Folder 1/n -> matches Nested One
+        suggestions = gdrive.get_course_suggestions('course1/Sub Folder 1/n')
+        assert suggestions == ['course1/Sub Folder 1/Nested One']
+
 if __name__ == "__main__":
     if len(sys.argv) > 2 and sys.argv[1] == "extract":
         extract_to_test_db(sys.argv[2:])