Merge lp:~ursinha/uci-team/remove-spec-add-branch-nick into lp:uci-team

[Ursula Junque]

Removing reference to specs, we're not using blueprints; Adding branch nick to refer to scanned branch; Changing Launchpad to uci-engine.

Some suggested improvements to the XXX reports, feel free to ignore:
- Removing reference to specs, we're not using blueprints (and don't think we plan to in a near future :P)
- Adding branch nick to refer to scanned branch;
- Changing Launchpad to uci-engine.

[Evan (ev)]

Looks good.

review: Approve

=== modified file 'xxxreport.py'
--- xxxreport.py	2014-10-15 10:54:08 +0000
+++ xxxreport.py	2014-10-16 19:47:16 +0000
@@ -1,6 +1,6 @@
 #!/usr/bin/python
 #
-# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2014 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Create a XXX comment reports in many formats."""
@@ -40,7 +40,7 @@
             "Root directory does not exist: %s." % root_dir)
         self.root_dir = root_dir
         self.output_name = output_name
-        self.revno = self._getBranchRevno()
+        self.revno, self.nick = self._getBranchInfo()
         self.comments = self._findComments()
 
     def _close(self, output_file):
@@ -48,8 +48,8 @@
         if self.output_name is not None:
             output_file.close()
 
-    def _getBranchRevno(self):
-        """Return the bazaar revision number of the branch or None."""
+    def _getBranchInfo(self):
+        """Return the bazaar revision number of the branch and nick or None."""
         # pylint: disable-msg=W0612
         a_bzrdir = bzrdir.BzrDir.open_containing(self.root_dir)[0]
         try:
@@ -57,11 +57,12 @@
             branch.lock_read()
             try:
                 revno, head = branch.last_revision_info()
+                nick = branch.nick
             finally:
                 branch.unlock()
         except NotBranchError:
-            revno = None
-        return revno
+            revno, nick = None
+        return revno, nick
 
     def _findComments(self):
         """Set the list of XXX comments in files below a directory."""
@@ -145,26 +146,24 @@
         comments.append(comment)
 
     # The standard XXX comment form of:
-    # 'XXX: First Last Name 2007-07-01 bug=nnnn spec=cccc:'
+    # 'XXX: First Last Name 2007-07-01 bug=nnnn'
     # Colons, commas, and spaces may follow each token.
     xxx_person_date_re = re.compile(r"""
         .*XXX[:,]?[ ]                               # The XXX indicator.
         (?P<person>[a-zA-Z][^:]*[\w])[,: ]*         # The persons's nick.
         (?P<date>\d\d\d\d[/-]?\d\d[/-]?\d\d)[,: ]*  # The date in YYYY-MM-DD.
         (?:[(]?bug[s]?[= ](?P<bug>[\w-]*)[),: ]*)?  # The bug id.
-        (?:[(]?spec[= ](?P<spec>[\w-]*)[),: ]*)?    # The spec name.
         (?P<text>.*)                                # The comment text.
         """, re.VERBOSE)
 
     # An uncommon XXX comment form of:
-    # 'XXX: 2007-01-01 First Last Name bug=nnnn spec=cccc:'
+    # 'XXX: 2007-01-01 First Last Name bug=nnnn'
     # Colons, commas, and spaces may follow each token.
     xxx_date_person_re = re.compile(r"""
         .*XXX[:,]?[ ]                               # The XXX indicator.
         (?P<date>\d\d\d\d[/-]?\d\d[/-]?\d\d)[,: ]*  # The date in YYYY-MM-DD.
         (?P<person>[a-zA-Z][\w]+)[,: ]*             # The person's nick.
         (?:[(]?bug[s]?[= ](?P<bug>[\w-]*)[),: ]*)?  # The bug id.
-        (?:[(]?spec[= ](?P<spec>[\w-]*)[),: ]*)?    # The spec name.
         (?P<text>.*)                                # The comment text.
         """, re.VERBOSE)
 
@@ -173,10 +172,10 @@
 
         :param comment_line: The first line of an XXX comment contains the
             metadata.
-        :return: dict(person, date, bug, spec, and [text]). The text is the
+        :return: dict(person, date, bug and [text]). The text is the
         same as remainder of the comment_line after the metadata is extracted.
         """
-        comment = dict(person=None, date=None, bug=None, spec=None, text=[])
+        comment = dict(person=None, date=None, bug=None, text=[])
         match = (self.xxx_person_date_re.match(comment_line)
                  or self.xxx_date_person_re.match(comment_line))
         if match is not None:
@@ -184,7 +183,6 @@
             comment['person'] = match.group('person')
             comment['date'] = match.group('date')
             comment['bug'] = match.group('bug') or None
-            comment['spec'] = match.group('spec') or None
             text = match.group('text').lstrip(':, ')
         else:
             # Unknown comment format.
@@ -222,7 +220,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>XXX Comment report for Launchpad</title>
+    <title>XXX Comment report for uci-engine</title>
     <style type="text/css" media="screen, print">
       @import url(https://launchpad.net/+icing/rev6895/+style-slimmer.css);
       .context {
@@ -233,12 +231,12 @@
   </head>
 
   <body style="margin: 1em;">
-    <h1>XXX Comment report for Launchpad</h1>
+    <h1>XXX Comment report for uci-engine</h1>
 
     <p>
-      A report of the XXX comments in the rocketfuel branch. All files
+      A report of the XXX comments in the uci-engine %(nick)s branch. All files
       except *.pyc files were examined.
-      <br />This report may also be available as a tab-delimted file:
+      <br />This report may also be available as a tab-delimited file:
       <a href="xxx-report.csv">xxx-report.csv</a>
     </p>
 
@@ -266,7 +264,6 @@
         <strong class="person">%(person)s</strong>
         <strong class="date">%(date)s</strong>
         bug %(bugurl)s
-        spec %(specurl)s
         </div>
         <pre style="margin-top: 0px;">%(text)s</pre>
         <pre class="context">%(context)s</pre>
@@ -287,6 +284,7 @@
             output_file.write(
                 self.report_top % {"commentcount": len(self.comments),
                               "reporttime": report_time,
+                              "nick" : self.nick,
                               "revno": self.revno})
 
             for comment in self.comments:
@@ -298,13 +296,6 @@
                         % (comment['bug'], comment['bug']))
                 else:
                     comment['bugurl'] = comment['bug']
-                if comment['spec'] is not None:
-                    comment['specurl'] = (
-                        '<a href="https://blueprints.launchpad.net'
-                        '/launchpad-project/+specs?searchtext=%s">%s</a>'
-                        % (comment['spec'], comment['spec']))
-                else:
-                    comment['specurl'] = comment['spec']
                 output_file.write(self.report_comment % comment)
 
             output_file.write(self.report_bottom)
@@ -327,10 +318,10 @@
 class CSVReport(Report):
     """A CSV XXX report."""
     report_header = (
-        'File_Path, Line_No, Person, Date, Bug, Spec, Text\n')
+        'File_Path, Line_No, Person, Date, Bug, Text\n')
     report_comment = (
         '%(file_path)s, %(line_no)s, '
-        '%(person)s, %(date)s, %(bug)s, %(spec)s, %(text)s\n')
+        '%(person)s, %(date)s, %(bug)s, %(text)s\n')
 
     def markupText(self, text):
         """Return the line as TSV markup.
@@ -357,10 +348,10 @@
 class TSVReport(CSVReport):
     """A TSV XXX report."""
     report_header = (
-        'File_Path\tLine_No\tPerson\tDate\tBug\tSpec\tText\n')
+        'File_Path\tLine_No\tPerson\tDate\tBug\tText\n')
     report_comment = (
         '%(file_path)s\t%(line_no)s\t'
-        '%(person)s\t%(date)s\t%(bug)s\t%(spec)s\t%(text)s\n')
+        '%(person)s\t%(date)s\t%(bug)s\t%(text)s\n')
 
     def markupText(self, text):
         """Return the line as TSV markup.