From 651bdf0acc3f65c6cb6f69b91575a52d9aa2af94 Mon Sep 17 00:00:00 2001
From: Thomas Scholtes <thomas-scholtes@gmx.de>
Date: Mon, 7 Apr 2014 18:24:59 +0200
Subject: [PATCH] Refactor convert plugin

* `encode()` raises an error when the command returns with non-zero exit
  status. We catch that in the higher-level conversion functions and skip to
  the next item without writing tags.

* Simplified the handling of the `keep_new` flag.
---
 beetsplug/convert.py | 47 +++++++++++++++++++++++++-------------------
 test/test_convert.py |  2 ++
 2 files changed, 29 insertions(+), 20 deletions(-)

diff --git a/beetsplug/convert.py b/beetsplug/convert.py
index 0e0cadafd..6738faaac 100644
--- a/beetsplug/convert.py
+++ b/beetsplug/convert.py
@@ -22,10 +22,9 @@ import tempfile
 from string import Template
 import pipes
 
+from beets import ui, util, plugins, config
 from beets.plugins import BeetsPlugin
-from beets import ui, util
 from beetsplug.embedart import _embed
-from beets import config
 
 log = logging.getLogger('beets')
 _fs_lock = threading.Lock()
@@ -83,6 +82,12 @@ def get_format():
 
 
 def encode(source, dest):
+    """Encode ``source`` to ``dest`` using the command from ``get_format()``.
+
+    Raises an ``ui.UserError`` if the command was not found and a
+    ``subprocess.CalledProcessError`` if the command exited with a
+    non-zero status code.
+    """
     quiet = config['convert']['quiet'].get()
 
     if not quiet:
@@ -102,15 +107,13 @@ def encode(source, dest):
 
     try:
         util.command_output(opts)
-
     except subprocess.CalledProcessError:
         # Something went wrong (probably Ctrl+C), remove temporary files
         log.info(u'Encoding {0} failed. Cleaning up...'
                  .format(util.displayable_path(source)))
         util.remove(dest)
         util.prune_dirs(os.path.dirname(dest))
-        return
-
+        raise
     except OSError as exc:
         raise ui.UserError(
             u'convert: could invoke ffmpeg: {0}'.format(exc)
@@ -120,7 +123,6 @@ def encode(source, dest):
         log.info(u'Finished encoding {0}'.format(
             util.displayable_path(source))
         )
-    return True
 
 
 def should_transcode(item):
@@ -157,25 +159,28 @@ def convert_item(dest_dir, keep_new, path_formats):
             log.info(u'Moving to {0}'.
                      format(util.displayable_path(dest)))
             util.move(item.path, dest)
+            original = dest
+            _, ext = get_format()
+            converted = os.path.splitext(item.path)[0] + ext
+        else:
+            original = item.path
+            converted = dest
 
         if not should_transcode(item):
             # No transcoding necessary.
             log.info(u'Copying {0}'.format(util.displayable_path(item.path)))
-            if keep_new:
-                util.copy(dest, item.path)
-            else:
-                util.copy(item.path, dest)
-
+            util.copy(original, converted)
         else:
-            if keep_new:
-                _, ext = get_format()
-                item.path = os.path.splitext(item.path)[0] + ext
-                encode(dest, item.path)
-            else:
-                encode(item.path, dest)
+            try:
+                encode(original, converted)
+            except subprocess.CalledProcessError:
+                continue
+
+        if keep_new:
+            item.path = converted
 
         # Write tags from the database to the converted file.
-        item.write(path=dest)
+        item.write(path=converted)
 
         if keep_new:
             # If we're keeping the transcoded file, read it again (after
@@ -189,6 +194,7 @@ def convert_item(dest_dir, keep_new, path_formats):
                 artpath = album.artpath
                 if artpath:
                     _embed(artpath, [item])
+        plugins.send('after_convert', item=item, dest=dest, keepnew=keep_new)
 
 
 def convert_on_import(lib, item):
@@ -200,8 +206,9 @@ def convert_on_import(lib, item):
         fd, dest = tempfile.mkstemp(ext)
         os.close(fd)
         _temp_files.append(dest)  # Delete the transcode later.
-        if encode(item.path, dest) is None:
-            # FIXME we should raise an exception instead
+        try:
+            encode(item.path, dest)
+        except subprocess.CalledProcessError:
             return
         item.path = dest
         item.write()
diff --git a/test/test_convert.py b/test/test_convert.py
index 093b37784..3543e88db 100644
--- a/test/test_convert.py
+++ b/test/test_convert.py
@@ -41,6 +41,7 @@ class ImportConvertTest(unittest.TestCase, TestHelper):
         self.assertIsNotNone(item)
         self.assertTrue(os.path.isfile(item.path))
 
+
 class ImportCliTest(unittest.TestCase, TestHelper):
 
     def setUp(self):
@@ -72,6 +73,7 @@ class ImportCliTest(unittest.TestCase, TestHelper):
         self.item.load()
         self.assertEqual(Path(self.item.path).suffix, '.mp3')
 
+
 def suite():
     return unittest.TestLoader().loadTestsFromName(__name__)