From bf3d434b244c57556bec979acbc658c30eb58221 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sat, 12 Dec 2009 00:31:55 -0500
Subject: Added libbe.command.base (with Command class) and moved list command
 to new format.

---
 libbe/command/base.py | 224 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 224 insertions(+)
 create mode 100644 libbe/command/base.py

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
new file mode 100644
index 0000000..973b840
--- /dev/null
+++ b/libbe/command/base.py
@@ -0,0 +1,224 @@
+# Copyright
+
+import optparse
+import sys
+
+import libbe
+import libbe.util.plugin
+import libbe.ui.util.repo
+
+class UserError(Exception):
+    pass
+
+class UnknownCommand(UserError):
+    def __init__(self, cmd):
+        Exception.__init__(self, "Unknown command '%s'" % cmd)
+        self.cmd = cmd
+
+
+def get_command(command_name):
+    """Retrieves the module for a user command
+
+    >>> try:
+    ...     get_command('asdf')
+    ... except UnknownCommand, e:
+    ...     print e
+    Unknown command 'asdf'
+    >>> repr(get_command('list')).startswith("<module 'libbe.command.list' from ")
+    True
+    """
+    try:
+        cmd = libbe.util.plugin.import_by_name(
+            'libbe.command.%s' % command_name.replace("-", "_"))
+    except ImportError, e:
+        raise UnknownCommand(command_name)
+    return cmd
+
+def commands():
+    for modname in libbe.util.plugin.modnames('libbe.command'):
+        if modname != 'base':
+            yield modname
+
+class CommandInput (object):
+    def __init__(self, name, help=''):
+        self.name = name
+        self.help = help
+
+class Option (CommandInput):
+    def __init__(self, option_callback=None, short_name=None, arg=None,
+                 type=None, *args, **kwargs):
+        CommandInput.__init__(self, *args, **kwargs)
+        self.option_callback = option_callback
+        self.short_name = short_name
+        self.arg = arg
+        self.type = type
+        if self.arg != None:
+            assert self.arg.name == self.name, \
+                'Name missmatch: %s != %s' % (self.arg.name, self.name)
+
+class Argument (CommandInput):
+    def __init__(self, metavar=None, default=None, 
+                 optional=False, repeatable=False,
+                 completion_callback=None, *args, **kwargs):
+        CommandInput.__init__(self, *args, **kwargs)
+        self.metavar = metavar
+        self.default = default
+        self.optional = optional
+        self.repeatable = repeatable
+        self.completion_callback = completion_callback
+
+class _DummyParser (object):
+    def __init__(self, options):
+        self.option_list = options
+        self.option_groups = []
+        for option in self.option_list: # add required methods and attributes
+            option.dest = option.name
+            option._short_opts = []
+            if option.short_name != None:
+                option._short_opts.append('-' + option.short_name)
+            option._long_opts = ['--' + option.name]
+            option.takes_value = lambda : option.arg != None
+            if option.takes_value():
+                option.metavar = option.arg.metavar
+            else:
+                option.metavar = None
+
+class OptionFormatter (optparse.IndentedHelpFormatter):
+    def __init__(self, options):
+        optparse.IndentedHelpFormatter.__init__(self)
+        self.options = options
+    def option_help(self):
+        # based on optparse.OptionParser.format_option_help()
+        parser = _DummyParser(self.options)
+        self.store_option_strings(parser)
+        ret = []
+        ret.append(self.format_heading('Options'))
+        self.indent()
+        for option in self.options:
+            ret.append(self.format_option(option))
+            ret.append('\n')
+        self.dedent()
+        # Drop the last '\n', or the header if no options or option groups:
+        return ''.join(ret[:-1])
+
+class Command (object):
+    """
+    >>> c = Command()
+    >>> print c.help()
+    usage: be command [options]
+    <BLANKLINE>
+    Options:
+      -h HELP, --help=HELP  Print a help message
+    <BLANKLINE>
+      --complete=STRING     Print a list of possible completions
+    <BLANKLINE>
+      -r REPO, --repo=REPO  Select BE repository (see `be help repo`) rather
+                            thanthe current directory.
+    <BLANKLINE>
+    A detailed help message.
+    """
+
+    name = 'command'
+
+    def __init__(self, input_encoding=None, output_encoding=None):
+        self.status = None
+        self.result = None
+        self.input_encoding = None
+        self.output_encoding = None
+        self.options = [
+            Option(name='help', short_name='h',
+                help='Print a help message',
+                option_callback=self.help),
+            Option(name='complete', type='string',
+                help='Print a list of possible completions',
+                arg=Argument(name='complete', metavar='STRING', optional=True)),
+                ]
+        self.args = []
+
+    def run(self, bugdir, options=None, args=None):
+        if options == None:
+            options = {}
+        if args == None:
+            args = []
+        params = {}
+        for option in self.options:
+            if option.name in options:
+                params[option.name] = options.pop(option.name)
+            elif option.arg != None:
+                params[option.name] = option.arg.default
+            else: # non-arg options are flags, set to default flag value
+                params[option.name] = False
+        if len(options) > 0:
+            raise UserError, 'Invalid options passed to command %s:\n  %s' \
+                % (self.name, '\n  '.join(['%s: %s' % (k,v)
+                                           for k,v in options.items()]))
+        for arg in self.args:
+            pass
+        if params['help'] == True:
+            pass
+        else:
+            params.pop('help')
+        if params['complete'] != None:
+            pass
+        else:
+            params.pop('complete')
+        self._setup_io(self.input_encoding, self.output_encoding)
+        self.status = self._run(bugdir, **params)
+        return self.status
+
+    def _run(self, bugdir, **kwargs):
+        pass
+
+    def _setup_io(self, input_encoding=None, output_encoding=None):
+        if input_encoding == None:
+            input_encoding = get_terminal_encoding()
+        if output_encoding == None:
+            output_encoding = get_terminal_encoding()
+        self.stdin = codecs.getwriter(input_encoding)(sys.stdin)
+        self.stdin.encoding = input_encoding
+        self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
+        self.stdout.encoding = output_encoding
+
+    def help(self, *args):        
+        return '\n\n'.join([self._usage(),
+                            self._option_help(),
+                            self._long_help()])
+#        if cmd != None:
+#            return get_command(cmd).help()
+#        cmdlist = []
+#        for name in commands():
+#            module = get_command(name)
+#            cmdlist.append((name, module.__desc__))
+#        cmdlist.sort()
+#        longest_cmd_len = max([len(name) for name,desc in cmdlist])
+#        ret = ["Bugs Everywhere - Distributed bug tracking",
+#               "", "Supported commands"]
+#        for name, desc in cmdlist:
+#            numExtraSpaces = longest_cmd_len-len(name)
+#            ret.append("be %s%*s    %s" % (name, numExtraSpaces, "", desc))
+#        ret.extend(["", "Run", "  be help [command]", "for more information."])
+#        longhelp = "\n".join(ret)
+#        if parser == None:
+#            return longhelp
+#        return parser.help_str() + "\n" + longhelp
+
+    def _usage(self):
+        usage = 'usage: be %s [options]' % self.name
+        num_optional = 0
+        for arg in self.args:
+            usage += ' '
+            if arg.optional == True:
+                usage += '['
+                num_optional += 1
+            usage += arg.metavar
+            if arg.repeatable == True:
+                usage += ' ...'
+        usage += ']'*num_optional
+        return usage
+
+    def _option_help(self):
+        o = OptionFormatter(self.options)
+        return o.option_help().strip('\n')
+
+    def _long_help(self):
+        return "A detailed help message."
-- 
cgit 


From 8b4ad37815cbef1e06532179f9ca098588d9cb44 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sat, 12 Dec 2009 01:12:17 -0500
Subject: Moved command completion from libbe.ui.util to libbe.command.util

---
 libbe/command/base.py | 1 -
 1 file changed, 1 deletion(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 973b840..d18e070 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -5,7 +5,6 @@ import sys
 
 import libbe
 import libbe.util.plugin
-import libbe.ui.util.repo
 
 class UserError(Exception):
     pass
-- 
cgit 


From 86f886399813d37f3cfcf74a824d352e01eb0d8c Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sat, 12 Dec 2009 01:46:22 -0500
Subject: Use get_input/output_encoding() in libbe.command.base.Command

---
 libbe/command/base.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index d18e070..0db156b 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -4,6 +4,7 @@ import optparse
 import sys
 
 import libbe
+import libbe.util.encoding
 import libbe.util.plugin
 
 class UserError(Exception):
@@ -170,9 +171,9 @@ class Command (object):
 
     def _setup_io(self, input_encoding=None, output_encoding=None):
         if input_encoding == None:
-            input_encoding = get_terminal_encoding()
+            input_encoding = libbe.util.get_input_encoding()
         if output_encoding == None:
-            output_encoding = get_terminal_encoding()
+            output_encoding = libbe.util.get_output_encoding()
         self.stdin = codecs.getwriter(input_encoding)(sys.stdin)
         self.stdin.encoding = input_encoding
         self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
-- 
cgit 


From dff6bd9bf89ca80e2265696a478e540476718c9c Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sat, 12 Dec 2009 20:57:59 -0500
Subject: Moved be to libbe.ui.command_line and transitioned to Command format.

---
 libbe/command/base.py | 102 ++++++++++++++++++++++++++++----------------------
 1 file changed, 57 insertions(+), 45 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 0db156b..252dd24 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -36,7 +36,7 @@ def get_command(command_name):
 
 def commands():
     for modname in libbe.util.plugin.modnames('libbe.command'):
-        if modname != 'base':
+        if modname not in ['base', 'util']:
             yield modname
 
 class CommandInput (object):
@@ -44,28 +44,48 @@ class CommandInput (object):
         self.name = name
         self.help = help
 
-class Option (CommandInput):
-    def __init__(self, option_callback=None, short_name=None, arg=None,
-                 type=None, *args, **kwargs):
-        CommandInput.__init__(self, *args, **kwargs)
-        self.option_callback = option_callback
-        self.short_name = short_name
-        self.arg = arg
-        self.type = type
-        if self.arg != None:
-            assert self.arg.name == self.name, \
-                'Name missmatch: %s != %s' % (self.arg.name, self.name)
-
 class Argument (CommandInput):
-    def __init__(self, metavar=None, default=None, 
+    def __init__(self, metavar=None, default=None, type='string',
                  optional=False, repeatable=False,
                  completion_callback=None, *args, **kwargs):
         CommandInput.__init__(self, *args, **kwargs)
         self.metavar = metavar
         self.default = default
+        self.type = type
         self.optional = optional
         self.repeatable = repeatable
         self.completion_callback = completion_callback
+        if self.metavar == None:
+            self.metavar = self.name.upper()
+
+class Option (CommandInput):
+    def __init__(self, callback=None, short_name=None, arg=None,
+                 *args, **kwargs):
+        CommandInput.__init__(self, *args, **kwargs)
+        self.callback = callback
+        self.short_name = short_name
+        self.arg = arg
+        if self.arg == None and self.callback == None:
+            # use an implicit boolean argument
+            self.arg = Argument(name=self.name, help=self.help,
+                                default=False, type='bool')
+        self.validate()
+
+    def validate(self):
+        if self.arg == None:
+            assert self.callback != None
+            return
+        assert self.callback == None, self.callback
+        assert self.arg.name == self.name, \
+            'Name missmatch: %s != %s' % (self.arg.name, self.name)
+        assert self.arg.optional == False
+        assert self.arg.repeatable == False
+
+    def __str__(self):
+        return '--%s' % self.name
+
+    def __repr__(self):
+        return '<Option %s>' % self.__str__()
 
 class _DummyParser (object):
     def __init__(self, options):
@@ -102,20 +122,18 @@ class OptionFormatter (optparse.IndentedHelpFormatter):
         return ''.join(ret[:-1])
 
 class Command (object):
-    """
+    """One-line command description.
+
     >>> c = Command()
     >>> print c.help()
     usage: be command [options]
     <BLANKLINE>
     Options:
-      -h HELP, --help=HELP  Print a help message
+      -h HELP, --help=HELP  Print a help message.
     <BLANKLINE>
-      --complete=STRING     Print a list of possible completions
+      --complete=STRING     Print a list of possible completions.
     <BLANKLINE>
-      -r REPO, --repo=REPO  Select BE repository (see `be help repo`) rather
-                            thanthe current directory.
-    <BLANKLINE>
-    A detailed help message.
+     A detailed help message.
     """
 
     name = 'command'
@@ -123,15 +141,16 @@ class Command (object):
     def __init__(self, input_encoding=None, output_encoding=None):
         self.status = None
         self.result = None
+        self.requires_bugdir = False
         self.input_encoding = None
         self.output_encoding = None
         self.options = [
             Option(name='help', short_name='h',
-                help='Print a help message',
-                option_callback=self.help),
-            Option(name='complete', type='string',
-                help='Print a list of possible completions',
-                arg=Argument(name='complete', metavar='STRING', optional=True)),
+                help='Print a help message.',
+                callback=self.help),
+            Option(name='complete',
+                help='Print a list of possible completions.',
+                callback=self.complete),
                 ]
         self.args = []
 
@@ -179,28 +198,10 @@ class Command (object):
         self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
         self.stdout.encoding = output_encoding
 
-    def help(self, *args):        
+    def help(self, *args):       
         return '\n\n'.join([self._usage(),
                             self._option_help(),
                             self._long_help()])
-#        if cmd != None:
-#            return get_command(cmd).help()
-#        cmdlist = []
-#        for name in commands():
-#            module = get_command(name)
-#            cmdlist.append((name, module.__desc__))
-#        cmdlist.sort()
-#        longest_cmd_len = max([len(name) for name,desc in cmdlist])
-#        ret = ["Bugs Everywhere - Distributed bug tracking",
-#               "", "Supported commands"]
-#        for name, desc in cmdlist:
-#            numExtraSpaces = longest_cmd_len-len(name)
-#            ret.append("be %s%*s    %s" % (name, numExtraSpaces, "", desc))
-#        ret.extend(["", "Run", "  be help [command]", "for more information."])
-#        longhelp = "\n".join(ret)
-#        if parser == None:
-#            return longhelp
-#        return parser.help_str() + "\n" + longhelp
 
     def _usage(self):
         usage = 'usage: be %s [options]' % self.name
@@ -222,3 +223,14 @@ class Command (object):
 
     def _long_help(self):
         return "A detailed help message."
+
+    def complete(self, argument=None, fragment=None):
+        if argument == None:
+            ret = ['--%s' % o.name for o in self.options]
+            if len(self.args) > 0 and self.args[0].completion_callback != None:
+                ret.extend(self.args[0].completion_callback(self, argument))
+            return ret
+        elif argument.completion_callback != None:
+            # finish a particular argument
+            return argument.completion_callback(self, argument, fragment)
+        return [] # the particular argument doesn't supply completion info
-- 
cgit 


From 4d057dab603f42ec40b911dbee6792dcf107bd14 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sun, 13 Dec 2009 06:19:23 -0500
Subject: Converted libbe.storage.vcs.base to new Storage format.

---
 libbe/command/base.py | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 252dd24..52f193d 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -1,5 +1,6 @@
 # Copyright
 
+import codecs
 import optparse
 import sys
 
@@ -168,7 +169,7 @@ class Command (object):
             else: # non-arg options are flags, set to default flag value
                 params[option.name] = False
         if len(options) > 0:
-            raise UserError, 'Invalid options passed to command %s:\n  %s' \
+            raise UserError, 'Invalid option passed to command %s:\n  %s' \
                 % (self.name, '\n  '.join(['%s: %s' % (k,v)
                                            for k,v in options.items()]))
         for arg in self.args:
@@ -190,9 +191,9 @@ class Command (object):
 
     def _setup_io(self, input_encoding=None, output_encoding=None):
         if input_encoding == None:
-            input_encoding = libbe.util.get_input_encoding()
+            input_encoding = libbe.util.encoding.get_input_encoding()
         if output_encoding == None:
-            output_encoding = libbe.util.get_output_encoding()
+            output_encoding = libbe.util.encoding.get_output_encoding()
         self.stdin = codecs.getwriter(input_encoding)(sys.stdin)
         self.stdin.encoding = input_encoding
         self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
-- 
cgit 


From 9b1f9db34189744ded87a28aaa395d9344593df2 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 01:12:08 -0500
Subject: Transitioned assign to Command format

---
 libbe/command/base.py | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 52f193d..2cf75bd 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -5,9 +5,11 @@ import optparse
 import sys
 
 import libbe
+import libbe.ui.util.user
 import libbe.util.encoding
 import libbe.util.plugin
 
+
 class UserError(Exception):
     pass
 
@@ -162,18 +164,45 @@ class Command (object):
             args = []
         params = {}
         for option in self.options:
+            assert option.name not in params, params[option.name]
             if option.name in options:
                 params[option.name] = options.pop(option.name)
             elif option.arg != None:
                 params[option.name] = option.arg.default
             else: # non-arg options are flags, set to default flag value
                 params[option.name] = False
+        assert 'user-id' not in params, params['user-id']
+        if 'user-id' in options:
+            params['user-id'] = options.pop('user-id')
+        else:
+            params['user-id'] = libbe.ui.util.user.get_user_id(bugdir.storage)
         if len(options) > 0:
             raise UserError, 'Invalid option passed to command %s:\n  %s' \
                 % (self.name, '\n  '.join(['%s: %s' % (k,v)
                                            for k,v in options.items()]))
-        for arg in self.args:
-            pass
+        in_optional_args = False
+        for i,arg in enumerate(self.args):
+            if arg.repeatable == True:
+                assert i == len(self.args)-1, arg.name
+            if in_optional_args == True:
+                assert arg.optional == True, arg.name
+            else:
+                in_optional_args = arg.optional
+            if i < len(args):
+                if arg.repeatable == True:
+                    params[arg.name] = [args[i]]
+                else:
+                    params[arg.name] = args[i]
+            else:  # no value given
+                assert in_optional_args == True, arg.name
+                if arg.repeatable == True:
+                    params[arg.name] = [arg.default]
+                else:
+                    params[arg.name] = arg.default
+        if len(args) > len(self.args):  # add some additional repeats
+            assert self.args[-1].repeatable == True, self.args[-1].name
+            params[self.args[-1].name].extend(args[len(self.args):])
+
         if params['help'] == True:
             pass
         else:
@@ -182,6 +211,7 @@ class Command (object):
             pass
         else:
             params.pop('complete')
+
         self._setup_io(self.input_encoding, self.output_encoding)
         self.status = self._run(bugdir, **params)
         return self.status
-- 
cgit 


From 2f0ceedba5b6619faf476cd1aa67e826e91d5c7c Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 03:29:20 -0500
Subject: Transitioned init to Command format

---
 libbe/command/base.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 2cf75bd..b27e188 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -145,6 +145,7 @@ class Command (object):
         self.status = None
         self.result = None
         self.requires_bugdir = False
+        self.requires_unconnected_storage = False
         self.input_encoding = None
         self.output_encoding = None
         self.options = [
@@ -157,7 +158,7 @@ class Command (object):
                 ]
         self.args = []
 
-    def run(self, bugdir, options=None, args=None):
+    def run(self, storage=None, bugdir=None, options=None, args=None):
         if options == None:
             options = {}
         if args == None:
@@ -175,7 +176,7 @@ class Command (object):
         if 'user-id' in options:
             params['user-id'] = options.pop('user-id')
         else:
-            params['user-id'] = libbe.ui.util.user.get_user_id(bugdir.storage)
+            params['user-id'] = libbe.ui.util.user.get_user_id(storage)
         if len(options) > 0:
             raise UserError, 'Invalid option passed to command %s:\n  %s' \
                 % (self.name, '\n  '.join(['%s: %s' % (k,v)
@@ -213,10 +214,10 @@ class Command (object):
             params.pop('complete')
 
         self._setup_io(self.input_encoding, self.output_encoding)
-        self.status = self._run(bugdir, **params)
+        self.status = self._run(storage, bugdir, **params)
         return self.status
 
-    def _run(self, bugdir, **kwargs):
+    def _run(self, storage, bugdir, **kwargs):
         pass
 
     def _setup_io(self, input_encoding=None, output_encoding=None):
-- 
cgit 


From 19fe0817ba7c2cd04caea3adfa82d4490288a548 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 07:37:51 -0500
Subject: Transitioned comment to Command format

---
 libbe/command/base.py | 105 ++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 81 insertions(+), 24 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index b27e188..e28cf33 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -2,6 +2,7 @@
 
 import codecs
 import optparse
+import os.path
 import sys
 
 import libbe
@@ -9,7 +10,6 @@ import libbe.ui.util.user
 import libbe.util.encoding
 import libbe.util.plugin
 
-
 class UserError(Exception):
     pass
 
@@ -90,34 +90,55 @@ class Option (CommandInput):
     def __repr__(self):
         return '<Option %s>' % self.__str__()
 
-class _DummyParser (object):
-    def __init__(self, options):
-        self.option_list = options
-        self.option_groups = []
-        for option in self.option_list: # add required methods and attributes
-            option.dest = option.name
-            option._short_opts = []
-            if option.short_name != None:
-                option._short_opts.append('-' + option.short_name)
-            option._long_opts = ['--' + option.name]
-            option.takes_value = lambda : option.arg != None
-            if option.takes_value():
-                option.metavar = option.arg.metavar
-            else:
-                option.metavar = None
+class _DummyParser (optparse.OptionParser):
+    def __init__(self, command):
+        optparse.OptionParser.__init__(self)
+        self.remove_option('-h')
+        self.command = command
+        self._command_opts = []
+        for option in self.command.options:
+            self._add_option(option)
+
+    def _add_option(self, option):
+        # from libbe.ui.command_line.CmdOptionParser._add_option
+        option.validate()
+        long_opt = '--%s' % option.name
+        if option.short_name != None:
+            short_opt = '-%s' % option.short_name
+        assert '_' not in option.name, \
+            'Non-reconstructable option name %s' % option.name
+        kwargs = {'dest':option.name.replace('-', '_'),
+                  'help':option.help}
+        if option.arg == None or option.arg.type == 'bool':
+            kwargs['action'] = 'store_true'
+            kwargs['metavar'] = None
+            kwargs['default'] = False
+        else:
+            kwargs['type'] = option.arg.type
+            kwargs['action'] = 'store'
+            kwargs['metavar'] = option.arg.metavar
+            kwargs['default'] = option.arg.default
+        if option.short_name != None:
+            opt = optparse.Option(short_opt, long_opt, **kwargs)
+        else:
+            opt = optparse.Option(long_opt, **kwargs)
+        #option.takes_value = lambda : option.arg != None
+        opt._option = option
+        self._command_opts.append(opt)
+        self.add_option(opt)
 
 class OptionFormatter (optparse.IndentedHelpFormatter):
-    def __init__(self, options):
+    def __init__(self, command):
         optparse.IndentedHelpFormatter.__init__(self)
-        self.options = options
+        self.command = command
     def option_help(self):
         # based on optparse.OptionParser.format_option_help()
-        parser = _DummyParser(self.options)
+        parser = _DummyParser(self.command)
         self.store_option_strings(parser)
         ret = []
         ret.append(self.format_heading('Options'))
         self.indent()
-        for option in self.options:
+        for option in parser._command_opts:
             ret.append(self.format_option(option))
             ret.append('\n')
         self.dedent()
@@ -132,11 +153,11 @@ class Command (object):
     usage: be command [options]
     <BLANKLINE>
     Options:
-      -h HELP, --help=HELP  Print a help message.
+      -h, --help  Print a help message.
     <BLANKLINE>
-      --complete=STRING     Print a list of possible completions.
+      --complete  Print a list of possible completions.
     <BLANKLINE>
-     A detailed help message.
+    A detailed help message.
     """
 
     name = 'command'
@@ -145,7 +166,9 @@ class Command (object):
         self.status = None
         self.result = None
         self.requires_bugdir = False
+        self.requires_storage = False
         self.requires_unconnected_storage = False
+        self.restrict_file_access = True
         self.input_encoding = None
         self.output_encoding = None
         self.options = [
@@ -250,7 +273,7 @@ class Command (object):
         return usage
 
     def _option_help(self):
-        o = OptionFormatter(self.options)
+        o = OptionFormatter(self)
         return o.option_help().strip('\n')
 
     def _long_help(self):
@@ -266,3 +289,37 @@ class Command (object):
             # finish a particular argument
             return argument.completion_callback(self, argument, fragment)
         return [] # the particular argument doesn't supply completion info
+
+    def check_restricted_access(self, storage, path):
+        """
+        Check that the file at path is inside bugdir.root.  This is
+        important if you allow other users to execute becommands with
+        your username (e.g. if you're running be-handle-mail through
+        your ~/.procmailrc).  If this check wasn't made, a user could
+        e.g.  run
+          be commit -b ~/.ssh/id_rsa "Hack to expose ssh key"
+        which would expose your ssh key to anyone who could read the
+        VCS log.
+
+        >>> class DummyStorage (object): pass
+        >>> s = DummyStorage()
+        >>> s.repo = os.path.expanduser('~/x/')
+        >>> c = Command()
+        >>> try:
+        ...     c.check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
+        ... except UserError, e:
+        ...     assert str(e).startswith('file access restricted!'), str(e)
+        ...     print 'we got the expected error'
+        we got the expected error
+        >>> c.check_restricted_access(s, os.path.expanduser('~/x'))
+        >>> c.check_restricted_access(s, os.path.expanduser('~/x/y'))
+        >>> c.restrict_file_access = False
+        >>> c.check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
+        """
+        if self.restrict_file_access == True:
+            path = os.path.abspath(path)
+            repo = os.path.abspath(storage.repo).rstrip(os.path.sep)
+            if path == repo or path.startswith(repo+os.path.sep):
+                return
+            raise UserError('file access restricted!\n  %s not in %s'
+                            % (path, repo))
-- 
cgit 


From 3e5823d0985a54dec37f103dc72fda604d12a948 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 18:25:28 -0500
Subject: Transitioned import_xml to Command-format

---
 libbe/command/base.py | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index e28cf33..fe29908 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -37,6 +37,21 @@ def get_command(command_name):
         raise UnknownCommand(command_name)
     return cmd
 
+def get_command_class(module, command_name):
+    """Retrieves a command class from a module.
+
+    >>> import_xml_mod = get_command('import-xml')
+    >>> import_xml = get_command_class(import_xml_mod, 'import-xml')
+    >>> repr(import_xml)
+    "<class 'libbe.command.import_xml.Import_XML'>"
+    """
+    try:
+        cname = command_name.capitalize().replace('-', '_')
+        cmd = getattr(module, cname)
+    except ImportError, e:
+        raise UnknownCommand(command_name)
+    return cmd
+
 def commands():
     for modname in libbe.util.plugin.modnames('libbe.command'):
         if modname not in ['base', 'util']:
@@ -76,13 +91,13 @@ class Option (CommandInput):
 
     def validate(self):
         if self.arg == None:
-            assert self.callback != None
+            assert self.callback != None, self.name
             return
-        assert self.callback == None, self.callback
+        assert self.callback == None, '%s: %s' (self.name, self.callback)
         assert self.arg.name == self.name, \
             'Name missmatch: %s != %s' % (self.arg.name, self.name)
-        assert self.arg.optional == False
-        assert self.arg.repeatable == False
+        assert self.arg.optional == False, self.name
+        assert self.arg.repeatable == False, self.name
 
     def __str__(self):
         return '--%s' % self.name
-- 
cgit 


From f9ee7a537561be80b9c232dd4fc848ddb564f6b0 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 20:33:35 -0500
Subject: Transitioned help to Command-format

---
 libbe/command/base.py | 1 +
 1 file changed, 1 insertion(+)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index fe29908..54463c8 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -180,6 +180,7 @@ class Command (object):
     def __init__(self, input_encoding=None, output_encoding=None):
         self.status = None
         self.result = None
+        self.ui = None # calling user-interface, e.g. for Help()
         self.requires_bugdir = False
         self.requires_storage = False
         self.requires_unconnected_storage = False
-- 
cgit 


From 1b9c628529848af370adbc67b5ba298236a1b86d Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 14 Dec 2009 23:15:58 -0500
Subject: Transitioned severity to Command-format, also added Command._get_*()

The old
  .requires_*
thing was rediculous.  The new ._get_*() callbacks allow the caller
to provide a means for getting the expensive structures, which the
command can use, or not, as required.  This will also make it easier
to implement the completion callbacks.

The callbacks should probably have matching .set_*() methods, to
avoid the current cache tweaking
  cmd._storage = ...
etc.  But that can wait for now...
---
 libbe/command/base.py | 73 +++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 54 insertions(+), 19 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 54463c8..2aaf51e 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -177,16 +177,15 @@ class Command (object):
 
     name = 'command'
 
-    def __init__(self, input_encoding=None, output_encoding=None):
+    def __init__(self, input_encoding=None, output_encoding=None,
+                 get_unconnected_storage=None, ui=None):
+        self.input_encoding = input_encoding
+        self.output_encoding = output_encoding
+        self.get_unconnected_storage = get_unconnected_storage
+        self.ui = ui # calling user-interface, e.g. for Help()
         self.status = None
         self.result = None
-        self.ui = None # calling user-interface, e.g. for Help()
-        self.requires_bugdir = False
-        self.requires_storage = False
-        self.requires_unconnected_storage = False
         self.restrict_file_access = True
-        self.input_encoding = None
-        self.output_encoding = None
         self.options = [
             Option(name='help', short_name='h',
                 help='Print a help message.',
@@ -197,7 +196,7 @@ class Command (object):
                 ]
         self.args = []
 
-    def run(self, storage=None, bugdir=None, options=None, args=None):
+    def run(self, options=None, args=None):
         if options == None:
             options = {}
         if args == None:
@@ -213,9 +212,7 @@ class Command (object):
                 params[option.name] = False
         assert 'user-id' not in params, params['user-id']
         if 'user-id' in options:
-            params['user-id'] = options.pop('user-id')
-        else:
-            params['user-id'] = libbe.ui.util.user.get_user_id(storage)
+            self._user_id = options.pop('user-id')
         if len(options) > 0:
             raise UserError, 'Invalid option passed to command %s:\n  %s' \
                 % (self.name, '\n  '.join(['%s: %s' % (k,v)
@@ -253,11 +250,11 @@ class Command (object):
             params.pop('complete')
 
         self._setup_io(self.input_encoding, self.output_encoding)
-        self.status = self._run(storage, bugdir, **params)
+        self.status = self._run(**params)
         return self.status
 
-    def _run(self, storage, bugdir, **kwargs):
-        pass
+    def _run(self, **kwargs):
+        raise NotImplementedError
 
     def _setup_io(self, input_encoding=None, output_encoding=None):
         if input_encoding == None:
@@ -306,7 +303,7 @@ class Command (object):
             return argument.completion_callback(self, argument, fragment)
         return [] # the particular argument doesn't supply completion info
 
-    def check_restricted_access(self, storage, path):
+    def _check_restricted_access(self, storage, path):
         """
         Check that the file at path is inside bugdir.root.  This is
         important if you allow other users to execute becommands with
@@ -322,15 +319,15 @@ class Command (object):
         >>> s.repo = os.path.expanduser('~/x/')
         >>> c = Command()
         >>> try:
-        ...     c.check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
+        ...     c._check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
         ... except UserError, e:
         ...     assert str(e).startswith('file access restricted!'), str(e)
         ...     print 'we got the expected error'
         we got the expected error
-        >>> c.check_restricted_access(s, os.path.expanduser('~/x'))
-        >>> c.check_restricted_access(s, os.path.expanduser('~/x/y'))
+        >>> c._check_restricted_access(s, os.path.expanduser('~/x'))
+        >>> c._check_restricted_access(s, os.path.expanduser('~/x/y'))
         >>> c.restrict_file_access = False
-        >>> c.check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
+        >>> c._check_restricted_access(s, os.path.expanduser('~/.ssh/id_rsa'))
         """
         if self.restrict_file_access == True:
             path = os.path.abspath(path)
@@ -339,3 +336,41 @@ class Command (object):
                 return
             raise UserError('file access restricted!\n  %s not in %s'
                             % (path, repo))
+
+    def _get_unconnected_storage(self):
+        """Callback for use by commands that need it."""
+        if not hasattr(self, '_unconnected_storage'):
+            if self.get_unconnected_storage == None:
+                raise NotImplementedError
+            self._unconnected_storage = self.get_unconnected_storage()
+        return self._unconnected_storage
+
+    def _get_storage(self):
+        """
+        Callback for use by commands that need it.
+        
+        Note that with the current implementation,
+        _get_unconnected_storage() will not work after this method
+        runs, but that shouldn't be an issue for any command I can
+        think of...
+        """
+        if not hasattr(self, '_storage'):
+            self._storage = self._get_unconnected_storage()
+            self._storage.connect()
+        return self._storage
+
+    def _get_bugdir(self):
+        """Callback for use by commands that need it."""
+        if not hasattr(self, '_bugdir'):
+            self._bugdir = libbe.bugdir.BugDir(self._get_storage(), from_storage=True)
+        return self._bugdir
+
+    def _get_user_id(self):
+        """Callback for use by commands that need it."""
+        if not hasattr(self, '_user_id'):
+            self._user_id = libbe.ui.util.user.get_user_id(self._get_storage())
+        return self._user_id
+
+    def cleanup(self):
+        if hasattr(self, '_storage'):
+            self._storage.disconnect()
-- 
cgit 


From a1bd5432ffbf28bf2fadfed8a5b2db917f243344 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Tue, 15 Dec 2009 01:52:17 -0500
Subject: Transitioned tag to Command-format

---
 libbe/command/base.py | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 2aaf51e..74573a3 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -232,10 +232,7 @@ class Command (object):
                     params[arg.name] = args[i]
             else:  # no value given
                 assert in_optional_args == True, arg.name
-                if arg.repeatable == True:
-                    params[arg.name] = [arg.default]
-                else:
-                    params[arg.name] = arg.default
+                params[arg.name] = arg.default
         if len(args) > len(self.args):  # add some additional repeats
             assert self.args[-1].repeatable == True, self.args[-1].name
             params[self.args[-1].name].extend(args[len(self.args):])
-- 
cgit 


From 58bedebfddbb8e1fc8f0a441163526feaecb753b Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Tue, 15 Dec 2009 03:31:48 -0500
Subject: Transition to Command-format complete.

Well, except for going through and updating the _long_help()
strings.
  $ python test.py libbe.command
succeeds for everything except Diff and Subscribe, which is expected
since I haven't fixed up libbe.diff yet.
---
 libbe/command/base.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 74573a3..9f50632 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -266,7 +266,7 @@ class Command (object):
     def help(self, *args):       
         return '\n\n'.join([self._usage(),
                             self._option_help(),
-                            self._long_help()])
+                            self._long_help().rstrip('\n')])
 
     def _usage(self):
         usage = 'usage: be %s [options]' % self.name
-- 
cgit 


From 89b7a1411e4658e831f5d635534b24355dbb941d Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Tue, 15 Dec 2009 06:44:20 -0500
Subject: Fixed libbe.command.diff + ugly BugDir.duplicate_bugdir
 implementation

duplicate_bugdir() works, but for the vcs backends, it could require
shelling out for _every_ file read.  This could, and probably will, be
horribly slow.  Still it works ;).

I'm not sure what a better implementation would be.  The old
implementation checked out the entire earlier state into a temporary
directory
  pros: single shell out, simple upgrade implementation
  cons: wouldn't work well for HTTP backens

I think a good solution would run along the lines of the currently
commented out code in duplicate_bugdir(), where a
  VersionedStorage.changed_since(revision)
call would give you a list of changed files.  diff could work off of
that directly, without the need to generate a whole duplicate bugdir.
I'm stuck on how to handle upgrades though...

Also removed trailing whitespace from all python files.
---
 libbe/command/base.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 9f50632..6a49413 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -263,7 +263,7 @@ class Command (object):
         self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
         self.stdout.encoding = output_encoding
 
-    def help(self, *args):       
+    def help(self, *args):
         return '\n\n'.join([self._usage(),
                             self._option_help(),
                             self._long_help().rstrip('\n')])
@@ -345,7 +345,7 @@ class Command (object):
     def _get_storage(self):
         """
         Callback for use by commands that need it.
-        
+
         Note that with the current implementation,
         _get_unconnected_storage() will not work after this method
         runs, but that shouldn't be an issue for any command I can
-- 
cgit 


From dff704764d77bffbf6cc94c5ba4bb03309da45f8 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sun, 27 Dec 2009 16:30:54 -0500
Subject: Added storage.Storage.storage_version() and
 command.InvalidStorageVersion.

Now commands automatically check for storage version compatibility.
---
 libbe/command/base.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 6a49413..1409c74 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -6,6 +6,7 @@ import os.path
 import sys
 
 import libbe
+import libbe.storage
 import libbe.ui.util.user
 import libbe.util.encoding
 import libbe.util.plugin
@@ -18,6 +19,15 @@ class UnknownCommand(UserError):
         Exception.__init__(self, "Unknown command '%s'" % cmd)
         self.cmd = cmd
 
+class InvalidStorageVersion(UserError):
+    def __init__(self, active_version, expected_version=None):
+        if expected_version == None:
+            expected_version = libbe.storage.STORAGE_VERSION
+        msg = 'Storage in "%s" not the expected "%s"' \
+            % (active_version, expected_version)
+        UserError.__init__(self, msg)
+        self.active_version = active_version
+        self.expected_version = expected_version
 
 def get_command(command_name):
     """Retrieves the module for a user command
@@ -354,6 +364,9 @@ class Command (object):
         if not hasattr(self, '_storage'):
             self._storage = self._get_unconnected_storage()
             self._storage.connect()
+            version = self._storage.storage_version()
+            if version != libbe.storage.STORAGE_VERSION:
+                raise InvalidStorageVersion(version)
         return self._storage
 
     def _get_bugdir(self):
-- 
cgit 


From cfebc238cbda9b6338ec57d5c215c4cbf0246f8b Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sun, 27 Dec 2009 16:50:36 -0500
Subject: Moved InvalidStorageVersion from libbe.command to libbe.storage

Also added ConnectionError pretty-print to ui.command_line, storage
version checking to BugDir.duplicate_bugdir(), and optional revision
argument to Storage.storage_version().
---
 libbe/command/base.py | 12 +-----------
 1 file changed, 1 insertion(+), 11 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 1409c74..ac6a58b 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -19,16 +19,6 @@ class UnknownCommand(UserError):
         Exception.__init__(self, "Unknown command '%s'" % cmd)
         self.cmd = cmd
 
-class InvalidStorageVersion(UserError):
-    def __init__(self, active_version, expected_version=None):
-        if expected_version == None:
-            expected_version = libbe.storage.STORAGE_VERSION
-        msg = 'Storage in "%s" not the expected "%s"' \
-            % (active_version, expected_version)
-        UserError.__init__(self, msg)
-        self.active_version = active_version
-        self.expected_version = expected_version
-
 def get_command(command_name):
     """Retrieves the module for a user command
 
@@ -366,7 +356,7 @@ class Command (object):
             self._storage.connect()
             version = self._storage.storage_version()
             if version != libbe.storage.STORAGE_VERSION:
-                raise InvalidStorageVersion(version)
+                raise libbe.storage.InvalidStorageVersion(version)
         return self._storage
 
     def _get_bugdir(self):
-- 
cgit 


From e2b648f2148d7b6550fb3a4bcfde4eff714a7ec6 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 28 Dec 2009 10:56:04 -0500
Subject: Allow external use of Command.usage() and use
 CmdOptionParser.set_usage()

This fixes
  $ python be diff -2
  Usage: be [options]

  be: error: no such option: -2
and we now get the correct output
  $ python be diff -2
  Usage: be diff [options] [REVISION]

  be: error: no such option: -2
---
 libbe/command/base.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index ac6a58b..cdb4043 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -264,11 +264,11 @@ class Command (object):
         self.stdout.encoding = output_encoding
 
     def help(self, *args):
-        return '\n\n'.join([self._usage(),
+        return '\n\n'.join([self.usage(),
                             self._option_help(),
                             self._long_help().rstrip('\n')])
 
-    def _usage(self):
+    def usage(self):
         usage = 'usage: be %s [options]' % self.name
         num_optional = 0
         for arg in self.args:
-- 
cgit 


From 4372a17b4215df25b3da0b68daf4d6b490a8955c Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Tue, 29 Dec 2009 19:00:40 -0500
Subject: Fixed up the completion helpers in libbe.command.util

This entailed a fairly thorough cleanup of libbe.util.id.

Remaining unimplemented completion helpers:
  * complete_assigned()
  * complete_extra_strings()
Since these would require scanning all (active?) bugs to compile
lists, and I was feeling lazy...
---
 libbe/command/base.py | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index cdb4043..2318aa7 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -62,6 +62,12 @@ class CommandInput (object):
         self.name = name
         self.help = help
 
+    def __str__(self):
+        return '<%s %s>' % (self.__class__.__name__, self.name)
+
+    def __repr__(self):
+        return self.__str__()
+
 class Argument (CommandInput):
     def __init__(self, metavar=None, default=None, type='string',
                  optional=False, repeatable=False,
-- 
cgit 


From cfae8a8302f06a84196700138d7ddbb25e91ea31 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Thu, 31 Dec 2009 14:32:39 -0500
Subject: Added UserInterface and other improved abstractions for command
 handling

---
 libbe/command/base.py | 221 +++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 172 insertions(+), 49 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 2318aa7..357940f 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -3,6 +3,7 @@
 import codecs
 import optparse
 import os.path
+import StringIO
 import sys
 
 import libbe
@@ -37,14 +38,19 @@ def get_command(command_name):
         raise UnknownCommand(command_name)
     return cmd
 
-def get_command_class(module, command_name):
+def get_command_class(module=None, command_name=None):
     """Retrieves a command class from a module.
 
     >>> import_xml_mod = get_command('import-xml')
     >>> import_xml = get_command_class(import_xml_mod, 'import-xml')
     >>> repr(import_xml)
     "<class 'libbe.command.import_xml.Import_XML'>"
+    >>> import_xml = get_command_class(command_name='import-xml')
+    >>> repr(import_xml)
+    "<class 'libbe.command.import_xml.Import_XML'>"
     """
+    if module == None:
+        module = get_command(command_name)
     try:
         cname = command_name.capitalize().replace('-', '_')
         cmd = getattr(module, cname)
@@ -167,7 +173,7 @@ class OptionFormatter (optparse.IndentedHelpFormatter):
         return ''.join(ret[:-1])
 
 class Command (object):
-    """One-line command description.
+    """One-line command description here.
 
     >>> c = Command()
     >>> print c.help()
@@ -183,12 +189,8 @@ class Command (object):
 
     name = 'command'
 
-    def __init__(self, input_encoding=None, output_encoding=None,
-                 get_unconnected_storage=None, ui=None):
-        self.input_encoding = input_encoding
-        self.output_encoding = output_encoding
-        self.get_unconnected_storage = get_unconnected_storage
-        self.ui = ui # calling user-interface, e.g. for Help()
+    def __init__(self, ui=None):
+        self.ui = ui # calling user-interface
         self.status = None
         self.result = None
         self.restrict_file_access = True
@@ -203,6 +205,21 @@ class Command (object):
         self.args = []
 
     def run(self, options=None, args=None):
+        self.status = 1 # in case we raise an exception
+        params = self._parse_options_args(options, args)
+        if params['help'] == True:
+            pass
+        else:
+            params.pop('help')
+        if params['complete'] != None:
+            pass
+        else:
+            params.pop('complete')
+
+        self.status = self._run(**params)
+        return self.status
+
+    def _parse_options_args(self, options=None, args=None):
         if options == None:
             options = {}
         if args == None:
@@ -242,33 +259,11 @@ class Command (object):
         if len(args) > len(self.args):  # add some additional repeats
             assert self.args[-1].repeatable == True, self.args[-1].name
             params[self.args[-1].name].extend(args[len(self.args):])
-
-        if params['help'] == True:
-            pass
-        else:
-            params.pop('help')
-        if params['complete'] != None:
-            pass
-        else:
-            params.pop('complete')
-
-        self._setup_io(self.input_encoding, self.output_encoding)
-        self.status = self._run(**params)
-        return self.status
+        return params
 
     def _run(self, **kwargs):
         raise NotImplementedError
 
-    def _setup_io(self, input_encoding=None, output_encoding=None):
-        if input_encoding == None:
-            input_encoding = libbe.util.encoding.get_input_encoding()
-        if output_encoding == None:
-            output_encoding = libbe.util.encoding.get_output_encoding()
-        self.stdin = codecs.getwriter(input_encoding)(sys.stdin)
-        self.stdin.encoding = input_encoding
-        self.stdout = codecs.getwriter(output_encoding)(sys.stdout)
-        self.stdout.encoding = output_encoding
-
     def help(self, *args):
         return '\n\n'.join([self.usage(),
                             self._option_help(),
@@ -340,43 +335,171 @@ class Command (object):
             raise UserError('file access restricted!\n  %s not in %s'
                             % (path, repo))
 
-    def _get_unconnected_storage(self):
-        """Callback for use by commands that need it."""
+    def cleanup(self):
+        pass
+
+class InputOutput (object):
+    def __init__(self, stdin=None, stdout=None):
+        self.stdin = stdin
+        self.stdout = stdout
+
+    def setup_command(self, command):
+        if not hasattr(self.stdin, 'encoding'):
+            self.stdin.encoding = libbe.util.encoding.get_input_encoding()
+        if not hasattr(self.stdout, 'encoding'):
+            self.stdout.encoding = libbe.util.encoding.get_output_encoding()
+        command.stdin = self.stdin
+        command.stdin.encoding = self.stdin.encoding
+        command.stdout = self.stdout
+        command.stdout.encoding = self.stdout.encoding
+
+    def cleanup(self):
+        pass
+
+class StdInputOutput (InputOutput):
+    def __init__(self, input_encoding=None, output_encoding=None):
+        stdin,stdout = self._get_io(input_encoding, output_encoding)
+        InputOutput.__init__(self, stdin, stdout)
+
+    def _get_io(self, input_encoding=None, output_encoding=None):
+        if input_encoding == None:
+            input_encoding = libbe.util.encoding.get_input_encoding()
+        if output_encoding == None:
+            output_encoding = libbe.util.encoding.get_output_encoding()
+        stdin = codecs.getwriter(input_encoding)(sys.stdin)
+        stdin.encoding = input_encoding
+        stdout = codecs.getwriter(output_encoding)(sys.stdout)
+        stdout.encoding = output_encoding
+        return (stdin, stdout)
+
+class StringInputOutput (InputOutput):
+    """
+    >>> s = StringInputOutput()
+    >>> s.set_stdin('hello')
+    >>> s.stdin.read()
+    'hello'
+    >>> s.stdin.read()
+    >>> print >> s.stdout, 'goodbye'
+    >>> s.get_stdout()
+    'goodbye\n'
+    >>> s.get_stdout()
+    ''
+
+    Also works with unicode strings
+
+    >>> s.set_stdin(u'hello')
+    >>> s.stdin.read()
+    u'hello'
+    >>> print >> s.stdout, u'goodbye'
+    >>> s.get_stdout()
+    u'goodbye\n'
+    """
+    def __init__(self):
+        stdin = StringIO.StringIO()
+        stdin.encoding = 'utf-8'
+        stdout = StringIO.StringIO()
+        stdout.encoding = 'utf-8'
+        InputOutput.__init__(self, stdin, stdout)
+
+    def set_stdin(self, stdin_string):
+        self.stdin = StringIO.StringIO(stdin_string)
+
+    def get_stdout(self):
+        ret = self.stdout.getvalue()
+        self.stdout = StringIO.StringIO() # clear stdout for next read
+        self.stdin.encoding = 'utf-8'
+        return ret
+
+class UnconnectedStorageGetter (object):
+    def __init__(self, location):
+        self.location = location
+
+    def __call__(self):
+        return libbe.storage.get_storage(self.location)
+
+class StorageCallbacks (object):
+    def __init__(self, location=None):
+        if location == None:
+            location = '.'
+        self.location = location
+        self._get_unconnected_storage = UnconnectedStorageGetter(location)
+
+    def setup_command(self, command):
+        command._get_unconnected_storage = self.get_unconnected_storage
+        command._get_storage = self.get_storage
+        command._get_bugdir = self.get_bugdir
+
+    def get_unconnected_storage(self):
+        """
+        Callback for use by commands that need it.
+        
+        The returned Storage instance is may actually be connected,
+        but commands that make use of the returned value should only
+        make use of non-connected Storage methods.  This is mainly
+        intended for the init command, which calls Storage.init().
+        """
         if not hasattr(self, '_unconnected_storage'):
-            if self.get_unconnected_storage == None:
+            if self._get_unconnected_storage == None:
                 raise NotImplementedError
-            self._unconnected_storage = self.get_unconnected_storage()
+            self._unconnected_storage = self._get_unconnected_storage()
         return self._unconnected_storage
 
-    def _get_storage(self):
-        """
-        Callback for use by commands that need it.
+    def set_unconnected_storage(self, unconnected_storage):
+        self._unconnected_storage = unconnected_storage
 
-        Note that with the current implementation,
-        _get_unconnected_storage() will not work after this method
-        runs, but that shouldn't be an issue for any command I can
-        think of...
-        """
+    def get_storage(self):
+        """Callback for use by commands that need it."""
         if not hasattr(self, '_storage'):
-            self._storage = self._get_unconnected_storage()
+            self._storage = self.get_unconnected_storage()
             self._storage.connect()
             version = self._storage.storage_version()
             if version != libbe.storage.STORAGE_VERSION:
                 raise libbe.storage.InvalidStorageVersion(version)
         return self._storage
 
-    def _get_bugdir(self):
+    def set_storage(self, storage):
+        self._storage = storage
+
+    def get_bugdir(self):
         """Callback for use by commands that need it."""
         if not hasattr(self, '_bugdir'):
-            self._bugdir = libbe.bugdir.BugDir(self._get_storage(), from_storage=True)
+            self._bugdir = libbe.bugdir.BugDir(self.get_storage(),
+                                               from_storage=True)
         return self._bugdir
 
+    def set_bugdir(self, bugdir):
+        self._bugdir = bugdir
+
+    def cleanup(self):
+        if hasattr(self, '_storage'):
+            self._storage.disconnect()
+
+class UserInterface (object):
+    def __init__(self, io=None, location=None):
+        if io == None:
+            io = StringInputOutput()
+        self.io = io
+        self.storage_callbacks = StorageCallbacks(location)
+        self.restrict_file_access = True
+
+    def help(self):
+        raise NotImplementedError
+
+    def run(self, command, options=None, args=None):
+        command.ui = self
+        self.io.setup_command(command)
+        self.storage_callbacks.setup_command(command)
+        command.restrict_file_access = self.restrict_file_access
+        command._get_user_id = self._get_user_id
+        return command.run(options, args)
+
     def _get_user_id(self):
         """Callback for use by commands that need it."""
         if not hasattr(self, '_user_id'):
-            self._user_id = libbe.ui.util.user.get_user_id(self._get_storage())
+            self._user_id = libbe.ui.util.user.get_user_id(
+                self.storage_callbacks.get_storage())
         return self._user_id
 
     def cleanup(self):
-        if hasattr(self, '_storage'):
-            self._storage.disconnect()
+        self.storage_callbacks.cleanup()
+        self.io.cleanup()
-- 
cgit 


From 2d1562d951e763fed71fe60e77cc9921be9abdc9 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Thu, 31 Dec 2009 15:33:39 -0500
Subject: Use fragment in base command completion + command io fixups.

---
 libbe/command/base.py | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 357940f..2f0ccc6 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -294,7 +294,7 @@ class Command (object):
         if argument == None:
             ret = ['--%s' % o.name for o in self.options]
             if len(self.args) > 0 and self.args[0].completion_callback != None:
-                ret.extend(self.args[0].completion_callback(self, argument))
+                ret.extend(self.args[0].completion_callback(self, argument, fragment))
             return ret
         elif argument.completion_callback != None:
             # finish a particular argument
@@ -486,12 +486,18 @@ class UserInterface (object):
         raise NotImplementedError
 
     def run(self, command, options=None, args=None):
-        command.ui = self
-        self.io.setup_command(command)
-        self.storage_callbacks.setup_command(command)
+        self.setup_command(command)
+        return command.run(options, args)
+
+    def setup_command(self, command):
+        if command.ui == None:
+            command.ui = self
+        if self.io != None:
+            self.io.setup_command(command)
+        if self.storage_callbacks != None:
+            self.storage_callbacks.setup_command(command)        
         command.restrict_file_access = self.restrict_file_access
         command._get_user_id = self._get_user_id
-        return command.run(options, args)
 
     def _get_user_id(self):
         """Callback for use by commands that need it."""
-- 
cgit 


From 4d4283ecd654f1efb058cd7f7dba6be88b70ee92 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Fri, 1 Jan 2010 08:11:08 -0500
Subject: Updated copyright information

---
 libbe/command/base.py | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 2f0ccc6..6df04db 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -1,4 +1,18 @@
-# Copyright
+# Copyright (C) 2009-2010 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 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.
 
 import codecs
 import optparse
-- 
cgit 


From 0dd273f8605bc21589a51d3b046a231ff9df6fbb Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Mon, 1 Feb 2010 11:36:21 -0500
Subject: Fix command name output of `be --complete`.

By adding command_names option to libbe.command.commands.  Previous
versions of `be --complete` printed "import_xml", not "import-xml".

Also fixed libbe.command.base's doctests, so test.py can run them.
---
 libbe/command/base.py | 37 +++++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)

(limited to 'libbe/command/base.py')

diff --git a/libbe/command/base.py b/libbe/command/base.py
index 6df04db..6b1c050 100644
--- a/libbe/command/base.py
+++ b/libbe/command/base.py
@@ -72,10 +72,38 @@ def get_command_class(module=None, command_name=None):
         raise UnknownCommand(command_name)
     return cmd
 
-def commands():
+def modname_to_command_name(modname):
+    """Little hack to replicate
+    >>> import sys
+    >>> def real_modname_to_command_name(modname):
+    ...     mod = libbe.util.plugin.import_by_name(
+    ...         'libbe.command.%s' % modname)
+    ...     attrs = [getattr(mod, name) for name in dir(mod)]
+    ...     commands = []
+    ...     for attr_name in dir(mod):
+    ...         attr = getattr(mod, attr_name)
+    ...         try:
+    ...             if issubclass(attr, Command):
+    ...                 commands.append(attr)
+    ...         except TypeError, e:
+    ...             pass
+    ...     if len(commands) == 0:
+    ...         raise Exception('No Command classes in %s' % dir(mod))
+    ...     return commands[0].name
+    >>> real_modname_to_command_name('new')
+    'new'
+    >>> real_modname_to_command_name('import_xml')
+    'import-xml'
+    """
+    return modname.replace('_', '-')
+
+def commands(command_names=False):
     for modname in libbe.util.plugin.modnames('libbe.command'):
         if modname not in ['base', 'util']:
-            yield modname
+            if command_names == False:
+                yield modname
+            else:
+                yield modname_to_command_name(modname)
 
 class CommandInput (object):
     def __init__(self, name, help=''):
@@ -393,9 +421,10 @@ class StringInputOutput (InputOutput):
     >>> s.stdin.read()
     'hello'
     >>> s.stdin.read()
+    ''
     >>> print >> s.stdout, 'goodbye'
     >>> s.get_stdout()
-    'goodbye\n'
+    'goodbye\\n'
     >>> s.get_stdout()
     ''
 
@@ -406,7 +435,7 @@ class StringInputOutput (InputOutput):
     u'hello'
     >>> print >> s.stdout, u'goodbye'
     >>> s.get_stdout()
-    u'goodbye\n'
+    u'goodbye\\n'
     """
     def __init__(self):
         stdin = StringIO.StringIO()
-- 
cgit