Merge pull request #83 from MinchinWeb/alt-top-command

Alternate for `top` command

README.md

@@ -32,6 +32,16 @@ Simply install with:
                         (not supported for Python 3.2).
 * [prompt-toolkit][6] : For topydo's _prompt_ mode, which offers a shell-like
                         interface with auto-completion.
+* [arrow][8]          : Used to turn dates into a human readable version.
+* [backports.shutil_get_terminal_size][9] : Used to determine your terminal
+                                            window size. This function was
+                                            added to the standard library in
+                                            Python 3.3 and so is only
+                                            required in older versions of
+                                            Python.
+* [python-dateutil][10]: A dependency of *arrow*.
+* [mock][11]          : Used for testing. This was added to the standard
+                        library in Python 3.3.
 
 Demo
 ----
@@ -46,3 +56,7 @@ Demo
 [5]: https://raw.githubusercontent.com/bram85/topydo/master/doc/topydo.gif
 [6]: https://github.com/jonathanslenders/python-prompt-toolkit
 [7]: https://github.com/collective/icalendar
+[8]: https://github.com/crsmithdev/arrow
+[9]: https://github.com/chrippa/backports.shutil_get_terminal_size
+[10]: https://dateutil.readthedocs.org/
+[11]: https://github.com/testing-cabal/mock

setup.py

@@ -33,9 +33,11 @@ setup(
     ],
     extras_require = {
         ':sys_platform=="win32"': ['colorama>=0.2.5'],
+        ':python_version=="3.2"': ['backports.shutil_get_terminal_size>=1.0.0'],
         'ical': ['icalendar'],
         'prompt-toolkit': ['prompt-toolkit >= 0.53'],
         'test': ['coverage', 'freezegun', 'green', ],
+        'test:python_version=="3.2"': ['mock'],
     },
     entry_points= {
         'console_scripts': ['topydo = topydo.cli.UILoader:main'],

test/data/ListCommand_50_items.txt

+(A) item 1
+(B) item 2
+(C) item 3
+(D) item 4
+(E) item 5
+(F) item 6
+(G) item 7
+(H) item 8
+(I) item 9
+(J) item 10
+(K) item 11
+(L) item 12
+(M) item 13
+(N) item 14
+(O) item 15
+(P) item 16
+(Q) item 17
+(R) item 18
+(S) item 19
+(T) item 20
+(U) item 21
+(V) item 22
+(W) item 23
+(X) item 24
+(Y) item 25
+(Z) item 26
+(A) item 27
+(B) item 28
+(C) item 29
+(D) item 30
+(E) item 31
+(F) item 32
+(G) item 33
+(H) item 34
+(I) item 35
+(J) item 36
+(K) item 37
+(L) item 38
+(M) item 39
+(N) item 40
+(O) item 41
+(P) item 42
+(Q) item 43
+(R) item 44
+(S) item 45
+(T) item 46
+(U) item 47
+(V) item 48
+(W) item 49
+(X) item 50

test/test_list_command.py

@@ -17,17 +17,27 @@
 import codecs
 import re
 import unittest
+from collections import namedtuple
 
 from test.command_testcase import CommandTest
 from test.facilities import load_file_to_todolist
 from topydo.commands.ListCommand import ListCommand
 from topydo.lib.Config import config
 
+# We're searching for 'mock'
+# 'mock' was added as 'unittest.mock' in Python 3.3, but PyPy 3 is based on Python 3.2
+# pylint: disable=no-name-in-module
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
 
 class ListCommandTest(CommandTest):
     def setUp(self):
         super(ListCommandTest, self).setUp()
         self.todolist = load_file_to_todolist("test/data/ListCommandTest.txt")
+        self.terminal_size = namedtuple('terminal_size', ['columns', 'lines'])
 
     def test_list01(self):
         command = ListCommand([""], self.todolist, self.out, self.error)
@@ -313,13 +323,62 @@ class ListCommandTest(CommandTest):
         self.assertEqual(self.errors, "option -z not recognized\n")
 
     def test_list42(self):
-        command = ListCommand(["-x", "+Project1", "-id:1"], self.todolist, self.out,
-            self.error)
+        command = ListCommand(["-x", "+Project1", "-id:1"], self.todolist,
+                              self.out, self.error)
         command.execute()
 
         self.assertEqual(self.output, "|  1| (C) 2015-11-05 Foo @Context2 Not@Context +Project1 Not+Project\n")
         self.assertEqual(self.errors, "")
 
+    def test_list43(self):
+        """Test basic 'N' parameter."""
+        command = ListCommand(["-N"], self.todolist, self.out, self.error)
+        command.execute()
+
+        self.assertEqual(self.output, "|  1| (C) 2015-11-05 Foo @Context2 Not@Context +Project1 Not+Project\n|  4| (C) Drink beer @ home\n|  5| (C) 13 + 29 = 42\n|  2| (D) Bar @Context1 +Project2\n")
+        self.assertEqual(self.errors, "")
+
+    @mock.patch('topydo.commands.ListCommand.get_terminal_size')
+    def test_list44(self, mock_terminal_size):
+        """
+        Test 'N' parameter with output longer than available terminal lines.
+        """
+        self.todolist = load_file_to_todolist("test/data/ListCommand_50_items.txt")
+        mock_terminal_size.return_value = self.terminal_size(80, 23)
+
+        command = ListCommand(["-N"], self.todolist, self.out, self.error)
+        command.execute()
+
+        self.assertEqual(self.output, "|  1| (A) item 1\n| 27| (A) item 27\n|  2| (B) item 2\n| 28| (B) item 28\n|  3| (C) item 3\n| 29| (C) item 29\n|  4| (D) item 4\n| 30| (D) item 30\n|  5| (E) item 5\n| 31| (E) item 31\n|  6| (F) item 6\n| 32| (F) item 32\n|  7| (G) item 7\n| 33| (G) item 33\n|  8| (H) item 8\n| 34| (H) item 34\n|  9| (I) item 9\n| 35| (I) item 35\n| 10| (J) item 10\n| 36| (J) item 36\n| 11| (K) item 11\n")
+        self.assertEqual(self.errors, "")
+
+    @mock.patch('topydo.commands.ListCommand.get_terminal_size')
+    def test_list45(self, mock_terminal_size):
+        """Test basic 'N' parameter with nine line terminal."""
+        # have 9 lines on the terminal will print 7 items and leave 2 lines
+        # for the next prompt
+        mock_terminal_size.return_value = self.terminal_size(100, 9)
+        self.todolist = load_file_to_todolist("test/data/ListCommand_50_items.txt")
+
+        command = ListCommand(["-N"], self.todolist, self.out, self.error)
+        command.execute()
+
+        self.assertEqual(self.output, "|  1| (A) item 1\n| 27| (A) item 27\n|  2| (B) item 2\n| 28| (B) item 28\n|  3| (C) item 3\n| 29| (C) item 29\n|  4| (D) item 4\n")
+        self.assertEqual(self.errors, "")
+
+    @mock.patch('topydo.commands.ListCommand.get_terminal_size')
+    def test_list46(self, mock_terminal_size):
+        """Test basic 'N' parameter with zero height terminal."""
+        # we still print at least 1 item
+        mock_terminal_size.return_value = self.terminal_size(100, 0)
+        self.todolist = load_file_to_todolist("test/data/ListCommand_50_items.txt")
+
+        command = ListCommand(["-N"], self.todolist, self.out, self.error)
+        command.execute()
+
+        self.assertEqual(self.output, "|  1| (A) item 1\n")
+        self.assertEqual(self.errors, "")
+
     def test_help(self):
         command = ListCommand(["help"], self.todolist, self.out, self.error)
         command.execute()

topydo.conf

@@ -52,7 +52,7 @@ append_parent_contexts      = 0
 [aliases]
 ;showall = ls -x
 ;next = ls -n 1
-;top = ls -F '|%I| %x %p %S %k	%{(}H{)}'
+;top = ls -F '%I %x %P %S %k	%{(}H{)}' -N
 ;lsproj = lsprj
 ;listprj = lsprj
 ;listproj = lsprj

topydo/commands/ListCommand.py

@@ -20,6 +20,7 @@ from topydo.lib.Filter import InstanceFilter
 from topydo.lib.PrettyPrinter import pretty_printer_factory
 from topydo.lib.prettyprinters.Format import PrettyPrinterFormatFilter
 from topydo.lib.TodoListBase import InvalidTodoException
+from topydo.lib.Utils import get_terminal_size
 
 
 class ListCommand(ExpressionCommand):
@@ -50,7 +51,7 @@ class ListCommand(ExpressionCommand):
         return True
 
     def _process_flags(self):
-        opts, args = self.getopt('f:F:i:n:s:x')
+        opts, args = self.getopt('f:F:i:n:Ns:x')
 
         for opt, value in opts:
             if opt == '-x':
@@ -69,11 +70,15 @@ class ListCommand(ExpressionCommand):
                     self.printer = None
             elif opt == '-F':
                 self.format = value
+            elif opt == '-N':
+                # 2 lines are assumed to be taken up by printing the next prompt
+                # display at least one item
+                self.limit = max(get_terminal_size().lines - 2, 1)
             elif opt == '-n':
                 try:
                     self.limit = int(value)
                 except ValueError:
-                    pass # use default value in configuration
+                    pass  # use default value in configuration
             elif opt == '-i':
                 self.ids = value.split(',')
 
@@ -142,7 +147,7 @@ class ListCommand(ExpressionCommand):
 
     def usage(self):
         return """Synopsis: ls [-x] [-s <sort_expression>] [-f <output format>]
-[-F <format string>] [expression]"""
+[-F <format string>] [-i <item numbers>] [-N | -n <integer>] [expression]"""
 
     def help(self):
         return """\
@@ -177,6 +182,7 @@ When an expression is given, only the todos matching that expression are shown.
          %k: List of tags separated by spaces (excluding hidden tags).
          %K: List of all tags separated by spaces.
          %p: Priority.
+         %P: Priority or placeholder space if no priority.
          %s: Todo text.
          %S: Todo text, truncated such that an item fits on one line.
          %t: Absolute creation date.
@@ -193,6 +199,8 @@ When an expression is given, only the todos matching that expression are shown.
 
      A tab character serves as a marker to start right alignment.
 -i : Comma separated list of todo IDs to print.
+-n : Number of items to display. Defaults to the value in the configuration.
+-N : Limit number of items displayed such that they fit on the terminal.
 -s : Sort the list according to a sort expression. Defaults to the expression
      in the configuration.
 -x : Show all todos (i.e. do not filter on dependencies or relevance).

topydo/lib/ListFormat.py

@@ -152,6 +152,7 @@ class ListFormatParser(object):
 
             # relative dates in form:  creation, due, start
             'H': lambda t: humanize_dates(t.due_date(), t.start_date(), t.creation_date()),
+
             # todo ID
             'i': lambda t: str(self.todolist.number(t)),
 
@@ -172,6 +173,9 @@ class ListFormatParser(object):
             # priority
             'p': lambda t: t.priority() if t.priority() else '',
 
+            # priority (or placeholder space)
+            'P': lambda t: t.priority() if t.priority() else ' ',
+
             # text
             's': lambda t: t.text(),
 

topydo/lib/Utils.py

@@ -23,6 +23,12 @@ import re
 from collections import namedtuple
 from datetime import date
 
+# shutil.get_terminal_size was added to the standard library in Python 3.3
+try:
+    from shutil import get_terminal_size as _get_terminal_size  # pylint: disable=no-name-in-module
+except ImportError:
+    from backports.shutil_get_terminal_size import get_terminal_size as _get_terminal_size  # pylint: disable=import-error
+
 
 def date_string_to_date(p_date):
     """
@@ -54,15 +60,14 @@ def escape_ansi(p_string):
 
 escape_ansi.pattern = re.compile(r'\x1b[^m]*m')
 
+
 def get_terminal_size():
     """
     Try to determine terminal size at run time. If that is not possible,
     returns the default size of 80x24.
     """
-    from shutil import get_terminal_size # pylint: disable=no-name-in-module
-
     try:
-        sz = get_terminal_size()
+        sz = _get_terminal_size()
     except ValueError:
         """
         This can result from the 'underlying buffer being detached', which