release.py

#!/usr/bin/python

import json
import os
import subprocess

PACKAGE_PATH = os.path.dirname(__file__)
MESSAGE_DIR = 'messages'
MESSAGE_PATH = os.path.join(PACKAGE_PATH, MESSAGE_DIR)

GLOBAL_MESSAGE = """


💛 Git Gutter? Want to support development?

I've teamed up with Wes Bos to offer the following discounts:

+------------------------------------------------+
|                                                |
|   Use the coupon code GITGUTTER for $10 off    |
|                                                |
+------------------------------------------------+

🏅 ⭐ ES6 ⭐

👉 ES6.io/friend/GITGUTTER

🏅 ⭐ Sublime Text Book ⭐

👉 SublimeTextBook.com/friend/GITGUTTER

🏅 ⭐ React For Beginners ⭐

👉 ReactForBeginners.com/friend/GITGUTTER


Join 15,000 other developers already learning with Wes Bos.

These are fantastic resources - 100% money back guarantee! 🌟
"""


def get_message(fname):
    with open(fname, 'r', encoding='utf-8') as file:
        message = file.read()
    return message


def put_message(fname, text):
    with open(fname, 'w', encoding='utf-8') as file:
        file.write(text)


def add_global_message(fname):
    """Append the GLOBAL_MESSAGE to a file if not yet contained."""
    text = get_message(fname)
    if GLOBAL_MESSAGE not in text:
        put_message(fname, text.strip() + GLOBAL_MESSAGE)


def remove_global_message(fname):
    """Remove the GLOBAL_MESSAGE from a file."""
    text = get_message(fname)
    new_text = text.replace(GLOBAL_MESSAGE, '').strip() + '\n'
    if new_text != text:
        put_message(fname, new_text)


def update_global_message(version_history):
    # remove global message from previous release
    remove_global_message(
        os.path.join(MESSAGE_PATH, version_history[-3] + '.txt'))
    # add global message to current release
    add_global_message(
        os.path.join(MESSAGE_PATH, version_history[-2] + '.txt'))


def built_messages_json(version_history):
    """Write the version history to the messages.json file."""
    output = os.path.join(PACKAGE_PATH, 'messages.json')
    with open(output, 'w+', encoding='utf-8') as file:
        json.dump(
            obj={v: MESSAGE_DIR + '/' + v + '.txt' for v in version_history},
            fp=file, indent=4, separators=(',', ': '), sort_keys=True)
        file.write('\n')


def version_history():
    """Return a list of all releases."""
    def generator():
        for filename in os.listdir(MESSAGE_PATH):
            basename, ext = os.path.splitext(filename)
            if ext.lower() == '.txt':
                yield basename
    return tuple(generator())


def git(*args):
    """Run git command within current package path."""
    if os.name == 'nt':
        startupinfo = subprocess.STARTUPINFO()
        startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
    else:
        startupinfo = None
    proc = subprocess.Popen(
        args=['git'] + [arg for arg in args], startupinfo=startupinfo,
        stdout=subprocess.PIPE, stdin=subprocess.PIPE, cwd=PACKAGE_PATH)
    stdout, _ = proc.communicate()
    return stdout.decode('utf-8').strip() if stdout else None


def commit_release(version):
    """Create a 'Cut <version>' commit and tag."""
    commit_message = 'Cut %s' % version
    git('add', '.')
    git('commit', '-m', commit_message)
    git('tag', '-a', '-m', commit_message, version)


def build_release():
    """Built the new release locally."""
    history = version_history()
    version = history[-2]
    put_message(os.path.join(PACKAGE_PATH, 'VERSION'), version)
    update_global_message(history)
    built_messages_json(history)
    commit_release(version)
    print("Release %s created!" % version)


def publish_release(token):
    """Publish the new release."""
    history = version_history()
    version = history[-2]

    repo_url = 'https://github.com/jisaacks/GitGutter.git'
    # push master branch to server
    git('push', repo_url, 'master')
    # push tags to server
    git('push', repo_url, 'tag', version)

    # publish the release
    post_url = '/repos/jisaacks/GitGutter/releases?access_token=' + token
    headers = {
        'User-Agent': 'Sublime Text',
        'Content-type': 'application/json',
    }
    # get message from /messages/<version>.txt
    text = get_message(os.path.join(MESSAGE_PATH, version + '.txt'))
    # strip global message
    text = text.replace(GLOBAL_MESSAGE, '').strip()
    # strip message header (version)
    text = text[text.find('\n') + 1:]
    # built the JSON request body
    data = json.dumps({
        "tag_name": version,
        "target_commitish": "master",
        "name": version,
        "body": text,
        "draft": False,
        "prerelease": False
    })
    try:
        import http.client
        client = http.client.HTTPSConnection('api.github.com')
        client.request('POST', post_url, body=data, headers=headers)
        response = client.getresponse()
        print("Release %s published!" % version
              if response.status == 201 else
              "Release %s failed!" % version)
    finally:
        client.close()


"""
======================================
Command Line Interface
======================================
"""
if __name__ == '__main__':
    import argparse

    parser = argparse.ArgumentParser(
        description='Built and Publish GitGutter Releases')
    parser.add_argument(
        dest='command',
        help='The command to perform is one of [BUILD|PUBLISH].')
    parser.add_argument(
        '--token',
        nargs='?',
        help='The GitHub access token used for authentication.')
    args = parser.parse_args()
    if args.command.lower() == 'build':
        build_release()
    elif args.command.lower() == 'publish':
        publish_release(args.token)


"""
======================================
Sublime Text Command Interface
======================================
"""
try:
    import sublime
    import sublime_plugin

    SETTINGS = "GitGutter.sublime-settings"

    class GitGutterBuildReleaseCommand(sublime_plugin.ApplicationCommand):

        def is_visible(self):
            settings = sublime.load_settings(SETTINGS)
            return settings.has('github_token')

        def run(self):
            """Built a new release."""
            build_release()

    class GitGutterPublishReleaseCommand(sublime_plugin.ApplicationCommand):

        def is_visible(self):
            settings = sublime.load_settings(SETTINGS)
            return settings.has('github_token')

        def run(self):
            """Publish the new release."""
            settings = sublime.load_settings(SETTINGS)
            publish_release(settings.get('github_token', ''))

except ImportError:
    pass