Merge lp:~abudden/bzr-explorer/customise-custom-dialogs into lp:bzr-explorer

[Dr Al]

[Dr Al (abudden)]

This branch adds a new registry allowing plugins (e.g. those providing custom workspace models) to override Bazaar Explorer's custom (init, branch & checkout) dialogs in order to add specialist features or customise operation.

[lp:~abudden/bzr-explorer/customise-custom-dialogs]

388. By Dr Al on 2010-01-31

Merge trunk.

389. By Dr Al on 2010-02-02

Merge trunk.

[Ian Clatworthy (ian-clatworthy)]

Cool. I'll merge this. Please provide a follow-on patch ASAP though with these changes:

1. rename the registry key from init-workspace to init
2. Add Neil's custom switch dialog.

review: Approve

[Dr Al (abudden)]

Done: https://code.edge.launchpad.net/~abudden/bzr-explorer/custom-dialog-follow-on/+merge/18601

I hadn't noticed that there was a new switch dialog, but having done this change, I also noticed a bug in that dialog: https://bugs.edge.launchpad.net/bzr-explorer/+bug/516957

[Ian Clatworthy (ian-clatworthy)]

Thanks. The diff below looks good but pulling your branch shows the last version as 389 (which doesn't include your latest changes). Maybe that's a Launchpad bug?

Could you push the latest code to another branch please so I can pull/merge from there instead?

review: Approve

[Dr Al (abudden)]

I think this is because I did it as a separate branch: I assumed I couldn't add more features to an approved branch, so I posted it as custom-dialog-follow-on:

https://code.edge.launchpad.net/~abudden/bzr-explorer/custom-dialog-follow-on/+merge/18601

It should be revision 407.

bzr branch lp:~abudden/bzr-explorer/custom-dialog-follow-on
[Skipped all the md5 sha module deprecation warnings]
Connected (version 2.0, client Twisted)
Authentication (publickey) successful!
Secsh channel 1 opened.
Branched 407 revision(s).

=== modified file 'NEWS'
--- NEWS	2010-02-02 07:24:22 +0000
+++ NEWS	2010-02-02 08:14:12 +0000
@@ -40,6 +40,9 @@
 * A custom switch dialog is now provided that makes switching between
   branches in a colocated workspace easier. (Neil Martinsen-Burrell)
 
+* Plugins can now override Bazaar Explorer's custom dialogs in order
+  to provide additional or alternative functionality.
+
 Improvements:
 
 * The *Advanced Commands* action has been renamed to *All Commands* to

=== added file 'lib/custom_dialogs.py'
--- lib/custom_dialogs.py	1970-01-01 00:00:00 +0000
+++ lib/custom_dialogs.py	2010-02-02 08:14:12 +0000
@@ -0,0 +1,53 @@
+# Copyright (C) 2010 Canonical Ltd
+#
+# 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.
+#
+# 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.
+
+from bzrlib.lazy_import import lazy_import
+lazy_import(globals(), '''
+
+import os
+
+from bzrlib import (
+    builtins,
+    bzrdir,
+    commands,
+    errors,
+    osutils,
+    registry,
+    trace,
+    transport,
+    )
+from bzrlib.trace import note, mutter
+from bzrlib.plugins.explorer.lib.helpers import plural
+''')
+
+import workspace_dialogs
+import checkout_dialog
+
+class CustomDialogRegistry(registry.Registry):
+    """Registry for custom dialogs.
+    
+    The registered object should be a SubProcessDialog subclass.
+    """
+    pass
+
+custom_dialog_registry = CustomDialogRegistry()
+
+custom_dialog_registry.register('init-workspace',
+        workspace_dialogs.QInitWorkspaceDialog)
+custom_dialog_registry.register('branch',
+        workspace_dialogs.QBranchExplorerStyleDialog)
+custom_dialog_registry.register('checkout',
+        checkout_dialog.QCheckoutExplorerStyleDialog)

=== modified file 'lib/explorer.py'
--- lib/explorer.py	2010-02-02 07:24:22 +0000
+++ lib/explorer.py	2010-02-02 08:14:12 +0000
@@ -32,7 +32,6 @@
     accessories_dialog,
     app_runner,
     app_suite as mod_app_suite,
-    checkout_dialog,
     desktop_env,
     helpers,
     history_manager,
@@ -45,11 +44,11 @@
     tool_dialogs,
     ui_explorer,
     welcome,
-    workspace_dialogs,
     workspace_models,
     wt_browser,
     sidebar_toolbox,
     )
+from bzrlib.plugins.explorer.lib.custom_dialogs import custom_dialog_registry
 from bzrlib.plugins.explorer.lib.builders import (
     toolbar_builders,
     )
@@ -1296,7 +1295,7 @@
         except KeyError:
             # Use the default if the preference is no longer in the registry
             model = workspace_models.workspace_model_registry.get()
-        return workspace_dialogs.QInitWorkspaceDialog(
+        return custom_dialog_registry.get('init-workspace')(
             default_init_location, model=model, parent=self)
 
     def _finish_init(self, result, dialog):
@@ -1311,7 +1310,7 @@
             if from_location and from_location.startswith("file://"):
                 from_location = from_location[len("file://"):]
         bind = self._preferences.get('bind-branches-by-default')
-        return workspace_dialogs.QBranchExplorerStyleDialog(from_location,
+        return custom_dialog_registry.get('branch')(from_location,
             bind=bind, parent=self)
 
     def _finish_branch(self):
@@ -1322,7 +1321,7 @@
             self.open_location(new_location)
 
     def _start_checkout(self, context=None):
-        return checkout_dialog.QCheckoutExplorerStyleDialog(parent=self)
+        return custom_dialog_registry.get('checkout')(parent=self)
 
     def _finish_checkout(self):
         dialog = self._custom_modeless_dialogs['checkout']