aboutsummaryrefslogtreecommitdiffstats
path: root/becommands/tag.py
blob: e22cb70b2c5eba2a0817c3a7ee62708f1e3335bb (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# Copyright (C) 2009 Gianluca Montecchi <gian@grys.it>
#                    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.
"""Tag a bug, or search bugs for tags"""
from libbe import cmdutil, bugdir
import os, copy
__desc__ = __doc__

def execute(args, manipulate_encodings=True, restrict_file_access=False):
    """
    >>> from libbe import utility
    >>> bd = bugdir.SimpleBugDir()
    >>> bd.set_sync_with_disk(True)
    >>> os.chdir(bd.root)
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    []
    >>> execute(["a", "GUI"], manipulate_encodings=False)
    Tags for 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"], manipulate_encodings=False)
    Tags for a:
    GUI
    later
    >>> execute(["a"], manipulate_encodings=False)
    Tags for a:
    GUI
    later
    >>> execute(["--list"], manipulate_encodings=False)
    GUI
    later
    >>> execute(["a", "Alphabetically first"], manipulate_encodings=False)
    Tags for 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
    []
    >>> execute(["a"], manipulate_encodings=False)
    >>> bd._clear_bugs() # resync our copy of bug
    >>> a = bd.bug_from_shortname("a")
    >>> print a.extra_strings
    []
    >>> execute(["a", "Alphabetically first"], manipulate_encodings=False)
    Tags for a:
    Alphabetically first
    >>> execute(["--remove", "a", "Alphabetically first"], manipulate_encodings=False)
    >>> bd.cleanup()
    """
    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) == 0 and options.list == False:
        raise cmdutil.UsageError("Please specify a bug id.")
    elif len(args) > 2 or (len(args) > 0 and options.list == True):
        help()
        raise cmdutil.UsageError("Too many arguments.")
    
    bd = bugdir.BugDir(from_disk=True,
                       manipulate_encodings=manipulate_encodings)
    if options.list:
        bd.load_all_bugs()
        tags = []
        for bug in bd:
            for estr in bug.extra_strings:
                if estr.startswith("TAG:"):
                    tag = estr[4:]
                    if tag not in tags:
                        tags.append(tag)
        tags.sort()
        if len(tags) > 0:
            print '\n'.join(tags)
        return
    bug = cmdutil.bug_from_id(bd, args[0])
    if len(args) == 2:
        given_tag = args[1]
        estrs = bug.extra_strings
        tag_string = "TAG:%s" % given_tag
        if options.remove == True:
            estrs.remove(tag_string)
        else: # add the tag
            estrs.append(tag_string)
        bug.extra_strings = estrs # reassign to notice change

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

    if len(tags) > 0:
        print "Tags for %s:" % bug.uuid
        print '\n'.join(tags)

def get_parser():
    parser = cmdutil.CmdOptionParser("be tag BUG-ID [TAG]\nor:    be tag --list")
    parser.add_option("-r", "--remove", action="store_true", dest="remove",
                      help="Remove TAG (instead of adding it)")
    parser.add_option("-l", "--list", action="store_true", dest="list",
                      help="List all available tags and exit")
    return parser

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

To search for bugs with a particular tag, try
  $ be list --extra-strings TAG:<your-tag>
"""

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