stub-components.js

// @flow

import Vue from 'vue'
import { compileToFunctions } from 'vue-template-compiler'
import {
  throwError,
  camelize,
  capitalize,
  hyphenate
} from './util'
import {
  componentNeedsCompiling,
  templateContainsComponent,
  isVueComponent
} from './validators'
import { compileTemplate } from './compile-template'

function isVueComponentStub (comp): boolean {
  return comp && comp.template || isVueComponent(comp)
}

function isValidStub (stub: any): boolean {
  return (
    (!!stub && typeof stub === 'string') ||
    stub === true ||
    isVueComponentStub(stub)
  )
}

function resolveComponent (obj: Object, component: string): Object {
  return obj[component] ||
    obj[hyphenate(component)] ||
    obj[camelize(component)] ||
    obj[capitalize(camelize(component))] ||
    obj[capitalize(component)] ||
    {}
}

function isRequiredComponent (name): boolean {
  return (
    name === 'KeepAlive' || name === 'Transition' || name === 'TransitionGroup'
  )
}

function getCoreProperties (componentOptions: Component): Object {
  return {
    attrs: componentOptions.attrs,
    name: componentOptions.name,
    on: componentOptions.on,
    key: componentOptions.key,
    ref: componentOptions.ref,
    props: componentOptions.props,
    domProps: componentOptions.domProps,
    class: componentOptions.class,
    staticClass: componentOptions.staticClass,
    staticStyle: componentOptions.staticStyle,
    style: componentOptions.style,
    normalizedStyle: componentOptions.normalizedStyle,
    nativeOn: componentOptions.nativeOn,
    functional: componentOptions.functional
  }
}

function createStubFromString (
  templateString: string,
  originalComponent: Component,
  name: string
): Component {
  if (!compileToFunctions) {
    throwError(
      `vueTemplateCompiler is undefined, you must pass ` +
        `precompiled components if vue-template-compiler is ` +
        `undefined`
    )
  }

  if (templateContainsComponent(templateString, name)) {
    throwError('options.stub cannot contain a circular reference')
  }

  const componentOptions = typeof originalComponent === 'function'
    ? originalComponent.extendOptions
    : originalComponent

  return {
    ...getCoreProperties(componentOptions),
    ...compileToFunctions(templateString)
  }
}

function createBlankStub (
  originalComponent: Component,
  name: string
): Component {
  const componentOptions = typeof originalComponent === 'function'
    ? originalComponent.extendOptions
    : originalComponent
  const tagName = `${name}-stub`

  // ignoreElements does not exist in Vue 2.0.x
  if (Vue.config.ignoredElements) {
    Vue.config.ignoredElements.push(tagName)
  }

  return {
    ...getCoreProperties(componentOptions),
    render (h) {
      return h(
        tagName,
        !componentOptions.functional && this.$slots.default
      )
    }
  }
}

export function createComponentStubs (
  originalComponents: Object = {},
  stubs: Stubs
): Components {
  const components = {}
  if (!stubs) {
    return components
  }
  if (Array.isArray(stubs)) {
    stubs.forEach(stub => {
      if (stub === false) {
        return
      }

      if (typeof stub !== 'string') {
        throwError(`each item in an options.stubs array must be a ` + `string`)
      }
      const component = resolveComponent(originalComponents, stub)

      components[stub] = createBlankStub(component, stub)
    })
  } else {
    const stubsObject = (stubs: { [name: string]: Component | string | true })
    Object.keys(stubsObject).forEach(stubName => {
      const stub = stubsObject[stubName]
      if (stub === false) {
        return
      }

      if (!isValidStub(stub)) {
        throwError(
          `options.stub values must be passed a string or ` + `component`
        )
      }

      if (stub === true) {
        const component = resolveComponent(originalComponents, stubName)
        components[stubName] = createBlankStub(component, stubName)
        return
      }

      if (typeof stub !== 'string' && componentNeedsCompiling(stub)) {
        compileTemplate(stub)
      }

      if (originalComponents[stubName]) {
        // Remove cached constructor
        delete originalComponents[stubName]._Ctor
        if (typeof stub === 'string') {
          components[stubName] = createStubFromString(
            stub,
            originalComponents[stubName],
            stubName
          )
        } else {
          const stubObject = (stub: Object)
          components[stubName] = {
            ...stubObject,
            name: originalComponents[stubName].name
          }
        }
      } else {
        if (typeof stub === 'string') {
          if (!compileToFunctions) {
            throwError(
              `vueTemplateCompiler is undefined, you must pass ` +
                `precompiled components if vue-template-compiler is ` +
                `undefined`
            )
          }
          components[stubName] = {
            ...compileToFunctions(stub)
          }
        } else {
          const stubObject = (stub: Object)
          components[stubName] = {
            ...stubObject
          }
        }
      }
    })
  }
  return components
}

function stubComponents (
  components: Components,
  stubbedComponents: Components
): void {
  Object.keys(components).forEach(component => {
    const cmp = components[component]
    const componentOptions = typeof cmp === 'function'
      ? cmp.extendOptions
      : cmp
    // Remove cached constructor
    delete componentOptions._Ctor
    if (!componentOptions.name) {
      componentOptions.name = component
    }
    stubbedComponents[component] = createBlankStub(componentOptions, component)
  })
}

export function createComponentStubsForAll (component: Component): Components {
  const stubbedComponents = {}

  if (component.components) {
    stubComponents(component.components, stubbedComponents)
  }

  stubbedComponents[component.name] = createBlankStub(component, component.name)

  let extended = component.extends

  // Loop through extended component chains to stub all child components
  while (extended) {
    if (extended.components) {
      stubComponents(extended.components, stubbedComponents)
    }
    extended = extended.extends
  }

  let extendOptions = component.extendOptions
  while (extendOptions) {
    if (extendOptions && extendOptions.components) {
      stubComponents(extendOptions.components, stubbedComponents)
    }
    extendOptions = extendOptions.extendOptions
  }

  return stubbedComponents
}

export function createComponentStubsForGlobals (
  instance: Component
): Components {
  const components = {}
  Object.keys(instance.options.components).forEach(c => {
    if (isRequiredComponent(c)) {
      return
    }

    components[c] = createBlankStub(instance.options.components[c], c)
    delete instance.options.components[c]._Ctor
    delete components[c]._Ctor
  })
  return components
}