Fixed bug with paragraphs in policy description

grit/format/policy_templates/writers/doc_writer.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 
 import json
 from xml.dom import minidom
 from grit import lazy_re
 from grit.format.policy_templates.writers import xml_formatted_writer
@@ skipping 48 matching lines @@
     return ', '.join([item_map[x] for x in items])
 
   def _AddTextWithLinks(self, parent, text):
     '''Parse a string for URLs and add it to a DOM node with the URLs replaced
     with <a> HTML links.
 
     Args:
       parent: The DOM node to which the text will be added.
       text: The string to be added.
     '''
+    # A simple regexp to search for URLs. It is enough for now.
+    url_matcher = lazy_re.compile('(http://[^\\s]*[^\\s\\.])')
+
     # Iterate through all the URLs and replace them with links.
-    out = []
     while True:
       # Look for the first URL.
-      res = self._url_matcher.search(text)
+      res = url_matcher.search(text)
       if not res:
         break
       # Calculate positions of the substring of the URL.
       url = res.group(0)
       start = res.start(0)
       end = res.end(0)
       # Add the text prior to the URL.
       self.AddText(parent, text[:start])
       # Add a link for the URL.
       self.AddElement(parent, 'a', {'href': url}, url)
       # Drop the part of text that is added.
       text = text[end:]
     self.AddText(parent, text)
 
+  def _AddParagraphs(self, parent, text):
+    '''Break description into paragraphs and replace URLs with links.
+
+    Args:
+      parent: The DOM node to which the text will be added.
+      text: The string to be added.
+    '''
+    if len(text) == 0:

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: This check is no longer needed. The loop below won't run if text is empty.

[peletskyi, 2015/02/10 16:12:56]

Done.

+      return
+    # Split text into list of paragraphs

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: missing period

[peletskyi, 2015/02/10 16:12:56]

Done.

+    entries = text.split('\n\n')
+    for entry in entries:
+      # Create a new paragraph node

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: period

[peletskyi, 2015/02/10 16:12:56]

Done.

+      paragraph = self.AddElement(parent, 'p')
+      # Insert text to the paragraph with processing the urls

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: period

[peletskyi, 2015/02/10 16:12:56]

Done.

+      self._AddTextWithLinks(paragraph, entry)
 
   def _AddStyledElement(self, parent, name, style_ids, attrs=None, text=None):
     '''Adds an XML element to a parent, with CSS style-sheets included.
 
     Args:
       parent: The parent DOM node.
       name: Name of the element to add.
       style_ids: A list of CSS style strings from self._STYLE[].
       attrs: Dictionary of attributes for the element.
       text: Text content for the element.
     '''
     if attrs == None:
       attrs = {}
 
     style = ''.join([self._STYLE[x] for x in style_ids])
     if style != '':
       # Apply the style specified by style_ids.
       attrs['style'] = style + attrs.get('style', '')
     return self.AddElement(parent, name, attrs, text)
 
   def _AddDescription(self, parent, policy):
     '''Adds a string containing the description of the policy. URLs are
     replaced with links and the possible choices are enumerated in case
     of 'string-enum' and 'int-enum' type policies.
 
     Args:
       parent: The DOM node for which the feature list will be added.
       policy: The data structure of a policy.
     '''
-    # Replace URLs with links in the description.
-    self._AddTextWithLinks(parent, policy['desc'])
+

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: no reason for a blank line here AFAICT?

[peletskyi, 2015/02/10 16:12:56]

Done.

+    # Replace URLs with links and /n with <p>...</p> in the description.

[Mattias Nissler (ping if slow), 2015/02/10 14:09:55]

nit: I suggested to reword the comment to be clearer, did you forget or decide
against it for some reason? If the latter, please comment why and fix s|/n|\n|.

[peletskyi, 2015/02/10 16:12:56]

I have "Break description into paragraphs and replace URLs with links." in
description of the method. Don't want to have copy-paste in the comments. But I
will try to change the description to make it short and clear.

+    self._AddParagraphs(parent, policy['desc'])
     # Add list of enum items.
     if policy['type'] in ('string-enum', 'int-enum', 'string-enum-list'):
       ul = self.AddElement(parent, 'ul')
       for item in policy['items']:
         if policy['type'] == 'int-enum':
           value_string = str(item['value'])
         else:
           value_string = '"%s"' % item['value']
         self.AddElement(
             ul, 'li', {}, '%s = %s' % (value_string, item['caption']))
@@ skipping 372 matching lines @@
     a link for that page.
 
     Args:
       policy: The data structure of the policy.
     '''
     if 'problem_href' not in policy:
       return
     problem_href = policy['problem_href']
     div = self._AddStyledElement(parent, 'div', ['div.note'])
     note = self._GetLocalizedMessage('note').replace('$6', problem_href)
-    self._AddTextWithLinks(div, note)
+    self._AddParagraphs(div, note)
 
   def _AddPolicyRow(self, parent, policy):
     '''Adds a row for the policy in the summary table.
 
     Args:
       parent: The DOM node of the summary table.
       policy: The data structure of the policy.
     '''
     tr = self._AddStyledElement(parent, 'tr', ['tr'])
     indent = 'padding-left: %dpx;' % (7 + self._indent_level * 14)
@@ skipping 68 matching lines @@
 
   def BeginTemplate(self):
     # Add a <div> for the summary section.
     if self._GetChromiumVersionString() is not None:
       self.AddComment(self._main_div, self.config['build'] + \
           ' version: ' + self._GetChromiumVersionString())
 
     summary_div = self.AddElement(self._main_div, 'div')
     self.AddElement(summary_div, 'a', {'name': 'top'})
     self.AddElement(summary_div, 'br')
-    self._AddTextWithLinks(
+    self._AddParagraphs(
         summary_div,
         self._GetLocalizedMessage('intro'))
     self.AddElement(summary_div, 'br')
     self.AddElement(summary_div, 'br')
     self.AddElement(summary_div, 'br')
     # Add the summary table of policies.
     summary_table = self._AddStyledElement(summary_div, 'table', ['table'])
     # Add the first row.
     thead = self.AddElement(summary_table, 'thead')
     tr = self._AddStyledElement(thead, 'tr', ['tr'])
@@ skipping 72 matching lines @@
       'td.right': 'width: 100%;',
       'dt': 'font-weight: bold;',
       'dd dl': 'margin-top: 0px; margin-bottom: 0px;',
       '.monospace': 'font-family: monospace;',
       '.pre': 'white-space: pre;',
       'div.note': 'border: 2px solid black; padding: 5px; margin: 5px;',
       'div.group_desc': 'margin-top: 20px; margin-bottom: 20px;',
       'ul': 'padding-left: 0px; margin-left: 0px;'
     }
 
-    # A simple regexp to search for URLs. It is enough for now.
-    self._url_matcher = lazy_re.compile('(http://[^\\s]*[^\\s\\.])')
 
   def GetTemplateText(self):
     # Return the text representation of the main <div> tag.
     return self._main_div.toxml()
     # To get a complete HTML file, use the following.
     # return self._doc.toxml()