Haxe Lib Symlink Script

haxe_lib_symlink.py

"""Create flattened symlinks to haxe libs

This script makes symlinks to library source directories. It makes it
easier to configure IDE classpath such as Intellij IDEA that don't
check for the correct source directory and fail to find the package
name.

Note that in Intellij, this script might not be needed if you configure
the Haxe SDK to contain only the std library while having a separate
config in the Global Libraries. If you select the lib directory,
the GUI in the Global Libraries attempts to scan for libraries
so you don't have to manually add one-by-one.

"""

# MIT License
#
# Copyright (c) 2017 Christopher Foo
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import argparse
import glob
import json
import os
import re

import sys

import collections


class NotFoundError(ValueError):
    pass


def main():
    arg_parser = argparse.ArgumentParser()
    arg_parser.add_argument('lib', help="Path to Haxe lib directory")
    arg_parser.add_argument('dest', help='Destination directory for symlinks')

    args = arg_parser.parse_args()

    if not os.path.isdir(args.lib):
        print(args.lib, "is not a directory", file=sys.stderr)
        sys.exit(1)

    if not os.path.isdir(args.dest):
        print(args.dest, "is not a directory", file=sys.stderr)
        sys.exit(1)

    for project_name in sorted(os.listdir(args.lib)):
        version = get_library_current_version(os.path.join(args.lib, project_name)).replace('.', ',')

        if re.search(r'\b(demos?|samples?)\b', project_name):
            continue

        project_lib_path = os.path.join(args.lib, project_name, version)
        project_source_path = project_lib_path

        json_path = os.path.join(project_lib_path, 'haxelib.json')

        if os.path.isfile(json_path):
            with open(json_path) as file:
                doc = json.load(file)

            if 'classPath' in doc:
                project_source_path = os.path.join(project_source_path, doc['classPath'])
            else:
                try:
                    project_source_path = os.path.join(
                        project_source_path,
                        guess_source_containing_directory(project_source_path)
                    )
                except NotFoundError:
                    pass
        else:
            try:
                project_source_path = os.path.join(
                    project_source_path,
                    guess_source_containing_directory(project_source_path)
                )
            except NotFoundError:
                pass

        try:
            project_source_path = os.path.join(
                project_source_path,
                guess_haxe_source_package_directory(project_source_path, project_name)
            )
        except NotFoundError:
            pass

        project_package_source_path = os.path.abspath(project_source_path)
        dest_path = os.path.abspath(os.path.join(args.dest, project_name))

        if os.path.islink(dest_path):
            print('Removing old symlink', dest_path, file=sys.stderr)
            os.remove(dest_path)

        print('Linking', dest_path, '->', project_package_source_path, file=sys.stderr)

        os.symlink(project_package_source_path, dest_path, True)

    print("Done.", file=sys.stderr)


def get_library_current_version(library_path: str) -> str:
    current_path = os.path.join(library_path, '.current')

    if not os.path.isfile(current_path):
        raise NotFoundError("No version.")

    with open(current_path) as file:
        version = file.read().strip()

    return version


def guess_source_containing_directory(project_directory: str) -> str:
    for name in os.listdir(project_directory):
        if name.lower() in ('src', 'source'):
            return os.path.join(project_directory, name)

    raise NotFoundError()


def guess_haxe_source_package_directory(source_directory: str, project_name: str) -> str:
    counter = collections.Counter()

    for name in os.listdir(source_directory):
        files = list(glob.glob(os.path.join(source_directory, name, '*.hx')))

        if files:
            counter[os.path.join(source_directory, name)] = len(files)
            if name.lower() == project_name.lower():
                counter[os.path.join(source_directory, name)] += 100

    if not counter:
        raise NotFoundError()

    return counter.most_common(1)[0][0]


if __name__ == '__main__':
    main()