Update ss13_genchangelog.py

Author: ToasterBiome

tools/ss13_genchangelog.py

@@ -1,6 +1,6 @@
 '''
 Usage:
-    $ python ss13_genchangelog.py [--dry-run] html/changelog.html html/changelogs/
+    $ python ss13_genchangelog.py html/changelogs/
 
 ss13_genchangelog.py - Generate changelog from YAML.
 
@@ -32,31 +32,29 @@
 
 today = date.today()
 
-dateformat = "%d %B %Y"
+fileDateFormat = "%Y-%m"
 
 opt = argparse.ArgumentParser()
-opt.add_argument('-d', '--dry-run', dest='dryRun', default=False, action='store_true', help='Only parse changelogs and, if needed, the targetFile. (A .dry_changelog.yml will be output for debugging purposes.)')
-opt.add_argument('-t', '--time-period', dest='timePeriod', default=13, type=int, help='Define how many weeks back the changelog should display')
-opt.add_argument('targetFile', help='The HTML changelog we wish to update.')
 opt.add_argument('ymlDir', help='The directory of YAML changelogs we will use.')
 
 args = opt.parse_args()
+archiveDir = os.path.join(args.ymlDir, 'archive')
 
 all_changelog_entries = {}
 
+# Do not change the order, add to the bottom of the array if necessary
 validPrefixes = [
     'bugfix',
     'wip',
-    'tweak',
+    'qol',
     'soundadd',
     'sounddel',
-    'rscdel',
     'rscadd',
+    'rscdel',
     'imageadd',
     'imagedel',
     'spellcheck',
     'experiment',
-    'tgs',
     'balance',
     'code_imp',
     'refactor',
@@ -68,87 +66,61 @@
 def dictToTuples(inp):
     return [(k, v) for k, v in inp.items()]
 
-changelog_cache = os.path.join(args.ymlDir, '.all_changelog.yml')
+old_changelog_cache = os.path.join(args.ymlDir, '.all_changelog.yml')
 
-failed_cache_read = True
-if os.path.isfile(changelog_cache):
+if os.path.isfile(old_changelog_cache):
     try:
-        with open(changelog_cache,encoding='utf-8') as f:
+        print('Reading old changelog cache...')
+        data = {}
+        with open(old_changelog_cache,encoding='utf-8') as f:
             (_, all_changelog_entries) = yaml.load_all(f, Loader=yaml.SafeLoader)
-            failed_cache_read = False
 
-            # Convert old timestamps to newer format.
-            new_entries = {}
+            # Categorize changes by year and month
             for _date in all_changelog_entries.keys():
                 ty = type(_date).__name__
-                # print(ty)
-                if ty in ['str', 'unicode']:
-                    temp_data = all_changelog_entries[_date]
-                    _date = datetime.strptime(_date, dateformat).date()
-                    new_entries[_date] = temp_data
-                else:
-                    new_entries[_date] = all_changelog_entries[_date]
-            all_changelog_entries = new_entries
+                formattedDate = _date.strftime(fileDateFormat)
+                if not formattedDate in data:
+                    data[formattedDate] = {}
+                data[formattedDate][_date] = all_changelog_entries[_date]
+            # Write files with changes by year and month
+            for month in data.keys():
+                print("Writing " + month + ".yml...")
+                if not os.path.exists(archiveDir):
+                    os.makedirs(archiveDir)
+                currentFile = os.path.join(archiveDir, month + '.yml')
+                with open(currentFile, 'w', encoding='utf-8') as f:
+                    yaml.dump(data[month], f, default_flow_style=False)
+        # Remove the old changelog cache, as we won't use it anymore
+        print("Removing old changelog cache...")
+        os.remove(old_changelog_cache)
+        old_changelog_html = os.path.join(args.ymlDir, '..', 'changelog.html')
+        if os.path.isfile(old_changelog_html):
+            print("Removing old changelog html...")
+            os.remove(old_changelog_html)
     except Exception as e:
-        print("Failed to read cache:")
+        print("Failed to read old changelog cache:")
         print(e, file=sys.stderr)
 
-if args.dryRun:
-    changelog_cache = os.path.join(args.ymlDir, '.dry_changelog.yml')
-
-if failed_cache_read and os.path.isfile(args.targetFile):
-    from bs4 import BeautifulSoup
-    from bs4.element import NavigableString
-    print(' Generating cache...')
-    with open(args.targetFile, 'r', encoding='utf-8') as f:
-        soup = BeautifulSoup(f)
-        for e in soup.find_all('div', {'class':'commit'}):
-            entry = {}
-            date = datetime.strptime(e.h2.string.strip(), dateformat).date()  # key
-            for authorT in e.find_all('h3', {'class':'author'}):
-                author = authorT.string
-                # Strip suffix
-                if author.endswith('updated:'):
-                    author = author[:-8]
-                author = author.strip()
-
-                # Find <ul>
-                ulT = authorT.next_sibling
-                while(ulT.name != 'ul'):
-                    ulT = ulT.next_sibling
-                changes = []
-
-                for changeT in ulT.children:
-                    if changeT.name != 'li': continue
-                    val = changeT.decode_contents(formatter="html")
-                    newdat = {changeT['class'][0] + '': val + ''}
-                    if newdat not in changes:
-                        changes += [newdat]
-
-                if len(changes) > 0:
-
-                    entry[author] = changes
-            if date in all_changelog_entries:
-                all_changelog_entries[date].update(entry)
-            else:
-                all_changelog_entries[date] = entry
-
-del_after = []
 print('Reading changelogs...')
 for fileName in glob.glob(os.path.join(args.ymlDir, "*.yml")):
     name, ext = os.path.splitext(os.path.basename(fileName))
     if name.startswith('.'): continue
     if name == 'example': continue
     fileName = os.path.abspath(fileName)
+    formattedDate = today.strftime(fileDateFormat)
+    monthFile = os.path.join(archiveDir, formattedDate + '.yml')
     print(' Reading {}...'.format(fileName))
     cl = {}
     with open(fileName, 'r',encoding='utf-8') as f:
         cl = yaml.load(f, Loader=yaml.SafeLoader)
-        f.close()
-    if today not in all_changelog_entries:
-        all_changelog_entries[today] = {}
-    author_entries = all_changelog_entries[today].get(cl['author'], [])
-    if cl['changes']:
+    currentEntries = {}
+    if os.path.exists(monthFile):
+        with open(monthFile,'r',encoding='utf-8') as f:
+            currentEntries = yaml.load(f, Loader=yaml.SafeLoader)
+    if today not in currentEntries:
+        currentEntries[today] = {}
+    author_entries = currentEntries[today].get(cl['author'], [])
+    if len(cl['changes']):
         new = 0
         for change in cl['changes']:
             if change not in author_entries:
@@ -157,65 +129,14 @@ def dictToTuples(inp):
                     print('  {0}: Invalid prefix {1}'.format(fileName, change_type), file=sys.stderr)
                 author_entries += [change]
                 new += 1
-        all_changelog_entries[today][cl['author']] = author_entries
+        currentEntries[today][cl['author']] = author_entries
         if new > 0:
             print('  Added {0} new changelog entries.'.format(new))
 
     if cl.get('delete-after', False):
         if os.path.isfile(fileName):
-            if args.dryRun:
-                print('  Would delete {0} (delete-after set)...'.format(fileName))
-            else:
-                del_after += [fileName]
-
-    if args.dryRun: continue
-
-    cl['changes'] = []
-    with open(fileName, 'w', encoding='utf-8') as f:
-        yaml.dump(cl, f, default_flow_style=False)
-
-targetDir = os.path.dirname(args.targetFile)
-
-with open(args.targetFile.replace('.htm', '.dry.htm') if args.dryRun else args.targetFile, 'w', encoding='utf-8') as changelog:
-    with open(os.path.join(targetDir, 'templates', 'header.html'), 'r', encoding='utf-8') as h:
-        for line in h:
-            changelog.write(line)
-
-    weekstoshow = timedelta(weeks=args.timePeriod)
-    for _date in reversed(sorted(all_changelog_entries.keys())):
-        if not (today - _date < weekstoshow):
-            continue
-        entry_htm = '\n'
-        entry_htm += '\t\t\t<h2 class="date">{date}</h2>\n'.format(date=_date.strftime(dateformat))
-        write_entry = False
-        for author in sorted(all_changelog_entries[_date].keys()):
-            if not all_changelog_entries[_date]: continue
-            author_htm = '\t\t\t<h3 class="author">{author} updated:</h3>\n'.format(author=author)
-            author_htm += '\t\t\t<ul class="changes bgimages16">\n'
-            changes_added = []
-            for (css_class, change) in (dictToTuples(e)[0] for e in all_changelog_entries[_date][author]):
-                if change in changes_added: continue
-                write_entry = True
-                changes_added += [change]
-                author_htm += '\t\t\t\t<li class="{css_class}">{change}</li>\n'.format(css_class=css_class, change=change.strip())
-            author_htm += '\t\t\t</ul>\n'
-            if changes_added:
-                entry_htm += author_htm
-        if write_entry:
-            changelog.write(entry_htm)
-
-    with open(os.path.join(targetDir, 'templates', 'footer.html'), 'r', encoding='utf-8') as h:
-        for line in h:
-            changelog.write(line)
-
-
-with open(changelog_cache, 'w') as f:
-    cache_head = 'DO NOT EDIT THIS FILE BY HAND!  AUTOMATICALLY GENERATED BY ss13_genchangelog.py.'
-    yaml.dump_all([cache_head, all_changelog_entries], f, default_flow_style=False)
-
-if del_after:
-    print('Cleaning up...')
-    for fileName in del_after:
-        if os.path.isfile(fileName):
-            print(' Deleting {0} (delete-after set)...'.format(fileName))
+            print('  Deleting {0} (delete-after set)...'.format(fileName))
             os.remove(fileName)
+
+    with open(monthFile, 'w', encoding='utf-8') as f:
+        yaml.dump(currentEntries, f, default_flow_style=False)