client_js.js

/*
    Copyright (C) 2016  PencilBlue, LLC

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
'use strict';

//dependencies
var util = require('./util.js');

module.exports = function ClientJsModule(pb) {

    /**
     * Service for creating JavaScript tags
     *
     * @module Services
     * @class ClientJs
     * @constructor
     */
    function ClientJs(){}

    /**
     * Creates a basic AngularJS controller with a repeat directive for templatizing
     * @static
     * @method getAngularController
     * @param {Object} objects     Object to be passed into AngularJS scope
     * @param {Array}  modules     Array of AngularJS module names
     * @param {String} [directiveJS] JavaScript to run after on-finish-render directive
     */
    ClientJs.getAngularController = function(objects, modules, directiveJS) {
        if(!util.isArray(modules) || modules.length === 0) {
            modules = ['ngRoute'];
        }

        var angularController = 'var pencilblueApp = angular.module("pencilblueApp", ' + JSON.stringify(modules) + ')';
        if(!util.isNullOrUndefined(directiveJS)) {
            angularController += '.directive("onFinishRender", function($timeout){return {restrict: "A",link: function(scope, element, attr){if (scope.$last === true){$timeout(function(){' + directiveJS + '})}}}})';
        }

        var scopeString = ClientJs.getAngularObjects(objects);
        angularController = angularController.concat('.controller("PencilBlueController", function($scope, $sce) {' + scopeString + "});\n");
        angularController = angularController.concat('pencilblueApp.config(["$compileProvider",function(e){e.aHrefSanitizationWhitelist(/^\s*(https?|ftp|mailto|javascript):/)}]);');
        return ClientJs.getJSTag(angularController);
    };

    /**
     *
     * @static
     * @method getAngularObjects
     * @param {Object} objects
     * @return {String}
     */
    ClientJs.getAngularObjects = function(objects) {
        var scopeString = '';
        Object.keys(objects).forEach(function(key) {
            if(util.isString(objects[key]) && objects[key].indexOf('function(') === 0) {
                scopeString = scopeString.concat('$scope.' + key + ' = ' + objects[key] + ";\n");
                return;
            }
            scopeString = scopeString.concat('$scope.' + key + '=' + JSON.stringify(objects[key], null, pb.log.isSilly() ? ' ' : undefined) + ";\n");
        });

        return scopeString;
    };

    /**
     * Creates a JS tag that loads the specified url
     *
     * @static
     * @method includeJS
     * @param {String} url
     */
    ClientJs.includeJS = function(url) {
        return new pb.TemplateValue('<script type="text/javascript" src="' + url + '"></script>', false);
    };

    /**
     * Puts the supplied JS code string into a script tag
     *
     * @static
     * @method getJSTag
     * @param {String} jsCode
     */
    ClientJs.getJSTag = function(jsCode) {
        return new pb.TemplateValue('<script type="text/javascript">\n' + jsCode + '\n</script>', false);
    };

    //exports
    return ClientJs;
};