feat: add RouterLinkStub (#366)

* docs: add getting started with karma

* docs: add karma guide to menu

* feat(RouterLinkStub): add RouterLinkStub component

Author: eddyerburgh

docs/en/SUMMARY.md

@@ -42,7 +42,6 @@
     * [isVueInstance](api/wrapper/isVueInstance.md)
     * [name](api/wrapper/name.md)
     * [props](api/wrapper/props.md)
-    * [setComputed](api/wrapper/setComputed.md)
     * [setData](api/wrapper/setData.md)
     * [setMethods](api/wrapper/setMethods.md)
     * [setProps](api/wrapper/setProps.md)
@@ -69,6 +68,7 @@
   * [components](api/components/README.md)
     * [TransitionStub](api/components/TransitionStub.md)
     * [TransitionGroupStub](api/components/TransitionGroupStub.md)
+    * [RouterLinkStub](api/components/RouterLinkStub.md)
   * [Selectors](api/selectors.md)
   * [createLocalVue](api/createLocalVue.md)
   * [config](api/config.md)

docs/en/api/components/RouterLinkStub.md

@@ -0,0 +1,20 @@
+# RouterLinkStub
+
+A component to stub the Vue Router `router-link` component.
+
+You can use this component to find a router-link component in the render tree.
+
+- **Usage:**
+
+To set it as a stub in mounting options:
+
+```js
+import { mount, RouterLinkStub } from '@vue/test-utils'
+
+const wrapper = mount(Component, {
+  stubs: {
+    RouterLink: RouterLinkStub
+  }
+})
+expect(wrapper.find(RouterLinkStub).props().to).toBe('/some/path')
+```

src/components/RouterLinkStub.js

@@ -0,0 +1,29 @@
+// @flow
+const toTypes: Array<Function> = [String, Object]
+const eventTypes: Array<Function> = [String, Array]
+
+export default {
+  name: 'RouterLinkStub',
+  props: {
+    to: {
+      type: toTypes,
+      required: true
+    },
+    tag: {
+      type: String,
+      default: 'a'
+    },
+    exact: Boolean,
+    append: Boolean,
+    replace: Boolean,
+    activeClass: String,
+    exactActiveClass: String,
+    event: {
+      type: eventTypes,
+      default: 'click'
+    }
+  },
+  render (h: Function) {
+    return h(this.tag, undefined, this.$slots.default)
+  }
+}

src/index.js

@@ -3,6 +3,7 @@ import mount from './mount'
 import createLocalVue from './create-local-vue'
 import TransitionStub from './components/TransitionStub'
 import TransitionGroupStub from './components/TransitionGroupStub'
+import RouterLinkStub from './components/RouterLinkStub'
 import config from './config'
 
 export default {
@@ -11,5 +12,6 @@ export default {
   mount,
   shallow,
   TransitionStub,
-  TransitionGroupStub
+  TransitionGroupStub,
+  RouterLinkStub
 }

test/unit/specs/components/RouterLink.spec.js

@@ -0,0 +1,52 @@
+import { mount, RouterLinkStub } from '~vue-test-utils'
+
+describe('RouterLinkStub', () => {
+  it('takes correct props', () => {
+    const TestComponent = {
+      template: `
+        <div>
+          <router-link
+            to="to1"
+            tag="tag1"
+            exact="exact1"
+            append="append1"
+            replace="replace1"
+            activeClass="activeClass1"
+            exactActiveClass="exactActiveClass1"
+            event="event1"
+          />
+        </div>
+      `
+    }
+    const wrapper = mount(TestComponent, {
+      stubs: {
+        RouterLink: RouterLinkStub
+      }
+    })
+    const routerLink = wrapper.find(RouterLinkStub)
+    expect(routerLink.props().to).to.equal('to1')
+    expect(routerLink.props().tag).to.equal('tag1')
+    expect(routerLink.props().exact).to.equal('exact1')
+    expect(routerLink.props().append).to.equal('append1')
+    expect(routerLink.props().replace).to.equal('replace1')
+    expect(routerLink.props().activeClass).to.equal('activeClass1')
+    expect(routerLink.props().exactActiveClass).to.equal('exactActiveClass1')
+    expect(routerLink.props().event).to.equal('event1')
+  })
+
+  it('renders slot content', () => {
+    const TestComponent = {
+      template: `
+        <div>
+          <router-link>some text</router-link>
+        </div>
+      `
+    }
+    const wrapper = mount(TestComponent, {
+      stubs: {
+        RouterLink: RouterLinkStub
+      }
+    })
+    expect(wrapper.find(RouterLinkStub).text()).to.equal('some text')
+  })
+})