Merge pull request #137 from sindrig/show-length-of-playlist

Show length of playlist

Author: sindrig

spoppy/__init__.py

@@ -10,7 +10,7 @@
 
 
 def get_version():
-    return '1.6.0'
+    return '1.6.1'
 
 
 if click:

spoppy/players.py

@@ -242,9 +242,12 @@ def get_ui(self):
 
                 ])
             right_side_items = [
-                'Shuffle on' if self.shuffle else '',
+                '%d of %d' % (
+                    self.current_track_idx + 1, len(self.song_order)
+                ),
+                'Total playlist length: %s' % self.get_total_playlist_length(),
                 'Repeat: %s' % self.repeat,
-                '%d of %d' % (self.current_track_idx + 1, len(self.song_order))
+                'Shuffle on' if self.shuffle else '',
             ]
             songs_to_show = (
                 list(range(
@@ -259,13 +262,13 @@ def get_ui(self):
             )
             for song_idx in songs_to_show:
                 song = self.get_track_by_idx(song_idx)
-                right_side = right_side_items and right_side_items.pop()
+                right_side = right_side_items and right_side_items.pop(0)
                 if song_idx == self.current_track_idx:
                     if song_idx != songs_to_show[0]:
                         # Small spacing around current...
                         res.append(('', right_side or ''))
                         right_side = (
-                            right_side_items and right_side_items.pop()
+                            right_side_items and right_side_items.pop(0)
                         )
                     formatted_song = '>>>%s' % format_track(
                         song,
@@ -292,6 +295,10 @@ def get_ui(self):
 
         return res
 
+    def get_total_playlist_length(self):
+        total_seconds = sum([song.duration for song in self.song_list]) / 1000
+        return get_duration_from_s(total_seconds, max_length=None)
+
     def trigger_redraw(self):
         '''
         Tell the player to trigger a full redraw in the next loop.

spoppy/util.py

@@ -96,22 +96,28 @@ def sorted_menu_items(items):
         yield key, value
 
 
-def get_duration_from_s(s):
+def get_duration_from_s(s, max_length=59 * 60 + 59):
     '''
     Formats seconds as "%M:%S"
+    If max_length exceed 60, give format in "%H:%M:%S"
     :param s: Seconds in int/float
+    :param max_length: Max length in seconds. Default is 59 minutes, 59 seconds
     :returns: s formatted as "%M:%S"
     '''
-    # Max length is 59 minutes, 59 seconds
-    MAX_LENGTH = 59 * 60 + 59
     if not isinstance(s, (int, float)):
         raise TypeError('Seconds must be int/float')
     elif s < 0:
         raise TypeError('Seconds must be positive')
-    elif s > MAX_LENGTH:
-        s = MAX_LENGTH
-    return '%s:%s' % (
-        str(int(s / 60)).zfill(2),
+    elif max_length and s > max_length:
+        s = max_length
+    m = s / 60
+    h = ''
+    if m > 60:
+        h = ('%s:' % int(m / 60)).zfill(3)
+        m = m % 60
+    return '%s%s:%s' % (
+        h,
+        str(int(m)).zfill(2),
         str(int(s % 60)).zfill(2)
     )
 

tests/test_players.py

@@ -520,3 +520,19 @@ def test_save_as_playlist(self, patched_saveplaylist):
         SavePlaylist.callback(playlist)
         self.assertEqual(self.player.playlist, playlist)
         self.assertEqual(self.player.original_playlist_name, 'foobar')
+
+    @patch('spoppy.players.get_duration_from_s')
+    def test_get_total_playlist_length(self, patched_get_duration_from_s):
+        # total length of list is 71000 ms = 71 s
+        expected_duration = 'Expected this duration message'
+        patched_get_duration_from_s.return_value = expected_duration
+        self.player.song_list = [
+            utils.Track('', '', duration=1000),
+            utils.Track('', '', duration=10000),
+            utils.Track('', '', duration=60000),
+        ]
+        result = self.player.get_total_playlist_length()
+        patched_get_duration_from_s.assert_called_once_with(
+            71, max_length=None
+        )
+        self.assertEquals(result, expected_duration)

tests/test_utils.py

@@ -16,6 +16,20 @@ def test_get_duration_from_s(self):
             self.assertEqual(
                 util.get_duration_from_s(seconds), expected
             )
+        two_hours_minus_second = 2 * 60 * 60 - 1
+        self.assertEqual(
+            util.get_duration_from_s(
+                two_hours_minus_second, max_length=None
+            ),
+            '01:59:59'
+        )
+        one_hour_one_minute_one_second = 1 * 60 * 60 + 60 + 1
+        self.assertEqual(
+            util.get_duration_from_s(
+                one_hour_one_minute_one_second, max_length=None
+            ),
+            '01:01:01'
+        )
 
     def test_get_duration_from_s_raises(self):
         with self.assertRaises(TypeError):

tests/utils.py

@@ -7,13 +7,14 @@
 
 
 class Track(object):
-    def __init__(self, name, artists, available=True):
+    def __init__(self, name, artists, available=True, duration=0):
         self.artists = [Artist(artist) for artist in artists]
         self.name = name
         if available:
             self.availability = TrackAvailability.AVAILABLE
         else:
             self.availability = TrackAvailability.UNAVAILABLE
+        self.duration = duration
 
 
 class Playlist(object):