Project

General

Profile

1
#!/usr/bin/env python
2
# Translates a data dictionary spreadsheet to Redmine formatting
3

    
4
import csv
5
import re
6
import sys
7

    
8
# Spreadsheet format
9
source_sep = ', '
10

    
11
##### URLs
12

    
13
url_comment_re = r'(?:\([^)]*\))'
14

    
15
def simplify_url(url): return re.sub(r'\(.*?\)', r'', url)
16

    
17
def url_comment_text(comment):
18
    if not comment: return comment
19
    
20
    match = re.match(r'^\(\d*:?(.*?)\)$', comment)
21
    assert match
22
    text, = match.groups()
23
    return text
24

    
25
def url_term(url):
26
    '''Prefixes any provider in the URL to the term name, to create a namespace.
27
    Each hierarchical component of the provider is stored in a URL comment.
28
    '''
29
    match = re.match(r'^('+url_comment_re+r'*).*?([\w:-]+)$', url)
30
    assert match
31
    provider_str, term = match.groups()
32
    provider = filter(bool, map(url_comment_text,
33
        re.findall(url_comment_re, provider_str)))
34
    
35
    return ':'.join(provider+[term])
36

    
37
##### Redmine
38

    
39
sp = ' ' # Unicode thin space
40

    
41
def redmine_bold(text): return '*'+text+'*'
42

    
43
def redmine_pad(text): return sp+text+sp
44

    
45
def redmine_url(text, url):
46
    if not url: return text
47
    elif url.find('://') >= 0: return '"'+text+'":'+url # external link
48
    else: return '[['+url+'|'+text+']]' # internal link
49

    
50
def source2redmine_url(url):
51
    if url: return redmine_url(url_term(url), simplify_url(url))
52
    else: return ''
53

    
54
def redmine_add_links(page_name, text):
55
    # Link citations to entry in sources list
56
    text = re.sub(r'(?<=\[)(.*?)(?=\])',
57
        redmine_pad(redmine_bold(redmine_url('\g<0>', page_name+r'#\g<0>'))),
58
        text) # redmine_pad() avoids [[[, which Redmine would parse incorrectly
59
    return text
60

    
61
class RedmineTableWriter:
62
    '''Formats rows as a Redmine table'''
63
    
64
    def __init__(self, stream):
65
        self.stream = stream
66
    
67
    def writerow(self, row):
68
        self.stream.write(('|'.join(['']+row+['']))+'\n')
69

    
70
class RedmineDictWriter:
71
    '''Formats rows as Redmine sections containing a table'''
72
    
73
    def __init__(self, term_col, def_col, header, stream):
74
        self.term_col = term_col
75
        self.def_col = def_col
76
        self.header = header
77
        self.page_name = header[term_col]
78
        self.stream = stream
79
    
80
    def writerow(self, row):
81
        row = map(lambda f: redmine_add_links(self.page_name, f), row)
82
        
83
        term = row[self.term_col]
84
        def_ = row[self.def_col]
85
        self.stream.write('h3. '+term+'\n\n')
86
        if def_: self.stream.write(def_+'\n\n')
87
        
88
        table = RedmineTableWriter(self.stream)
89
        for i, col_name in enumerate(self.header):
90
            if not i in set([self.term_col, self.def_col]):
91
                value = row[i]
92
                if value: table.writerow([redmine_bold(col_name), value])
93
        self.stream.write('\n')
94

    
95

    
96
def main():
97
    try: _prog_name, term_col, def_col, sources_col = sys.argv
98
    except ValueError: raise SystemExit('Usage: '+sys.argv[0]
99
        +' <spreadsheet term_col# definition_col# sources_col# >redmine')
100
    term_col, def_col, sources_col = map(int, [term_col, def_col, sources_col])
101
    
102
    # Translate input
103
    reader = csv.reader(sys.stdin)
104
    header = reader.next()
105
    writer = RedmineDictWriter(term_col, def_col, header, sys.stdout)
106
    for row in reader:
107
        term = row[term_col]
108
        sources = row[sources_col].split(source_sep)
109
        
110
        row[term_col] = redmine_url(term, simplify_url(sources[0]))
111
        row[sources_col] = source_sep.join(map(source2redmine_url, sources))
112
        
113
        writer.writerow(row)
114

    
115
main()
(13-13/69)