aboutsummaryrefslogtreecommitdiffstats
path: root/becommands/tag.py
blob: 0b19e91ed68ed128defa5aac1e7dcf277f216623 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# Copyright (C) 2005 Aaron Bentley and Panometrics, Inc.
# <abentley@panoramicfeedback.com>
#
#    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
"""Tag a bug, or search bugs for tags."""
from libbe import cmdutil, bugdir
import os, copy
__desc__ = __doc__

def execute(args, test=False):
    """
    >>> from libbe import utility
    >>> bd = bugdir.simple_bug_dir()
    >>> os.chdir(bd.root)
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    []
    >>> execute(["a", "GUI"], test=True)
    Tagging bug a:
    GUI
    >>> bd._clear_bugs() # resync our copy of bug
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    ['TAG:GUI']
    >>> execute(["a", "later"], test=True)
    Tagging bug a:
    GUI
    later
    >>> execute(["a"], test=True)
    Tags for a:
    GUI
    later
    >>> execute(["a", "Alphabetically first"], test=True)
    Tagging bug a:
    Alphabetically first
    GUI
    later
    >>> bd._clear_bugs() # resync our copy of bug
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    ['TAG:Alphabetically first', 'TAG:GUI', 'TAG:later']
    >>> a.extra_strings = []
    >>> print a.extra_strings
    []
    >>> a.save()
    >>> execute(["a"], test=True)
    Tags for a:
    >>> bd._clear_bugs() # resync our copy of bug
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    []
    """
    parser = get_parser()
    options, args = parser.parse_args(args)
    cmdutil.default_complete(options, args, parser,
                             bugid_args={0: lambda bug : bug.active==True})

    if len(args) < 1:
        raise cmdutil.UsageError("Please specify a bug id.")
    if len(args) > 2:
        help()
        raise cmdutil.UsageError("Too many arguments.")
    
    bd = bugdir.BugDir(from_disk=True, manipulate_encodings=not test)
    bug = bd.bug_from_shortname(args[0])

    new_tag = None
    if len(args) == 2:
        given_tag = args[1]
        # reassign list so the change_hook realizes we've altered it.
        tags = bug.extra_strings
        tag_string = "TAG:%s" % given_tag
        if options.remove == True:
            tags.remove(tag_string)
        else: # add the tag
            new_tag = given_tag
            tags.append(tag_string)
        bug.extra_strings = tags

    tags = []
    for estr in bug.extra_strings:
        if estr.startswith("TAG:"):
            tags.append(estr[4:])

    bd.save()

    if new_tag == None:
        print "Tags for %s:" % bug.uuid
    else:
        print "Tagging bug %s:" % bug.uuid
    for tag in tags:
        print tag

def get_parser():
    parser = cmdutil.CmdOptionParser("be tag BUG-ID [TAG]")
    parser.add_option("-r", "--remove", action="store_true", dest="remove",
                      help="Remove TAG (instead of adding it)")
    return parser

longhelp="""
If TAG is given, add TAG to BUG-ID.  If it is not specified, just
print the tags for BUG-ID.
"""

def help():
    return get_parser().help_str() + longhelp