tools/lib/cordova/post/versionmenu.js

/*
       Licensed to the Apache Software Foundation (ASF) under one
       or more contributor license agreements.  See the NOTICE file
       distributed with this work for additional information
       regarding copyright ownership.  The ASF licenses this file
       to you under the Apache License, Version 2.0 (the
       "License"); you may not use this file except in compliance
       with the License.  You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

       Unless required by applicable law or agreed to in writing,
       software distributed under the License is distributed on an
       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
       KIND, either express or implied.  See the License for the
       specific language governing permissions and limitations
       under the License.
*/
/* jslint node: true */
var fs = require('fs-extra');
var path = require('path');
var cheerio = require('cheerio');

/**
* Preprocessor which updates top stripe with header or the page.
*/
var VersionMenu = (function () {
    'use strict';
    var languages = null;
    var versions = null;

    /**
    * Creates a new instance of FileMerger
    * @param options Options for the generation process.
    */
    function VersionMenu (options) {
        this.options = options || { verbose: 0 };
        this.stage = 'Populate version menu';
        if (languages === null) {
            languages = [];
            versions = {};
            this.buildVersionsData();
        }

        this.generatedMenu = this.generateMenu();
        this.generatedLanguageMenu = this.generateLanguageMenu();
    }

    VersionMenu.prototype.run = function (file, $) {
        if (path.extname(file) !== '.html') {
            return;
        }

        if (this.options.verbose > 1) {
            console.info('Building version menu for file ' + file);
        }

        var element,
            scriptTag,
            currentPageSettings;

        element = $('#header small select#language').first();
        this.generatedLanguageMenu.forEach(function (optionGroup) {
            element.append(optionGroup).append('\n');
        });
        element = $('head').first();
        currentPageSettings = {
            lang: this.options.lang,
            version: this.options.version
        };
        scriptTag = cheerio('<script></script>');
        scriptTag.text('var settings = ' + JSON.stringify(currentPageSettings) + ';');
        element.append(scriptTag);
    };

    VersionMenu.prototype.buildVersionsData = function () {
        var docs_path = path.resolve(path.join(module.filename, '..', '..', '..', '..', 'docs'));
        var lang_dirs;
        var lang_labels = [];

        lang_dirs = fs.readdirSync(docs_path);
        lang_dirs.forEach(function (lang) {
            versions[lang] = [];
            var lang_dir = path.join(docs_path, lang);
            var version_dirs;
            version_dirs = fs.readdirSync(lang_dir);
            version_dirs.forEach(function (version) {
                var configFile = path.join(lang_dir, version, 'config.json');
                var configData = JSON.parse(fs.readFileSync(configFile));
                versions[lang].push(version);
                lang_labels[lang] = configData.language;
            });

            languages.push({ lang: lang, label: lang_labels[lang] });
        });
        languages = languages.sort(function (a, b) {
            if (a.label === b.label) {
                return 0;
            }

            if (a.label > b.label) {
                return 1;
            }

            return -1;
        });
    };

    VersionMenu.prototype.generateMenu = function () {
        var result = [];
        var langGroup;
        var versionData;
        var versionOption;
        var lang;
        var versionIndex;
        var version;
        var mapper;
        var key;

        mapper = function (item) {
            return item;
        };

        for (key in languages) {
            if (languages.hasOwnProperty(key)) {
                lang = languages[key].lang;
                langGroup = cheerio('<optgroup></optgroup>');
                langGroup.append('\n');
                langGroup.attr('label', languages[key].label);
                langGroup.attr('value', lang);

                versionData = versions[lang].map(mapper).reverse();
                for (versionIndex = 0; versionIndex < versionData.length; versionIndex = versionIndex + 1) {
                    version = versionData[versionIndex];
                    versionOption = cheerio('<option></option>');
                    if (this.options.version === version && this.options.lang === lang) {
                        versionOption.attr('selected', 'selected');
                    }

                    versionOption.attr('value', version);
                    versionOption.text(version);
                    langGroup.append(versionOption).append('\n');
                }

                result.push(langGroup);
            }
        }

        return result;
    };

    VersionMenu.prototype.generateLanguageMenu = function () {
        var result = [];
        var langGroup;
        var lang;
        var mapper; // eslint-disable-line
        var key;

        mapper = function (item) {
            return item;
        };

        for (key in languages) {
            if (languages.hasOwnProperty(key)) {
                lang = languages[key].lang;
                langGroup = cheerio('<option></option>');
                langGroup.append('\n');
                langGroup.attr('label', languages[key].label);
                langGroup.attr('value', lang);

                result.push(langGroup);
            }
        }

        return result;
    };

    return VersionMenu;
}());
module.exports = VersionMenu;