synchronization of developers in entries with developers list

code/maintenance_inspirations.py

@@ -0,0 +1,121 @@
+"""
+Maintenance of inspirations.md and synchronization with the inspirations in the entries.
+"""
+
+from utils import osg, osg_ui
+
+valid_duplicates = ('Age of Empires', 'ARMA', 'Catacomb', 'Civilization', 'Company of Heroes', 'Descent', 'Duke Nukem', 'Dungeon Keeper',
+                    'Final Fantasy', 'Heroes of Might and Magic', 'Jazz Jackrabbit', 'Marathon', 'Master of Orion', 'Quake',
+                    'RollerCoaster Tycoon', 'Star Wars Jedi Knight', 'The Settlers', 'Ultima', 'Ship Simulator')
+
+class InspirationMaintainer:
+
+    def __init__(self):
+        self.inspirations = None
+        self.entries = None
+
+    def read_inspirations(self):
+        self.inspirations = osg.read_inspirations()
+        print('{} inspirations read'.format(len(self.inspirations)))
+
+    def write_inspirations(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        osg.write_inspirations(self.inspirations)
+        print('inspirations written')
+
+    def check_for_duplicates(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        inspiration_names = list(self.inspirations.keys())
+        for index, name in enumerate(inspiration_names):
+            for other_name in inspiration_names[index + 1:]:
+                if any((name.startswith(x) and other_name.startswith(x) for x in valid_duplicates)):
+                    continue
+                if osg.name_similarity(name, other_name) > 0.8:
+                    print(' {} - {} is similar'.format(name, other_name))
+        print('duplicates checked')
+
+    def check_for_orphans(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        for inspiration in self.inspirations.values():
+            if not inspiration['Inspired entries']:
+                print(' {} has no inspired entries'.format(inspiration['Name']))
+        print('orphanes checked')
+
+    def check_for_missing_inspirations_in_entries(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        if not self.entries:
+            print('entries not yet loaded')
+            return
+        for inspiration in self.inspirations.values():
+            inspiration_name = inspiration['Name']
+            for entry_name in inspiration['Inspired entries']:
+                x = [x for x in self.entries if x['Title'] == entry_name]
+                assert len(x) <= 1
+                if not x:
+                    print('Entry "{}" listed in inspiration "{}" but this entry does not exist'.format(entry_name, inspiration_name))
+                else:
+                    entry = x[0]
+                    if 'Inspirations' not in entry or inspiration_name not in entry['Inspirations']:
+                        print('Entry "{}" listed in inspiration "{}" but not listed in this entry'.format(entry_name, inspiration_name))
+        print('missed inspirations checked')
+
+    def check_for_wikipedia_links(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        for inspiration in self.inspirations.values():
+            if 'Media' in inspiration and any(('https://en.wikipedia.org/wiki/' in x for x in inspiration['Media'])):
+                continue
+            # search in wikipedia
+
+    def update_inspired_entries(self):
+        if not self.inspirations:
+            print('inspirations not yet loaded')
+            return
+        if not self.entries:
+            print('entries not yet loaded')
+            return
+        # loop over all inspirations and delete inspired entries
+        for inspiration in self.inspirations.values():
+            inspiration['Inspired entries'] = []
+        # loop over all entries and add to inspirations of entry
+        for entry in self.entries:
+            entry_name = entry['Title']
+            for inspiration in entry.get('Inspirations', []):
+                if inspiration in self.inspirations:
+                    self.inspirations[inspiration]['Inspired entries'].append(entry_name)
+                else:
+                    self.inspirations[inspiration] = {'Name': inspiration, 'Inspired entries': [entry_name]}
+        print('inspired entries updated')
+
+    def read_entries(self):
+        self.entries = osg.read_entries()
+        print('{} entries read'.format(len(self.entries)))
+
+
+if __name__ == "__main__":
+
+    m = InspirationMaintainer()
+
+    actions = {
+        'Read inspirations': m.read_inspirations,
+        'Write inspirations': m.write_inspirations,
+        'Check for duplicates': m.check_for_duplicates,
+        'Check for orphans': m.check_for_orphans,
+        'Check for inspirations not listed': m.check_for_missing_inspirations_in_entries,
+        'Update inspirations from entries': m.update_inspired_entries,
+        'Read entries': m.read_entries
+    }
+
+    osg_ui.run_simple_button_app('Maintenance inspirations', actions)
+
+
+