StackGenVis/frontend/node_modules/vinyl-item/index.js

'use strict';

var Base = require('base');
var Vinyl = require('vinyl');
var Stream = require('stream');
var utils = require('./utils');

/**
 * Expose `Item`
 */

module.exports = exports = Item;

/**
 * Create an instance of `Item`. Optionally pass a default object to use. See [vinyl][]
 * docs for API details and additional documentation.
 *
 * ```js
 * var item = new Item({
 *   path: 'foo.html',
 *   contents: new Buffer('...')
 * });
 * ```
 * @param {Object} `item`
 * @api public
 */

function Item(item) {
  if (!item) item = {};

  utils.syncContents(this, item.contents || item.content);
  this.cache = item.cache || {};
  this.options = item.options || {};
  this.locals = item.locals || {};
  this.data = item.data || {};

  this.define('contents', {
    configurable: true,
    enumerable: false,
    set: function(val) {
      utils.syncContents(this, val);
    },
    get: function() {
      return this._contents;
    }
  });

  Vinyl.call(this, item);
  var base = this.base;
  delete item.base;

  Base.call(this, item);
  delete this.base;
  this.base = base;

  for (var key in item) {
    var val = item[key];
    if (key === 'stat' && utils.isObject(val) && val.mode) {
      this.set(key, utils.cloneStats(val));
    } else if (val) {
      this.set(key, val);
    }
  }

  this.is('Item');
  this.use(utils.option());
  this.use(utils.plugin());
}

/**
 * Inherit `Base` and `Vinyl`
 */

Base.extend(Item);
Base.inherit(Item, Vinyl);

/**
 * Re-decorate Item methods after calling
 * vinyl's `.clone()` method.
 *
 * ```js
 * item.clone({deep: true}); // false by default
 * ```
 * @param  {Object} `options`
 * @return {Object} `item` Cloned instance
 */

Item.prototype.clone = function(opts) {
  opts = opts || {};

  if (typeof opts === 'boolean') {
    opts = { deep: true };
  }

  opts.deep = opts.deep === true;
  opts.contents = opts.contents !== false;

  // clone the instance's item contents
  var contents = this.contents;
  if (this.isStream()) {
    contents = this.contents.pipe(new Stream.PassThrough());
    this.contents = this.contents.pipe(new Stream.PassThrough());
  } else if (this.isBuffer()) {
    contents = opts.contents ? utils.cloneBuffer(this.contents) : this.contents;
  }

  var item = new Item({
    cwd: this.cwd,
    base: this.base,
    stat: (this.stat ? utils.cloneStats(this.stat) : null),
    history: this.history.slice(),
    contents: contents
  });

  var ignored = ['_contents', 'stat', 'history', 'path', 'base', 'cwd', 'options', 'data'];
  for (var key in this) {
    if (ignored.indexOf(key) < 0) {
      utils.define(item, key, opts.deep ? utils.clone(this[key], true) : this[key]);
    }
  }

  if (opts.deep !== true) {
    item.options = this.options;
    item.data = this.data;
  } else {
    item.options = utils.extend({}, this.options);
    item.data = utils.extend({}, this.data);
  }
  return item;
};

/**
 * Override the vinyl `inspect` method.
 */

Item.prototype.inspect = function() {
  var name = this._name.charAt(0).toUpperCase() + this._name.slice(1);
  var inspect = [];

  var fp = this.key || ((this.path && this.base) ? this.relative : this.path);
  if (fp) inspect.push('"' + fp + '"');

  // if `isBuffer` isn't defined, we don't want this throwing an error,
  // we want the root cause to be transparent
  if (this.isBuffer && this.isBuffer()) {
    inspect.push(this.contents.inspect());
  }

  if (this.isStream && this.isStream()) {
    inspect.push(utils.inspectStream(this.contents));
  }
  return '<' + name + ' ' + inspect.join(' ') + '>';
};

/**
 * Expose `filename` as an alias for `stem`
 */

utils.define(Item.prototype, 'filename', {
  configurable: true,
  set: function(val) {
    this.stem = val;
  },
  get: function() {
    return this.stem;
  }
});

/**
 * Normalize the `content` and `contents` properties on `item`. This is done to
 * ensure compatibility with the vinyl convention of using `contents` as a Buffer,
 * as well as the assemble convention of using `content` as a string. We will eventually
 * deprecate the `content` property.
 *
 * ```js
 * var item = new Item({path: 'foo/bar.hbs', contents: new Buffer('foo')});
 * console.log(item.content);
 * //=> 'foo'
 * ```
 * @name .content
 * @api public
 */

utils.define(Item.prototype, 'content', {
  configurable: true,
  set: function(val) {
    utils.syncContents(this, val);
  },
  get: function() {
    return this._content;
  }
});

/**
 * Getter/setter to resolve the name of the `engine` to use for rendering.
 *
 * ```js
 * var item = new Item({path: 'foo/bar.hbs'});
 * console.log(item.engine);
 * //=> '.hbs'
 * ```
 * @name .engine
 * @api public
 */

utils.define(Item.prototype, 'engine', {
  configurable: true,
  set: function(val) {
    this.define('_engine', val);
  },
  get: function() {
    return this._engine || Item.resolveEngine(this);
  }
});

/**
 * Expose static `resolveEngine` method to allow overriding
 */

Item.resolveEngine = utils.resolveEngine;