adapt-cli 2.1.11 → 3.0.0

package/lib/PackageMeta.js

@@ -1,41 +0,0 @@
-var bower = require('bower'),
-    Q = require('q');
-
-module.exports = {
-    getKeywords: function (plugin, config) {
-        var deferred = Q.defer();
-
-        bower.commands.info(plugin.toString(), 'keywords', config || {})
-             .on('end', function(results) {
-                deferred.resolve(results);
-             })
-             .on('error', function(err) {
-                deferred.reject(err);
-             });
-        return deferred.promise;
-    },
-    getFrameworkCompatibility: function (plugin, config) {
-        var deferred = Q.defer();
-        var allVersions = '*';
-
-        bower.commands.info(plugin.toString(), 'framework', config || {})
-             .on('end', function(results) {
-                deferred.resolve(results || allVersions);
-             })
-             .on('error', function() {
-                deferred.resolve(allVersions);
-             });
-        return deferred.promise;
-    },
-    getRepositoryUrl: function (plugin, config) {
-        var deferred = Q.defer();
-        bower.commands.lookup(plugin.name, config || {})
-            .on('end', function(results) {
-                deferred.resolve(results);
-            })
-            .on('error', function(err) {
-                deferred.reject(err);
-            });
-        return deferred.promise;
-    }
-};

package/lib/Plugin.js

@@ -1,53 +0,0 @@
-var slug = require('./Slug'),
-    endpointParser = require('bower-endpoint-parser'),
-    zero = '0.0.0',
-    any = '*';
-
-
-var Plugin = function(name, versionOrIsContrib, isContrib) {
-    this.name = name;
-
-    if(typeof isContrib === 'undefined') {
-        isContrib = false;
-    }
-    if(typeof versionOrIsContrib === 'undefined') {
-        isContrib = false;
-        this.version = any;
-    } else if(typeof versionOrIsContrib === 'boolean'){
-        isContrib = versionOrIsContrib;
-        this.version = any;
-    } else {
-        this.version = versionOrIsContrib === zero ? any : versionOrIsContrib;
-    }
-    this.packageName = makePackageName(name, isContrib);
-
-    Object.defineProperty(this, 'isContrib', {
-        get: function () {
-            return /^adapt-contrib/.test(this.packageName);
-        }
-    });
-};
-
-Plugin.prototype.toString = function() {
-    var version = '';
-    if(this.version !== any) {
-        version = '#'+ this.version;
-    }
-    return ''+this.packageName + version;
-};
-
-function makePackageName(name, isContrib) {
-    return (/^adapt-/i.test(name) ? '' : 'adapt-') + (!isContrib ? '' : 'contrib-') + slug(name);
-}
-
-Plugin.parse = function (endpoint) {
-    var ep = endpointParser.decompose(endpoint),
-        version = /^\*$/.test(ep.target) ? any : ep.target;
-    return new Plugin(ep.name || ep.source, version);
-};
-
-Plugin.compose = function (endpoint) {
-    return Plugin.parse(endpointParser.compose(endpoint));
-};
-
-module.exports = Plugin;

package/lib/PluginTypeResolver.js

@@ -1,47 +0,0 @@
-var PluginTypeResolver = function(types) {
-        this.types = types || [
-            {
-                pattern: /^adapt-component$/,
-                typename: 'component',
-                belongsTo: 'components'
-            },
-            {
-                pattern: /^adapt-extension$/,
-                typename: 'extension',
-                belongsTo: 'extensions'
-            },
-            {
-                pattern: /^adapt-menu$/,
-                typename: 'menu',
-                belongsTo: 'menu'
-            },
-            {
-                pattern: /^adapt-theme$/,
-                typename: 'theme',
-                belongsTo: 'theme'
-            }
-        ];
-        this.defaultType = this.types[0];
-};
-PluginTypeResolver.prototype.resolve = function (keywords) {
-    keywords = Array.isArray(keywords) ? keywords : [keywords];
-
-    var types = keywords.map(toType(this.types))
-                        .filter(NonMatchingKeywords);
-
-    return  (types.length ? types[0] : this.defaultType);
-};
-module.exports = PluginTypeResolver;
-
-function toType(types) {
-    return function (keyword) {
-        var typematches = types.filter(function (type) {
-            return type.pattern.test(keyword);
-        });
-        if(typematches.length) return typematches[0];
-    }
-}
-
-function NonMatchingKeywords(item) {
-    return item !== undefined
-}

package/lib/Project.js

@@ -1,89 +0,0 @@
-var Plugin = require('./Plugin'),
-    fs = require('fs'),
-    _ = require('lodash'),
-    JsonLoader = require('./JsonLoader'),
-    JsonWriter = require('./JsonWriter'),
-    chalk = require('chalk'),
-    renderer =  require('./ConsoleRenderer'),
-    EmptyProject = function (){
-        return {
-            dependencies: {}
-        };
-    };
-    EmptyPackage = function () {
-        return { "version": "0.0.0" };
-    };
-
-var Project = function (manifestFilePath, frameworkPackagePath) {
-    this.manifestFilePath = manifestFilePath;
-    this.frameworkPackagePath = frameworkPackagePath;
-    Object.defineProperty(this, 'plugins', {
-        get: function () {
-            var manifest = parse(this.manifestFilePath);
-            return _.toPairs(manifest.dependencies)
-                    .map(function (pair) {
-                        return new Plugin(pair[0], pair[1]);
-                    });
-        }.bind(this)
-    });
-};
-
-Project.prototype.add = function (plugin) {
-    if(typeof Plugin !== 'object' && plugin.constructor !== Plugin) {
-        plugin = new Plugin(plugin);
-    }
-    var manifest;
-    if(this.isProjectContainsManifestFile()) {
-        manifest = parse(this.manifestFilePath);
-    } else {
-        manifest = EmptyProject();
-    }
-    manifest.dependencies[plugin.packageName] = plugin.version;
-    save(this.manifestFilePath, manifest);
-};
-
-Project.prototype.remove = function (plugin) {
-    if(typeof Plugin !== 'object' && plugin.constructor !== Plugin) {
-        plugin = new Plugin(plugin);
-    }
-    var manifest = parse(this.manifestFilePath);
-    delete manifest.dependencies[plugin.packageName];
-    save(this.manifestFilePath, manifest);
-};
-
-Project.prototype.getFrameworkVersion = function () {
-    return parsePackage(this.frameworkPackagePath).version;
-};
-
-Project.prototype.isProjectContainsManifestFile = function() {
-    return fs.existsSync(this.manifestFilePath);
-};
-
-function parse(manifestFilePath) {
-    if(!manifestFilePath) return EmptyProject();
-
-    return JsonLoader.readJSONSync(manifestFilePath);
-}
-
-function parsePackage(frameworkPackagePath) {
-    var EmptyPackage = function () {
-        return { "version": "0.0.0" }
-    };
-
-    if(!frameworkPackagePath) return EmptyPackage();
-
-    try {
-        return JsonLoader.readJSONSync(frameworkPackagePath);
-    }
-    catch (ex) {
-        return EmptyPackage();
-    }
-}
-
-function save(manifestFilePath, manifest) {
-    if(manifestFilePath) {
-        JsonWriter.writeJSONSync(manifestFilePath, manifest);
-    }
-}
-
-module.exports = Project;

package/lib/RendererHelpers.js

@@ -1,51 +0,0 @@
-var chalk = require('chalk'),
-    prompt = require('prompt'),
-    Q = require('q');
-
-module.exports = {
-    reportCompatibilityWarning : function (renderer, plugin) {
-        renderer.log(chalk.yellow('The plugin'), chalk.white(plugin), chalk.yellow('is not compatible with this version of Adapt.', 'Installing it may cause unexpected behaviour.'));
-        return confirm(plugin);
-    },
-    reportFailure : function (renderer, done) {
-        return function (err) {
-            renderer.log(chalk.red('Oh dear, something went wrong.'), err.message);
-            done(err);
-        };
-    },
-    reportInvalidFrameworkDirectory : function (renderer, done) {
-        return function (err) {
-            renderer.log(chalk.red('Fatal error: please run above commands in adapt course directory.'));
-            done(err);
-        };
-    },
-};
-
-function confirm(plugin) {
-    var deferred = Q.defer();
-    var schema = {
-            properties: {
-                continueWithInstall: {
-                    description: 'Install this plugin anyway?',
-                    message: 'Please specify (y)es or (n)o',
-                    pattern: /^y$|^n$/i,
-                    type: 'string',
-                    default: 'n',
-                    required: true,
-                    before: function(value) { return /^y$/i.test(value); }
-                }
-            }
-        };
-    prompt.message = chalk.cyan('Confirm');
-    prompt.delimiter = ' ';
-    prompt.start();
-    prompt.get(schema, function (err, properties) {
-        if(err) return deferred.reject(err);
-
-        deferred.resolve({
-            plugin: plugin,
-            continueWithInstall: properties.continueWithInstall
-        });
-    });
-    return deferred.promise;
-}

package/lib/RepositoryDownloader.js

@@ -1,64 +0,0 @@
-var Constants = require('./Constants'),
-    urljoin = require('url-join'),
-    path = require('path'),
-    Q = require('q');
-
-var RepositoryDownloader = function(options) {
-    if (!options.branch && !options.repository)
-        throw new Error('Repository details are required.');
-    this.options = options;
-
-    Object.defineProperty(this, 'url', {
-        get: function() {
-            return urljoin(this.options.repository, 'archive', this.options.branch + '.zip');
-        }
-    });
-};
-
-RepositoryDownloader.prototype.fetch = function(destination) {
-    var deferred = Q.defer(),
-        download = require('download'),
-        previousPercent = 0,
-        fileName = '';
-
-    download(this.url, destination, {
-        extract: true
-    })
-    .on('response', function (response) {
-        fileName = getFileName(response.headers['content-disposition']);
-    })
-    .on('downloadProgress', function(progress) {
-        var state = {
-            receivedSize: progress.transferred,
-            percent: Math.round(progress.transferred / progress.total * 100)
-        };
-        
-        if(state.percent > previousPercent) {
-            previousPercent = state.percent;
-            deferred.notify(state, progress);
-        }
-    })
-    .on('error', function(err) {
-        deferred.reject(err);
-    })
-    .then(function() {
-        deferred.resolve(fileName);
-    });
-
-    return deferred.promise;
-};
-
-function getFileName(disposition) {
-    var fileName = "";
-    if (disposition && disposition.indexOf('attachment') !== -1) {
-        var regex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/;
-        var matches = regex.exec(disposition);
-        if (matches != null && matches[1]) {
-            fileName = matches[1].replace(/['"]/g, '');
-        }
-    }
-    return fileName;
-}
-
-module.exports = RepositoryDownloader;
-

package/lib/Slug.js

@@ -1,5 +0,0 @@
-var slug = require('speakingurl');
-module.exports = function (name) {
-
-    return slug(name, { maintainCase: true })
-};

package/lib/VersionChecker.js

@@ -1,7 +0,0 @@
-var semver = require('semver');
-
-module.exports = {
-    assertVersionCompatibility: function (adaptVersion, compatibleVersionRange) {
-        return semver.satisfies(adaptVersion, compatibleVersionRange);
-    }
-};

package/lib/commands/create/index.js

@@ -1,6 +0,0 @@
-var chalk = require('chalk');
-
-module.exports = {
-    "course": require('./course'),
-    "component": require('./component')
-};

package/lib/commands/index.js

@@ -1,16 +0,0 @@
-var _ = require('lodash'),
-    fs = require('fs'),
-    commands = {},
-    files = fs.readdirSync(__dirname);
-
-module.exports = files.filter(excludeIndex).reduce(function (commands, filename) {
-    var useDefaultDependencies = {},
-        command = require('./' + filename);
-
-    if(typeof command === 'function') command = command(useDefaultDependencies);
-    return _.extend(commands, command);
-}, {});
-
-function excludeIndex (filename) {
-    return !/^index.js$/.test(filename);
-}

package/lib/commands/install/InstallLog.js

@@ -1,32 +0,0 @@
-var readline = require('readline');
-
-var isLoggingProgress = false;
-var lastProgressStr = '';
-
-module.exports = {
-    logProgress:function(str) {
-        lastProgressStr = str;
-        isLoggingProgress = true;
-        readline.cursorTo(process.stdout, 0);
-        process.stdout.write(str);
-    },
-
-    logProgressConclusion(str) {
-        lastProgressStr = str;
-        isLoggingProgress = false;
-        readline.cursorTo(process.stdout, 0);
-        process.stdout.write(str);
-        process.stdout.write('\n');
-    },
-
-    log:function() {
-        if (isLoggingProgress) {
-            readline.clearLine(process.stdout, 0);
-            readline.cursorTo(process.stdout, 0);
-            console.log.apply(console, arguments);
-            this.logProgress(lastProgressStr);
-        } else {
-            console.log.apply(console, arguments);
-        }
-    }
-}

package/lib/commands/install/InstallTarget.js

@@ -1,259 +0,0 @@
-var bower = require('bower'),
-    _ = require('lodash'),
-    Q = require('q'),
-    readline = require('readline'),
-    endpointParser = require('bower-endpoint-parser'),
-    semver = require('semver'),
-    Plugin = require('../../Plugin'),
-    InstallLog = require('./InstallLog'),
-    Constants = require('../../Constants'),
-    extend = require('./extend');
-
-var any = '*';
-var BOWER_MAX_TRY = 5;
-
-var InstallTarget = extend(Plugin, {
-
-    constructor: function(name, requestedVersion, isCompatibleEnabled) {
-        var endpoint = name+'#'+(isCompatibleEnabled ? any : requestedVersion),
-            ep = endpointParser.decompose(endpoint),
-            version = /^\*$/.test(ep.target) ? any : ep.target,
-            proposal;
-
-        Plugin.call(this, ep.name || ep.source, version);
-
-        if (this.version !== any) {
-            proposal = this.version;
-            this._isConstrained = true;
-            this.version = semver.validRange(proposal);
-
-            if (!this.version) {
-                throw new Error(this.packageName+' "'+proposal+'" is not a valid constraint');
-            }
-        }
-
-        // the constraint given by the user
-        this._requestedVersion = requestedVersion;
-        // the result of the current query to the server
-        this._rawInfo = undefined;
-        // information about a particular version of the plugin
-        this._versionInfo = undefined;
-        // the number of attempts made to query the server
-        this._bowerCmdCount = 0;
-        // a list of tags denoting the versions of the plugin
-        this._versions = undefined;
-        // an index denoting which version is being queried
-        this._versionIndex = 0;
-        // whether querying the server for plugin information failed at all
-        this._isMissingAtRepo = false;
-        // the most recent version of the plugin compatible with the given framework
-        this._latestCompatibleVersion = undefined;
-        // the most recent version of the plugin
-        this._latestVersion = undefined;
-        // whether the user supplied a constraint that is not supported by the plugin
-        this._isBadConstraint = false;
-        // whether the constraint has been checked for compatibility
-        this._constraintChecked = false;
-        // a non-wildcard constraint resolved to the highest version of the plugin that satisfies the constraint and is compatible with the framework
-        this._resolvedConstraint = undefined;
-        // the version to be installed
-        this._versionToInstall = undefined;
-    },
-
-    getInitialInfo: function() {
-        return this.getInfo().then(_.bind(processInfo, this));
-
-        function processInfo() {
-            if (!this._isMissingAtRepo) {
-                this._latestVersion = this._versionInfo.version;
-
-                if (this._rawInfo.versions) {
-                    this._versions = this._rawInfo.versions;
-                    if (this._versions.length > 0) {
-                        // check if the user supplied a constraint that cannot be met
-                        this._isBadConstraint = semver.maxSatisfying(this._versions, this.version) === null;
-                    }
-                }
-            }
-        }
-    },
-
-    getInfo: function(deferred) {
-        // presence of deferred signifies a retry
-        if (!deferred) this._bowerCmdCount = 0;
-
-        deferred = deferred || Q.defer();
-
-        try {
-            var versionString = this._versions ? '#'+this._versions[this._versionIndex] : '';
-            this._bowerCmdCount++;
-            bower.commands.info(this.packageName+versionString, null, {registry:Constants.getRegistry(), cwd: Constants.cwd}).on('end', _.bind(onSuccess, this)).on('error', _.bind(onFail, this));
-        } catch(err) {
-            onFail.call(this, err);
-        }
-
-        function onSuccess(results) {
-            this._rawInfo = results;
-            this._versionInfo = results.latest || results;
-            deferred.notify();
-            deferred.resolve(results);
-        }
-
-        function onFail() {
-            if (this._bowerCmdCount < BOWER_MAX_TRY) {
-                this.getInfo(deferred);
-            } else {
-                this._isMissingAtRepo = true;
-                deferred.notify();
-                deferred.resolve();
-            }
-        }
-
-        return deferred.promise;
-    },
-
-    findCompatibleVersion: function(framework) {
-        if (this._isMissingAtRepo) return Q.resolve();
-
-        // check if the latest version is compatible
-        if (semver.satisfies(framework, this._versionInfo.framework)) {
-            this._latestCompatibleVersion = this._versionInfo.version || '*';
-            return Q.resolve();
-        }
-
-        // if the plugin has no tags then there are no other versions to check
-        if (!this._versions || this._versions.length == 0) return Q.resolve();
-
-        this._versionIndex = 0;
-
-        return this.checkProposedVersion(framework);
-    },
-
-    checkConstraint: function(framework) {
-        // check that the plugin exists
-        if (this._isMissingAtRepo) {
-            this._constraintChecked = true;
-            //InstallLog.log(this.packageName, 'cannot resolve constraint due to missing info');
-            return Q.resolve();
-        }
-
-        // check that there are other versions to be considered
-        if (!this._versions || this._versions.length == 0) {
-            this._constraintChecked = true;
-            //InstallLog.log(this.packageName, 'cannot resolve constraint because there are no tags');
-            return Q.resolve();
-        }
-
-        // check that a valid constraint exists
-        if (this.version == any || this._isBadConstraint) {
-            this._constraintChecked = true;
-            //InstallLog.log(this.packageName, 'cannot resolve constraint because a valid constraint has not been given');
-            return Q.resolve();
-        }
-
-        this._versionIndex = 0;
-
-        return this.getInfo().then(_.bind(function() {
-            return this.checkConstraintCompatibility(framework);
-        }, this));
-    },
-
-    // find the highest version that satisfies the constraint and is compatible with the framework
-    checkConstraintCompatibility: function(framework, deferred) {
-        deferred = deferred || Q.defer();
-
-        // give up if there is any failure to obtain version info
-        if (this._isMissingAtRepo) {
-            this._constraintChecked = true;
-            //InstallLog.log(this.packageName, 'cannot resolve constraint due to missing info');
-            deferred.notify();
-            deferred.resolve();
-            return deferred.promise;
-        }
-
-        //InstallLog.log(this.packageName, 'checking', this._versionInfo.version, 'against', this.version, 'framework', framework);
-
-        // check if the version satisfies the constraint and whether the version is compatible
-        if (semver.satisfies(this._versionInfo.version, this.version) && semver.satisfies(framework, this._versionInfo.framework)) {
-            this._resolvedConstraint = this._versionInfo.version;
-            this._constraintChecked = true;
-            //InstallLog.log(this.packageName, 'resolved constraint to', this._resolvedConstraint);
-            deferred.notify();
-            deferred.resolve();
-        } else {
-            if (this._versionIndex + 1 < this._versions.length) {
-                this._versionIndex++;
-
-                this.getInfo().then(_.bind(function() {
-                    return this.checkConstraintCompatibility(framework, deferred);
-                }, this));
-
-            } else {
-                this._resolvedConstraint = null;
-                this._constraintChecked = true;
-                //InstallLog.log(this.packageName, 'cannot resolve constraint');
-                deferred.notify();
-                deferred.resolve();
-            }
-        }
-
-        return deferred.promise;
-    },
-
-    // find the highest version that is compatible with the framework
-    checkProposedVersion: function(framework, deferred) {
-        deferred = deferred || Q.defer();
-
-        // give up if there is any failure to obtain version info
-        if (this._isMissingAtRepo) {
-            this._latestCompatibleVersion = null;
-            deferred.notify();
-            deferred.resolve();
-            return deferred.promise;
-        }
-
-        // check that the proposed plugin is compatible with the installed framework
-        if (semver.satisfies(framework, this._versionInfo.framework)) {
-            this._latestCompatibleVersion = this._versionInfo.version;
-            deferred.notify();
-            deferred.resolve();
-        } else {
-            if (this._versionIndex + 1 < this._versions.length) {
-                this._versionIndex++;
-
-                this.getInfo().then(_.bind(function() {
-                    this.checkProposedVersion(framework, deferred);
-                }, this));
-
-            } else {
-                this._latestCompatibleVersion = null;
-                deferred.notify();
-                deferred.resolve();
-            }
-        }
-
-        return deferred.promise;
-    },
-
-    markRequestedForInstallation:function() {
-        if (this._resolvedConstraint != undefined && this._resolvedConstraint != null) {
-            this._versionToInstall = this._resolvedConstraint;
-        } else {
-            this._versionToInstall = semver.maxSatisfying(this._versions, this.version);
-        }
-    },
-
-    markLatestCompatibleForInstallation:function() {
-        this._versionToInstall = this._latestCompatibleVersion;
-    },
-
-    markLatestForInstallation:function() {
-        this._versionToInstall = this._latestVersion;
-    },
-
-    logToConsole:function() {
-        console.log(this.packageName, this.version, this._versionInfo ? this._versionInfo.framework : 'missing');
-    }
-});
-
-module.exports = InstallTarget;