Remove deprecated modules

Author: SBoudrias

lib/actions/file.js

@@ -62,8 +62,8 @@ function formatArg(argItem) {
 }
 
 /**
- * Output usage information for this given generator, depending on its arguments,
- * options or hooks.
+ * Output usage information for this given generator, depending on its arguments
+ * or options.
  */
 
 help.usage = function usage() {
@@ -125,16 +125,7 @@ help.optionsHelp = function optionsHelp() {
     return el.hide;
   });
 
-  var hookOpts = this._hooks.map(function (hook) {
-    return hook.generator && hook.generator._options;
-  }).reduce(function (a, b) {
-    a = a.concat(b);
-    return a;
-  }, []).filter(function (opts) {
-    return opts && opts.name !== 'help';
-  });
-
-  var rows = options.concat(hookOpts).map(function (opt) {
+  var rows = options.map(function (opt) {
     var defaults = opt.default;
 
     return [

lib/actions/help.js

@@ -4,8 +4,6 @@ var path = require('path');
 var events = require('events');
 var assert = require('assert');
 var _ = require('lodash');
-var _s = require('underscore.string');
-var async = require('async');
 var findUp = require('find-up');
 var readPkgUp = require('read-pkg-up');
 var chalk = require('chalk');
@@ -16,32 +14,25 @@ var through = require('through2');
 var userHome = require('user-home');
 var GruntfileEditor = require('gruntfile-editor');
 var FileEditor = require('mem-fs-editor');
-var wiring = require('html-wiring');
 var pathIsAbsolute = require('path-is-absolute');
 var pathExists = require('path-exists');
 var Conflicter = require('./util/conflicter');
 var Storage = require('./util/storage');
-var deprecate = require('./util/deprecate');
 var promptSuggestion = require('./util/prompt-suggestion');
 var debug = require('debug')('yeoman:generator');
 
 /**
  * The `Base` class provides the common API shared by all generators.
- * It define options, arguments, hooks, file, prompt, log, API, etc.
+ * It define options, arguments, file, prompt, log, API, etc.
  *
  * It mixes into its prototype all the methods found in the `actions/` mixins.
  *
  * Every generator should extend this base class.
  *
  * @constructor
  * @mixes actions/actions
- * @mixes actions/fetch
- * @mixes actions/file
  * @mixes actions/install
- * @mixes actions/invoke
  * @mixes actions/spawn_command
- * @mixes actions/string
- * @mixes actions/remote
  * @mixes actions/user
  * @mixes actions/help
  * @mixes nodejs/EventEmitter
@@ -79,7 +70,6 @@ var Base = module.exports = function Base(args, options) {
   this._args = args || [];
   this._options = {};
   this._arguments = [];
-  this._hooks = [];
   this._composedWith = [];
   this._transformStreams = [];
 
@@ -140,19 +130,6 @@ var Base = module.exports = function Base(args, options) {
     this.destinationRoot(rootPath);
   }
 
-  var deprecatedFileUtils = deprecate.log.bind(null, [
-    '#src() and #dest() are deprecated. Please read the documentation to learn about',
-    'the new ways of handling files. http://yeoman.io/authoring/file-system.html'
-  ].join('\n'));
-
-  Object.defineProperty(this, 'src', { get: deprecatedFileUtils });
-  Object.defineProperty(this, 'dest', { get: deprecatedFileUtils });
-  Object.defineProperty(this, '_', {
-    get: deprecate.log.bind(null, [
-      '#_ is deprecated. Require your own version of', chalk.cyan('Lodash'), 'or', chalk.cyan('underscore.string')
-    ].join(' '))
-  });
-
   this.appname = this.determineAppname();
   this.config = this._getStorage();
   this._globalConfig = this._getGlobalStorage();
@@ -192,36 +169,10 @@ util.inherits(Base, events.EventEmitter);
 
 // Mixin the actions modules
 _.extend(Base.prototype, require('./actions/actions'));
-_.extend(Base.prototype, require('./actions/file'));
 _.extend(Base.prototype, require('./actions/install'));
 _.extend(Base.prototype, require('./actions/help'));
 _.extend(Base.prototype, require('./actions/spawn_command'));
-
-// Deprecated modules and functions
-_.extend(Base.prototype, deprecate.object('this.<%= name %>() is deprecated. Use require("html-wiring").<%= name %>() instead.', wiring));
-var deprecatedRemote = function () {
-  deprecate.log('Remotes functions are deprecated. See https://github.com/yeoman/generator/issues/949 for update guide.');
-};
-Base.prototype.remote = deprecatedRemote;
-Base.prototype.remoteDir = deprecatedRemote;
-Base.prototype.fetch = deprecatedRemote;
-Base.prototype.extract = deprecatedRemote;
-Base.prototype.tarball = deprecatedRemote;
-
 Base.prototype.user = require('./actions/user');
-Base.prototype.invoke = deprecate(
-  'generator#invoke() is deprecated. Use generator#composeWith() - see http://yeoman.io/authoring/composability.html',
-  require('./actions/invoke')
-);
-
-// TODO: Remove before 1.0.0
-// DEPRECATED: Use the module directly
-Base.prototype.welcome = deprecate(
-  'Generator#welcome() is deprecated. Instead, `require("yeoman-welcome")` directly.',
-  function () {
-    console.log(require('yeoman-welcome'));
-  }
-);
 
 /**
  * Prompt user to answer questions. The signature of this method is the same as {@link https://github.com/SBoudrias/Inquirer.js Inquirer.js}
@@ -498,110 +449,10 @@ Base.prototype.run = function run(cb) {
     }.bind(this));
   }.bind(this));
 
-  this.on('end', function () {
-    debug('Running the hooked generators');
-    this.runHooks();
-  });
-
   _.invokeMap(this._composedWith, 'run');
   return this;
 };
 
-/**
- * Goes through all registered hooks, invoking them in series.
- *
- * @param {Function} [cb]
- */
-
-Base.prototype.runHooks = function runHooks(cb) {
-  cb = _.isFunction(cb) ? cb : function () {};
-
-  var setupInvoke = function (hook) {
-    var resolved = this.defaultFor(hook.name);
-    var options = _.clone(hook.options || this.options);
-    options.args = _.clone(hook.args || this.args);
-
-    return function (next) {
-      this.invoke(resolved + (hook.as ? ':' + hook.as : ''), options, next);
-    }.bind(this);
-  }.bind(this);
-
-  async.series(this._hooks.map(setupInvoke), cb);
-  return this;
-};
-
-/**
- * Registers a hook to invoke when this generator runs.
- *
- * A generator with a namespace based on the value supplied by the user
- * to the given option named `name`. An option is created when this method is
- * invoked and you can set a hash to customize it.
- *
- * Must be called prior to running the generator (shouldn't be called within
- * a generator "step" - top-level methods).
- *
- * ### Options:
- *
- *   - `as`      The context value to use when runing the hooked generator
- *   - `args`    The array of positional arguments to init and run the generator with
- *   - `options` An object containing a nested `options` property with the hash of options
- *               to use to init and run the generator with
- *
- * ### Examples:
- *
- *     // $ yo webapp --test-framework jasmine
- *     this.hookFor('test-framework');
- *     // => registers the `jasmine` hook
- *
- *     // $ yo mygen:subgen --myargument
- *     this.hookFor('mygen', {
- *       as: 'subgen',
- *       options: {
- *         options: {
- *           'myargument': true
- *         }
- *       }
- *     }
- *
- * @deprecated use `#composeWith()` instead.
- * @param {String} name
- * @param {Object} config
- */
-
-Base.prototype.hookFor = deprecate(
-  'generator#hookFor() is deprecated. Use generator#composeWith() - see http://yeoman.io/authoring/composability.html',
-  function (name, config) {
-    config = config || {};
-
-    // enforce use of hookFor during instantiation
-    assert(!this._running, 'hookFor can only be used inside the constructor function');
-
-    // add the corresponding option to this class, so that we output these hooks
-    // in help
-    this.option(name, {
-      desc: _s.humanize(name) + ' to be invoked',
-      default: this.options[name] || ''
-    });
-
-    this._hooks.push(_.defaults(config, {
-      name: name
-    }));
-
-    return this;
-  }
-);
-
-/**
- * Return the default value for the option name.
- *
- * @deprecated
- * @param {String} name
- */
-
-Base.prototype.defaultFor = function defaultFor(name) {
-  return this.options[name] || name;
-};
-
 /**
  * Compose this generator with another one.
  * @param  {String} namespace  The generator namespace to compose with

lib/actions/invoke.js

@@ -4,7 +4,6 @@
 
 'use strict';
 var Environment = require('yeoman-environment');
-var deprecate = require('./util/deprecate');
 
 /**
  * The generator system is a framework for node to author reusable and
@@ -41,59 +40,3 @@ var yeoman = module.exports = function createEnv() {
 // hoist up top level class the generator extend
 yeoman.Base = require('./base');
 yeoman.NamedBase = require('./named-base');
-
-deprecate.property(
-  'NamedBase constructor is deprecated. See https://github.com/yeoman/generator/issues/882',
-  yeoman,
-  'NamedBase'
-);
-
-/**
- * Test helpers
- * {@link module:test/helpers}
- */
-Object.defineProperty(yeoman, 'test', {
-  get: function () {
-    deprecate.log('yeoman.test is deprecated. Instead `require(\'yeoman-test\')`.');
-    return require('yeoman-test');
-  }
-});
-
-/**
- * Test assertions helpers
- * {@link https://github.com/yeoman/yeoman-assert}
- */
-yeoman.assert = require('yeoman-assert');
-deprecate.property(
-  'yeoman.assert is deprecated. Instead `require(\'yeoman-assert\')`. See https://github.com/yeoman/generator/issues/883',
-  yeoman,
-  'assert'
-);
-
-/**
- * Yeoman base's generators
- * @enum generators
- */
-yeoman.generators = {
-  /**
-   * Base Generator
-   * {@link Base}
-   */
-  Base: yeoman.Base,
-
-  /**
-   * Named Base Generator
-   * {@link NamedBase}
-   */
-  NamedBase: require('./named-base')
-};
-deprecate.property(
-  'require(\'yeoman-generator\').generators.Base is deprecated. Use require(\'yeoman-generator\').Base directly',
-  yeoman.generators,
-  'Base'
-);
-deprecate.property(
-  'NamedBase constructor is deprecated. See https://github.com/yeoman/generator/issues/882',
-  yeoman.generators,
-  'NamedBase'
-);

lib/base.js

@@ -13,7 +13,7 @@ var _ = require('lodash');
  * @param {String} configPath The filepath used as a storage.
  *
  * @example
- * var MyGenerator = yeoman.generators.base.extend({
+ * var MyGenerator = yeoman.base.extend({
  *   config: function() {
  *     this.config.set('coffeescript', false);
  *   }
@@ -58,16 +58,6 @@ Storage.prototype.save = function () {
   this._persist(this._store());
 };
 
-/**
- * Alias to save.
- * @deprecated don't use save yourself.
- * @return {null}
- */
-
-Storage.prototype.forceSave = function () {
-  this.save();
-};
-
 /**
  * Get a stored value
  * @param  {String} key  The key under which the value is stored.

lib/index.js

@@ -46,7 +46,6 @@
     "github-username": "^2.0.0",
     "glob": "^7.0.3",
     "gruntfile-editor": "^1.0.0",
-    "html-wiring": "^1.0.0",
     "istextorbinary": "^2.1.0",
     "lodash": "^4.11.1",
     "mem-fs-editor": "^2.0.0",
@@ -62,12 +61,8 @@
     "shelljs": "^0.7.0",
     "text-table": "^0.2.0",
     "through2": "^2.0.0",
-    "underscore.string": "^3.0.3",
     "user-home": "^2.0.0",
-    "yeoman-assert": "^2.0.0",
-    "yeoman-environment": "^1.1.0",
-    "yeoman-test": "^1.0.0",
-    "yeoman-welcome": "^1.0.0"
+    "yeoman-environment": "^1.1.0"
   },
   "devDependencies": {
     "gulp": "^3.6.0",
@@ -85,6 +80,8 @@
     "pinkie-promise": "^2.0.0",
     "proxyquire": "^1.0.0",
     "sinon": "^1.9.1",
-    "tui-jsdoc-template": "^1.0.4"
+    "tui-jsdoc-template": "^1.0.4",
+    "yeoman-assert": "^2.0.0",
+    "yeoman-test": "^1.0.0"
   }
 }

lib/util/storage.js

@@ -294,21 +294,4 @@ describe('generators.Base (actions/actions)', function () {
       this.dummy.conflicter.resolve(done);
     });
   });
-
-  describe('#expandFiles()', function () {
-    before(function (done) {
-      this.dummy.copy('foo.js', 'write/abc/abc.js');
-      this.dummy._writeFiles(done);
-    });
-
-    it('returns expand files', function () {
-      var files = this.dummy.expandFiles('write/abc/**');
-      assert.deepEqual(files, ['write/abc/abc.js']);
-    });
-
-    it('returns expand files', function () {
-      var files = this.dummy.expandFiles('abc/**', { cwd: './write' });
-      assert.deepEqual(files, ['abc/abc.js']);
-    });
-  });
 });

package.json

@@ -39,20 +39,6 @@ describe('generators.Base', function () {
       exec: sinon.spy()
     });
 
-    this.env.registerStub(this.Dummy, 'ember:all');
-    this.env.registerStub(this.Dummy, 'hook1:ember');
-    this.env.registerStub(this.Dummy, 'hook2:ember:all');
-    this.env.registerStub(this.Dummy, 'hook3');
-
-    this.env.registerStub(generators.Base.extend({
-      writing: function () {
-        this.fs.write(
-          path.join(tmpdir, 'app/scripts/models/application-model.js'),
-          '// ...'
-        );
-      }
-    }), 'hook4');
-
     this.dummy = new this.Dummy(['bar', 'baz', 'bom'], {
       foo: false,
       something: 'else',
@@ -62,12 +48,6 @@ describe('generators.Base', function () {
       env: this.env,
       'skip-install': true
     });
-
-    this.dummy
-      .hookFor('hook1', { as: 'ember' })
-      .hookFor('hook2', { as: 'ember:all' })
-      .hookFor('hook3')
-      .hookFor('hook4');
   });
 
   describe('constructor', function () {
@@ -708,49 +688,6 @@ describe('generators.Base', function () {
     });
   });
 
-  describe('#runHooks()', function () {
-    it('go through all registered hooks, and invoke them in series', function (done) {
-      this.dummy.runHooks(function () {
-        fs.stat('app/scripts/models/application-model.js', done);
-      });
-    });
-  });
-
-  describe('#hookFor()', function () {
-    it('emit errors if called when running', function () {
-      try {
-        this.dummy.hookFor('maoow');
-      } catch (err) {
-        assert.equal(err.message, 'hookFor must be used within the constructor only');
-      }
-    });
-
-    it('create the matching option', function () {
-      this.dummy._running = false;
-      this.dummy.hookFor('something');
-
-      assert.deepEqual(this.dummy._options.something, {
-        desc: 'Something to be invoked',
-        name: 'something',
-        type: Boolean,
-        default: 'else',
-        hide: false
-      });
-    });
-
-    it('update the internal hooks holder', function () {
-      this.dummy.hookFor('something');
-      assert.deepEqual(this.dummy._hooks.pop(), { name: 'something' });
-    });
-  });
-
-  describe('#defaultFor()', function () {
-    it('return the value for the option name, doing lookup in options and Grunt config', function () {
-      var name = this.dummy.defaultFor('something');
-      assert.equal(name, 'else');
-    });
-  });
-
   describe('#composeWith()', function () {
     beforeEach(function () {
       this.dummy = new this.Dummy([], {
@@ -875,10 +812,6 @@ describe('generators.Base', function () {
         '-h, --help # Print the generator\'s options and usage',
         '--skip-cache # Do not remember prompt answers Default: false',
         '--skip-install # Do not automatically install dependencies Default: false',
-        '--hook1 # Hook1 to be invoked',
-        '--hook2 # Hook2 to be invoked',
-        '--hook3 # Hook3 to be invoked',
-        '--hook4 # Hook4 to be invoked',
         '--ooOoo # Description for ooOoo',
         '',
         'Arguments:',
@@ -1097,7 +1030,7 @@ describe('generators.Base', function () {
         // Run event, emitted right before running the generator.
         .on('run', assertEvent('run'))
         // End event, emitted after the generation process, when every generator
-        // methods are executed (hooks are executed after)
+        // methods are executed
         .on('end', assertEvent('end'))
         .on('method:createSomething', assertEvent('method:createSomething'))
         .on('method:createSomethingElse', assertEvent('method:createSomethingElse'));

test/actions.js

@@ -1,18 +1,8 @@
-
+'use strict';
 // in real use case, users need to require `yeoman-generators`
 // var generators = require('yeoman-generators');
 var generators = require('../../../');
-var util = require('util');
-
-var Generator = module.exports = function Generator(args, options) {
-  generators.NamedBase.apply(this, arguments);
-  // arguments === this.arguments
-  // options === this.options
-};
-
-// namespace
-Generator.namespace = 'mocha:generator-base';
-
-util.inherits(Generator, generators.NamedBase);
 
-Generator.prototype.doStuff = function() {};
+module.exports = generators.NamedBase.extend({
+  doStuff: function () {}
+});

test/base.js

@@ -9,9 +9,9 @@
 
 var yeoman = require('../../../');
 
-module.exports = yeoman.generators.Base.extend({
+module.exports = yeoman.Base.extend({
   constructor: function () {
-    yeoman.generators.Base.apply(this, arguments);
+    yeoman.Base.apply(this, arguments);
 
     // this.log('as passed in: ', this.options.testOption);
     this.option('testOption', {