vue/src/instance/scope.js

var _ = require('../util')
var Observer = require('../observe/observer')
var scopeEvents = ['set', 'mutate', 'add', 'delete']

/**
 * Setup instance scope.
 * The scope is reponsible for prototypal inheritance of
 * parent instance propertiesm abd all binding paths and
 * expressions of the current instance are evaluated against
 * its scope.
 *
 * This should only be called once during _init().
 */

exports._initScope = function () {
  var parent = this.$parent
  var inherit = parent && !this.$options.isolated
  var data = this._data
  var scope = this.$scope = inherit
    ? Object.create(parent.$scope)
    : {}
  // copy initial data into scope
  var keys = Object.keys(data)
  var i = keys.length
  while (i--) {
    // use defineProperty so we can shadow parent accessors
    key = keys[i]
    _.define(scope, key, data[key], true)
  }
  // create scope observer
  this.$observer = Observer.create(scope, {
    callbackContext: this,
    doNotAlterProto: true
  })
  // setup sync between data and the scope
  this._syncData()

  if (!inherit) {
    return
  }
  // relay change events that sent down from
  // the scope prototype chain.
  var ob = this.$observer
  var pob = parent.$observer
  var listeners = this._scopeListeners = {}
  scopeEvents.forEach(function (event) {
    var cb = listeners[event] = function (key, a, b) {
      // since these events come from upstream,
      // we only emit them if we don't have the same keys
      // shadowing them in current scope.
      if (!scope.hasOwnProperty(key)) {
        ob.emit(event, key, a, b, true)
      }
    }
    pob.on(event, cb)
  })
}

/**
 * Teardown scope, unsync data, and remove all listeners
 * including ones attached to parent's observer.
 * Only called once during $destroy().
 */

exports._teardownScope = function () {
  this.$observer.off()
  this._unsyncData()
  this._data = null
  this.$scope = null
  if (this.$parent) {
    var pob = this.$parent.$observer
    var listeners = this._scopeListeners
    scopeEvents.forEach(function (event) {
      pob.off(event, listeners[event])
    })
    this._scopeListeners = null
  }
}

/**
 * Called when swapping the $data object.
 *
 * Old properties that are not present in new data are
 * deleted from the scope, and new data properties not
 * already on the scope are added. Teardown old data sync
 * listeners and setup new ones.
 *
 * @param {Object} data
 */

exports._setData = function (data) {
  this._data = data
  var scope = this.$scope
  var key
  // teardown old sync listeners
  this._unsyncData()
  // delete keys not present in the new data
  for (key in scope) {
    if (
      key.charCodeAt(0) !== 0x24 && // $
      scope.hasOwnProperty(key) &&
      !(key in data)
    ) {
      scope.$delete(key)
    }
  }
  // copy properties into scope
  for (key in data) {
    if (scope.hasOwnProperty(key)) {
      // existing property, trigger set
      scope[key] = data[key]
    } else {
      // new property
      scope.$add(key, data[key])
    }
  }
  // setup sync between scope and new data
  if (!this.$options._noSync) {
    this._syncData()
  }
}

/**
 * Proxy the scope properties on the instance itself,
 * so that vm.a === vm.$scope.a.
 *
 * Note this only proxies *local* scope properties. We want
 * to prevent child instances accidentally modifying
 * properties with the same name up in the scope chain
 * because scope perperties are all getter/setters.
 *
 * To access parent properties through prototypal fall
 * through, access it on the instance's $scope.
 *
 * This should only be called once during _init().
 */

exports._initProxy = function () {
  var scope = this.$scope

  // scope --> vm

  // proxy scope data on vm
  var keys = Object.keys(scope)
  var i = keys.length
  while (i--) {
    _.proxy(this, scope, keys[i])
  }
  // keep proxying up-to-date with added/deleted keys.
  this.$observer
    .on('add:self', function (key) {
      _.proxy(this, scope, key)
    })
    .on('delete:self', function (key) {
      delete this[key]
    })

  // vm --> scope

  // $parent & $root are read-only on $scope
  scope.$parent = this.$parent
  scope.$root = this.$root
  // proxy $data
  _.proxy(scope, this, '$data')
}

/**
 * Setup computed properties.
 * All computed properties are proxied onto the scope.
 * Because they are accessors their `this` context will
 * be the instance instead of the scope.
 */

function noop () {}

exports._initComputed = function () {
  var computed = this.$options.computed
  var scope = this.$scope
  if (computed) {
    for (var key in computed) {
      var def = computed[key]
      if (typeof def === 'function') {
        def = {
          get: def,
          set: noop
        }
      }
      def.enumerable = true
      def.configurable = true
      Object.defineProperty(this, key, def)
      _.proxy(scope, this, key)
    }
  }
}

/**
 * Setup instance methods.
 * Methods are also copied into scope, but they must
 * be bound to the instance.
 */

exports._initMethods = function () {
  var methods = this.$options.methods
  var scope = this.$scope
  if (methods) {
    for (var key in methods) {
      var method = methods[key]
      this[key] = method
      scope[key] = _.bind(method, this)
    }
  }
}

/**
 * Setup two-way sync between the instance scope and
 * the original data. Requires teardown.
 */

exports._syncData = function () {
  var data = this._data
  var scope = this.$scope
  var locked = false
  var listeners = this._syncListeners = {
    data: {
      set: guard(function (key, val) {
        data[key] = val
      }),
      add: guard(function (key, val) {
        data.$add(key, val)
      }),
      delete: guard(function (key) {
        data.$delete(key)
      })
    },
    scope: {
      set: guard(function (key, val) {
        scope[key] = val
      }),
      add: guard(function (key, val) {
        scope.$add(key, val)
      }),
      delete: guard(function (key) {
        scope.$delete(key)
      })
    }
  }
  // sync scope and original data.
  this.$observer
    .on('set:self', listeners.data.set)
    .on('add:self', listeners.data.add)
    .on('delete:self', listeners.data.delete)

  this._dataObserver = Observer.create(data)
  this._dataObserver
    .on('set:self', listeners.scope.set)
    .on('add:self', listeners.scope.add)
    .on('delete:self', listeners.scope.delete)

  /**
   * The guard function prevents infinite loop
   * when syncing between two observers. Also
   * filters out properties prefixed with $ or _.
   *
   * @param {Function} fn
   * @return {Function}
   */

  function guard (fn) {
    return function (key, val) {
      if (locked) {
        return
      }
      var c = key.charCodeAt(0)
      if (c === 0x24 || c === 0x5F) { // $ and _
        return
      }
      locked = true
      fn(key, val)
      locked = false
    }
  }
}

/**
 * Teardown the sync between scope and previous data object.
 */

exports._unsyncData = function () {
  var listeners = this._syncListeners
  if (!listeners) {
    return
  }
  this.$observer
    .off('set:self', listeners.data.set)
    .off('add:self', listeners.data.add)
    .off('delete:self', listeners.data.delete)
  this._dataObserver
    .off('set:self', listeners.scope.set)
    .off('add:self', listeners.scope.add)
    .off('delete:self', listeners.scope.delete)
  this._syncListeners = null
}