oldnews 0.7.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

oldnews/screens/main.py

@@ -6,6 +6,10 @@ from dataclasses import dataclass
 from datetime import datetime, timedelta
 from webbrowser import open as open_url
 
+##############################################################################
+# BagOfStuff imports.
+from bagofstuff.pipe import Pipe
+
 ##############################################################################
 # OldAs imports.
 from oldas import (
@@ -79,11 +83,12 @@ from ..data import (
     update_configuration,
 )
 from ..providers import MainCommands
-from ..sync import ToRSync
+from ..sync import TheOldReaderSync
 from ..widgets import ArticleContent, ArticleList, Navigation
 from .folder_input import FolderInput
 from .information_display import InformationDisplay
 from .new_subscription import NewSubscription
+from .process_subscription import ProcessSubscription
 
 
 ##############################################################################
@@ -402,17 +407,19 @@ class Main(EnhancedScreen[None]):
     @work(exclusive=True)
     async def action_refresh_from_the_old_reader_command(self) -> None:
         """Load the main data from TheOldReader."""
-        await ToRSync(
+        await TheOldReaderSync(
             self._session,
-            on_new_step=lambda step: self.post_message(self.SubTitle(step)),
-            on_new_result=lambda result: self.notify(result),
-            on_new_folders=lambda folders: self.post_message(self.NewFolders(folders)),
-            on_new_subscriptions=lambda subscriptions: self.post_message(
-                self.NewSubscriptions(subscriptions)
+            on_new_step=Pipe[str, bool](self.SubTitle, self.post_message),
+            on_new_result=self.notify,
+            on_new_folders=Pipe[Folders, bool](self.NewFolders, self.post_message),
+            on_new_subscriptions=Pipe[Subscriptions, bool](
+                self.NewSubscriptions, self.post_message
+            ),
+            on_new_unread=Pipe[LocalUnread, bool](self.NewUnread, self.post_message),
+            on_sync_finished=Pipe[Pipe.Nullary, bool](
+                self.SyncFinished, self.post_message
             ),
-            on_new_unread=lambda unread: self.post_message(self.NewUnread(unread)),
-            on_sync_finished=lambda: self.post_message(self.SyncFinished()),
-        ).refresh()
+        ).sync()
 
     @on(Navigation.CategorySelected)
     def _handle_navigaion_selection(self, message: Navigation.CategorySelected) -> None:
@@ -624,11 +631,10 @@ class Main(EnhancedScreen[None]):
         if subscription := await self.app.push_screen_wait(
             NewSubscription(self.folders)
         ):
-            self.notify(
-                subscription.feed, title="Subscription request sent to TheOldReader..."
-            )
             if (
-                result := await Subscriptions.add(self._session, subscription.feed)
+                result := await self.app.push_screen_wait(
+                    ProcessSubscription(self._session, subscription)
+                )
             ).failed:
                 self.notify(
                     result.error or "TheOldReader did not give a reason",

oldnews/screens/process_subscription.py

@@ -0,0 +1,87 @@
+"""Provides a dialog for waiting for TheOldReader to add a subscription."""
+
+##############################################################################
+# OldAS imports.
+from oldas import Session, Subscriptions
+from oldas.subscriptions import SubscribeResult
+
+##############################################################################
+# Textual imports.
+from textual import work
+from textual.app import ComposeResult
+from textual.containers import Center, Vertical
+from textual.screen import ModalScreen
+from textual.widgets import Label, LoadingIndicator
+
+##############################################################################
+# Local data.
+from .new_subscription import NewSubscriptionData
+
+
+##############################################################################
+class ProcessSubscription(ModalScreen[SubscribeResult]):
+    """Dialog for waiting for TheOldReader to process a subscription."""
+
+    CSS = """
+    ProcessSubscription {
+        align: center middle;
+
+        &> Vertical {
+            padding: 1 2;
+            width: auto;
+            height: auto;
+            min-width: 60%;
+            max-width: 90%;
+            background: $panel;
+            border: panel $border;
+            LoadingIndicator {
+                margin-top: 1;
+            }
+            Center {
+                width: 100%;
+            }
+        }
+    }
+    """
+
+    def __init__(self, session: Session, new_subscription: NewSubscriptionData) -> None:
+        """Initialise the subscription processing dialog object.
+
+        Args:
+            session: The ToR API session object.
+            new_subscription: The new subscription.
+        """
+        self._session = session
+        """The API session object."""
+        self._feed = new_subscription.feed
+        """The feed to subscribe to."""
+        self._folder = new_subscription.folder
+        """The folder to place the subscription in."""
+        super().__init__()
+
+    def compose(self) -> ComposeResult:
+        """Compose the content of the screen."""
+        with Vertical() as dialog:
+            dialog.border_title = "Waiting for TheOldReader to add the feed..."
+            yield Label(
+                f"Subscribing to {self._feed}"
+                + (f" and adding it to {self._folder}" if self._folder else "")
+                + ".\n\n"
+                "TheOldReader can take a short while to scan and add a feed. Please wait...",
+                shrink=True,
+                markup=False,
+            )
+            with Center():
+                yield LoadingIndicator()
+
+    @work
+    async def _request_subscription(self) -> None:
+        """Process the request."""
+        self.dismiss(await Subscriptions.add(self._session, self._feed))
+
+    def on_mount(self) -> None:
+        """Start the work once the DOM is ready."""
+        self._request_subscription()
+
+
+### process_subscription.py ends here

oldnews/sync.py

@@ -4,7 +4,7 @@
 # Python imports.
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
-from typing import Any, AsyncIterator, Callable, Iterable
+from typing import Any, AsyncIterator, Callable, Final, Iterable
 
 ##############################################################################
 # OldAS imports.
@@ -41,10 +41,14 @@ type Callback = Callable[[], Any] | None
 type CallbackWith[T] = Callable[[T], Any] | None
 """Type of callback with a single argument."""
 
+##############################################################################
+BATCH_SIZE: Final[int] = 10
+"""Batch size for downloading articles."""
+
 
 ##############################################################################
 @dataclass
-class ToRSync:
+class TheOldReaderSync:
     """Class that handles syncing data from TheOldReader."""
 
     session: Session
@@ -111,11 +115,11 @@ class ToRSync:
             # TODO: Right now I'm saving articles one at a time; perhaps I
             # should save them in small batches? This would be simple enough
             # -- perhaps same them in batches the same size as the buffer
-            # window I'm using right now (currently 10 articles per trip to
-            # ToR).
+            # window I'm using right now (currently BATCH_SIZE articles per
+            # trip to ToR).
             save_local_articles(Articles([article]))
             loaded += 1
-            if (loaded % 10) == 0:
+            if (loaded % BATCH_SIZE) == 0:
                 self._step(f"{description}: {loaded}", log=False)
         return loaded
 
@@ -147,7 +151,9 @@ class ToRSync:
         )
         for subscription in subscriptions:
             if loaded := await self._download(
-                Articles.stream_new_since(self.session, cutoff, subscription, n=10),
+                Articles.stream_new_since(
+                    self.session, cutoff, subscription, n=BATCH_SIZE
+                ),
                 f"Downloading article backlog for {subscription.title}",
             ):
                 self._result(
@@ -192,7 +198,7 @@ class ToRSync:
             new_grab - timedelta(days=load_configuration().local_history)
         )
         if loaded := await self._download(
-            Articles.stream_new_since(self.session, last_grabbed, n=10),
+            Articles.stream_new_since(self.session, last_grabbed, n=BATCH_SIZE),
             "Downloading articles from TheOldReader",
         ):
             self._result(f"Articles downloaded: {loaded}")
@@ -264,17 +270,17 @@ class ToRSync:
     def _get_unread_counts(
         self, folders: Folders, subscriptions: Subscriptions
     ) -> None:
-        """Get the updated unread counts."""
-        unread = get_local_unread(folders, subscriptions)
-        if self.on_new_unread:
-            self.on_new_unread(unread)
-
-    async def refresh(self) -> None:
-        """Refresh the data from TheOldReader.
+        """Get the updated unread counts.
 
         Args:
-            session: The TheOldReader API session object.
+            folders: The folders to get the counts for.
+            subscriptions: The subscriptions to get the counts for.
         """
+        if self.on_new_unread:
+            self.on_new_unread(get_local_unread(folders, subscriptions))
+
+    async def sync(self) -> None:
+        """Sync the data from TheOldReader."""
         folders = await self._get_folders()
         original_subscriptions, subscriptions = await self._get_subscriptions()
         await self._get_new_articles()

oldnews/widgets/_next_matching_option.py

@@ -0,0 +1,52 @@
+"""Support code for OptionLists that want to find things."""
+
+##############################################################################
+# Python imports.
+from typing import Callable
+
+##############################################################################
+# BagOfStuff imports.
+from bagofstuff.itertools import Direction, starting_at
+
+
+##############################################################################
+def next_matching_option[T](
+    options: list[T],
+    current_highlight: int | None,
+    direction: Direction,
+    matching: Callable[[T], bool] | None = None,
+) -> T | None:
+    """Return a list of `OptionList` options after the highlight.
+
+    Args:
+        options: The options from the given option list.
+        current_highlight: The current highlighted option.
+        direction: The direction to work in.
+        matching: Optional filter to apply to the list.
+
+    Returns:
+        The next matching option, or `None` if there isn't one.
+
+    Notes:
+        If there is no highlight, we default at position 0.
+    """
+    matching = matching or (lambda _: True)
+    if current_highlight is None:
+        current_highlight = 0
+    else:
+        current_highlight += 1 if direction == "forward" else -1
+    return next(
+        (
+            option
+            for option in starting_at(options, current_highlight, direction)
+            if matching(option)
+        ),
+        None,
+    )
+
+
+##############################################################################
+# Re-export the direction type.
+__all__ = ["Direction"]
+
+### _next_matching_option.py ends here

oldnews/widgets/article_list.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 ##############################################################################
 # Python imports.
 from dataclasses import dataclass
+from operator import attrgetter
 from typing import cast
 
 ##############################################################################
@@ -32,7 +33,7 @@ from textual_enhanced.widgets import EnhancedOptionList
 
 ##############################################################################
 # Local imports.
-from ._after_highlight import HighlightDirection, options_after_highlight
+from ._next_matching_option import Direction, next_matching_option
 
 
 ##############################################################################
@@ -142,7 +143,7 @@ class ArticleList(EnhancedOptionList):
         assert isinstance(message.option, ArticleView)
         self.post_message(self.ViewArticle(message.option.article))
 
-    def _highlight_unread(self, direction: HighlightDirection) -> bool:
+    def _highlight_unread(self, direction: Direction) -> bool:
         """Highlight the next unread article, if there is one.
 
         Args:
@@ -152,14 +153,11 @@ class ArticleList(EnhancedOptionList):
             `True` if an unread article was found and highlighted, `False`
             if not.
         """
-        if next_hit := next(
-            options_after_highlight(
-                self,
-                cast(list[ArticleView], self.options),
-                direction,
-                lambda article_view: article_view.article.is_unread,
-            ),
-            None,
+        if next_hit := next_matching_option(
+            cast(list[ArticleView], self.options),
+            self.highlighted,
+            direction,
+            attrgetter("article.is_unread"),
         ):
             if next_hit.id is not None:
                 self.highlighted = self.get_option_index(next_hit.id)
@@ -177,11 +175,11 @@ class ArticleList(EnhancedOptionList):
 
     def highlight_next_unread_article(self) -> None:
         """Highlight the next unread article in the list."""
-        self._highlight_unread("next")
+        self._highlight_unread("forward")
 
     def highlight_previous_unread_article(self) -> None:
         """Highlight the previous unread article in the list."""
-        self._highlight_unread("previous")
+        self._highlight_unread("backward")
 
     def select_next_article(self) -> None:
         """Select the next article in the list."""
@@ -195,12 +193,12 @@ class ArticleList(EnhancedOptionList):
 
     def select_next_unread_article(self) -> None:
         """Select the next unread article in the list."""
-        if self._highlight_unread("next"):
+        if self._highlight_unread("forward"):
             self.call_later(self.run_action, "select")
 
     def select_previous_unread_article(self) -> None:
         """Select the next unread article in the list."""
-        if self._highlight_unread("previous"):
+        if self._highlight_unread("backward"):
             self.call_later(self.run_action, "select")
 
 

oldnews/widgets/navigation.py

@@ -35,7 +35,7 @@ from textual_enhanced.widgets import EnhancedOptionList
 ##############################################################################
 # Local imports.
 from ..data import LocalUnread, get_navigation_state, save_navigation_state
-from ._after_highlight import HighlightDirection, options_after_highlight
+from ._next_matching_option import Direction, next_matching_option
 
 
 ##############################################################################
@@ -328,7 +328,18 @@ class Navigation(EnhancedOptionList):
             return current
         return None
 
-    def _highlight_unread(self, direction: HighlightDirection) -> bool:
+    def _contains_unread(self, category: FolderView | SubscriptionView) -> bool:
+        """Does the given folder or subscription have unread items?
+
+        Args:
+            category: The folder or subscription to check.
+
+        Returns:
+            `True` if there are unread items, `False` if not.
+        """
+        return bool(category.id and self.unread.get(category.id))
+
+    def _highlight_unread(self, direction: Direction) -> bool:
         """Highlight the next category with unread articles, if there is one.
 
         Args:
@@ -338,14 +349,11 @@ class Navigation(EnhancedOptionList):
             `True` if an unread category was found and highlighted, `False`
             if not.
         """
-        if next_hit := next(
-            options_after_highlight(
-                self,
-                cast(list[FolderView | SubscriptionView], self.options),
-                direction,
-                lambda category: bool(category.id and self.unread.get(category.id)),
-            ),
-            None,
+        if next_hit := next_matching_option(
+            cast(list[FolderView | SubscriptionView], self.options),
+            self.highlighted,
+            direction,
+            self._contains_unread,
         ):
             if next_hit.id is not None:
                 self.highlighted = self.get_option_index(next_hit.id)
@@ -355,11 +363,11 @@ class Navigation(EnhancedOptionList):
 
     def highlight_next_unread_category(self) -> None:
         """Highlight the next unread category."""
-        self._highlight_unread("next")
+        self._highlight_unread("forward")
 
     def highlight_previous_unread_category(self) -> None:
         """Highlight the previous unread category."""
-        self._highlight_unread("previous")
+        self._highlight_unread("backward")
 
 
 ### navigation.py ends here

{oldnews-0.7.0.dist-info → oldnews-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oldnews
-Version: 0.7.0
+Version: 0.8.0
 Summary: A terminal-based client for TheOldReader
 Keywords: atom,client,Google Reader,RSS,TheOldReader,terminal,news-reader,news
 Author: Dave Pearson
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
+Requires-Dist: bagofstuff>=0.1.0
 Requires-Dist: html-to-markdown>=2.15.0
 Requires-Dist: oldas>=0.10.0
 Requires-Dist: textual>=6.3.0

{oldnews-0.7.0.dist-info → oldnews-0.8.0.dist-info}/RECORD

@@ -25,15 +25,16 @@ oldnews/screens/__init__.py,sha256=-Iif16T316dnZkgJjX1YE7e4v7FxI0k_V08qd5za0t8,3
 oldnews/screens/folder_input.py,sha256=i6KeRVD1Ucfg2T6VJmzdKKnUHf6qo_1ka0ZLlNMuabA,1869
 oldnews/screens/information_display.py,sha256=-qG1BJxnhF9HtaP8d_HIuRzwMlAwl5raCLIAFpIDODg,2543
 oldnews/screens/login.py,sha256=a2hUERxpKYg7GQIYlpyDgHTAUEKmsANjwHZx1r-gXSw,3377
-oldnews/screens/main.py,sha256=AuCL54UC-DHl-fyRTr1_lSS2hCBXQKizQirpWpLBazs,28618
+oldnews/screens/main.py,sha256=lV62hmWbxn3Iq90gcGyEmX8X2zM7fQUvZVVo-8EcFHY,28766
 oldnews/screens/new_subscription.py,sha256=bk01RXWu3kvJbtm88o1mrYpll73Op3PWWl7ggIH29kk,4011
-oldnews/sync.py,sha256=OZv5JvImvzPAjV6cuCbiSoIeVy0TnfWAq-rL-Xs_ffk,10877
+oldnews/screens/process_subscription.py,sha256=8Z7aJLx-KkItaCQXfgf44cOQ83AZPlRJcMxFDuaHk54,2891
+oldnews/sync.py,sha256=iZbVniwhTTvZmLBGvwviG3wV-lyOBXEPQpm2xgiTeo8,11150
 oldnews/widgets/__init__.py,sha256=5VSjKswHxv2W8g0O-LWlUFS-gy7iQrIM8PGvSBhDNLU,438
-oldnews/widgets/_after_highlight.py,sha256=cUJXUXElKfDrTsmy2WzKqGcxu67mlTamRBSi-VM_ddQ,1903
+oldnews/widgets/_next_matching_option.py,sha256=rKGyIcj_wUcGZEeQJ1QAJmVke1XRsDpNRy9GS7PZEYo,1600
 oldnews/widgets/article_content.py,sha256=pv8zobd3eTsALHYmP854dd_enqy32QXGoWXEILYnWfA,3553
-oldnews/widgets/article_list.py,sha256=dSmSGlk1X94ryy0bJ6ejc2WXO0XMvTWyTxEtR1cL_5k,7428
-oldnews/widgets/navigation.py,sha256=8GMjJtLFnvc9GJH7_ufChLsywPQno7HwWmBIrEnDjgo,12433
-oldnews-0.7.0.dist-info/WHEEL,sha256=e_m4S054HL0hyR3CpOk-b7Q7fDX6BuFkgL5OjAExXas,80
-oldnews-0.7.0.dist-info/entry_points.txt,sha256=FxY6Y4IsHZubhtdd0QJG3p2kCTcXe0e-Ib_AW0qkotE,51
-oldnews-0.7.0.dist-info/METADATA,sha256=BHH_29q28IZdWENsHZ7DpnqXBxoNDznqhJK2Vg-3JQk,2918
-oldnews-0.7.0.dist-info/RECORD,,
+oldnews/widgets/article_list.py,sha256=586r4LLeQbNhamO4pEe0cj_nHDvctPmJTmTw4amHoEM,7372
+oldnews/widgets/navigation.py,sha256=IWlET89rcXw99sNX2at1Zi76EKVADMfm-MzaG_XfCl4,12698
+oldnews-0.8.0.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+oldnews-0.8.0.dist-info/entry_points.txt,sha256=FxY6Y4IsHZubhtdd0QJG3p2kCTcXe0e-Ib_AW0qkotE,51
+oldnews-0.8.0.dist-info/METADATA,sha256=_9fxAFDTm7UlU8AHPV4wkRHdtIi-TTpS9pRkOwC5byQ,2951
+oldnews-0.8.0.dist-info/RECORD,,

{oldnews-0.7.0.dist-info → oldnews-0.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.27
+Generator: uv 0.9.28
 Root-Is-Purelib: true
 Tag: py3-none-any

oldnews/widgets/_after_highlight.py

@@ -1,53 +0,0 @@
-"""Support code for OptionLists that want to find things."""
-
-##############################################################################
-# Python imports.
-from typing import Callable, Iterator, Literal
-
-##############################################################################
-# Textual imports.
-from textual.widgets import OptionList
-
-##############################################################################
-type HighlightDirection = Literal["next", "previous"]
-"""Type of a unread search direction."""
-
-
-##############################################################################
-def options_after_highlight[T](
-    option_list: OptionList,
-    options: list[T],
-    direction: HighlightDirection,
-    option_filter: Callable[[T], bool] | None = None,
-) -> Iterator[T]:
-    """Return a list of `OptionList` options after the highlight.
-
-    Args:
-        option_list: The `OptionList` to work against.
-        options: The options from the given option list.
-        direction: The direction to consider as 'after'.
-        option_filter: Optional filter to apply to the list.
-
-    Returns:
-        An iterator of options.
-
-    Notes:
-        If there is no highlight, we default at position 0.
-
-        The options are taken as a parameter, rather than just been pulled
-        out of `option_list`, so that you have a chance to `cast` the list
-        to the desired type, which in turn ensures that the return type
-        matches.
-    """
-    option_filter = option_filter or (lambda _: True)
-    highlight = option_list.highlighted or 0
-    options = list(reversed(options)) if direction == "previous" else options
-    highlight = (len(options) - highlight - 1) if direction == "previous" else highlight
-    return (
-        option
-        for option in [*options[highlight:], *options[:highlight]][1:]
-        if option_filter(option)
-    )
-
-
-### _after_highlight.py ends here