Merge pull request #16 from Progmasoft/chore/remove-upstream-leftovers

Remove what Catch2's maintainers left that is not ours

7 files changed, 11 insertions, 244 deletions

diff --git a/tools/scripts/developBuild.py b/tools/scripts/developBuild.py
deleted file mode 100755
index 8837770c..00000000
--- a/tools/scripts/developBuild.py
+++ /dev/null
@@ -1,9 +0,0 @@
-#!/usr/bin/env python3
-
-import releaseCommon
-
-v = releaseCommon.Version()
-v.incrementBuildNumber()
-releaseCommon.performUpdates(v)
-
-print( "Updated files to v{0}".format( v.getVersionString() ) )
diff --git a/tools/scripts/extractFeaturesFromReleaseNotes.py b/tools/scripts/extractFeaturesFromReleaseNotes.py
deleted file mode 100644
index d8be0437..00000000
--- a/tools/scripts/extractFeaturesFromReleaseNotes.py
+++ /dev/null
@@ -1,92 +0,0 @@
-#!/usr/bin/env python3
-
-#
-# extractFeaturesFromReleaseNotes.py
-#
-# Read the release notes - docs/release-notes.md - and generate text
-# for pasting in to individual documentation pages, to indicate which
-# versions recent features were released in.
-#
-# Using the output of the file is easier than manually constructing
-# the text to paste in to documentation pages.
-#
-# One way to use this:
-# - run this script, saving the output to some temporary file
-# - diff this output with the actual release notes page
-# - the differences are Markdown text that can be pasted in to the
-#   appropriate documentation pages in the docs/ directory.
-# - each release also has a github link to show which documentation files
-#   were changed in it.
-#   This can be helpful to see which documentation pages
-#   to add the 'Introduced in Catch ...' snippets to the relevant pages.
-#
-
-import re
-
-
-def create_introduced_in_text(version, bug_number = None):
-    """Generate text to paste in to documentation file"""
-    if bug_number:
-        return '> [Introduced](https://github.com/catchorg/Catch2/issues/%s) in Catch %s.' % (bug_number, version)
-    else:
-        # Use this text for changes that don't have issue numbers
-        return '> Introduced in Catch %s.' % version
-
-
-def link_to_changes_in_release(release, releases):
-    """
-    Markdown text for a hyperlink showing all edits in a release, or empty string
-
-    :param release: A release version, as a string 
-    :param releases: A container of releases, in descending order - newest to oldest
-    :return: Markdown text for a hyperlink showing the differences between the give release and the prior one,
-             or empty string, if the previous release is not known
-    """
-
-    if release == releases[-1]:
-        # This is the earliest release we know about
-        return ''
-    index = releases.index(release)
-    previous_release = releases[index + 1]
-    return '\n[Changes in %s](https://github.com/catchorg/Catch2/compare/v%s...v%s)' % (release, previous_release, release)
-
-
-def write_recent_release_notes_with_introduced_text():
-    current_version = None
-    release_toc_regex = r'\[(\d.\d.\d)\]\(#\d+\)<br>'
-    issue_number_regex = r'#[0-9]+'
-    releases = []
-    with open('../docs/release-notes.md') as release_notes:
-        for line in release_notes:
-            line = line[:-1]
-            print(line)
-
-            # Extract version number from table of contents
-            match = re.search(release_toc_regex, line)
-            if match:
-                release_name = match.group(1)
-                releases.append(release_name)
-
-            if line.startswith('## '):
-                # It's a section with version number
-                current_version = line.replace('## ', '')
-
-                # We decided not to add released-date info for older versions
-                if current_version == 'Older versions':
-                    break
-
-                print(create_introduced_in_text(current_version))
-                print(link_to_changes_in_release(current_version, releases))
-
-            # Not yet found a version number, so to avoid picking up hyperlinks to
-            # version numbers in the index, keep going
-            if not current_version:
-                continue
-
-            for bug_link in re.findall(issue_number_regex, line):
-                bug_number = bug_link.replace('#', '')
-                print(create_introduced_in_text(current_version, bug_number))
-
-
-if __name__ == '__main__':
-    write_recent_release_notes_with_introduced_text()
diff --git a/tools/scripts/generateAmalgamatedFiles.py b/tools/scripts/generateAmalgamatedFiles.py
index 5fed3358..2d40bcb4 100755
--- a/tools/scripts/generateAmalgamatedFiles.py
+++ b/tools/scripts/generateAmalgamatedFiles.py
@@ -39,7 +39,7 @@ file_header = '''\
 
 // SPDX-License-Identifier: BSL-1.0
 
-//  Catch v{version_string}
+//  Catch3 v{catch3_version}, on the Catch2 v{version_string} engine
 //  Generated: {generation_time}
 //  ----------------------------------------------------------
 //  This file is an amalgamation of multiple different files.
@@ -54,8 +54,17 @@ file_header = '''\
 # REUSE-IgnoreEnd
 
 # Returns file header with proper version string and generation time
+def catch3_version():
+    version_file = os.path.join(root_path, 'Progmasoft', 'Catch3', 'Version.hpp')
+    with open(version_file, mode='r', encoding='utf-8') as input:
+        match = re.search(r'kVersion = "([^"]+)"', input.read())
+    if not match:
+        raise RuntimeError('no kVersion in ' + version_file)
+    return match.group(1)
+
 def formatted_file_header(version):
     return file_header.format(version_string=version.getVersionString(),
+                              catch3_version=catch3_version(),
                               generation_time=datetime.datetime.now())
 
 # Which headers were already concatenated (and thus should not be
diff --git a/tools/scripts/majorRelease.py b/tools/scripts/majorRelease.py
deleted file mode 100755
index eb712b46..00000000
--- a/tools/scripts/majorRelease.py
+++ /dev/null
@@ -1,9 +0,0 @@
-#!/usr/bin/env python3
-
-import releaseCommon
-
-v = releaseCommon.Version()
-v.incrementMajorVersion()
-releaseCommon.performUpdates(v)
-
-print( "Updated files to v{0}".format( v.getVersionString() ) )
diff --git a/tools/scripts/minorRelease.py b/tools/scripts/minorRelease.py
deleted file mode 100755
index 0992c8fb..00000000
--- a/tools/scripts/minorRelease.py
+++ /dev/null
@@ -1,9 +0,0 @@
-#!/usr/bin/env python3
-
-import releaseCommon
-
-v = releaseCommon.Version()
-v.incrementMinorVersion()
-releaseCommon.performUpdates(v)
-
-print( "Updated files to v{0}".format( v.getVersionString() ) )
diff --git a/tools/scripts/patchRelease.py b/tools/scripts/patchRelease.py
deleted file mode 100755
index 48256c15..00000000
--- a/tools/scripts/patchRelease.py
+++ /dev/null
@@ -1,9 +0,0 @@
-#!/usr/bin/env python3
-
-import releaseCommon
-
-v = releaseCommon.Version()
-v.incrementPatchNumber()
-releaseCommon.performUpdates(v)
-
-print( "Updated files to v{0}".format( v.getVersionString() ) )
diff --git a/tools/scripts/releaseCommon.py b/tools/scripts/releaseCommon.py
index 920fb98c..cbdd92e1 100644
--- a/tools/scripts/releaseCommon.py
+++ b/tools/scripts/releaseCommon.py
@@ -1,19 +1,14 @@
 import os
 import re
-import string
-import fnmatch
 
 from scriptCommon import catchPath
 
 versionParser = re.compile( r'(\s*static\sVersion\sversion)\s*\(\s*(.*)\s*,\s*(.*)\s*,\s*(.*)\s*,\s*\"(.*)\"\s*,\s*(.*)\s*\).*' )
 rootPath = os.path.join( catchPath, 'src/catch2' )
 versionPath = os.path.join( rootPath, "catch_version.cpp" )
-definePath = os.path.join(rootPath, 'catch_version_macros.hpp')
-readmePath = os.path.join( catchPath, "README.md" )
-cmakePath = os.path.join(catchPath, 'CMakeLists.txt')
-mesonPath = os.path.join(catchPath, 'meson.build')
 
 class Version:
+    """The version of the Catch2 compatibility engine, from catch_version.cpp."""
     def __init__(self):
         f = open( versionPath, 'r' )
         for line in f:
@@ -27,117 +22,8 @@ class Version:
                 self.buildNumber = int(m.group(6))
         f.close()
 
-    def nonDevelopRelease(self):
-        if self.branchName != "":
-            self.branchName = ""
-            self.buildNumber = 0
-    def developBuild(self):
-        if self.branchName == "":
-            self.branchName = "develop"
-            self.buildNumber = 0
-
-    def incrementBuildNumber(self):
-        self.developBuild()
-        self.buildNumber = self.buildNumber+1
-
-    def incrementPatchNumber(self):
-        self.nonDevelopRelease()
-        self.patchNumber = self.patchNumber+1
-
-    def incrementMinorVersion(self):
-        self.nonDevelopRelease()
-        self.patchNumber = 0
-        self.minorVersion = self.minorVersion+1
-
-    def incrementMajorVersion(self):
-        self.nonDevelopRelease()
-        self.patchNumber = 0
-        self.minorVersion = 0
-        self.majorVersion = self.majorVersion+1
-
     def getVersionString(self):
         versionString = '{0}.{1}.{2}'.format( self.majorVersion, self.minorVersion, self.patchNumber )
         if self.branchName != "":
             versionString = versionString + '-{0}.{1}'.format( self.branchName, self.buildNumber )
         return versionString
-
-    def updateVersionFile(self):
-        f = open( versionPath, 'r' )
-        lines = []
-        for line in f:
-            m = versionParser.match( line )
-            if m:
-                lines.append( '{0}( {1}, {2}, {3}, "{4}", {5} );'.format( self.variableDecl, self.majorVersion, self.minorVersion, self.patchNumber, self.branchName, self.buildNumber ) )
-            else:
-                lines.append( line.rstrip() )
-        f.close()
-        f = open( versionPath, 'w' )
-        for line in lines:
-            f.write( line + "\n" )
-
-
-def updateCmakeFile(version):
-    with open(cmakePath, 'rb') as file:
-        lines = file.readlines()
-    replacementRegex = re.compile(b'''VERSION (\\d+.\\d+.\\d+) # CML version placeholder, don't delete''')
-    replacement = '''VERSION {0} # CML version placeholder, don't delete'''.format(version.getVersionString()).encode('ascii')
-    with open(cmakePath, 'wb') as file:
-        for line in lines:
-            file.write(replacementRegex.sub(replacement, line))
-
-
-def updateMesonFile(version):
-    with open(mesonPath, 'rb') as file:
-        lines = file.readlines()
-    replacementRegex = re.compile(b'''version\\s*:\\s*'(\\d+.\\d+.\\d+)', # CML version placeholder, don't delete''')
-    replacement = '''version: '{0}', # CML version placeholder, don't delete'''.format(version.getVersionString()).encode('ascii')
-    with open(mesonPath, 'wb') as file:
-        for line in lines:
-            file.write(replacementRegex.sub(replacement, line))
-
-
-def updateVersionDefine(version):
-    # First member of the tuple is the compiled regex object, the second is replacement if it matches
-    replacementRegexes = [(re.compile(b'#define CATCH_VERSION_MAJOR \\d+'),'#define CATCH_VERSION_MAJOR {}'.format(version.majorVersion).encode('ascii')),
-                          (re.compile(b'#define CATCH_VERSION_MINOR \\d+'),'#define CATCH_VERSION_MINOR {}'.format(version.minorVersion).encode('ascii')),
-                          (re.compile(b'#define CATCH_VERSION_PATCH \\d+'),'#define CATCH_VERSION_PATCH {}'.format(version.patchNumber).encode('ascii')),
-                         ]
-    with open(definePath, 'rb') as file:
-        lines = file.readlines()
-    with open(definePath, 'wb') as file:
-        for line in lines:
-            for replacement in replacementRegexes:
-                line = replacement[0].sub(replacement[1], line)
-            file.write(line)
-
-
-def updateVersionPlaceholder(filename, version):
-    with open(filename, 'rb') as file:
-        lines = file.readlines()
-    placeholderRegex = re.compile(b'Catch[0-9]? v?X.Y.Z')
-    replacement = 'Catch2 {}.{}.{}'.format(version.majorVersion, version.minorVersion, version.patchNumber).encode('ascii')
-    with open(filename, 'wb') as file:
-        for line in lines:
-            file.write(placeholderRegex.sub(replacement, line))
-
-
-def updateDocumentationVersionPlaceholders(version):
-    print('Updating version placeholder in documentation')
-    docsPath = os.path.join(catchPath, 'docs/')
-    for basePath, _, files in os.walk(docsPath):
-        for file in files:
-            if fnmatch.fnmatch(file, "*.md") and "contributing.md" != file:
-                updateVersionPlaceholder(os.path.join(basePath, file), version)
-
-
-def performUpdates(version):
-    version.updateVersionFile()
-    updateVersionDefine(version)
-
-    import generateAmalgamatedFiles
-    generateAmalgamatedFiles.generate_header()
-    generateAmalgamatedFiles.generate_cpp()
-
-    updateCmakeFile(version)
-    updateMesonFile(version)
-    updateDocumentationVersionPlaceholders(version)