update naming, ref contains test

matt-oconnell · matt-oconnell · commit 9fc1a822b016 · 2017-11-10T16:13:47.000-05:00
diff --git a/flow/wrapper.flow.js b/flow/wrapper.flow.js
@@ -3,11 +3,11 @@
 import type Wrapper from '~src/Wrapper'
 import type WrapperArray from '~src/WrapperArray'
 
-// declare type FindOptions = {
+// declare type RefSelector = {
 //     ref: string,
 // }
 
-// declare type Selector = string | Component | FindOptions
+// declare type Selector = string | Component | RefSelector
 // Component is not getting imported
 declare type Selector = any
 
diff --git a/src/lib/get-selector-type.js b/src/lib/get-selector-type.js
@@ -1,6 +1,6 @@
 // @flow
 
-import { isDomSelector, isVueComponent, isFindOption } from './validators.js'
+import { isDomSelector, isVueComponent, isRefSelector } from './validators.js'
 import { throwError } from '../lib/util'
 
 export const selectorTypes = {
@@ -18,7 +18,7 @@ function getSelectorType (selector: Selector): string | void {
     return selectorTypes.VUE_COMPONENT
   }
 
-  if (isFindOption(selector)) {
+  if (isRefSelector(selector)) {
     return selectorTypes.OPTIONS_OBJECT
   }
 }
diff --git a/src/lib/validators.js b/src/lib/validators.js
@@ -47,20 +47,20 @@ export function isValidSelector (selector: any): boolean {
     return true
   }
 
-  return isFindOption(selector)
+  return isRefSelector(selector)
 }
 
-export function isFindOption (findOptions: any) {
-  if (typeof findOptions !== 'object') {
+export function isRefSelector (refOptionsObject: any) {
+  if (typeof refOptionsObject !== 'object') {
     return false
   }
 
-  if (findOptions === null) {
+  if (refOptionsObject === null) {
     return false
   }
 
   const validFindKeys = ['ref']
-  const entries = Object.entries(findOptions)
+  const entries = Object.entries(refOptionsObject)
 
   if (!entries.length) {
     return false
diff --git a/src/wrappers/wrapper.js b/src/wrappers/wrapper.js
@@ -45,6 +45,9 @@ export default class Wrapper implements BaseWrapper {
     }
 
     if (selectorType === selectorTypes.OPTIONS_OBJECT) {
+      if (!this.isVueComponent) {
+        throwError('$ref selectors can only be used on Vue component wrappers')
+      }
       const nodes = findVNodesByRef(this.vnode, selector.ref)
       return nodes.length > 0
     }
diff --git a/test/unit/specs/mount/Wrapper/contains.spec.js b/test/unit/specs/mount/Wrapper/contains.spec.js
@@ -21,6 +21,15 @@ describe('contains', () => {
     expect(wrapper.contains({ ref: 'foo' })).to.equal(true)
   })
 
+  it('throws an error when ref selector is called on a wrapper that is not a Vue component', () => {
+    const compiled = compileToFunctions('<div><a href="/"></a></div>')
+    const wrapper = mount(compiled)
+    const a = wrapper.find('a')
+    const message = '[vue-test-utils]: $ref selectors can only be used on Vue component wrappers'
+    const fn = () => a.contains({ ref: 'foo' })
+    expect(fn).to.throw().with.property('message', message)
+  })
+
   it('returns false if wrapper does not contain element', () => {
     const compiled = compileToFunctions('<div><input /></div>')
     const wrapper = mount(compiled)
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -26,9 +26,9 @@ type Stubs = {
 } | string[]
 
 /**
- * Utility type for options object that can be used as a Selector
+ * Utility type for ref options object that can be used as a Selector
  */
-type FindOptions = {
+type RefSelector = {
   ref: string
 }
 
@@ -67,13 +67,13 @@ interface Wrapper<V extends Vue> extends BaseWrapper {
   find<R extends Vue> (selector: ComponentOptions<R>): Wrapper<R>
   find (selector: FunctionalComponentOptions): Wrapper<Vue>
   find (selector: string): Wrapper<Vue>
-  find (selector: FindOptions): Wrapper<Vue>
+  find (selector: RefSelector): Wrapper<Vue>
 
   findAll<R extends Vue, Ctor extends VueClass<R> = VueClass<R>> (selector: Ctor): WrapperArray<R>
   findAll<R extends Vue> (selector: ComponentOptions<R>): WrapperArray<R>
   findAll (selector: FunctionalComponentOptions): WrapperArray<Vue>
   findAll (selector: string): WrapperArray<Vue>
-  findAll (selector: FindOptions): WrapperArray<Vue>
+  findAll (selector: RefSelector): WrapperArray<Vue>
 
   html (): string
   text (): string

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`// @flow`
`2`	`2`
`3`		`-import { isDomSelector, isVueComponent, isFindOption } from './validators.js'`
	`3`	`+import { isDomSelector, isVueComponent, isRefSelector } from './validators.js'`
`4`	`4`	`import { throwError } from '../lib/util'`
`5`	`5`
`6`	`6`	`export const selectorTypes = {`
`@@ -18,7 +18,7 @@ function getSelectorType (selector: Selector): string \| void {`
`18`	`18`	`return selectorTypes.VUE_COMPONENT`
`19`	`19`	`}`
`20`	`20`
`21`		`- if (isFindOption(selector)) {`
	`21`	`+ if (isRefSelector(selector)) {`
`22`	`22`	`return selectorTypes.OPTIONS_OBJECT`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,20 +47,20 @@ export function isValidSelector (selector: any): boolean {`
`47`	`47`	`return true`
`48`	`48`	`}`
`49`	`49`
`50`		`- return isFindOption(selector)`
	`50`	`+ return isRefSelector(selector)`
`51`	`51`	`}`
`52`	`52`
`53`		`-export function isFindOption (findOptions: any) {`
`54`		`- if (typeof findOptions !== 'object') {`
	`53`	`+export function isRefSelector (refOptionsObject: any) {`
	`54`	`+ if (typeof refOptionsObject !== 'object') {`
`55`	`55`	`return false`
`56`	`56`	`}`
`57`	`57`
`58`		`- if (findOptions === null) {`
	`58`	`+ if (refOptionsObject === null) {`
`59`	`59`	`return false`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`const validFindKeys = ['ref']`
`63`		`- const entries = Object.entries(findOptions)`
	`63`	`+ const entries = Object.entries(refOptionsObject)`
`64`	`64`
`65`	`65`	`if (!entries.length) {`
`66`	`66`	`return false`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ export default class Wrapper implements BaseWrapper {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`if (selectorType === selectorTypes.OPTIONS_OBJECT) {`
	`48`	`+ if (!this.isVueComponent) {`
	`49`	`+ throwError('$ref selectors can only be used on Vue component wrappers')`
	`50`	`+ }`
`48`	`51`	`const nodes = findVNodesByRef(this.vnode, selector.ref)`
`49`	`52`	`return nodes.length > 0`
`50`	`53`	`}`