tools/lib/cordova/post/stepprocessor.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');
var AddTitle = require('./addtitle');
var TableOfContents = require('./tableofcontents');
var VersionMenu = require('./versionmenu');
var NavigationMenu = require('./navigationmenu');
var Prettify = require('./prettify');
var NoIndex = require('./noindex');

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

    /**
    * Creates a new instance of StepProcessor
    * @param options Options for the generation process.
    */
    function StepProcessor (options) {
        var self = this;
        this.options = options || { verbose: 0, timing: -1 };
        this.stage = 'Step 1';
        this.processors = [AddTitle, TableOfContents, VersionMenu, NavigationMenu, Prettify, NoIndex].map(function (StepConstructor) {
            var stepObject;
            self.captureExecutionTime(' Substep init ' + StepConstructor, 2, function () {
                stepObject = new StepConstructor(self.options);
            });
            return stepObject;
        });
    }

    StepProcessor.prototype.run = function (file) {
        var self = this;
        var $;
        if (path.extname(file) !== '.html') {
            return;
        }

        $ = cheerio.load(fs.readFileSync(file));
        this.processors.forEach(function (stepObject) {
            self.captureExecutionTime(' Substep run: ' + stepObject.stage, 2, function () {
                stepObject.run(file, $);
            });
        });
        // Save all content to file
        fs.writeFileSync(file, $.html());
    };

    StepProcessor.prototype.captureExecutionTime = function (step_name, level, callback) {
        var startDate;
        var finishDate;
        var timingLevel = -1;
        var secondsPassed;
        if (this.options.timing) {
            if (this.options.timing === true) {
                timingLevel = 0;
            } else {
                timingLevel = this.options.timing;
            }
        }

        if (timingLevel >= level) {
            startDate = new Date();
            if (this.options.verbose > 0) {
                console.log(startDate, 'Start ' + step_name);
            }
        }

        callback.apply(this);
        if (timingLevel >= level) {
            finishDate = new Date();
            if (this.options.verbose > 0) {
                console.log(finishDate, 'Finish ' + step_name);
            }

            secondsPassed = (finishDate.valueOf() - startDate.valueOf()) / 1000;
            console.log(step_name + '. Total time: ', secondsPassed);
        }
    };

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