-
Notifications
You must be signed in to change notification settings - Fork 0
/
link-tool.py
205 lines (165 loc) · 5.88 KB
/
link-tool.py
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
import glob
import os.path
class Link:
GLOSSARY = 1
HARDLINK = 2
NETLINK = 3
PERSONA = 4
def __init__(self, type, link):
self.type = type
self.link = link
def __str__(self):
type = 'glossary'
if self.type == Link.HARDLINK:
type = 'hardlink'
if self.type == Link.NETLINK:
type = 'netlink'
if self.type == Link.PERSONA:
type = 'persona'
return f'{type}: "{self.link}"'
@staticmethod
def make_glossary(link):
return Link(Link.GLOSSARY, link)
@staticmethod
def make_hardlink(link):
return Link(Link.HARDLINK, link)
@staticmethod
def make_netlink(link):
return Link(Link.NETLINK, link)
@staticmethod
def make_persona(link):
return Link(Link.PERSONA, link)
class Note:
def __init__(self, name: str):
self.name = name.strip()
self.links = []
self.write_issues = []
def add_link(self, link):
self.links.append(link)
def add_write_issue(self, issue):
self.write_issues.append(issue)
def check_instruction(instruction, line):
start = f'({instruction} '
if line.startswith(start) and line.endswith(')') and line != start + ')':
return line[len(start):-1]
return None
class NoteThread:
def __init__(self, path: str, name: str, group_path: list):
self.path = path
self.name = name.strip()
self.group_path = group_path
self.notes = []
def __str__(self):
return f'{{{self.name} in {"/".join(self.group_path)} notes {len(self.notes)}}}'
@staticmethod
def get(filepath):
if not os.path.isfile(filepath) or not filepath.endswith('.md'):
return None
dir, filename = os.path.split(filepath)
name = filename[:-3]
groups = []
while dir:
dir, group = os.path.split(dir)
groups.append(group)
groups.reverse()
thread = NoteThread(path=filepath, name=name, group_path=groups)
note = None
with open(filepath) as f:
for line in f:
line = line.strip()
if line.startswith('# '):
continue
if line.startswith('## ') and note is not None:
thread.notes.append(note)
if line.startswith('## '):
note = Note(line[3:])
if note is None:
continue
for link_type in ('glossary', 'hardlink', 'netlink', 'persona'):
link = check_instruction(link_type, line)
if link:
f = getattr(Link, f'make_{link_type}')
note.add_link(f(link))
break
write = check_instruction('write', line)
if write:
note.add_write_issue(write)
if note is not None:
thread.notes.append(note)
return thread
def print_links(self):
for note in self.notes:
print(note.name)
for link in note.links:
print(' *', link)
class GlossaryItem:
def __init__(self, name):
self.references = 0
self.name = name
class Glossary:
def __init__(self):
self.topics = dict()
def add_topic(self, name):
if name in self.topics:
print(f'topic ambiguos {name}')
else:
self.topics[name] = []
item = GlossaryItem(name)
self.topics[name].append(item)
def init(self):
for file in glob.glob('glossary/**/*.md', recursive=True):
note_thread = NoteThread.get(file)
self.add_topic(note_thread.name)
for note in note_thread.notes:
self.add_topic(note.name)
class NoteManager:
def __init__(self):
self.dictionary = dict()
def add_note(self, path, note):
self.dictionary[os.path.join(path, note.name)] = note
def add_note_thread(self, note_thread):
self.dictionary[note_thread.path] = note_thread
for note in note_thread.notes:
self.add_note(note_thread.path, note)
if __name__ == '__main__':
glossary = Glossary()
glossary.init()
missed_links = []
write_issues = []
note_manager = NoteManager()
personas = []
note_threads = [NoteThread.get(file) for file in glob.glob('**/*.md', recursive=True)]
for note_thread in note_threads:
note_manager.add_note_thread(note_thread)
for note_thread in note_threads:
for note in note_thread.notes:
for link in note.links:
if link.type == Link.NETLINK:
continue
if link.type == Link.HARDLINK:
if link.link not in note_manager.dictionary:
missed_links.append(link)
elif link.type == Link.PERSONA:
personas.append(link)
elif link.type != Link.GLOSSARY or link.link not in glossary.topics:
missed_links.append(link)
for write_issue in note.write_issues:
if ' ' in write_issue:
write_issue = f'"{write_issue}"'
write_issues.append('/'.join((*note_thread.group_path, note_thread.name, note.name, write_issue)))
if missed_links:
print(f'Found {len(missed_links)} missed links')
for link in missed_links:
print(' *', link)
if glossary.topics:
print(f'Found {len(glossary.topics)} topics')
for topic in glossary.topics.keys():
print(' *', topic)
if write_issues:
print(f'Found {len(write_issues)} write issues')
for issue in write_issues:
print(' *', issue)
if personas:
print(f'Found {len(personas)} personas')
for persona in personas:
print(' *', persona)