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 40 matching lines @@
       item_map: A dictionary containing all the elements of 'items' as
         keys.
       items: A list of arbitrary items.
 
     Returns:
       Looks up each item of 'items' in 'item_maps' and concatenates the
       resulting items into a comma-separated list.
     '''
     return ', '.join([item_map[x] for x in items])
 
+

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

Nit: Don't introduce a blank line here (two blank lines only between top-level
definitions).

   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):
+    '''Parse a string for paragraphs (/n/n) and add them to a DOM node with
+    the URLs replaced with <a> HTML links (done by _AddTextWithLinks).
+
+    Args:
+      parent: The DOM node to which the text will be added.
+      text: The string to be added.'''

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: Other docstrings in this file place a newline before the closing '''.
Please do the same for consistency.

+    if len(text) == 0:
+      return
+    
+    # A regexp to search for line breaks.
+    new_line_matcher = lazy_re.compile('\n\n')

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

You can simplify this a lot by just doing text.split('\n\n'), then iterating
over the result and calling AddElement and _AddTextWithLinks.

+
+    # Open paragraph
+    paragraph = self.AddElement(parent, 'p')
+    while True:
+      # Look for the first break line.

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: s/break line/line break/.

+      res = new_line_matcher.search(text)
+      if not res:
+        break
+      # Get postiotons of begin and end of new line charecters.

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: spelling

+      start = res.start(0)
+      end = res.end(0)
+      # Insert text to the paragraph with processing the urls
+      self._AddTextWithLinks(paragraph, text[:start])
+      #Create a new paragraph. The old one will be automatically closed.

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: space after #

+      paragraph = self.AddElement(parent, 'p')
+      # Drop the part of text that is added.
+      text = text[end:]
+    self._AddTextWithLinks(paragraph, text) # Adding the rest of the text
+

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: remove extra blank line.

 
   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'])
+
+    # Replace URLs with links and /n with <p>...</p> in the description.

[Mattias Nissler (ping if slow), 2015/02/10 12:54:13]

nit: I think "Break description into paragraphs and replace URLs with links"
would be clearer.

+    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()