Merge pull request #134 from xgi/feature/133-keybind-update

Feature/133 keybind update

fixes #133

Author: xgi

castero/__init__.py

@@ -23,9 +23,11 @@
     {key_help} - show this help screen
     {key_exit} - exit the client
     {key_add_feed} - add a feed
-    {key_delete} - delete the selected feed
-    {key_reload} - reload/refresh feeds
+    {key_remove} - remove the selected feed
+    {key_reload} - reload all feeds
+    {key_reload_selected} - reload the selected feed
     {key_save} - save episode for offline playback
+    {key_delete} - delete downloaded episodes
     {key_up/key_down} - navigate up/down in menus
     {key_right/key_left} - navigate right/left in menus
     {key_scroll_up/key_scroll_down} - scroll up/down in menus

castero/config.py

@@ -130,6 +130,13 @@ def migrate(self, conf, default_conf) -> None:
             for key in default_conf[section]:
                 default_conf_dict[key] = default_conf[section][key]
 
+        # In an update, we renamed key_delete to key_remove and added a
+        # different key_delete value. If the user has key_delete but not
+        # key_removed, we swap these values manually.
+        if 'key_delete' in conf_dict and 'key_remove' not in conf_dict:
+            conf_dict['key_remove'] = conf_dict['key_delete']
+            conf_dict['key_delete'] = default_conf_dict['key_delete']
+
         with open(self._default_path, "r") as default_conf_file:
             lines = default_conf_file.readlines()
             for line in lines:

castero/database.py

@@ -412,8 +412,8 @@ def queue(self) -> List[Episode]:
         # retrieved ep_ids to get complete list of desired episodes
         return [episodes_cache[ep_id] for ep_id in ep_ids]
 
-    def reload(self, display=None) -> None:
-        """Reload all feeds in the database.
+    def reload(self, display=None, feeds=None) -> None:
+        """Reload feeds in the database.
 
         To preserve user metadata for episodes (such as played/marked status),
         we use Episode.replace_from() which "manually" copies such fields to
@@ -436,10 +436,13 @@ def reload(self, display=None) -> None:
 
         Args:
             display: (optional) the display to write status updates to
+            feeds: (optional) a list of feeds to reload. If not specified,
+                all feeds in the database will be reloaded
         """
-        feeds = self.feeds()
+        if feeds is None:
+            feeds = self.feeds()
         total_feeds = len(feeds)
-        completed_feeds = 1
+        completed_feeds = 0
 
         reqs = []
         url_pairs = {}
@@ -456,24 +459,21 @@ def reload(self, display=None) -> None:
             else:
                 file_feeds.append(feed)
 
-        if display is not None:
-            display.change_status("Reloading feeds...")
-
         # handle each response as downloads complete asynchronously
         for response in grequests.imap(reqs, size=3):
+            if display is not None:
+                display.change_status(
+                    "Reloading feeds (%d/%d)" % (completed_feeds, total_feeds))
             old_feed = url_pairs[response.request.url]
             new_feed = Feed(url=response.request.url, response=response)
-            self._reload_feed(old_feed, new_feed)
+            self._reload_feed_data(old_feed, new_feed)
 
             completed_feeds += 1
-            if display is not None:
-                display.change_status(
-                    "Reloading feeds (%d/%d)" % (completed_feeds, total_feeds))
 
         # handle each file-based feed
         for old_feed in file_feeds:
             new_feed = Feed(file=old_feed.key)
-            self._reload_feed(old_feed, new_feed)
+            self._reload_feed_data(old_feed, new_feed)
 
             completed_feeds += 1
             if display is not None:
@@ -485,7 +485,7 @@ def reload(self, display=None) -> None:
                 "Successfully reloaded %d feeds" % total_feeds)
             display.menus_valid = False
 
-    def _reload_feed(self, old_feed: Feed, new_feed: Feed):
+    def _reload_feed_data(self, old_feed: Feed, new_feed: Feed):
         """Helper method to update a feed and its episodes in the database.
 
         Args:

castero/display.py

@@ -551,36 +551,85 @@ def reload_feeds(self) -> None:
             t = threading.Thread(target=self.database.reload, args=[self])
             t.start()
 
+    def reload_selected_feed(self, feed: Feed) -> None:
+        """Reloads the selected feed.
+
+        This method starts the reloading in a new un-managed thread.
+        """
+        t = threading.Thread(target=self.database.reload, args=[self, [feed]])
+        t.start()
+
     def save_episodes(self, feed=None, episode=None) -> None:
         """Save a feed or episode.
 
-        If the user is saving an episode and the episode is already saved, this
-        method will instead ask the user if they would like to delete the
-        downloaded episode. However, if the user is saving a feed, there is no
-        prompt to delete episodes, even if some are downloaded. In this case,
-        downloaded episodes are simply skipped.
-
         Exactly one of either feed or episode must be given.
 
         Args:
             feed: (optional) a feed to download all episodes of
-            episode: (optional) an episode to download or delete
+            episode: (optional) an episode to download
         """
         assert (feed is None or episode is None) and (feed is not episode)
 
         if feed is not None:
+            num_saved = 0
+            num_to_save = 0
             for episode in self.database.episodes(feed):
                 if not episode.downloaded:
-                    self._download_queue.add(episode)
+                    num_to_save += 1
+
+            if num_to_save == 0:
+                return
+
+            should_delete = self._get_y_n(
+                    "Are you sure you want to download %d"
+                    " episodes from this feed? (y/n): " % num_to_save)
+            if should_delete:
+                for episode in self.database.episodes(feed):
+                    if not episode.downloaded:
+                        self._download_queue.add(episode)
+        else:
+            if not episode.downloaded:
+                self._download_queue.add(episode)
+
+    def delete_episodes(self, feed=None, episode=None) -> None:
+        """Delete a downloaded episode, or all of those from a feed.
+
+        Exactly one of either feed or episode must be given.
+
+        Args:
+            feed: (optional) a feed to delete all episodes of
+            episode: (optional) an episode or delete
+        """
+        assert (feed is None or episode is None) and (feed is not episode)
+
+        if feed is not None:
+            num_deleted = 0
+            num_to_delete = 0
+            for episode in self.database.episodes(feed):
+                if episode.downloaded:
+                    num_to_delete += 1
+
+            if num_to_delete == 0:
+                return
+
+            should_delete = self._get_y_n(
+                    "Are you sure you want to delete %d downloaded"
+                    " episodes from this feed? (y/n): " % num_to_delete)
+            if should_delete:
+                for episode in self.database.episodes(feed):
+                    if episode.downloaded:
+                        episode.delete(self)
+                        num_deleted += 1
+                self.menus_valid = False
+                self.change_status(
+                    "Successfully deleted %d episodes" % num_deleted)
         else:
             if episode.downloaded:
                 should_delete = self._get_y_n(
                     "Are you sure you want to delete the downloaded"
                     " episode? (y/n): ")
                 if should_delete:
                     episode.delete(self)
-            else:
-                self._download_queue.add(episode)
 
     def filter_menu(self, menu: Menu) -> None:
         menu.filter_text = self._get_input_str("Filter: ")

castero/perspective.py

@@ -172,12 +172,16 @@ def _generic_handle_input(self, c) -> bool:
             queue.change_rate(-1, display=self._display)
         elif c == key_mapping[Config['key_add_feed']]:
             self._display.add_feed()
-        elif c == key_mapping[Config['key_delete']]:
+        elif c == key_mapping[Config['key_remove']]:
             if self._active_window == 0:
                 self._display.delete_feed(self._feed_menu.item)
                 self.update_menus()
         elif c == key_mapping[Config['key_reload']]:
             self._display.reload_feeds()
+        elif c == key_mapping[Config['key_reload_selected']]:
+            feed = self._feed_menu.item
+            if feed is not None:
+                self._display.reload_selected_feed(feed)
         elif c == key_mapping[Config['key_show_url']]:
             if self._active_window == 1 and self._episode_menu.item:
                 self._display.show_episode_url(self._episode_menu.item)
@@ -186,6 +190,11 @@ def _generic_handle_input(self, c) -> bool:
                 self._display.save_episodes(feed=self._feed_menu.item)
             elif self._active_window == 1 and self._episode_menu.item:
                 self._display.save_episodes(episode=self._episode_menu.item)
+        elif c == key_mapping[Config['key_delete']]:
+            if self._active_window == 0 and self._feed_menu.item:
+                self._display.delete_episodes(feed=self._feed_menu.item)
+            elif self._active_window == 1 and self._episode_menu.item:
+                self._display.delete_episodes(episode=self._episode_menu.item)
         elif c == key_mapping[Config['key_execute']]:
             if self._active_window == 1 and self._episode_menu.item:
                 self._display.execute_command(self._episode_menu.item)

castero/perspectives/downloadedperspective.py

@@ -138,6 +138,10 @@ def handle_input(self, c) -> bool:
             if self._downloaded_menu.item:
                 self._display.save_episodes(episode=self._downloaded_menu.item)
                 self._display.menus_valid = False
+        elif c == key_mapping[Config['key_delete']]:
+            if self._downloaded_menu.item:
+                self._display.delete_episodes(episode=self._downloaded_menu.item)
+                self._display.menus_valid = False
         elif c == key_mapping[Config['key_mark_played']]:
             if self._active_window == 0:
                 episode = self._downloaded_menu.item
@@ -149,7 +153,9 @@ def handle_input(self, c) -> bool:
             episode = self._downloaded_menu.item
             if episode is not None:
                 self._display.execute_command(episode)
-        elif c == key_mapping[Config['key_delete']]:
+        elif c == key_mapping[Config['key_reload_selected']]:
+            pass
+        elif c == key_mapping[Config['key_remove']]:
             pass
         else:
             keep_running = self._generic_handle_input(c)

castero/perspectives/queueperspective.py

@@ -132,7 +132,7 @@ def handle_input(self, c) -> bool:
             queue.stop()
             queue.clear()
             self._display.menus_valid = False
-        elif c == key_mapping[Config['key_delete']]:
+        elif c == key_mapping[Config['key_remove']]:
             self._remove_selected_from_queue()
         elif c == key_mapping[Config['key_show_url']]:
             item = self._queue_menu.item
@@ -142,8 +142,12 @@ def handle_input(self, c) -> bool:
             item = self._queue_menu.item
             if item is not None:
                 self._display.execute_command(item.episode)
+        elif c == key_mapping[Config['key_reload_selected']]:
+            pass
         elif c == key_mapping[Config['key_save']]:
             pass
+        elif c == key_mapping[Config['key_delete']]:
+            pass
         elif c == key_mapping[Config['key_mark_played']]:
             pass
         elif c == key_mapping[Config['key_filter']]:

castero/templates/castero.conf

@@ -164,18 +164,26 @@ key_exit = q
 # default: a
 key_add_feed = a
 
-# Delete the selected feed.
+# Remove the selected feed.
 # default: d
-key_delete = d
+key_remove = d
 
-# Reload/refresh feeds.
+# Reload/refresh all feeds.
 # default: r
 key_reload = r
 
+# Reload/refresh the selected feed.
+# default: R
+key_reload_selected = R
+
 # Save episode for offline playback.
 # default: s
 key_save = s
 
+# Delete downloaded episodes.
+# default: x
+key_delete = x
+
 # Navigate up.
 # default: UP
 key_up = UP

tests/datafiles/working_no_comments.conf

@@ -39,10 +39,14 @@ key_exit = q
 
 key_add_feed = a
 
-key_delete = d
+key_remove = d
+
+key_delete = x
 
 key_reload = r
 
+key_reload_selected = R
+
 key_save = s
 
 key_up = UP

tests/test_database.py

@@ -142,7 +142,7 @@ def test_database_reload(prevent_modification, display):
 
     display.change_status = mock.MagicMock(name="change_status")
     mydatabase.reload(display)
-    assert display.change_status.call_count == 3
+    assert display.change_status.call_count == 2
     assert mydatabase.feeds()[0].title == real_title