Merge lp:~dholbach/developer-ubuntu-com/just-one-rawhtml-plugin into lp:developer-ubuntu-com

[Daniel Holbach]

[lp:~dholbach/developer-ubuntu-com/just-one-rawhtml-plugin]

217. By Daniel Holbach on 2016-04-21

fix test by adapting to new find_text_plugin return value

218. By Daniel Holbach on 2016-04-21

add separate tests for importer.publish

219. By Daniel Holbach on 2016-04-21

add proper logging, configure so that module and time are mentioned as well

220. By Daniel Holbach on 2016-04-22

merged lp:~davidc3/developer-ubuntu-com/hero-tour-fixes

221. By Daniel Holbach on 2016-04-22

go back to importing markdown once a day

222. By Daniel Holbach on 2016-04-22

merged lp:~davidc3/developer-ubuntu-com/hero-tour-fixes again

[David Callé (davidc3)]

+1!

review: Approve

=== modified file 'developer_portal/settings.py'
--- developer_portal/settings.py	2016-03-23 09:19:28 +0000
+++ developer_portal/settings.py	2016-04-22 15:01:37 +0000
@@ -98,7 +98,7 @@
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 
     'django.middleware.cache.FetchFromCacheMiddleware',
-    
+
     'cms.middleware.user.CurrentUserMiddleware',
     'cms.middleware.page.CurrentPageMiddleware',
     'cms.middleware.toolbar.ToolbarMiddleware',
@@ -317,13 +317,13 @@
     'DEFAULT_PERMISSION_CLASSES': [
         'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
     ],
-    
+
     'DEFAULT_AUTHENTICATION_CLASSES': (
         'rest_framework.authentication.BasicAuthentication',
         'rest_framework.authentication.SessionAuthentication',
         'rest_framework.authentication.TokenAuthentication',
     ),
-    
+
     #'PAGINATE_BY': 10,
 }
 
@@ -347,11 +347,17 @@
 LOGGING = {
     'version': 1,
     'disable_existing_loggers': False,
+    'formatters': {
+        'normal': {
+            'format': '%(levelname)s %(asctime)s %(module)s %(message)s'
+        },
+    },
     'handlers': {
         'errors': {
             'level': 'ERROR',
             'class': 'logging.FileHandler',
             'filename': './error.log',
+            'formatter': 'normal',
         },
     },
     'loggers': {

=== modified file 'md_importer/importer/__init__.py'
--- md_importer/importer/__init__.py	2016-03-08 13:07:19 +0000
+++ md_importer/importer/__init__.py	2016-04-22 15:01:37 +0000
@@ -2,6 +2,9 @@
 
 from md_importer.models import ExternalDocsBranchImportDirective
 
+import logging
+logger = logging.getLogger('django')
+
 DEFAULT_LANG = LANGUAGE_CODE
 HOME_PAGE_URL = '/{}/'.format(DEFAULT_LANG)
 SUPPORTED_ARTICLE_TYPES = ['.md', '.html']

=== modified file 'md_importer/importer/article.py'
--- md_importer/importer/article.py	2016-04-18 11:53:26 +0000
+++ md_importer/importer/article.py	2016-04-22 15:01:37 +0000
@@ -1,6 +1,5 @@
 from bs4 import BeautifulSoup
 import codecs
-import logging
 import markdown
 import os
 import re
@@ -9,6 +8,7 @@
 from . import (
     DEFAULT_LANG,
     DEFAULT_TEMPLATE,
+    logger,
     MARKDOWN_EXTENSIONS,
     SUPPORTED_ARTICLE_TYPES,
 )
@@ -51,7 +51,7 @@
 
     def read(self):
         if os.path.splitext(self.fn)[1] not in SUPPORTED_ARTICLE_TYPES:
-            logging.error("Don't know how to interpret '{}'.".format(
+            logger.error("Don't know how to interpret '{}'.".format(
                 self.fn))
             return False
         with codecs.open(self.fn, 'r', encoding='utf-8') as f:
@@ -64,7 +64,7 @@
                 self.html = f.read()
         self._find_local_images()
         if self.local_images:
-            logging.error('Found the following local image(s): {}'.format(
+            logger.error('Found the following local image(s): {}'.format(
                 ', '.join(self.local_images)
             ))
             return False

=== modified file 'md_importer/importer/process.py'
--- md_importer/importer/process.py	2016-04-18 08:56:51 +0000
+++ md_importer/importer/process.py	2016-04-22 15:01:37 +0000
@@ -1,11 +1,11 @@
 import datetime
-import logging
 import pytz
 import shutil
 import tempfile
 
 from django.core.management import call_command
 
+from md_importer.importer import logger
 from md_importer.importer.publish import find_page
 from md_importer.importer.repo import Repo
 from md_importer.models import (
@@ -51,7 +51,7 @@
             branch=branch, last_import__lt=timestamp):
         page = find_page(imported_article.url)
         if not page:
-            logging.error('Page {} not found for deletion.'.format(url))
+            logger.error('Page {} not found for deletion.'.format(url))
         else:
             page.delete()
             imported_article.delete()

=== modified file 'md_importer/importer/publish.py'
--- md_importer/importer/publish.py	2016-04-18 15:28:00 +0000
+++ md_importer/importer/publish.py	2016-04-22 15:01:37 +0000
@@ -1,16 +1,18 @@
 from md_importer.importer import (
     DEFAULT_LANG,
     DEFAULT_TEMPLATE,
+    logger,
 )
 from md_importer.importer.tools import remove_leading_and_trailing_slash
 
+from developer_portal.models import RawHtml
+
 from cms.api import create_page, add_plugin
 from cms.models import Page
 from cms.utils.page_resolver import get_page_from_path
 from djangocms_text_ckeditor.html import clean_html
 
 from bs4 import BeautifulSoup
-import logging
 import re
 import os
 
@@ -42,31 +44,21 @@
         if self.draft.template != template:
             self.draft.template = template
         if html:
-            (self.draft_placeholder,
-             self.draft_text_plugin) = get_text_plugin(self.draft)
             if self.page:
-                (self.placeholder,
-                 self.text_plugin) = get_text_plugin(self.page)
-            if self.draft_text_plugin:
-                if self._text_plugin_needs_update(html):
-                    self.draft_text_plugin.body = html
-                    self.draft_text_plugin.save()
-                else:
-                    # Reset draft
-                    self.draft.revert(DEFAULT_LANG)
+                self.text_plugin = find_text_plugin(self.page)
+            if self._text_plugin_needs_update(html):
+                self.draft_text_plugin.body = html
+                self.draft_text_plugin.save()
             else:
-                self.draft_plugin = add_plugin(
-                    self.draft_placeholder, 'RawHtmlPlugin', DEFAULT_LANG,
-                    body=html)
+                # Reset draft
+                self.draft.revert(DEFAULT_LANG)
 
     def __init__(self, title, full_url, menu_title=None, in_navigation=True,
                  html=None, template=DEFAULT_TEMPLATE):
         self.page = None
         self.draft = None
-        self.draft_placeholder = None
         self.draft_text_plugin = None
         self.text_plugin = None
-        self.placeholder = None
         self.full_url = full_url
         self.title = title
         self.menu_title = menu_title
@@ -85,6 +77,11 @@
                 title=title, template=template, language=DEFAULT_LANG,
                 slug=slug, parent=parent, menu_title=menu_title,
                 in_navigation=in_navigation, position='last-child')
+        else:
+            remove_superfluous_placeholders(self.draft)
+            remove_superfluous_plugins(self.draft)
+        add_rawhtml_plugin(self.draft)
+        self.draft_text_plugin = find_text_plugin(self.draft)
         self.update(title, full_url, menu_title, in_navigation, html,
                     template)
 
@@ -161,23 +158,44 @@
         return root
     parent = get_page_from_path(parent_url, draft=True)
     if not parent:
-        logging.error('Parent {} not found.'.format(parent_url))
+        logger.error('Parent {} not found.'.format(parent_url))
         return None
     return parent
 
 
-def get_text_plugin(page):
-    '''Finds text plugin, creates it if necessary.'''
+# More than one placeholder -> old style page
+def remove_superfluous_placeholders(page):
+    if page.placeholders.count() > 1:
+        for placeholder in page.placeholders.all()[1:]:
+            placeholder.delete()
+    return page.placeholders.all()[0]
+
+
+def remove_superfluous_plugins(page):
+    placeholder = page.placeholders.all()[0]
+    plugins = placeholder.get_plugins()
+    if plugins.count() >= 1:
+        for plugin in plugins[1:]:
+            plugin.delete()
+    if plugins.count() == 1 and \
+       type(plugins[0].get_plugin_instance()[0]) != RawHtml:
+        plugins[0].delete()
+
+
+def add_rawhtml_plugin(page):
+    placeholder = page.placeholders.all()[0]
+    if not placeholder.get_plugins().count():
+        add_plugin(
+            placeholder, 'RawHtmlPlugin', DEFAULT_LANG,
+            body='')
+
+
+def find_text_plugin(page):
     if not page:
-        return (None, None)
+        return None
     placeholders = page.placeholders.all()
     if not placeholders:
-        return (None, None)
+        return None
     # We create the page, so we know there's just one placeholder
     plugins = placeholders[0].get_plugins()
-    if plugins:
-        return (placeholders[0], plugins[0].get_plugin_instance()[0])
-    plugin = add_plugin(
-        placeholders[0], 'RawHtmlPlugin', DEFAULT_LANG,
-        body='')
-    return (placeholders[0], plugin)
+    return plugins[0].get_plugin_instance()[0]

=== modified file 'md_importer/importer/repo.py'
--- md_importer/importer/repo.py	2016-04-19 08:40:41 +0000
+++ md_importer/importer/repo.py	2016-04-22 15:01:37 +0000
@@ -1,6 +1,7 @@
 from . import (
     SUPPORTED_ARTICLE_TYPES,
     DEFAULT_TEMPLATE,
+    logger,
 )
 from .article import Article
 from .publish import (
@@ -13,7 +14,6 @@
 from md_importer.models import ExternalDocsBranchImportDirective
 
 import glob
-import logging
 import os
 
 
@@ -38,7 +38,7 @@
         sourcecode = SourceCode(self.origin, self.checkout_location,
                                 self.branch_name, self.post_checkout_command)
         if sourcecode.get() != 0:
-            logging.error(
+            logger.error(
                     'Could not check out branch "{}".'.format(self.origin))
             return 1
         return 0
@@ -118,7 +118,7 @@
         return True
 
     def _abort_import(self, msg):
-        logging.error('Importing of {} aborted: {}.'.format(self.origin, msg))
+        logger.error('Importing of {} aborted: {}.'.format(self.origin, msg))
         return False
 
     def _read_article(self, fn, write_to, advertise, template):
@@ -130,7 +130,7 @@
     def publish(self):
         for article in self.imported_articles:
             if not article.add_to_db():
-                logging.error('Publishing of {} aborted.'.format(self.origin))
+                logger.error('Publishing of {} aborted.'.format(self.origin))
                 return False
             article.replace_links(self.titles, self.url_map)
         for article in self.imported_articles:

=== modified file 'md_importer/importer/source.py'
--- md_importer/importer/source.py	2016-01-15 20:03:15 +0000
+++ md_importer/importer/source.py	2016-04-22 15:01:37 +0000
@@ -1,4 +1,5 @@
-import logging
+from md_importer.importer import logger
+
 import os
 import shutil
 import subprocess
@@ -43,7 +44,7 @@
                                            self.branch_name])
                 os.chdir(pwd)
             return retcode
-        logging.error(
+        logger.error(
             'Repo format "{}" not understood.'.format(self.origin))
         return 1
 
@@ -56,5 +57,5 @@
         retcode = process.wait()
         os.chdir(pwd)
         if retcode != 0:
-            logging.error(out)
+            logger.error(out)
         return retcode

=== modified file 'md_importer/management/commands/import_md.py'
--- md_importer/management/commands/import_md.py	2016-04-11 07:04:35 +0000
+++ md_importer/management/commands/import_md.py	2016-04-22 15:01:37 +0000
@@ -1,15 +1,14 @@
-import logging
-
 from django.core.management.base import BaseCommand
 
+from md_importer.importer import logger
 from md_importer.importer.process import process_branch
 from md_importer.models import ExternalDocsBranch
 
 
 def import_branches(selection):
     if not ExternalDocsBranch.objects.count():
-        logging.error('No branches registered in the '
-                      'ExternalDocsBranch table yet.')
+        logger.error('No branches registered in the '
+                     'ExternalDocsBranch table yet.')
         return
     for branch in ExternalDocsBranch.objects.filter(
             origin__regex=selection, active=True):
@@ -24,10 +23,6 @@
         parser.add_argument('branches', nargs='*')
 
     def handle(*args, **options):
-        logging.basicConfig(
-            level=logging.ERROR,
-            format='%(asctime)s %(levelname)-8s %(message)s',
-            datefmt='%F %T')
         branches = options['branches']
         if not branches:
             import_branches('.*')

=== modified file 'md_importer/tests/test_branch_import.py'
--- md_importer/tests/test_branch_import.py	2016-04-18 10:30:14 +0000
+++ md_importer/tests/test_branch_import.py	2016-04-22 15:01:37 +0000
@@ -10,7 +10,7 @@
     TEMPLATE_CHOICES,
 )
 from md_importer.importer.article import Article
-from md_importer.importer.publish import get_text_plugin
+from md_importer.importer.publish import find_text_plugin
 from md_importer.importer.tools import remove_trailing_slash
 
 from .utils import (
@@ -241,7 +241,7 @@
         published_pages.update()
         for page in published_pages.pages:
             if page != self.root:
-                (dummy, plugin) = get_text_plugin(page)
+                plugin = find_text_plugin(page)
                 self.assertGreater(now, plugin.changed_date)
 
 

=== added file 'md_importer/tests/test_publish.py'
--- md_importer/tests/test_publish.py	1970-01-01 00:00:00 +0000
+++ md_importer/tests/test_publish.py	2016-04-22 15:01:37 +0000
@@ -0,0 +1,77 @@
+from django.test import TestCase
+
+from cms.api import add_plugin, publish_pages
+
+from developer_portal.models import RawHtml
+
+from md_importer.importer import DEFAULT_LANG
+from md_importer.importer.publish import ArticlePage
+
+from .utils import (
+    db_empty_page_list,
+    db_create_root_page,
+    db_add_empty_page,
+    PublishedPages,
+)
+
+
+class TestCreateArticlePage(TestCase):
+    def runTest(self):
+        db_empty_page_list()
+        db_create_root_page()
+        published_pages = PublishedPages()
+        self.assertTrue(published_pages.has_size(1))
+        article_page = ArticlePage('Test page', 'test')
+        self.assertIsNotNone(article_page)
+        article_page.publish()
+        published_pages.update()
+        self.assertTrue(published_pages.has_size(2))
+
+
+class TestNewArticlePageForCorrectPlaceholderAndPlugins(TestCase):
+    def runTest(self):
+        db_empty_page_list()
+        db_create_root_page()
+        published_pages = PublishedPages()
+        self.assertTrue(published_pages.has_size(1))
+        article_page = ArticlePage('Test page', 'test')
+        self.assertIsNotNone(article_page)
+        article_page.publish()
+        published_pages.update()
+        self.assertTrue(published_pages.has_size(2))
+        placeholders = article_page.page.placeholders
+        self.assertEqual(placeholders.count(), 1)
+        plugins = placeholders.all()[0].get_plugins()
+        self.assertEqual(plugins.count(), 1)
+        self.assertIsInstance(plugins[0].get_plugin_instance()[0], RawHtml)
+
+
+class TestOldArticlePageForCorrectPlaceholderAndPlugins(TestCase):
+    def runTest(self):
+        db_empty_page_list()
+        root = db_create_root_page()
+        published_pages = PublishedPages()
+        self.assertTrue(published_pages.has_size(1))
+        page = db_add_empty_page('Test', parent=root)
+        publish_pages(page)
+        self.assertIsNotNone(page)
+        published_pages.update()
+        self.assertTrue(published_pages.has_size(2))
+        self.assertEqual(page.placeholders.count(), 1)
+        placeholder = page.placeholders.all()[0]
+        add_plugin(placeholder, 'TextPlugin', DEFAULT_LANG, body='')
+        add_plugin(placeholder, 'TextPlugin', DEFAULT_LANG, body='')
+        add_plugin(placeholder, 'TextPlugin', DEFAULT_LANG, body='')
+        plugins = placeholder.get_plugins()
+        self.assertEqual(plugins.count(), 3)
+
+        article_page = ArticlePage('Test', 'test')
+        self.assertIsNotNone(article_page)
+        article_page.publish()
+        published_pages.update()
+        self.assertTrue(published_pages.has_size(2))
+        self.assertEqual(article_page.page.placeholders.count(), 1)
+        placeholder = article_page.page.placeholders.all()[0]
+        plugins = placeholder.get_plugins()
+        self.assertEqual(plugins.count(), 1)
+        self.assertIsInstance(plugins[0].get_plugin_instance()[0], RawHtml)

=== modified file 'md_importer/tests/test_website_import.py'
--- md_importer/tests/test_website_import.py	2016-04-18 10:30:14 +0000
+++ md_importer/tests/test_website_import.py	2016-04-22 15:01:37 +0000
@@ -1,4 +1,3 @@
-from md_importer.importer import DEFAULT_LANG
 from md_importer.importer.repo import Repo
 from .utils import (
     db_add_empty_page,
@@ -6,7 +5,7 @@
     TestLocalBranchImport,
 )
 
-from cms.api import add_plugin, publish_pages
+from cms.api import publish_pages
 
 
 class TestSnappyWebsiteRead(TestLocalBranchImport):
@@ -29,8 +28,6 @@
             'Get started', parent=snappy_page, slug='start')
         as_dev = db_add_empty_page(
             'As developer', parent=start, slug='as-dev')
-        placeholder = as_dev.placeholders.all()[0]
-        add_plugin(placeholder, 'RawHtmlPlugin', DEFAULT_LANG, body='')
         page_16_04 = db_add_empty_page(
             '16.04', parent=as_dev, slug='16-04')
         publish_pages([snappy_page, start, as_dev, page_16_04])

=== modified file 'templates/snappy_hero_tour.html'
--- templates/snappy_hero_tour.html	2016-03-08 16:44:33 +0000
+++ templates/snappy_hero_tour.html	2016-04-22 15:01:37 +0000
@@ -99,31 +99,31 @@
         document.getElementById("button-container-right").style.display = "block";
     }
 
-    // Set next button url
-    nextBtn.href = getChoicesString();
+    // Get cookies
+    getChoicesString();
 
     // Setup navigation dots
-    setDots()
+    setNav()
 
     // Dynamically update all nav urls to match user choices
     if (!path.includes("/step")) {
         var atags = document.getElementsByTagName('a');
         for (var i = 0, length = atags.length; i < length; i++) { 
             atags[i].addEventListener('mouseover', function () {
-                nextBtn.href = getChoicesString();
-                setDots();
+                getChoicesString();
+                setNav();
             });
             atags[i].addEventListener('mousedown', function () {
-                nextBtn.href = getChoicesString();
-                setDots();
+                getChoicesString();
+                setNav();
             });
         }
     }
 
-    function setDots() {
+    function setNav() {
         var dots = document.getElementsByClassName("dot");
         for (var i = 0, length = dots.length; i < length; i++) {
-            dots[i].firstChild.href = createURLForDot(dots.length, i + 1)
+            dots[i].firstChild.href = createURLForDot(i + 1)
             var short_path = path.split("/snappy/get-started/")[1];
             var short_url = dots[i].firstChild.href.split("/snappy/get-started/")[1];
             if (short_path == short_url.replace("#", "")) {
@@ -134,27 +134,59 @@
                 removeClass(dots[i].firstChild.children[1], "here");
             }
         }
+        if (path.includes("/step")) {
+            page = path.split("/").reverse()[1];
+            current_step = page.split("-")[0].slice(-1);
+            }
+        else {
+            current_step = 1;
+        }
+        nextBtn.href = createURLForDot(parseInt(current_step)+1)
     }
 
-    function createURLForDot(length, position) {
+    function createURLForDot(position) {
         var host = getCookie("snappy-tour-host");
         var version = getCookie("snappy-tour-version");
         var target = getCookie("snappy-tour-target");
         var url = "";
         if (position == 1) {
             if (path.includes("/step")) {
-                url = "..";
+                url = "../..";
             }
             else {
                 url += "#";
             }
         }
-        else {
-            if (path.includes("/step")) {
-                url = "../step" + position + "-" + host + "-" + target + "/";
-            }
-            else {
-                url = version + "/step" + position + "-" + host + "-" + target + "/";
+	else if (position == 2) {
+            if (path.includes("/step")) {
+                url = "../step" + position + "-setup-" + target + "-" + host + "/";
+            }
+            else {
+                url = version + "/step" + position + "-setup-" + target + "-" + host + "/";
+            }
+        }
+	else if (position == 3) {
+            if (path.includes("/step")) {
+                url = "../step" + position + "-get-familiar/";
+            }
+            else {
+                url = version + "/step" + position + "-get-familiar/";
+            }
+        }
+	else if (position == 4) {
+            if (path.includes("/step")) {
+                url = "../step" + position + "-first-snap/";
+            }
+            else {
+                url = version + "/step" + position + "-first-snap/";
+            }
+        }
+	else {
+            if (path.includes("/step")) {
+                url = "../step" + position + "-further-readings/";
+            }
+            else {
+                url = version + "/step" + position + "-further-readings/";
             }
         }
         return url;
@@ -167,7 +199,6 @@
             next_step = current_step.replace(/(\d+)/, function () {
                 return arguments[1] * 1 + 1;
             });
-            return "../" + page.replace(current_step, next_step);
         }
         else {
             var step = "step2";
@@ -193,7 +224,6 @@
             setCookie("snappy-tour-version", version);
             setCookie("snappy-tour-host", host);
             setCookie("snappy-tour-target", target);
-            return version + "/" + step + "-" + host + "-" + target + "/";
         }
     }
 
@@ -332,3 +362,4 @@
 {% endblock %}
 {% block footer %}
 {% endblock %}
+