.updatedoc.py

#!/usr/bin/env python3
# pass import - Password Store Extension (https://www.passwordstore.org/)
# Copyright (C) 2017-2019 Alexandre PUJOL <alexandre@pujol.io>.
#

# This script will update the readme file in this repo.

import io
import pass_import


def replace(marker_begin, marker_end, string, newcontent):
    """Replace data inside string markers."""
    begin = string.find(marker_begin)
    end = string.find(marker_end)
    return string.replace(string[begin + len(marker_begin):end], newcontent)


def rspace(string):
    """Remove space from url in markdown string."""
    if '](' in string:
        begin = string.find('](')
        end = string.find(')')
        url_space = string[begin + 2:end]
        string = string.replace(url_space, url_space.replace(' ', ''))
    return string


def rmarkdown(string):
    """Remove markdown link from a string."""
    guide = '[guide]('
    if guide in string:
        string = string.replace(guide, 'guide: \\fI')
        string = string.replace(')', '\\fP')
    return string


def importers_nb():
    """Return a string of the importer len."""
    return "%d" % len(pass_import.importers)


def importers_nb_line():
    """Return a line of the importer len."""
    return "\n%d\n" % len(pass_import.importers)


def markdown_table():
    """Generate the new supported table."""
    res = ('| **Password Manager** | **How to export Data** | **Command line** |\n'  # noqa
           '|:--------------------:|:----------------------:|:----------------:|\n')  # noqa

    for importer in sorted(pass_import.importers):
        doc = pass_import.getdoc(importer)
        export = rspace(doc['export'])
        res += "| [%s](%s) | *%s* | `%s` |\n" % (importer, doc['url'],
                                                 export, doc['import'])
    return "\n%s" % res


def importers_usage():
    """Generate the new supported table."""
    res = ''
    for importer in sorted(pass_import.importers):
        doc = pass_import.getdoc(importer)
        export = rmarkdown(rspace(doc['export']))
        res += ("\n.TP\n\\fB%s\\fP\n"
                "Website: \\fI%s\\fP\n\n" % (importer, doc['url']))

        if 'extra' in doc:
            res += "%s\n\n" % doc['extra']
        res += ("Export: %s\n\n"
                "Command: %s\n" % (export, doc['import']))
    return "\n%s" % res


def helpmessage():
    """Generate the new pass-import usage."""
    string = io.StringIO()
    parser = pass_import.argumentsparse()
    parser.print_help(string)
    return "\n```\n%s\n```\n" % string.getvalue()


UPDATE = {
    'README.md': [
        ('<!-- NB BEGIN -->', '<!-- NB END -->', importers_nb),
        ('<!-- SUPPORTED LIST BEGIN -->', '<!-- SUPPORTED LIST END -->',
         markdown_table),
        ('<!-- USAGE BEGIN -->', '<!-- USAGE END -->', helpmessage)
    ],
    'pass-import.1': [
        (r'\# NB BEGIN', r'\# NB END', importers_nb_line),
        (r'\# SUPPORTED LIST BEGIN', r'\# SUPPORTED LIST END', importers_usage)
    ],
}


def main():
    """Update the documentation files last usage and importer list."""
    for path, pattern in UPDATE.items():
        with open(path, 'r') as file:
            data = file.read()

        for item in pattern:
            data = replace(item[0], item[1], data, item[2]())

        with open(path, 'w') as file:
            file.write(data)


if __name__ == "__main__":
    main()