Add ability to move selected item on top (fixes #683)

rtv/docs.py

@@ -36,6 +36,7 @@
   h     : Return to the previous view
   m     : Move the cursor up one page
   n     : Move the cursor down one page
+  -     : Move the currently selected item to the top
   gg    : Jump to the top of the page
   G     : Jump to the bottom of the page
   1-7   : Sort submissions by category

rtv/objects.py

@@ -374,6 +374,23 @@ def absolute_index(self):
 
         return self.page_index + (self.step * self.cursor_index)
 
+    def focus_up(self):
+        """
+        Move the currently selected item to the top of the page.
+
+        Returns:
+            redraw (bool): Indicates whether or not the screen needs to be
+                redrawn.
+        """
+        redraw = True
+        if self.cursor_index > 0 or self.inverted:
+            self.page_index += self.cursor_index
+            self.cursor_index = 0
+            self.inverted = False
+        else:
+            redraw = False
+        return redraw
+
     def move(self, direction, n_windows):
         """
         Move the cursor up or down by the given increment.

rtv/page.py

@@ -240,6 +240,13 @@ def move_page_bottom(self):
         self.nav.cursor_index = 0
         self.nav.inverted = True
 
+    @PageController.register(Command('FOCUS_UP'))
+    def focus_up(self):
+        """
+        Move the currently selected item to the top of the page.
+        """
+        self.nav.focus_up()
+
     @PageController.register(Command('UPVOTE'))
     @logged_in
     def upvote(self):

rtv/templates/rtv.cfg

@@ -133,6 +133,7 @@ PREVIOUS_THEME = <KEY_F2>
 NEXT_THEME = <KEY_F3>
 PAGE_UP = m, <KEY_PPAGE>, <NAK>
 PAGE_DOWN = n, <KEY_NPAGE>, <EOT>
+FOCUS_UP = -
 PAGE_TOP = gg
 PAGE_BOTTOM = G
 UPVOTE = a

tests/test_objects.py

@@ -590,6 +590,36 @@ def valid_page_cb(index):
     assert valid
     assert redraw
 
+def test_objects_navigator_focus_up():
+
+    def valid_page_cb(index):
+        if index < 0 or index > 9:
+            raise IndexError()
+
+    nav = Navigator(valid_page_cb, cursor_index=3)
+
+    # Move the currently selected item to the top
+    redraw = nav.focus_up()
+    assert nav.page_index == 3
+    assert nav.cursor_index == 0
+    assert not nav.inverted
+    assert redraw
+
+    # Move up and move the currently selected item to the top
+    nav.move(-1, 2)
+    redraw = nav.focus_up()
+    assert nav.page_index == 2
+    assert nav.cursor_index == 0
+    assert not nav.inverted
+    assert not redraw
+
+    # Move down and move the currently selected item to the top
+    nav.move(1, 3)
+    redraw = nav.focus_up()
+    assert nav.page_index == 3
+    assert nav.cursor_index == 0
+    assert not nav.inverted
+    assert redraw
 
 def test_objects_navigator_flip():