Merge lp:~dholbach/help-app/1430336 into lp:~ubuntu-touch-coreapps-drivers/help-app/trunk

[Daniel Holbach]

[Nicholas Skaggs (nskaggs)]

LGTM

review: Approve

=== modified file 'HACKING'
--- HACKING	2015-03-10 13:53:09 +0000
+++ HACKING	2015-03-11 11:58:24 +0000
@@ -78,7 +78,8 @@
 Before you get started, run:
 
   sudo apt install python-pelican po4a make bzr \
-	ubuntu-html5-ui-toolkit python3-polib
+	ubuntu-html5-ui-toolkit python3-polib python3-magic \
+	python3-markdown
 
 This will install the necessary files, so you can build the app or web build
 locally and check if your changes actually make sense and look and work well.

=== modified file 'debian/control'
--- debian/control	2015-03-09 12:01:16 +0000
+++ debian/control	2015-03-11 11:58:24 +0000
@@ -6,6 +6,8 @@
                debhelper (>= 9),
                po4a,
                python-pelican (>= 3.5.0~),
+               python3-magic,
+               python3-markdown,
                python3-polib,
 #               ubuntu-html5-ui-toolkit
 Standards-Version: 3.9.6

=== modified file 'edit-here/tests/test_files.py'
--- edit-here/tests/test_files.py	2015-03-06 15:26:07 +0000
+++ edit-here/tests/test_files.py	2015-03-11 11:58:24 +0000
@@ -18,3 +18,9 @@
         sizes = [os.stat(fn).st_size
                  for fn in self.translations.po.langs]
         self.assertNotIn(0, sizes)
+
+    def test_markdown_files(self):
+        fns = self.translations.documents.find_docs()
+        checked_fns = [translations.verify_markdown_file(fn)
+                       for fn in fns]
+        self.assertEqual(len(fns), checked_fns.count(True))

=== modified file 'edit-here/translations.py'
--- edit-here/translations.py	2015-03-10 17:16:10 +0000
+++ edit-here/translations.py	2015-03-11 11:58:24 +0000
@@ -6,6 +6,7 @@
 import shutil
 import subprocess
 import sys
+import tempfile
 
 
 def require(package):
@@ -18,7 +19,17 @@
 except ImportError:
     require('python3-polib')
 
-from pelicanconf import PATH
+try:
+    import magic
+except:
+    require('python3-magic')
+
+try:
+    import markdown
+except:
+    require('python3-markdown')
+
+from pelicanconf import PATH, MD_EXTENSIONS
 
 # This defines how complete we expect translations to be before we
 # generate HTML from them. Needs to be string.
@@ -31,6 +42,38 @@
 
 META_TAGS = ['[TOC]']
 
+MD_MAGIC_FILE_TYPES = [
+    'ASCII text',
+    'UTF-8 Unicode text',
+    'UTF-8 Unicode text, with very long lines',
+    ]
+
+
+def _temp_write_markdown(fn):
+    (ret, tmp) = tempfile.mkstemp()
+    length = 0
+    ret = True
+    try:
+        markdown.markdownFromFile(fn, extensions=MD_EXTENSIONS, output=tmp)
+    except:
+        print('Could not convert "%s" into Markdown.' % fn)
+        ret = False
+    if ret:
+        length = len(open(tmp, 'r').read())
+    os.remove(tmp)
+    return (ret, length)
+
+
+def verify_markdown_file(fn):
+    ms = magic.open(magic.MAGIC_NONE)
+    ms.load()
+    if ms.file(fn) not in MD_MAGIC_FILE_TYPES:
+        return False
+    (ret, length) = _temp_write_markdown(fn)
+    if not length:
+        return False
+    return ret
+
 
 def find_bcp47_code(gettext_code):
     if gettext_code not in [c[0] for c in BCP47_OVERRIDES]:
@@ -239,13 +282,17 @@
 
 class Documents(object):
     def __init__(self):
-        self.docs = []
+        self.docs = [fn for fn in self.find_docs()
+                     if verify_markdown_file(fn)]
+
+    def find_docs(self):
+        docs = []
         for dirpath, dirnames, fns in os.walk(PATH):
-            for fn in [fn for fn in fns
-                       if fn.endswith('.md')]:
-                fn = os.path.relpath(os.path.join(dirpath, fn),
+            docs += [os.path.relpath(os.path.join(dirpath, fn),
                                      os.path.join(PATH, '..'))
-                self.docs += [fn]
+                     for fn in fns
+                     if fn.endswith('.md')]
+        return docs
 
     def translated_doc_fn(self, fn, bcp47_code):
         match = [doc for doc in self.docs