Changeset 12408 for main/waeup.ikoba/trunk/src/waeup

Timestamp:

6 Jan 2015, 09:15:21 (10 years ago)

Author:

Henrik Bettermann

Message:

Add RESTDocument.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba

Files:

• customers/fileviewlets.py (modified) (2 diffs)
• documents/browser.py (modified) (4 diffs)
• documents/document.py (modified) (3 diffs)
• documents/interfaces.py (modified) (1 diff)
• documents/tests/test_browser.py (modified) (1 diff)
• documents/tests/test_document.py (modified) (2 diffs)
• documents/utils.py (modified) (1 diff)
• utils/helpers.py (modified) (1 diff)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/fileviewlets.py

@@ -90 +90 @@
     label = _(u'Sample Scan')
     title = _(u'Sample Scan')
-    mus = 1024 * 50
+    mus = 1024 * 200
     download_name = u'sample'
     tab_redirect = '#tab2'
@@ -134 +134 @@
     label = _(u'PDF File')
     title = _(u'PDF File')
-    mus = 1024 * 200
+    mus = 1024 * 1000
     download_name = u'sample.pdf'
     tab_redirect = '#tab2'

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/browser.py

@@ -33 +33 @@
 from zope.formlib.textwidgets import BytesDisplayWidget
 from zope.security import checkPermission
-from waeup.ikoba.utils.helpers import html2dict
+from waeup.ikoba.utils.helpers import html2dict, rest2dict
 from waeup.ikoba.interfaces import MessageFactory as _
 from waeup.ikoba.interfaces import (
@@ -49 +49 @@
 
 from waeup.ikoba.documents.interfaces import (
-    IDocumentsContainer, IPublicDocument, IHTMLDocument, IDocumentsUtils)
+    IDocumentsContainer, IPublicDocument,
+    IHTMLDocument, IRESTDocument, IDocumentsUtils)
 
 grok.context(IIkobaObject) # Make IKofaObject the default context
@@ -217 +218 @@
 
 
+class RESTDocumentDisplayFormPage(HTMLDocumentDisplayFormPage):
+    """ Page to display html document data
+    """
+    grok.context(IRESTDocument)
+
+    @property
+    def form_fields(self):
+        return grok.AutoFields(self.context.form_fields_interface).omit(
+            'html_dict', 'rest_multilingual')
+
+
+class RESTDocumentDisplayContentPage(HTMLDocumentDisplayContentPage):
+    """ Page to display the html content of document
+    """
+    grok.context(IRESTDocument)
+
+    label = None
+
+
 class DocumentManageFormPage(IkobaEditFormPage,
                             LocalRoleAssignmentUtilityView):
@@ -270 +290 @@
         portal_language = getUtility(IIkobaUtils).PORTAL_LANGUAGE
         self.context.html_dict = html2dict(html_multilingual, portal_language)
+        return
+
+
+class RESTDocumentManageFormPage(DocumentManageFormPage):
+    """ View to manage restdocument data
+    """
+    grok.context(IRESTDocument)
+    grok.template('htmldocumentmanagepage')
+
+    @action(_('Save'), style='primary')
+    def save(self, **data):
+        msave(self, **data)
+        html_multilingual = getattr(self.context, 'rest_multilingual', None)
+        portal_language = getUtility(IIkobaUtils).PORTAL_LANGUAGE
+        self.context.html_dict = rest2dict(html_multilingual, portal_language)
         return
 

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/document.py

@@ -38 +38 @@
 from waeup.ikoba.documents.interfaces import (
     IDocument, IPublicDocument, IDocumentsUtils,
-    IPDFDocument, IHTMLDocument)
+    IPDFDocument, IHTMLDocument, IRESTDocument)
 
 class Document(grok.Container):
@@ -150 +150 @@
 
 
+class RESTDocument(PublicDocumentBase):
+    """This is a  document to render html-coded text.
+    """
+    grok.implements(IRESTDocument)
+    grok.provides(IRESTDocument)
+
+    form_fields_interface = IRESTDocument
+
+    def __init__(self, *args, **kw):
+        super(RESTDocument, self).__init__(*args, **kw)
+        self.html_dict = {}
+
+RESTDocument = attrs_to_fields(RESTDocument)
+
+
 class PDFDocumentFactory(grok.GlobalUtility):
     """A factory for documents.
@@ -178 +193 @@
     def getInterfaces(self):
         return implementedBy(HTMLDocument)
+
+
+class RESTDocumentFactory(grok.GlobalUtility):
+    """A factory for REST documents.
+    """
+    grok.implements(IFactory)
+    grok.name(u'waeup.RESTDocument')
+    title = u"Create a new REST document.",
+    description = u"This factory instantiates new REST documents."
+
+    def __call__(self, *args, **kw):
+        return RESTDocument(*args, **kw)
+
+    def getInterfaces(self):
+        return implementedBy(RESTDocument)
+
 
 #: The file id marker for files

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py

@@ -92 +92 @@
     """
 
-    html_dict = Attribute('Content as language dictionary with values in html format')
+    html_dict = Attribute('Content as language dictionary with values in HTML format')
 
     html_multilingual = schema.Text(
         title = _(u'Multilingual content in HTML format'),
+        required = False,
+        )
+
+class IRESTDocument(IPublicDocument):
+    """A base representation of REST documents.
+
+    """
+
+    html_dict = Attribute(
+        'Content as language dictionary with values in HTML format')
+
+    rest_multilingual = schema.Text(
+        title = _(u'Multilingual content in REST (reStructuredText) format'),
         required = False,
         )

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/tests/test_browser.py

@@ -292 +292 @@
             % document.document_id in logcontent)
 
+    def test_manage_rest_document(self):
+        # Managers can access the pages of documentsconter
+        # and can perform actions
+        self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
+        self.browser.open('http://localhost/app')
+        self.assertEqual(self.browser.headers['Status'], '200 Ok')
+        self.browser.getLink("Documents").click()
+        self.assertEqual(self.browser.url, self.container_path)
+        self.browser.getLink("Manage").click()
+        self.browser.getControl("Add document").click()
+        self.browser.getControl(name="doctype").value = ['RESTDocument']
+        self.browser.getControl(name="form.document_id").value = 'DOC3'
+        self.browser.getControl(name="form.title").value = 'My REST Document'
+        self.browser.getControl("Add document").click()
+        self.assertTrue('REST Document added.' in self.browser.contents)
+        document = self.app['documents']['DOC3']
+
+        # Document can be edited
+        self.browser.getLink("DOC3").click()
+        self.browser.getLink("Manage").click()
+        self.browser.getControl(name="form.rest_multilingual").value = """
+----------
+Main Title
+----------
+
+Subtitle
+========
+>>de<<
+----------
+Haupttitel
+----------
+
+Untertitel
+==========
+"""
+        self.browser.getControl("Save").click()
+        self.assertTrue('Form has been saved.' in self.browser.contents)
+        self.browser.getLink("View").click()
+        self.assertEqual(self.browser.url, self.container_path + '/DOC3/index')
+        self.assertTrue(
+            '<h1 class="title">Main Title</h1>' in self.browser.contents)
+        self.assertTrue(
+            '<h2 class="subtitle" id="subtitle">Subtitle</h2>'
+            in self.browser.contents)
+        self.assertFalse(
+            '<h1 class="title">Haupttitel</h1>' in self.browser.contents)
+        self.browser.getLink("de").click()
+        self.assertFalse(
+            '<h1 class="title">Main Title</h1>' in self.browser.contents)
+        self.assertTrue(
+            '<h1 class="title">Haupttitel</h1>' in self.browser.contents)
+        # The content can be rendered
+        IWorkflowState(document).setState(PUBLISHED)
+        self.browser.open(self.container_path + '/DOC3/display')
+        self.assertTrue(
+            '<h1 class="title">Haupttitel</h1>' in self.browser.contents)
+        # The page label (object title) is not displayed
+        self.assertFalse(
+            '<h1 class="ikoba-content-label">My REST Document</h1>'
+            in self.browser.contents)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/tests/test_document.py

@@ -30 +30 @@
 from waeup.ikoba.imagestorage import DefaultStorage
 from waeup.ikoba.documents.interfaces import (
-    IDocumentsContainer, IPublicDocument, IPDFDocument, IHTMLDocument)
+    IDocumentsContainer, IPublicDocument, IPDFDocument,
+    IHTMLDocument, IRESTDocument)
 from waeup.ikoba.documents.container import DocumentsContainer
 from waeup.ikoba.documents.document import (
-    PDFDocument, HTMLDocument,
+    PDFDocument, HTMLDocument, RESTDocument,
     DocumentFileNameChooser, DocumentFileStoreHandler)
 from waeup.ikoba.testing import (FunctionalLayer, FunctionalTestCase)
@@ -66 +67 @@
             verifyObject(
                 IHTMLDocument, HTMLDocument())
+            )
+        self.assertTrue(
+            verifyClass(
+                IRESTDocument, RESTDocument)
+            )
+        self.assertTrue(
+            verifyObject(
+                IRESTDocument, RESTDocument())
             )
         return

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/utils.py

@@ -39 +39 @@
         'PDFDocument': _('PDF Document'),
         'HTMLDocument': _('HTML Document'),
+        'RESTDocument': _('REST Document'),
         }
 

main/waeup.ikoba/trunk/src/waeup/ikoba/utils/helpers.py

@@ -832 +832 @@
                 contents=text)
     return elements
+
+def rest2dict(value=None,portal_language='en'):
+    """Transforms a localized REST text string into a dictionary.
+
+    Different languages must be separated by `>>xy<<` whereas
+    xy is the language code. Text parts without correct leading
+    language separator - usually the first part has no language
+    descriptor - are interpreted as texts in the portal's language.
+    The latter can be configured in waeup.srp.utils.utils.IkobaUtils.
+    """
+    try:
+        parts = value.split('>>')
+    except:
+        return {}
+    elements = {}
+    lang = portal_language
+    for part in parts:
+        if part[2:4] == u'<<':
+            lang = str(part[0:2].lower())
+            text = part[4:]
+            elements[lang] = renderElement(u'div id="rest"',
+                contents=ReST2HTML(text))
+        else:
+            text = part
+            elements[lang] = renderElement(u'div id="rest"',
+                contents=ReST2HTML(text))
+    return elements