File: converter.py

package info (click to toggle)
taskcoach 1.4.1-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 32,496 kB
  • ctags: 17,810
  • sloc: python: 72,170; makefile: 254; ansic: 120; xml: 29; sh: 16
file content (215 lines) | stat: -rw-r--r-- 8,297 bytes parent folder | download
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
'''
Task Coach - Your friendly task manager
Copyright (C) 2004-2014 Task Coach developers <developers@taskcoach.org>

Task Coach 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 3 of the License, or
(at your option) any later version.

Task Coach 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, see <http://www.gnu.org/licenses/>.
'''

import textwrap, changetypes, re


# Change (bugs fixed, features added, etc.) converters:

class ChangeConverter(object):
    def convert(self, change):
        result = self.preProcess(change.description)
        if hasattr(change, 'url'):
            result += ' (%s)'%self.convertURL(change.url)
        if change.changeIds:
            convertedIds = self.convertChangeIds(change)
            result += ' (%s)'%', '.join(convertedIds)
        return self.postProcess(result)
    
    def preProcess(self, changeToBeConverted):
        return changeToBeConverted

    def postProcess(self, convertedChange):
        return convertedChange

    def convertChangeIds(self, change):
        return [self.convertChangeId(change, id) for id in change.changeIds]

    def convertChangeId(self, change, changeId):
        return changeId

    def convertURL(self, url):
        return url
    

class ChangeToTextConverter(ChangeConverter):
    def __init__(self):
        self._textWrapper = textwrap.TextWrapper(initial_indent='- ', 
                subsequent_indent='  ', width=78)
        # Regular expression to remove multiple spaces, except when on
        # the start of a line:
        self._multipleSpaces = re.compile(r'(?<!^) +', re.M)
        self._initialSpaces = re.compile(r'^( *)(.*)$')

    def postProcess(self, convertedChange):
        convertedChange = self._textWrapper.fill(convertedChange)
        # Somehow the text wrapper introduces multiple spaces within
        # lines, this is a workaround (preserving the initial spaces):

        lines = []

        for line in convertedChange.split('\n'):
            match = self._initialSpaces.match(line)
            lines.append(match.group(1) + self._multipleSpaces.sub(' ', match.group(2)))

        return '\n'.join(lines)

    def convertChangeId(self, change, changeId):
        return changeId if changeId.startswith('http') else 'SF#%s'%changeId


class ChangeToDebianConverter(ChangeToTextConverter):
    def __init__(self):
        super(ChangeToDebianConverter, self).__init__()
        self._textWrapper = textwrap.TextWrapper(initial_indent='  * ', 
                subsequent_indent='    ', width=78)

    def postProcess(self, convertedChange):
        return super(ChangeToDebianConverter, self).postProcess(convertedChange) + '\n'


class ChangeToHTMLConverter(ChangeConverter):

    LinkToSourceForge = '<a href="https://sourceforge.net/tracker/index.php?func=detail&aid=%%(id)s&group_id=130831&atid=%(atid)s">%%(id)s</a>'
    LinkToSourceForgeBugReport = LinkToSourceForge%{'atid': '719134'}
    LinkToSourceForgeBugReportv2 = '<a href="https://sourceforge.net/p/taskcoach/bugs/%(id)s/">%(id)s</a>'
    LinkToSourceForgeFeatureRequest = LinkToSourceForge%{'atid': '719137'}
    NoConversion = '%(id)s'

    def preProcess(self, changeToBeConverted):
        changeToBeConverted = re.sub('<', '&lt;', changeToBeConverted)
        changeToBeConverted = re.sub('>', '&gt;', changeToBeConverted)
        return changeToBeConverted
    
    def postProcess(self, convertedChange):
        listOfUrlAndTextFragments = re.split('(http://[^\s()]+[^\s().])', convertedChange)
        listOfConvertedUrlsAndTextFragments = []
        for fragment in listOfUrlAndTextFragments:
            if fragment.startswith('http://'):
                fragment = self.convertURL(fragment)
            listOfConvertedUrlsAndTextFragments.append(fragment)
        convertedChange = ''.join(listOfConvertedUrlsAndTextFragments)
        return '<li>%s</li>'%convertedChange

    def convertChangeId(self, change, changeId):
        template = self.NoConversion # URL's will be converted in postProcess()
        if not changeId.startswith('http'):
            if isinstance(change, changetypes.Bugv2):
                template = self.LinkToSourceForgeBugReportv2
            elif isinstance(change, changetypes.Bug):
                template = self.LinkToSourceForgeBugReport    
            elif isinstance(change, changetypes.Feature):
                template = self.LinkToSourceForgeFeatureRequest
        return template%{'id': changeId}

    def convertURL(self, url):
        return '<a href="%s">%s</a>'%(url, url)


# Release converters:

class ReleaseConverter(object):
    def __init__(self):
        self._changeConverter = self.ChangeConverterClass()

    def _addS(self, listToCount):
        multiple = len(listToCount) > 1
        return dict(s='s' if multiple else '',
                    y='ies' if multiple else 'y')

    def convert(self, release, greeting=''):
        result = [self.summary(release, greeting)]
        if not greeting:
            result.insert(0, self.header(release))
        for section, list in [('Team change%(s)s', release.teamChanges),
                ('Bug%(s)s fixed', release.bugsFixed),
                ('Feature%(s)s added', release.featuresAdded),
                ('Feature%(s)s changed', release.featuresChanged),
                ('Feature%(s)s removed', release.featuresRemoved),
                ('Implementation%(s)s changed', release.implementationChanged),
                ('Dependenc%(y)s changed', release.dependenciesChanged),
                ('Distribution%(s)s changed', release.distributionsChanged),
                ('Website change%(s)s', release.websiteChanges)]:
            if list:
                result.append(self.sectionHeader(section, list))
                for change in list:
                    result.append(self._changeConverter.convert(change))
                result.append(self.sectionFooter(section, list))
        result = [line for line in result if line]
        return '\n'.join(result)+'\n\n'

    def header(self, release):
        return 'Release %s - %s'%(release.number, release.date)

    def summary(self, release, greeting=''):
        return ' '.join([text for text in greeting, release.summary if text])
    
    def sectionHeader(self, section, list):
        return '\n%s:'%(section%self._addS(list))
        
    def sectionFooter(self, section, list):
        return ''


class ReleaseToTextConverter(ReleaseConverter):
    ChangeConverterClass = ChangeToTextConverter

    def summary(self, *args, **kwargs):
        summary = super(ReleaseToTextConverter, self).summary(*args, **kwargs)
        wrapper = textwrap.TextWrapper(initial_indent='', 
            subsequent_indent='', width=78)
        multipleSpaces = re.compile(r'(?<!^) +', re.M)
        summary = wrapper.fill(summary)
        # Somehow the text wrapper introduces multiple spaces within
        # lines, this is a workaround:
        summary = multipleSpaces.sub(' ', summary)
        return summary


class ReleaseToDebianConverter(ReleaseConverter):
    ChangeConverterClass = ChangeToDebianConverter

    def summary(self, *args, **kwargs):
        return ''

    def header(self, release):
        return ''

    def sectionHeader(self, section, list):
        return ''


class ReleaseToHTMLConverter(ReleaseConverter):
    ChangeConverterClass = ChangeToHTMLConverter

    def header(self, release):
        return '<h2>Release %s <small>%s</small></h2>'%(release.number, release.date)

    def sectionHeader(self, section, list):
        return super(ReleaseToHTMLConverter, self).sectionHeader(section, 
            list) + '\n<ul>'

    def sectionFooter(self, section, list):
        return '</ul>'

    def summary(self, release, greeting=''):
        summaryText = super(ReleaseToHTMLConverter, self).summary(release)
        if summaryText:
            return '<p>%s</p>'%summaryText
        else:
            return ''