alias-repository.js

const filepath = require('filepath');
const AliasError = require('./exceptions/alias-error.js');
const gHelper = require('./helpers/general.js');
const filesHelper = require('./helpers/files.js');

class AliasRepository extends Array {
    ////////////////////////////////////////////////////
    // Configuration/Initialization
    ////////////////////////////////////////////////////

    async asyncAliasFiles() {
        // {source_directory: handling function}
        const SPECIAL_HANDLING_CASES = {
            './aliases/towers': this.loadTowerAliasFile,
            './aliases/raceid.json': this.loadRaceAlias,
        };

        for await (const absolutePath of filesHelper.getFiles('./aliases', [
            '.json',
        ])) {
            let fpath = filepath.create(absolutePath);
            let tokens = fpath.split();

            let relPath =
                './' +
                tokens
                    .slice(tokens.findIndex((i) => i === 'aliases'))
                    .join('/');

            // Determine the function that will handle the alias file

            // Default
            let handlingFunction = this.loadAliasFile;

            // See if the file has a special handler
            for (const specialRelPath in SPECIAL_HANDLING_CASES) {
                if (relPath.startsWith(specialRelPath)) {
                    handlingFunction =
                        SPECIAL_HANDLING_CASES[specialRelPath];
                    break;
                }
            }

            handlingFunction.call(this, relPath);
        }
    }

    // Default way to load in an alias file
    loadAliasFile(f) {
        const nextAliases = require(f);

        for (const canonical in nextAliases) {
            const nextAliasGroup = {
                canonical: canonical,
                aliases: nextAliases[canonical],
                sourcefile: f,
            };
            this.addAliasGroup(nextAliasGroup);
        }
    }

    // This handling is a bit more complex because there is implicit
    // meaning to the tower alias keys
    loadTowerAliasFile(f) {
        const towerUpgrades = require(f);

        const fpath = filepath.create(f);
        let baseName = fpath.split().slice(-1)[0].split('.')[0];

        for (const upgrade in towerUpgrades) {
            // xyz upgrade is meant to represent the tower as a whole ignoring upgrades
            // which is not exactly synonymous with the 000 tower.
            // The canonical form of the xyz tower is tower_name
            // whereas the canonical form of a specific upgrade is tower_name#ddd where d=digit
            const canonical =
                upgrade == 'xyz' ? `${baseName}` : `${baseName}#${upgrade}`;
            const nextAliasGroup = {
                canonical: canonical,
                aliases: towerUpgrades[upgrade],
                sourcefile: f,
            };
            this.addAliasGroup(nextAliasGroup);

            // Hack to add appropriate base tower entry
            if (upgrade == 'xyz') {
                const baseTowerAliasGroup = {
                    canonical: `${baseName}#222`,
                    aliases: towerUpgrades['xyz']
                        .concat(baseName)
                        .map((al) => [`base_${al}`, `b_${al}`]).flat(),
                    sourcefile: f,
                };
                this.addAliasGroup(baseTowerAliasGroup);
            }
        }
    }

    loadRaceAlias(f) {
        let raceIDs = require(f);
        let entries = Object.entries(raceIDs);
        for (let i = 0; i < Object.entries(raceIDs).length; i++) {
            let race = entries[i];
            const aliases = race[1];
            let canonical = race[0];
            aliases.push('r#' + i.toString());
            const nextAliasGroup = {
                canonical: canonical,
                aliases: aliases,
                sourcefile: f,
            };
            this.addAliasGroup(nextAliasGroup);
        }
    }
    // Ensure that none of the aliases clash before adding it in
    addAliasGroup(ag) {
        try {
            // If adora's_temple is an alias, include adoras_temple as well
            ag.aliases = [ag.aliases]
                .flat()
                .concat(ag.canonical)
                .map((al) => this.permuteRemovalForgettableCharacters(al))
                .flat();
            // Delete the canonical verbatim from the alias list
            ag.aliases.splice(ag.aliases.indexOf(ag.canonical), 1);

            // If another_brick is an alias, include another-brick and anotherbrick as well
            ag.aliases = ag.aliases
                .concat(ag.canonical)
                .map((al) => this.permuteSeparators(al))
                .flat();
            // Delete the canonical verbatim from the alias list
            ag.aliases.splice(ag.aliases.indexOf(ag.canonical), 1);

            // Remove duplicates, maintaining alias order
            ag.aliases = ag.aliases.filter((v, i, a) => a.indexOf(v) === i);
            // Make sure that none of these aliases overlap with other alias sets
            this.preventSharedAliases(ag);
        } catch (e) {
            if (e instanceof AliasError) {
                console.log(e.message);
            } else {
                console.log(e.name);
            }
        }
        this.push(ag);
    }

    // If "spike-o-pult", adds "spike_o_pult", "spike_o-pult", "spike-o_pult", "spike_opult", etc.
    permuteSeparators(al) {
        if (al.includes('#')) return [al];

        const SEPARATOR_TOKENS = ['_', '-'];
        const JOIN_TOKENS = ['_', '-', ''];

        const tokens = al.split(new RegExp(SEPARATOR_TOKENS.join('|')));
        let aliases = [tokens[0]];
        if (tokens.length < 8) {
            for (let i = 1; i < tokens.length; i++) {
                let new_aliases = [];
                for (let j = 0; j < aliases.length; j++) {
                    for (let k = 0; k < JOIN_TOKENS.length; k++) {
                        new_aliases.push(
                            aliases[j] + JOIN_TOKENS[k] + tokens[i]
                        );
                    }
                }
                aliases = [...new_aliases];
            }
        }

        // Move the original alias to the front of the transformed list
        aliases.splice(
            aliases.findIndex((a) => a == al),
            1
        );
        return [al].concat(aliases);
    }

    permuteRemovalForgettableCharacters(al) {
        if (al.includes('#')) return [al];

        const FORGETTABLE_CHARACTERS = [':', "'"];
        return this.forgetRecursive(al, FORGETTABLE_CHARACTERS);
    }

    forgetRecursive(w, chars) {
        const sepIndex = w.search(new RegExp(chars.join('|')));
        if (sepIndex == -1) return [w];

        const prefix = w.slice(0, sepIndex);
        const suffix = w.slice(sepIndex + 1);
        const sep = w[sepIndex];

        const useits = this.forgetRecursive(suffix, chars).map(
            (sfx) => prefix + sep + sfx
        );
        const loseits = this.forgetRecursive(suffix, chars).map(
            (sfx) => prefix + sfx
        );

        return useits.concat(loseits);
    }

    // Checks canonical + aliases against all other alias groups' canonical + aliases
    // and expects to find 0 matches between each set of aliases (alias set)
    preventSharedAliases(nextAliasGroup) {
        for (let i = 0; i < this.length; i++) {
            const existingAliasGroup = this[i];

            let nextAliasSet = nextAliasGroup.aliases.concat(
                nextAliasGroup.canonical
            );
            let existingAliasSet = existingAliasGroup.aliases.concat(
                existingAliasGroup.canonical
            );

            let sharedAliasMembers = nextAliasSet.filter((aliasMember) =>
                existingAliasSet.includes(aliasMember)
            );

            if (sharedAliasMembers.length > 0) {
                throw new AliasError(
                    `Aliases members [${sharedAliasMembers.map(
                        (a) => `"${a}"`
                    )}] clash among existing group ` +
                        `${this.formatAliasGroup(
                            existingAliasGroup
                        )} and new group ` +
                        `${this.formatAliasGroup(nextAliasGroup)}`
                );
            }
        }
    }

    formatAliasGroup(ag) {
        return JSON.stringify(ag, undefined, 2);
    }

    ////////////////////////////////////////////////////
    // Access
    ////////////////////////////////////////////////////

    // Converts a member of an alias group to its canonical form
    getCanonicalForm(aliasMember) {
        if (!aliasMember) return null;
        aliasMember = aliasMember.replace(/ /g, '_');
        let ag = this.getAliasGroup(aliasMember.toLowerCase());
        if (ag) return ag.canonical;
        else return null;
    }

    // Returns a single key-values pair alias group, `{canonical: [aliases]}`,
    // in which aliasMember is found
    getAliasGroup(aliasMember) {
        let ags = this.filter(
            (ag) =>
                ag.canonical == aliasMember || ag.aliases.includes(aliasMember)
        );
        if (!ags || ags.length == 0) {
            return null;
        } else if (ags.length == 1) {
            return ags[0];
        } else {
            throw (
                `Multiple alises groups found sharing a given alias member` +
                `(something went horribly wrong): ${ags.map(
                    (ag) => ag.canonical
                )}`
            );
        }
    }

    // Returns a flat list of aliases semantically equivalent to `aliasMember`
    getAliasSet(aliasMember) {
        aliasMember = aliasMember.toLowerCase();
        let ag = this.getAliasGroup(aliasMember);
        if (ag) return [ag.canonical].concat(ag.aliases);
        else return null;
    }

    getAliasGroupsFromSameFileAs(aliasMember) {
        aliasMember = aliasMember.toLowerCase();
        let ag = this.getAliasGroup(aliasMember);
        let result = this.filter(
            (otherAliasGroup) => otherAliasGroup.sourcefile === ag.sourcefile
        );
        return result;
    }

    getAliasGroupsFromSameImmediateDirectoryAs(aliasMember) {
        aliasMember = aliasMember.toLowerCase();
        let ag = this.getAliasGroup(aliasMember);
        let result = this.filter(function (otherAliasGroup) {
            let agPathTokens = ag.sourcefile.split('/');
            let otherAgPathTokens = otherAliasGroup.sourcefile.split('/');
            return (
                agPathTokens[agPathTokens.length - 2] ==
                otherAgPathTokens[otherAgPathTokens.length - 2]
            );
        });
        return result;
    }

    ////////////////////////////////////////////////////
    // Expedited Access
    ////////////////////////////////////////////////////
    allDifficulties() {
        const difficulties = this.getAliasGroupsFromSameFileAs('MEDIUM');

        return difficulties.map((ag) => ag.canonical).concat('impoppable');
    }

    allModes() {
        const modes = this.getAliasGroupsFromSameFileAs('STANDARD');

        return modes.map((ag) => ag.canonical);
    }

    toAliasNormalForm(indexForm) {
        return indexForm.toLowerCase().split(' ').join('_');
    }

    toAliasCanonical(indexForm) {
        return this.getCanonicalForm(this.toAliasNormalForm(indexForm));
    }

    toIndexNormalForm(canonical) {
        return canonical
            .split('_')
            .map((tk) => gHelper.toTitleCase(tk))
            .join(' ')
            .replace(/ \(.*\)/, ''); // Parentheticals are used to avoid clashing aliases (e.g. double shot) but are filtered out when displayed
    }

    allRaces() {
        let arr = this.getAliasGroupsFromSameFileAs('2018-12-13').map(
            (ag) => ag.canonical
        );
        return arr;
    }

    // Arg looks like `arg` or `argp1#argp2`
    // This converts each arg part to its canonical form.
    // `spact#025` gets converted to `spike_factory#025` for example.
    canonicizeArg(arg) {
        if (arg.startsWith('r#')) return Aliases.getCanonicalForm(arg) || arg; // for r#100 race args
        return arg
            .split('#')
            .map((t) => Aliases.getCanonicalForm(t) || t)
            .join('#');
    }
}

module.exports = AliasRepository;