added StringHTMLProperty wrapped() method to wrap long lines in issue display

also fixed a circular import in roundup.support

Author: Richard Jones

CHANGES.txt

@@ -5,6 +5,8 @@ are given with the most recent entry first.
 Feature:
 - full timezone support (sf patch 1465296)
 - handle connection loss when responding to web requests
+- added StringHTMLProperty wrapped() method to wrap long lines in issue
+  display
 
 Fixed:
 - Verbose option for import and export (sf bug 1505645)

roundup/cgi/templating.py

@@ -20,7 +20,7 @@
 from __future__ import nested_scopes
 
 import sys, cgi, urllib, os, re, os.path, time, errno, mimetypes, csv
-import calendar
+import calendar, textwrap
 
 from roundup import hyperdb, date, support
 from roundup import i18n
@@ -1248,6 +1248,34 @@ def plain(self, escape=0, hyperlink=0):
             s = self.hyper_re.sub(self._hyper_repl, s)
         return s
 
+    def wrapped(self, escape=1, hyperlink=1):
+        '''Render a "wrapped" representation of the property.
+
+        We wrap long lines at 80 columns on the nearest whitespace. Lines
+        with no whitespace are not broken to force wrapping.
+
+        Note that unlike plain() we default wrapped() to have the escaping
+        and hyperlinking turned on since that's the most common usage.
+
+        - "escape" turns on/off HTML quoting
+        - "hyperlink" turns on/off in-text hyperlinking of URLs, email
+          addresses and designators
+        '''
+        if not self.is_view_ok():
+            return self._('[hidden]')
+
+        if self._value is None:
+            return ''
+        s = support.wrap(str(self._value), width=80)
+        if escape:
+            s = cgi.escape(s)
+        if hyperlink:
+            # no, we *must* escape this text
+            if not escape:
+                s = cgi.escape(s)
+            s = self.hyper_re.sub(self._hyper_repl, s)
+        return s
+
     def stext(self, escape=0, hyperlink=1):
         ''' Render the value of the property as StructuredText.
 

roundup/support.py

@@ -4,8 +4,7 @@
 
 __docformat__ = 'restructuredtext'
 
-import os, time, sys
-import hyperdb
+import os, time, sys, re
 
 from sets import Set
 
@@ -155,6 +154,7 @@ def append(self, name):
         """Append a property to self.children. Will create a new
         propclass for the child.
         """
+        import hyperdb
         if name in self.propnames:
             return self.propnames [name]
         propclass = self.props [name]
@@ -192,4 +192,97 @@ def __iter__(self):
             for c in p:
                 yield c
 
+LEFT = 'left'
+LEFTN = 'left no strip'
+RIGHT = 'right'
+CENTER = 'center'
+
+def align(line, width=70, alignment=LEFTN):
+    ''' Code from http://www.faqts.com/knowledge_base/view.phtml/aid/4476 '''
+    if alignment == CENTER:
+        line = line.strip()
+        space = width - len(line)
+        return ' '*(space/2) + line + ' '*(space/2 + space%2)
+    elif alignment == RIGHT:
+        line = line.rstrip()
+        space = width - len(line)
+        return ' '*space + line
+    else:
+        if alignment == LEFT:
+            line = line.lstrip()
+        space = width - len(line)
+        return line + ' '*space
+
+
+def format_line(columns, positions, contents, spacer=' | ',
+        collapse_whitespace=True, wsre=re.compile(r'\s+')):
+    ''' Fill up a single row with data from the contents '''
+    l = []
+    data = 0
+    for i in range(len(columns)):
+        width, alignment = columns[i]
+        content = contents[i]
+        col = ''
+        while positions[i] < len(content):
+            word = content[positions[i]]
+            # if we hit a newline, honor it
+            if '\n' in word:
+                # chomp
+                positions[i] += 1
+                break
+
+            # make sure this word fits
+            if col and len(word) + len(col) > width:
+                break
+
+            # no whitespace at start-of-line
+            if collapse_whitespace and wsre.match(word) and not col:
+                # chomp
+                positions[i] += 1
+                continue
+
+            col += word
+            # chomp
+            positions[i] += 1
+        if col:
+            data = 1
+        col = align(col, width, alignment)
+        l.append(col)
+
+    if not data:
+        return ''
+    return spacer.join(l).rstrip()
+
+
+def format_columns(columns, contents, spacer=' | ', collapse_whitespace=True,
+        splitre=re.compile(r'(\n|\r\n|\r|[ \t]+|\S+)')):
+    ''' Format the contents into columns, with 'spacing' between the
+        columns
+    '''
+    assert len(columns) == len(contents), \
+        'columns and contents must be same length'
+
+    # split the text into words, spaces/tabs and newlines
+    for i in range(len(contents)):
+        contents[i] = splitre.findall(contents[i])
+
+    # now process line by line
+    l = []
+    positions = [0]*len(contents)
+    while 1:
+        l.append(format_line(columns, positions, contents, spacer,
+            collapse_whitespace))
+
+        # are we done?
+        for i in range(len(contents)):
+            if positions[i] < len(contents[i]):
+                break
+        else:
+            break
+    return '\n'.join(l)
+
+def wrap(text, width=75, alignment=LEFTN):
+    return format_columns(((width, alignment),), [text],
+        collapse_whitespace=False)
+
 # vim: set et sts=4 sw=4 :

test/test_textfmt.py

@@ -0,0 +1,17 @@
+import unittest
+
+from roundup.support import wrap
+
+class WrapTestCase(unittest.TestCase):
+    def testWrap(self):
+        lorem = '''Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'''
+        wrapped = '''Lorem ipsum dolor
+sit amet,
+consectetuer
+adipiscing elit.'''
+        self.assertEquals(wrap(lorem, 20), wrapped)
+
+def test_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(WrapTestCase))
+    return suite