Merge large rework from W. Trevor King.

1 files changed, 92 insertions, 43 deletions

diff --git a/libbe/bugdir.py b/libbe/bugdir.py
index fed9aa3..6e020ee 100644
--- a/libbe/bugdir.py
+++ b/libbe/bugdir.py
@@ -4,19 +4,19 @@
 #                         Oleg Romanyshyn <oromanyshyn@panoramicfeedback.com>
 #                         W. Trevor King <wking@drexel.edu>
 #
-#    This program is free software; you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation; either version 2 of the License, or
-#    (at your option) any later version.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
 #
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
-#    You should have received a copy of the GNU General Public License
-#    along with this program; if not, write to the Free Software
-#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 import os
 import os.path
 import errno
@@ -51,7 +51,7 @@ class NoRootEntry(Exception):
 class AlreadyInitialized(Exception):
     def __init__(self, path):
         self.path = path
-        Exception.__init__(self, 
+        Exception.__init__(self,
                            "Specified root is already initialized: %s" % path)
 
 class MultipleBugMatches(ValueError):
@@ -70,7 +70,7 @@ class BugDir (list, settings_object.SavedSettingsObject):
     """
     Sink to existing root
     ======================
-    
+
     Consider the following usage case:
     You have a bug directory rooted in
       /path/to/source
@@ -85,23 +85,35 @@ class BugDir (list, settings_object.SavedSettingsObject):
       /path/to/source/GUI/.be             miss
       /path/to/source/.be                 hit!
     So it still roots itself appropriately without much work for you.
-        
+
     File-system access
     ==================
-    
-    When rooted in non-bugdir directory, BugDirs live completely in
-    memory until the first call to .save().  This creates a '.be'
-    sub-directory containing configurations options, bugs, comments,
-    etc.  Once this sub-directory has been created (possibly by
-    another BugDir instance) any changes to the BugDir in memory will
-    be flushed to the file system automatically.  However, the BugDir
-    will only load information from the file system when it loads new
-    bugs/comments that it doesn't already have in memory, or when it
-    explicitly asked to do so (e.g. .load() or __init__(from_disk=True)).
-    
+
+    BugDirs live completely in memory when .sync_with_disk is False.
+    This is the default configuration setup by BugDir(from_disk=False).
+    If .sync_with_disk == True (e.g. BugDir(from_disk=True)), then
+    any changes to the BugDir will be immediately written to disk.
+
+    If you want to change .sync_with_disk, we suggest you use
+    .set_sync_with_disk(), which propogates the new setting through to
+    all bugs/comments/etc. that have been loaded into memory.  If
+    you've been living in memory and want to move to
+    .sync_with_disk==True, but you're not sure if anything has been
+    changed in memoryy, a call to save() is a safe move.
+
+    Regardless of .sync_with_disk, a call to .save() will write out
+    all the contents that the BugDir instance has loaded into memory.
+    If sync_with_disk has been True over the course of all interesting
+    changes, this .save() call will be a waste of time.
+
+    The BugDir will only load information from the file system when it
+    loads new bugs/comments that it doesn't already have in memory, or
+    when it explicitly asked to do so (e.g. .load() or
+    __init__(from_disk=True)).
+
     Allow RCS initialization
     ========================
-    
+
     This one is for testing purposes.  Setting it to True allows the
     BugDir to search for an installed RCS backend and initialize it in
     the root directory.  This is a convenience option for supporting
@@ -109,7 +121,7 @@ class BugDir (list, settings_object.SavedSettingsObject):
 
     Disable encoding manipulation
     =============================
-    
+
     This one is for testing purposed.  You might have non-ASCII
     Unicode in your bugs, comments, files, etc.  BugDir instances try
     and support your preferred encoding scheme (e.g. "utf-8") when
@@ -141,10 +153,11 @@ class BugDir (list, settings_object.SavedSettingsObject):
     def _guess_encoding(self):
         return encoding.get_encoding()
     def _check_encoding(value):
-        if value != None and value != settings_object.EMPTY:
+        if value != None:
             return encoding.known_encoding(value)
     def _setup_encoding(self, new_encoding):
-        if new_encoding != None and new_encoding != settings_object.EMPTY:
+        # change hook called before generator.
+        if new_encoding not in [None, settings_object.EMPTY]:
             if self._manipulate_encodings == True:
                 encoding.set_IO_stream_encodings(new_encoding)
     def _set_encoding(self, old_encoding, new_encoding):
@@ -159,7 +172,7 @@ class BugDir (list, settings_object.SavedSettingsObject):
     def encoding(): return {}
 
     def _setup_user_id(self, user_id):
-        self.rcs.user_id = user_id        
+        self.rcs.user_id = user_id
     def _guess_user_id(self):
         return self.rcs.get_user_id()
     def _set_user_id(self, old_user_id, new_user_id):
@@ -214,7 +227,21 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             if uuid not in map:
                 map[uuid] = None
         self._bug_map_value = map # ._bug_map_value used by @local_property
-    
+
+    def _extra_strings_check_fn(value):
+        return utility.iterable_full_of_strings(value, \
+                         alternative=settings_object.EMPTY)
+    def _extra_strings_change_hook(self, old, new):
+        self.extra_strings.sort() # to make merging easier
+        self._prop_save_settings(old, new)
+    @_versioned_property(name="extra_strings",
+                         doc="Space for an array of extra strings.  Useful for storing state for functionality implemented purely in becommands/<some_function>.py.",
+                         default=[],
+                         check_fn=_extra_strings_check_fn,
+                         change_hook=_extra_strings_change_hook,
+                         mutable=True)
+    def extra_strings(): return {}
+
     @Property
     @primed_property(primer=_bug_map_gen)
     @local_property("bug_map")
@@ -222,7 +249,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
     def _bug_map(): return {}
 
     def _setup_severities(self, severities):
-        if severities != None and severities != settings_object.EMPTY:
+        if severities not in [None, settings_object.EMPTY]:
             bug.load_severities(severities)
     def _set_severities(self, old_severities, new_severities):
         self._setup_severities(new_severities)
@@ -269,7 +296,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
         # get a temporary rcs until we've loaded settings
         self.sync_with_disk = False
         self.rcs = self._guess_rcs()
-        
+
         if from_disk == True:
             self.sync_with_disk = True
             self.load()
@@ -283,6 +310,11 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             self.rcs = rcs
             self._setup_user_id(self.user_id)
 
+    def set_sync_with_disk(self, value):
+        self.sync_with_disk = value
+        for bug in self:
+            bug.set_sync_with_disk(value)
+
     def _find_root(self, path):
         """
         Search for an existing bug database dir and it's ancestors and
@@ -301,7 +333,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             if beroot == None:
                 raise NoBugDir(path)
             return beroot
-        
+
     def get_version(self, path=None, use_none_rcs=False):
         if use_none_rcs == True:
             RCS = rcs.rcs_by_name("None")
@@ -316,6 +348,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
         return tree_version
 
     def set_version(self):
+        self.rcs.mkdir(self.get_path())
         self.rcs.set_file_contents(self.get_path("version"),
                                    TREE_VERSION_STRING)
 
@@ -347,7 +380,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             if not os.path.exists(self.get_path()):
                 raise NoBugDir(self.get_path())
             self.load_settings()
-            
+
             self.rcs = rcs.rcs_by_name(self.rcs_name)
             self._setup_user_id(self.user_id)
 
@@ -358,10 +391,17 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             self._load_bug(uuid)
 
     def save(self):
-        self.rcs.mkdir(self.get_path())
+        """
+        Save any loaded contents to disk.  Because of lazy loading of
+        bugs and comments, this is actually not too inefficient.
+
+        However, if self.sync_with_disk = True, then any changes are
+        automatically written to disk as soon as they happen, so
+        calling this method will just waste time (unless something
+        else has been messing with your on-disk files).
+        """
         self.set_version()
         self.save_settings()
-        self.rcs.mkdir(self.get_path("bugs"))
         for bug in self:
             bug.save()
 
@@ -377,7 +417,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
         allow_no_rcs = not self.rcs.path_in_root(settings_path)
         # allow_no_rcs=True should only be for the special case of
         # configuring duplicate bugdir settings
-        
+
         try:
             settings = mapfile.map_load(self.rcs, settings_path, allow_no_rcs)
         except rcs.NoSuchFile:
@@ -392,6 +432,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
         allow_no_rcs = not self.rcs.path_in_root(settings_path)
         # allow_no_rcs=True should only be for the special case of
         # configuring duplicate bugdir settings
+        self.rcs.mkdir(self.get_path(), allow_no_rcs)
         mapfile.map_save(self.rcs, settings_path, settings, allow_no_rcs)
 
     def duplicate_bugdir(self, revision):
@@ -442,6 +483,9 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
 
     def new_bug(self, uuid=None, summary=None):
         bg = bug.Bug(bugdir=self, uuid=uuid, summary=summary)
+        bg.set_sync_with_disk(self.sync_with_disk)
+        if bg.sync_with_disk == True:
+            bg.save()
         self.append(bg)
         self._bug_map_gen()
         return bg
@@ -455,7 +499,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
         Generate short names from uuids.  Picks the minimum number of
         characters (>=3) from the beginning of the uuid such that the
         short names are unique.
-        
+
         Obviously, as the number of bugs in the database grows, these
         short names will cease to be unique.  The complete uuid should be
         used for long term reference.
@@ -502,7 +546,7 @@ settings easy.  Don't set this attribute.  Set .rcs instead, and
             if bug_uuid not in self._bug_map:
                 return False
         return True
-        
+
 
 def simple_bug_dir():
     """
@@ -591,14 +635,17 @@ class BugDirTestCase(unittest.TestCase):
         self.failUnless(bugA == bugAprime, "%s != %s" % (bugA, bugAprime))
         self.bugdir.save()
         self.versionTest()
-    def testComments(self):
+    def testComments(self, sync_with_disk=False):
+        if sync_with_disk == True:
+            self.bugdir.set_sync_with_disk(True)
         self.bugdir.new_bug(uuid="a", summary="Ant")
         bug = self.bugdir.bug_from_uuid("a")
         comm = bug.comment_root
         rep = comm.new_reply("Ants are small.")
         rep.new_reply("And they have six legs.")
-        self.bugdir.save()
-        self.bugdir._clear_bugs()        
+        if sync_with_disk == False:
+            self.bugdir.save()
+        self.bugdir._clear_bugs()
         bug = self.bugdir.bug_from_uuid("a")
         bug.load_comments()
         self.failUnless(len(bug.comment_root)==1, len(bug.comment_root))
@@ -622,6 +669,8 @@ class BugDirTestCase(unittest.TestCase):
                                 comment.body)
             else:
                 self.failIf(True, "Invalid comment: %d\n%s" % (index, comment))
+    def testSyncedComments(self):
+        self.testComments(sync_with_disk=True)
 
 unitsuite = unittest.TestLoader().loadTestsFromTestCase(BugDirTestCase)
 suite = unittest.TestSuite([unitsuite])#, doctest.DocTestSuite()])