Merge lp:~dholbach/help-app/break-out-po4a-operations into lp:~ubuntu-touch-coreapps-drivers/help-app/trunk

[Daniel Holbach]

Move all functionality related to po4a into its own class. This will avoid further duplication of the code and make the code in general easier to read.

[David Planella (dpm)]

Looks good to me and it works. Happy to approve, but just so I make sure I understand - could you explain the rationale for the change?

review: Needs Information

[Daniel Holbach (dholbach)]

Simple refactoring to avoid duplication of code.

=== modified file 'edit-here/translations.py'
--- edit-here/translations.py	2015-02-24 09:17:31 +0000
+++ edit-here/translations.py	2015-02-24 11:03:11 +0000
@@ -1,4 +1,5 @@
 import codecs
+import copy
 import glob
 import os
 import shutil
@@ -13,15 +14,66 @@
     'date',
     ]
 
-# This defines how complete we expect translations to be before we generate
-# HTML from them. Needs to be string.
+# This defines how complete we expect translations to be before we
+# generate HTML from them. Needs to be string.
 TRANSLATION_COMPLETION_PERCENTAGE = '0'
 
-PO4A_ARGS = [
-    '-f', 'text',
-    '-o', 'markdown',
-    '-M', 'utf-8',
-    ]
+
+class PO4A(object):
+    def __init__(self, translations_dir, temp_dir):
+        self.default_args = [
+            '-f', 'text',
+            '-o', 'markdown',
+            '-M', 'utf-8',
+            ]
+        self.translations_dir = translations_dir
+        self.temp_dir = temp_dir
+
+    def run(self, po4a_command, additional_args, with_output=False,
+            working_dir=None):
+        if not working_dir:
+            working_dir = self.temp_dir
+        pwd = os.getcwd()
+        args = copy.copy(self.default_args)
+        args += additional_args
+        os.chdir(working_dir)
+        if with_output:
+            ret = subprocess.Popen([po4a_command]+args, stdout=subprocess.PIPE)
+        else:
+            ret = subprocess.call([po4a_command]+args)
+        os.chdir(pwd)
+        return ret
+
+    def gettextize(self, documents):
+        args = []
+        for document in documents:
+            args += ['-m', document]
+        args += [
+            '-p', os.path.join(self.translations_dir, 'help.pot'),
+            '-L', 'utf-8',
+            ]
+        return self.run('po4a-gettextize', args)
+
+    def updatepo(self, langs, documents):
+        for lang in langs:
+            args = []
+            for document in documents:
+                args += ['-m', document]
+            args += ['-p', os.path.join(self.translations_dir, lang+'.po')]
+            ret = self.run('po4a-updatepo', args)
+            if ret:
+                return False
+        return True
+
+    def translate(self, doc, lang):
+        args = [
+            '-k', TRANSLATION_COMPLETION_PERCENTAGE,
+            '-m', doc,
+            '-p', 'po/%s.po' % lang,
+            '-L', 'utf-8',
+            ]
+        return self.run('po4a-translate', args, with_output=True,
+                        working_dir=os.path.join(PATH, '..'))
 
 
 class Translations(object):
@@ -32,10 +84,11 @@
             [os.path.basename(a).split('.po')[0] for a
              in glob.glob(self.translations_dir+'/*.po')]
         self.documents = self._find_documents()
-        self.tempdir = tempfile.mkdtemp()
+        self.temp_dir = tempfile.mkdtemp()
+        self.po4a = PO4A(self.translations_dir, self.temp_dir)
 
     def __del__(self):
-        shutil.rmtree(self.tempdir)
+        shutil.rmtree(self.temp_dir)
 
     def _find_documents(self):
         documents = []
@@ -57,7 +110,7 @@
                 os.remove(f)
 
     def _remove_metadata(self, filename):
-        new_dir = os.path.join(self.tempdir, os.path.dirname(filename))
+        new_dir = os.path.join(self.temp_dir, os.path.dirname(filename))
         os.makedirs(new_dir, exist_ok=True)
         new_filename = os.path.join(new_dir, os.path.basename(filename))
         shutil.copy(filename, new_filename)
@@ -88,42 +141,13 @@
         return True
 
     def generate_pot_file(self):
-        args = PO4A_ARGS.copy()
-        for document in self.documents:
-            args += ['-m', document]
-        args += [
-            '-p', os.path.join(self.translations_dir, 'help.pot'),
-            '-L', 'utf-8',
-            ]
-        pwd = os.getcwd()
-        os.chdir(self.tempdir)
-        subprocess.call(['po4a-gettextize']+args)
-        os.chdir(pwd)
+        return self.po4a.gettextize(self.documents)
 
     def update_po_files(self):
-        pwd = os.getcwd()
-        os.chdir(self.tempdir)
-        for lang in self.available_languages:
-            args = PO4A_ARGS.copy()
-            for document in self.documents:
-                args += ['-m', document]
-            args += ['-p', os.path.join(self.translations_dir, lang+'.po')]
-            ret = subprocess.call(['po4a-updatepo']+args)
-            if ret:
-                return False
-        os.chdir(pwd)
-        return True
+        return self.po4a.updatepo(self.available_languages, self.documents)
 
     def _call_po4a_translate(self, doc, lang):
-        args = PO4A_ARGS.copy()
-        args += [
-            '-k', TRANSLATION_COMPLETION_PERCENTAGE,
-            '-m', doc,
-            '-p', 'po/%s.po' % lang,
-            '-L', 'utf-8',
-            ]
-        res = subprocess.Popen(['po4a-translate']+args,
-                               stdout=subprocess.PIPE)
+        res = self.po4a.translate(doc, lang)
         output = codecs.decode(res.communicate()[0])
         broken_title_line = [line for line in output.split('\n')
                              if line.lower().startswith('title:')][0]