adapt-cli 2.1.13 → 3.0.6

package/lib/promise/highest.js

@@ -1,109 +0,0 @@
-var async = require('async');
-var Q = require('q');
-var request = require('request');
-var semver = require('semver');
-var Constants = require('../Constants');
-var _ = require('lodash');
-
-module.exports = function () {
-  var deferred = Q.defer();
-
-  checkLatestAdaptRepoVersion(function (error, latestFrameworkTag) {
-    if (error) {
-      deferred.reject(error);
-    } else {
-      deferred.resolve(latestFrameworkTag);
-    }
-  });
-
-  return deferred.promise;
-}
-
-function checkLatestAdaptRepoVersion(versionLimit, callback) {
-  if (typeof versionLimit === 'function') {
-    callback = versionLimit;
-    versionLimit = undefined;
-  }
-  // used in pagination
-  var nextPage = `https://api.github.com/repos/${Constants.DefaultGitHubOrg}/${Constants.FrameworkRepositoryName}/releases`;
-
-  var _getReleases = function (done) {
-    request({
-      headers: {
-        'User-Agent': Constants.DefaultUserAgent
-      },
-      uri: nextPage,
-      method: 'GET'
-    }, done);
-  };
-  var _requestHandler = function (error, response, body) {
-    if (response) {
-      // we've exceeded the API limit
-      if (response.statusCode === 403 && response.headers['x-ratelimit-remaining'] === '0') {
-        var reqsReset = new Date(response.headers['x-ratelimit-reset'] * 1000);
-        error = `You have exceeded GitHub's request limit of ${response.headers['x-ratelimit-limit']} requests per hour. Please wait until at least ${reqsReset.toTimeString()} before trying again.`;
-      }
-      else if (response.statusCode !== 200) {
-        error = 'GitubAPI did not respond with a 200 status code.';
-      }
-    }
-    if (error) {
-      return callback(new Error(`Couldn't check latest version of ${Constants.FrameworkRepositoryName}. ${error}`));
-    }
-    nextPage = parseLinkHeader(response.headers.link).next;
-    try {
-      // parse and sort releases (newest first)
-      var releases = JSON.parse(body).sort((a, b) => {
-        if (semver.lt(a.tag_name, b.tag_name)) return 1;
-        if (semver.gt(a.tag_name, b.tag_name)) return -1;
-        return 0;
-      });
-    } catch (e) {
-      return callback(new Error(`Failed to parse GitHub release data\n${e}`));
-    }
-    var compatibleRelease;
-    async.someSeries(releases, function (release, cb) {
-      var isFullRelease = !release.draft && !release.prerelease;
-      var satisfiesVersion = !versionLimit || semver.satisfies(release.tag_name, versionLimit);
-
-      if (!isFullRelease || !satisfiesVersion) {
-        return cb(null, false);
-      }
-
-      compatibleRelease = release;
-      return cb(null, true);
-    }, function (error, satisfied) {
-      if (!satisfied) {
-        if (nextPage) {
-          return _getReleases(_requestHandler);
-        }
-        error = new Error(`Couldn't find any releases compatible with specified framework version (${versionLimit}), please check that it is a valid version.`);
-      }
-      if (error) {
-        return callback(error);
-      }
-      callback(error, compatibleRelease.tag_name);
-    });
-  };
-  // start recursion
-  _getReleases(_requestHandler);
-}
-
-// taken from https://gist.github.com/niallo/3109252
-function parseLinkHeader(header) {
-  if (!header || header.length === 0) {
-    return [];
-  }
-  var links = {};
-  // Parse each part into a named link
-  _.each(header.split(','), function (p) {
-    var section = p.split(';');
-    if (section.length !== 2) {
-      throw new Error("section could not be split on ';'");
-    }
-    var url = section[0].replace(/<(.*)>/, '$1').trim();
-    var name = section[1].replace(/rel="(.*)"/, '$1').trim();
-    links[name] = url;
-  });
-  return links;
-}

package/lib/promise/install.js

@@ -1,31 +0,0 @@
-var bower = require('bower'),
-    Q = require('q'),
-    path = require('path'),
-    rimraf = require('rimraf'),
-    Plugin = require('../Plugin');
-
-module.exports = function install (plugin, config) {
-    var deferred = Q.defer();
-
-    // (reliably) remove the plugin first
-    rimraf(path.join(config.cwd || '.', config.directory, plugin.packageName), {disableGlob:true}, doInstall);
-
-    function doInstall(err) {
-        if (err) {
-            deferred.notify();
-            deferred.resolve({error:'There was a problem writing to the target directory'});
-        } else {
-            bower.commands.install([plugin.packageName+'#'+plugin._versionToInstall], null, config)
-            .on('end', function() {
-                deferred.notify();
-                deferred.resolve({_wasInstalled:true});
-            })
-            .on('error', function (err) {
-                deferred.notify();
-                deferred.resolve({error:'Bower reported '+err});
-            });
-        }
-    }
-
-    return deferred.promise;
-}

package/lib/promise/installAdaptDependencies.js

@@ -1,30 +0,0 @@
-var chalk = require('chalk'),
-    Q = require('q'),
-    npm  = require('npm'),
-    installCommand = invokeFactoryOrProvideObject(require('../commands/install')),
-    Constants = require('../Constants'),
-    path = require('path');
-
-module.exports = function installAdaptDependencies (properties /* { renderer, localDir } */) {
-    var deferred = Q.defer(),
-        cwd = process.cwd();
-
-    properties.renderer.log(chalk.cyan('installing adapt dependencies'));
-
-    if(path.relative(cwd, properties.localDir)) {
-        process.chdir(properties.localDir);
-        console.log(cwd, 'change to',  process.cwd());
-    }
-    installCommand.install(properties.renderer, function (err) {
-        if(err) deferred.reject(err);
-
-        process.chdir(cwd);
-        deferred.resolve(properties);
-    });
-    return deferred.promise;
-};
-
-function invokeFactoryOrProvideObject(factoryOrObject, dependencies) {
-    if(typeof factoryOrObject === 'function') return factoryOrObject(dependencies || {});
-    return factoryOrObject;
-}

package/lib/promise/installNodeDependencies.js

@@ -1,28 +0,0 @@
-var chalk = require('chalk'),
-    Q = require('q'),
-    npm  = require('npm'),
-    Constants = require('../Constants'),
-    path = require('path');
-
-module.exports = function installNodeDependencies (properties /* { renderer, localDir } */) {            
-    var deferred = Q.defer(),
-        cwd = process.cwd();
-
-    properties.renderer.log(chalk.cyan('installing node dependencies'));
-
-    if(path.relative(cwd, properties.localDir)) {
-        process.chdir(properties.localDir);
-    }
-    npm.load(function (err) {
-        if(err) deferred.reject(err);
-
-        npm.commands.install(function () {
-            if(err) deferred.reject(err);
-
-            process.chdir(cwd);
-
-            deferred.resolve(properties);
-        });
-    });
-    return deferred.promise;
-};

package/lib/promise/removeTemporaryDownload.js

@@ -1,8 +0,0 @@
-var fs = require('q-io/fs');
-
-module.exports = function (properties) {
-    return fs.removeTree(properties.tmp)
-             .then(function () {
-                return properties;
-             });
-};

package/lib/promise/replaceTextContent.js

@@ -1,10 +0,0 @@
-var Q = require('q'),
-    fs = require('q-io/fs');
-
-module.exports = function (path, match, replacement) {
-    return fs.read(path)
-             .then(function (content) {
-                 var modifiedContent = content.replace(match, replacement);
-                 return fs.write(path, modifiedContent);
-             });
-};

package/lib/promise/uninstallPackage.js

@@ -1,15 +0,0 @@
-var bower = require('bower'),
-    Q = require('q');
-
-module.exports = function uninstall (plugin, config) {
-    var deferred = Q.defer();
-
-    bower.commands.uninstall([plugin.toString()], {}, config)
-    .on('end', function(uninstalled) {
-        uninstalled.hasOwnProperty(plugin.toString()) ? deferred.resolve() : deferred.reject();
-    })
-    .on('error', function (err) {
-        deferred.reject(err);
-    });
-    return deferred.promise;
-};

package/lib/promise/update.js

@@ -1,33 +0,0 @@
-var bower = require('bower'),
-    chalk = require('chalk'),
-    Q = require('q');
-
-module.exports = function update (plugin, options, config) {
-    var deferred = Q.defer();
-
-    function onSuccess() {
-        //console.log('onSuccess');
-        deferred.notify();
-        deferred.resolve({updated:true});
-    }
-
-    function onFail(err) {
-        console.log('onFail', err);
-        deferred.notify();
-        deferred.resolve({updated:false, error:err});
-    }
-
-    function onLog(obj) {
-        //console.log(chalk.cyan(obj.level), obj.id, obj.message);
-    }
-
-    try {
-        //console.log('UPDATE', plugin.packageName, config);
-        bower.commands.update([plugin.packageName], options, config).on('end', onSuccess).on('error', onFail).on('log', onLog);
-    } catch(err) {
-        console.log('bower update threw error');
-        onFail(err);
-    }
-
-    return deferred.promise;
-}

package/lib/promise/util.js

@@ -1,16 +0,0 @@
-var Q = require('q');
-
-module.exports = {
-    serialise: function (arr, iterator) {
-        // create a empty promise to start our series (so we can use `then`)
-        var currentPromise = Q();
-        var promises = arr.map(function (el) {
-            return currentPromise = currentPromise.then(function () {
-                // execute the next function after the previous has resolved successfully
-                return iterator(el)
-            })
-        });
-        // group the results and return the group promise
-        return Q.all(promises)
-    }
-};

package/test/fixtures/adapt-with-plugins.json

@@ -1,6 +0,0 @@
-{
-    "dependencies": {
-        "adapt-component" : "0.0.1",
-        "adapt-extension" : "0.0.2"
-    }
-}

package/test/specs/command_translation_concerns.js

@@ -1,13 +0,0 @@
-var mockery = require('mockery'),
-    sinon = require('sinon'),
-    expect = require('expect.js'),
-    CommandTranslator = require('../../lib/CommandTranslator');
-
-describe('Given I a list of parameters', function () {
-    describe('when I translate them', function () {
-        it('should translate -v to version', function () {
-            var parameters = [ '-v' ];
-            expect(CommandTranslator(parameters)[0]).to.be('version');
-        });
-    });
-});

package/test/specs/create_command_concerns.js

@@ -1,22 +0,0 @@
-var mockery = require('mockery'),
-    sinon = require('sinon'),
-    expect = require('expect.js'),
-    Q = require('q'),
-    Constants = require('../../lib/Constants'),
-    Project = require('../../lib/Project'),
-    Plugin = require('../../lib/Plugin'),
-    rimraf = require('rimraf');
-
-/* mockery is just too slow to run as a unit test
-describe('Given I have an create command', function () {
-    describe('when I create a course', function () {
-        it('should download the framework', function (done) {
-            var command = require('../../lib/commands/create');
-            command.create(console, 'course', './downloaded-files', 'develop', function () {
-                expect(false).to.be(true);
-                done();
-            });
-        });
-    });
-});
-*/

package/test/specs/create_concerns.js

@@ -1,30 +0,0 @@
-var sinon = require('sinon'),
-    expect = require('expect.js');
-    
-describe('Given I have an application', function () {
-    var AdaptConsoleApplication  = require('../../lib/AdaptConsoleApplication'),
-        CommandParser  = require('../../lib/CommandParser'),
-        createResult = {
-            success: true
-        },
-        commands = {
-            create: sinon.stub().yields(null, createResult)
-        },
-        outputDevice = {
-            log: sinon.stub()
-        },
-        argsv = function () {
-            return ['node', 'create-concerns.js'].concat(Array.prototype.slice.call(arguments));
-        },
-        app =  new AdaptConsoleApplication(commands, outputDevice);
-            
-    describe('when I execute a create command', function () {
-        it('should create the package', function (done) {
-            var create_command = new CommandParser(argsv('create', 'package-name'));
-            app.do(create_command, function (err, results) {
-                expect(commands.create.calledWith(outputDevice, 'package-name')).to.be(true);
-                done();
-            });
-        });
-    });
-});

package/test/specs/install_concerns.js

@@ -1,31 +0,0 @@
-var sinon = require('sinon'),
-    expect = require('expect.js');
-    
-describe('Given I have an application', function () {
-    var AdaptConsoleApplication  = require('../../lib/AdaptConsoleApplication'),
-        CommandParser  = require('../../lib/CommandParser'),
-        installResult = {
-            success: true
-        },
-        commands = {
-            install: sinon.stub().yields(null, installResult)
-        },
-        outputDevice = {
-            log: sinon.stub()
-        },
-        argsv = function () {
-            return ['node', 'search-concerns.js'].concat(Array.prototype.slice.call(arguments));
-        },
-        app =  new AdaptConsoleApplication(commands, outputDevice);
-            
-    describe('when I execute an install command for an existing package', function () {
-        it('should install the package', function (done) {
-            var install_command = new CommandParser(argsv('install', 'package-name'));
-            app.do(install_command, function (err, results) {
-                expect(commands.install.calledWith(outputDevice, 'package-name')).to.be(true);
-                done();
-            });
-        });
-    });
-    
-});

package/test/specs/installing_compatible_plugins_concerns.js

@@ -1,126 +0,0 @@
-var fs = require('fs'),
-    sinon = require('sinon'),
-    expect = require('expect.js'),
-    Project = require('../../lib/Project'),
-    RendererHelpers = require('../../lib/RendererHelpers'),
-    Q = require('q');
-
-describe('Given that I have Adapt Framework version 2', function () {
-    describe('When I install a plugin that is tagged as compatible with Adapt V2 framework version', function () {
-        before(function () {
-            fs.writeFileSync('./adapt.json', JSON.stringify(require('../fixtures/adapt.json')));
-        });
-
-        it('should install it', function (done) {
-
-            var context = createContext({
-                pluginCompatibility: '~2.0.0',
-                frameworkVersion: '2.0.0'
-            });
-
-            var installCommand = require('../../lib/commands/install')(context);
-
-            installCommand.install(context.renderer, 'plugin', function () {
-                expect(context.install.called).to.be(true);
-                done();
-            });
-        });
-
-        after(function() {
-            fs.unlinkSync('./adapt.json');
-            Project.prototype.getFrameworkVersion.restore();
-            RendererHelpers.reportCompatibilityWarning.restore();
-        });
-    });
-});
-
-describe('Given that I have Adapt Framework version 1.1.1 or earlier', function () {
-    describe('When I install a plugin that is tagged as compatible with Adapt V1.1 framework version', function () {
-        before(function () {
-            fs.writeFileSync('./adapt.json', JSON.stringify(require('../fixtures/adapt.json')));
-        });
-
-        it('should install it', function (done) {
-
-            var context = createContext({
-                pluginCompatibility: '1.1.1',
-                frameworkVersion: '1.1.1'
-            });
-
-            var installCommand = require('../../lib/commands/install')(context);
-
-            installCommand.install(context.renderer, 'plugin', function (err) {
-                expect(context.install.called).to.be(true);
-                done();
-            });
-        });
-
-        after(function() {
-            fs.unlinkSync('./adapt.json');
-            Project.prototype.getFrameworkVersion.restore();
-            RendererHelpers.reportCompatibilityWarning.restore();
-        });
-    });
-});
-
-describe('Given that I have Adapt Framework version 1.1.1 or earlier', function () {
-    describe('When I install a plugin that is NOT tagged', function () {
-        before(function () {
-            fs.writeFileSync('./adapt.json', JSON.stringify(require('../fixtures/adapt.json')));
-        });
-
-        it('should install it', function (done) {
-
-            var context = createContext({
-                pluginCompatibility: '*',
-                frameworkVersion: '1.1.1'
-            });
-
-            var installCommand = require('../../lib/commands/install')(context);
-
-            installCommand.install(context.renderer, 'plugin', function () {
-                expect(context.install.called).to.be(true);
-                done();
-            });
-        });
-
-        after(function() {
-            fs.unlinkSync('./adapt.json');
-            Project.prototype.getFrameworkVersion.restore();
-            RendererHelpers.reportCompatibilityWarning.restore();
-        });
-    });
-});
-
-function createContext(values) {
-    var getKeywordsSuccessfully = Q.defer(),
-        getFrameworkCompatibilitySuccessfully  = Q.defer(),
-        installSuccessfully = Q.defer();
-
-    getKeywordsSuccessfully.resolve('adapt-extension');
-    getFrameworkCompatibilitySuccessfully.resolve(values.pluginCompatibility);
-    installSuccessfully.resolve(true);
-
-    var warning = sinon.stub().yields();
-
-    var stubs = {
-        bower: {
-            commands: {
-                install: sinon.stub()
-            }
-        },
-        renderer: values.renderer || { log: sinon.stub() },
-        RendererHelpers: RendererHelpers,
-        Project: Project,
-        PackageMeta: {
-            getKeywords: sinon.stub().returns(getKeywordsSuccessfully.promise),
-            getFrameworkCompatibility: sinon.stub().returns(getFrameworkCompatibilitySuccessfully.promise)
-        },
-        install: sinon.stub().returns(installSuccessfully.promise),
-        warning: warning
-    };
-
-    sinon.stub(stubs.RendererHelpers, 'reportCompatibilityWarning').returns(warning);
-    sinon.stub(stubs.Project.prototype, 'getFrameworkVersion').returns(values.frameworkVersion);
-    return stubs;
-}

package/test/specs/installing_incompatible_plugins_concerns.js

@@ -1,103 +0,0 @@
-var fs = require('fs'),
-    sinon = require('sinon'),
-    expect = require('expect.js'),
-    Project = require('../../lib/Project'),
-    RendererHelpers = require('../../lib/RendererHelpers'),
-    Q = require('q');
-
-describe('Given that I have Adapt Framework version 2', function () {
-    describe('When I install a plugin that is tagged as incompatible with Adapt V2 framework version', function () {
-        before(function () {
-            fs.writeFileSync('./adapt.json', JSON.stringify(require('../fixtures/adapt.json')));
-        });
-
-        it('should warn that the plugin is incompatible', function (done) {
-
-            var context = createContext({
-                frameworkVersion: '2.0.0',
-                pluginCompatibility: '1.1.1'
-            });
-
-            var installCommand = require('../../lib/commands/install')(context);
-
-            installCommand.install(context.renderer, 'plugin', function (err) {
-                try {
-                    expect(RendererHelpers.reportCompatibilityWarning.called).to.be(true);
-                    done();
-                }
-                catch(ex) { done(ex); }
-            });
-        });
-
-        after(function() {
-            fs.unlinkSync('./adapt.json');
-            Project.prototype.getFrameworkVersion.restore();
-            RendererHelpers.reportCompatibilityWarning.restore();
-        });
-    });
-});
-
-describe('Given that I have Adapt Framework version 1.1.1 or earlier', function () {
-    describe('When I install a plugin that is tagged as compatible with Adapt V2 framework version', function () {
-        before(function () {
-            fs.writeFileSync('./adapt.json', JSON.stringify(require('../fixtures/adapt.json')));
-        });
-
-        it('should warn that the plugin is incompatible', function (done) {
-
-            var context = createContext({
-                frameworkVersion: '1.1.1',
-                pluginCompatibility: '>2.0.0'
-            });
-
-            var installCommand = require('../../lib/commands/install')(context);
-
-            installCommand.install(context.renderer, 'plugin', function (err) {
-                try {
-                    expect(RendererHelpers.reportCompatibilityWarning.called).to.be(true);
-                    done();
-                }
-                catch(ex) { done(ex); }
-            });
-        });
-
-        after(function() {
-            fs.unlinkSync('./adapt.json');
-            Project.prototype.getFrameworkVersion.restore();
-            RendererHelpers.reportCompatibilityWarning.restore();
-        });
-    });
-});
-
-function createContext(values) {
-    var getKeywordsSuccessfully = Q.defer(),
-        getFrameworkCompatibilitySuccessfully  = Q.defer(),
-        userAbandonsInstallation = Q.defer(),
-        installSuccessfully = Q.defer();
-
-    getKeywordsSuccessfully.resolve('adapt-extension');
-    getFrameworkCompatibilitySuccessfully.resolve(values.pluginCompatibility);
-    userAbandonsInstallation.resolve({ continueWithInstall: true });
-    installSuccessfully.resolve(true);
-
-    var stubs = {
-        bower: {
-            commands: {
-                install: sinon.stub()
-            }
-        },
-        renderer: { log: sinon.stub() },
-        RendererHelpers: RendererHelpers,
-        Project: Project,
-        PackageMeta: {
-            getKeywords: sinon.stub().returns(getKeywordsSuccessfully.promise),
-            getFrameworkCompatibility: sinon.stub().returns(getFrameworkCompatibilitySuccessfully.promise)
-        },
-        install: sinon.stub().returns(installSuccessfully.promise)
-    };
-
-    sinon.stub(stubs.RendererHelpers, 'reportCompatibilityWarning').returns(userAbandonsInstallation.promise);
-    sinon.stub(stubs.Project.prototype, 'getFrameworkVersion').returns(values.frameworkVersion);
-    return stubs;
-}
-

package/test/specs/ls_concerns.js

@@ -1,28 +0,0 @@
-var sinon = require('sinon'),
-    expect = require('expect.js');
-    
-describe('Given I have an application', function () {
-    var AdaptConsoleApplication  = require('../../lib/AdaptConsoleApplication'),
-        CommandParser  = require('../../lib/CommandParser'),
-        commands = {
-            ls: sinon.stub().yields()
-        },
-        outputDevice = {
-            log: sinon.stub()
-        },
-        argsv = function () {
-            return ['node', 'search-concerns.js'].concat(Array.prototype.slice.call(arguments));
-        },
-        app =  new AdaptConsoleApplication(commands, outputDevice);
-            
-    describe('when I execute an ls command for an existing package', function () {
-        it('should list the package', function (done) {
-            var ls_command = new CommandParser(argsv('ls'));
-            app.do(ls_command, function (err, results) {
-                expect(commands.ls.calledWith(outputDevice)).to.be(true);
-                done();
-            });
-        });
-    });
-    
-});