Merge lp:~vila/bzr-bookmarks/712935-2.3-compat into lp:~luks/bzr-bookmarks/trunk

[Vincent Ladeuil]

This fixes the compatibility with bzr-2.3 without trying to stay compatible with previous bzr versions.

Note that bzr config framework should (RSN) support this kind of feature out of the box (by using the trick pioneered here of prefixing config options instead of requiring a dedicated section).

[Vincent Ladeuil (vila)]

@lukas: I'd be happy to discuss further maintenance of the plugin with you.

[lp:~vila/bzr-bookmarks/712935-2.3-compat]

19. By Vincent Ladeuil on 2011-02-04

Add a version (2.3.0) to get better feedback in bug reports and make it clear we intend to be compatible with bzr >= 2.3.0.

[Vincent Ladeuil (vila)]

Merged in trunk

=== modified file '__init__.py'
--- __init__.py	2008-12-09 21:31:59 +0000
+++ __init__.py	2011-02-04 11:24:10 +0000
@@ -36,85 +36,84 @@
  $ bzr help bookmarks
 """
 
+import bzrlib
+from bzrlib import api
+
+bzr_plugin_version = (2, 3, 0, 'dev', 0)
+# bzr-2.4 should include enough config enhancements to provide the same
+# features but it doesn't hurt to try supporting it either.
+api.require_any_api(bzrlib, [(2, 3, 0), (2, 4, 0)])
+
+from bzrlib import (
+    config,
+    decorators,
+    errors,
+    )
 from bzrlib.urlutils import unescape_for_display
-from bzrlib.config import GlobalConfig, ensure_config_dir_exists
 from bzrlib.commands import Command, register_command
-from bzrlib.errors import InvalidURL, BzrCommandError, NotBranchError
 from bzrlib.option import Option
 from bzrlib.branch import Branch
 from bzrlib.transport import get_transport, register_transport
 
 
-class GlobalBookmarkProvider(object):
+class GlobalBookmarkProvider(config.GlobalConfig):
 
+    @decorators.needs_write_lock
     def set_bookmark(self, name, location):
-        config = GlobalConfig()
-        parser = config._get_parser()
-        if "BOOKMARKS" not in parser:
-            parser["BOOKMARKS"] = {}
-        parser["BOOKMARKS"][name] = location
-        parser.write(file(config._get_filename(), 'wb'))
+        self._set_option(name, location, 'BOOKMARKS')
 
     def unset_bookmark(self, name):
-        config = GlobalConfig()
-        parser = config._get_parser()
-        del parser["BOOKMARKS"][name]
-        parser.write(file(config._get_filename(), 'wb'))
+        self.remove_user_option(name, 'BOOKMARKS')
 
     def resolve_bookmark(self, name):
-        config = GlobalConfig()
         try:
-            return config._get_parser().get_value("BOOKMARKS", name)
+            return self._get_parser().get_value('BOOKMARKS', name)
         except KeyError:
             return None
 
     def get_bookmarks(self):
         bookmarks = {}
-        config = GlobalConfig()
-        filename = config._get_filename()
-        for name, value in config._get_parser().get("BOOKMARKS", {}).items():
+        filename = self.file_name
+        for name, value in self._get_parser().get("BOOKMARKS", {}).items():
             bookmarks[name] = filename, value
         return bookmarks
 
 
-class LocationBookmarkProvider(object):
+class LocationBookmarkProvider(config.BranchConfig):
 
     def __init__(self, base='.'):
         try:
-            self.branch = Branch.open_containing(base)[0]
-        except NotBranchError:
-            self.branch = None
+            b = Branch.open_containing(base)[0]
+        except errors.NotBranchError:
+            b = None
+        super(LocationBookmarkProvider, self).__init__(b)
 
     def set_bookmark(self, name, location):
         if self.branch is None:
-            return NotBranchError
-        config = self.branch.get_config()
-        return config.set_user_option("bookmark_%s" % name, location)
+            raise errors.NotBranchError
+        return self.set_user_option("bookmark_%s" % name, location)
 
     def unset_bookmark(self, name):
         if self.branch is None:
-            return NotBranchError
-        config = self.branch.get_config()
-        # FIXME: missing API to delete an option
-        return config.set_user_option("bookmark_%s" % name, '')
+            raise errors.NotBranchError
+        self.remove_user_option('bookmark_%s' % (name,))
 
     def resolve_bookmark(self, name):
         if self.branch is None:
             return None
-        config = self.branch.get_config()
-        return config._get_user_option("bookmark_%s" % name)
+        return self._get_user_option("bookmark_%s" % name)
 
     def get_bookmarks(self):
         bookmarks = {}
         if self.branch is None:
             return bookmarks
-        config = self.branch.get_config()
-        for source_class in config.option_sources:
+        for source_class in self.option_sources:
             source = source_class()
             try:
-                filename = source._get_filename()
+                filename = source.file_name
             except AttributeError:
-                filename = source._config._transport.base + source._config._filename
+                filename = (source._config._transport.base
+                            + source._config._filename)
                 filename = unescape_for_display(filename, 'utf-8')
             for section_name, extra_path in source._get_matching_sections():
                 parser = source._get_parser()
@@ -136,7 +135,7 @@
     elif base_url.startswith('bm:'):
         name = base_url[3:]
     else:
-        raise InvalidURL(path=base_url)
+        raise errors.InvalidURL(path=base_url)
     if '/' in name:
         bookmark, name = name.split('/', 1)
     else:
@@ -151,7 +150,7 @@
                 real_url = '/'.join([real_url, name])
             break
     else:
-        raise InvalidURL(path=base_url)
+        raise errors.InvalidURL(path=base_url)
     return real_url
 
 
@@ -169,7 +168,7 @@
 
 class cmd_bookmark(Command):
     """Add, remove or modify a bookmark."""
-    
+
     _see_also = ["bookmarks"]
 
     takes_args = ['name', 'location?']
@@ -183,18 +182,20 @@
             provider = LocationBookmarkProvider()
         else:
             provider = GlobalBookmarkProvider()
-        ensure_config_dir_exists()
+        # FIXME: ensure_config_dir_exists is probably not needed but it's hard
+        # to be sure without proper unit tests -- vila 20110204
+        config.ensure_config_dir_exists()
         if delete:
             if provider.resolve_bookmark(name) is None:
-                raise BzrCommandError(
+                raise errors.BzrCommandError(
                     'bookmark "%s" does not exist' % (name,))
             provider.unset_bookmark(name)
         else:
             if '/' in name:
-                raise BzrCommandError(
+                raise errors.BzrCommandError(
                     '"%s" contains a "/" character, bookmarks should not contain"/" characters"' % name)
             if not location:
-                raise BzrCommandError(
+                raise errors.BzrCommandError(
                     'no location provided for bookmark "%s"' % (name,))
             provider.set_bookmark(name, location)
 
@@ -209,10 +210,10 @@
         bookmarks = {}
         for provider_class in providers:
             provider = provider_class()
-            for name, (source, url) in provider.get_bookmarks().items():
-                bookmarks.setdefault(source, {})[name] = url
-        for source, items in sorted(bookmarks.items()):
-            self.outf.write('%s:\n' % (source,))
+            for name, (file_name, url) in provider.get_bookmarks().items():
+                bookmarks.setdefault(file_name, {})[name] = url
+        for file_name, items in sorted(bookmarks.items()):
+            self.outf.write('%s:\n' % (file_name,))
             for name, url in sorted(items.items()):
                 self.outf.write('  %-20s %s\n' % (name, url))