From a207b43097d28ab8fc0c72376d00223518c424b7 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Fri, 22 Sep 2017 00:21:28 +0100 Subject: updating script --- .travis.yml | 8 +--- scripts/add_version_headers | 94 +++++++++++++++++++++++++++++++++++++++++++++ scripts/update_docs | 15 ++++++++ tools/add_version_headers | 94 --------------------------------------------- tools/update_docs | 15 -------- 5 files changed, 110 insertions(+), 116 deletions(-) create mode 100755 scripts/add_version_headers create mode 100755 scripts/update_docs delete mode 100755 tools/add_version_headers delete mode 100755 tools/update_docs diff --git a/.travis.yml b/.travis.yml index a857df90..f4ef2330 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,13 +27,7 @@ script: - cmake .. - make - ctest -- | - if [ "$TRAVIS_BRANCH" == "master" ]; then - ./tools/update_docs - exit 0 - else - exit 0 - fi +- ./scripts/update_docs env: global: secure: NGWn7hJAd/iYfJQmr8oDjTlwttldj8zB+X0gk2TqDhAJ2gLiZ2+b8Bp5FSzBlNIyhcbuhzRU+rzkbo03XSwXZXFRZK/gyPMGaB75ay8MLQBrN3L7THXbjQm1SZg2mO17/MKT+rJH/NvhmqPoUoJaYnoki1G6AZfhnDx+3bW4MNp5/g3u8trk1HNvXWTvjdqS99OH36bvoq8BsOi53Po1veeCIWza6JO61n2nRHzCC2sYWtsZyTQSi3B//iie5zF3gvuRorbzjA/ayc8lLmhUsTmoA1t9HJP52fKzv/q3mxllXzyzpWNRmUJCzf7I1wY9jp1FVwojfl0umofzYPCCjwSrKlRtmwQfi0peg7VOJVCCJx7Eh/i0hamGUnDEu0aZnfhgwzkqDDIgO1AwcEv5i9egt/73kK4mdm22sEDa3dWVu37tnj5dItaQesMm6TXKMy9+r7v0aaVJbQB2atvBaf3RlW71P9iy8mOZ+geKNwVFRuBdu5g3oQe5QrqXRi4inMv0bjN8HwOVs/f8ZTGZePnbHnxOnYRErxLnha/bsu7btfDT8Q8nmZ/Rhcu7QkMRNTm5L3+YHFUngiIygOs8wrH6HECtSYwmi9WejRuPgU2GnYR0Rzyi5dyaFok1iN+jsYsY9YFx5tRgxuX4H9CnUlfDabdFSLzqbmKRlbP79as= diff --git a/scripts/add_version_headers b/scripts/add_version_headers new file mode 100755 index 00000000..def7d55a --- /dev/null +++ b/scripts/add_version_headers @@ -0,0 +1,94 @@ +#!/usr/bin/env python +# ----------------------------------------------------------------------------- +# add_version_headers +# +# Add version header +# +# Copyright (c) 2017 Yann Herklotz Grave -- MIT License +# See file LICENSE for more details +# ----------------------------------------------------------------------------- + +"""\file add_version_headers +\brief Adds the version headers to every file. + +Add Version Headers +=================== + +This file adds the version headers to every file in the directory + + +Improvements +------------ + +Add the ability to input command line arguments. +""" + +import os +import re +import sys + + +header = """/* ---------------------------------------------------------------\ +------------- + * {0} + * + * Copyright (c) 2017 Yann Herklotz Grave + * MIT License, see LICENSE file for more details. + * ---------------------------------------------------------------------------- + */ + +""" + + +class HeaderUpdate(object): + """Updates the header in all the source and header files in the code""" + def __init__(self, **kwargs): + self.match_re = ".*[.]cpp$|.*[.]hpp$" + self.exclude_re = "^$" + self.exclude_build = True + self.exclude_dir = ".*build.*" + self.match_dir = "" + self.comment_match = "^\/[*] -+" + self.starting_dir = os.getcwd() + for key, value in kwargs.items(): + setattr(self, key, value) + + def writeHeader(self): + def writeFileOperation(filePath, src): + if not re.match(self.comment_match, src): + print(filePath, end=" ") + with open(filePath, 'w') as src_file_lic: + src_file_lic.write(header.format(filePath)) + src_file_lic.write(src) + print("-- done") + + self._traverseDir(self.starting_dir, writeFileOperation) + + def updateHeader(self): + ... + + def removeHeader(self): + ... + + def _traverseDir(self, path, fileOperation): + for subdir, dirs, files in os.walk(os.getcwd()): + if (not re.match(self.exclude_dir, subdir)) and \ + (re.match(self.match_dir, subdir)): + for fileName in files: + if (re.match(self.match_re, fileName)) and \ + (not re.match(self.exclude_re, fileName)): + with open(os.path.join(subdir, fileName), 'r') \ + as src_file: + src = src_file.read() + fileOperation(os.path.join(subdir, fileName), src) + + +def main(argv): + update = HeaderUpdate(exclude_re="^picopng[.]cpp", + exclude_dir=".*build.*|.*google.*", + match_dir=".*src.*|.*include.*|.*test.*") + update.writeHeader() + + +if __name__ == "__main__": + main(sys.argv) diff --git a/scripts/update_docs b/scripts/update_docs new file mode 100755 index 00000000..f1ba2ba9 --- /dev/null +++ b/scripts/update_docs @@ -0,0 +1,15 @@ +#!/usr/bin/env bash + +if [[ "$TRAVIS_BRANCH" == "master" ]]; then + doxygen ./docs/Doxyfile + cd html + git init + git config user.name "TravisBot" + git config user.email "" + git remote add upstream "https://$GH_TOKEN@github.com/ymherklotz/YAGE.git" + git fetch upstream + git reset upstream/gh-pages + git add -A + git commit -m "Rebuilding documentation" + git push -q upstream HEAD:gh-pages +fi diff --git a/tools/add_version_headers b/tools/add_version_headers deleted file mode 100755 index def7d55a..00000000 --- a/tools/add_version_headers +++ /dev/null @@ -1,94 +0,0 @@ -#!/usr/bin/env python -# ----------------------------------------------------------------------------- -# add_version_headers -# -# Add version header -# -# Copyright (c) 2017 Yann Herklotz Grave -- MIT License -# See file LICENSE for more details -# ----------------------------------------------------------------------------- - -"""\file add_version_headers -\brief Adds the version headers to every file. - -Add Version Headers -=================== - -This file adds the version headers to every file in the directory - - -Improvements ------------- - -Add the ability to input command line arguments. -""" - -import os -import re -import sys - - -header = """/* ---------------------------------------------------------------\ -------------- - * {0} - * - * Copyright (c) 2017 Yann Herklotz Grave - * MIT License, see LICENSE file for more details. - * ---------------------------------------------------------------------------- - */ - -""" - - -class HeaderUpdate(object): - """Updates the header in all the source and header files in the code""" - def __init__(self, **kwargs): - self.match_re = ".*[.]cpp$|.*[.]hpp$" - self.exclude_re = "^$" - self.exclude_build = True - self.exclude_dir = ".*build.*" - self.match_dir = "" - self.comment_match = "^\/[*] -+" - self.starting_dir = os.getcwd() - for key, value in kwargs.items(): - setattr(self, key, value) - - def writeHeader(self): - def writeFileOperation(filePath, src): - if not re.match(self.comment_match, src): - print(filePath, end=" ") - with open(filePath, 'w') as src_file_lic: - src_file_lic.write(header.format(filePath)) - src_file_lic.write(src) - print("-- done") - - self._traverseDir(self.starting_dir, writeFileOperation) - - def updateHeader(self): - ... - - def removeHeader(self): - ... - - def _traverseDir(self, path, fileOperation): - for subdir, dirs, files in os.walk(os.getcwd()): - if (not re.match(self.exclude_dir, subdir)) and \ - (re.match(self.match_dir, subdir)): - for fileName in files: - if (re.match(self.match_re, fileName)) and \ - (not re.match(self.exclude_re, fileName)): - with open(os.path.join(subdir, fileName), 'r') \ - as src_file: - src = src_file.read() - fileOperation(os.path.join(subdir, fileName), src) - - -def main(argv): - update = HeaderUpdate(exclude_re="^picopng[.]cpp", - exclude_dir=".*build.*|.*google.*", - match_dir=".*src.*|.*include.*|.*test.*") - update.writeHeader() - - -if __name__ == "__main__": - main(sys.argv) diff --git a/tools/update_docs b/tools/update_docs deleted file mode 100755 index f1ba2ba9..00000000 --- a/tools/update_docs +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env bash - -if [[ "$TRAVIS_BRANCH" == "master" ]]; then - doxygen ./docs/Doxyfile - cd html - git init - git config user.name "TravisBot" - git config user.email "" - git remote add upstream "https://$GH_TOKEN@github.com/ymherklotz/YAGE.git" - git fetch upstream - git reset upstream/gh-pages - git add -A - git commit -m "Rebuilding documentation" - git push -q upstream HEAD:gh-pages -fi -- cgit