improvement(useLocation): Add tests for useLocation function

Author: microcipcip

src/components/useClickAway/useClickAway.spec.ts

@@ -28,8 +28,8 @@ const testComponent = () => ({
 describe('useClickAway', () => {
   it('should call document.addEventListener', async () => {
     const addEventListenerSpy = jest.spyOn(document, 'addEventListener')
-    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     expect(addEventListenerSpy).not.toHaveBeenCalled()
+    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     const wrapper = mount(testComponent())
     await wrapper.vm.$nextTick()
     expect(addEventListenerSpy).toHaveBeenCalled()

src/components/useGeolocation/stories/useGeolocation.md

@@ -38,8 +38,8 @@ function useGeolocation(
 
 ### Returns
 
-- `isTracking: Ref<boolean>` whether the function is tracking the user's location or not
 - `geo: Ref<UseGeolocation>` the geolocation object
+- `isTracking: Ref<boolean>` whether the function is tracking the user's location or not
 - `start: Function` the function used for starting the geolocation tracking
 - `stop: Function` the function used for stopping the geolocation tracking
 

src/components/useIdle/useIdle.spec.ts

@@ -25,8 +25,8 @@ describe('useIdle', () => {
 
   it('should call document.addEventListener', async () => {
     const addEventListenerSpy = jest.spyOn(document, 'addEventListener')
-    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     expect(addEventListenerSpy).not.toHaveBeenCalled()
+    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     const wrapper = mount(testComponent())
     await wrapper.vm.$nextTick()
     expect(addEventListenerSpy).toHaveBeenCalledTimes(totEvents)

src/components/useLocation/stories/UseLocationDemo.vue

@@ -18,7 +18,7 @@
           <button class="button is-primary" @click="push">
             Fire push event
           </button>
-          <button class="button is-danger" @click="replace">
+          <button class="button is-info" @click="replace">
             Fire replace event
           </button>
         </td>

src/components/useLocation/stories/useLocation.md

@@ -5,19 +5,84 @@ Vue function that tracks bar navigation location state.
 ## Reference
 
 ```typescript
-// function useLocation()
+interface UseLocationState {
+  trigger: string
+  state: any
+  length: number
+  hash: string
+  host: string
+  hostname: string
+  href: string
+  origin: string
+  pathname: string
+  port: string
+  protocol: string
+  search: string
+}
+```
+
+```typescript
+function useLocation(
+  runOnMount?: boolean
+): {
+  locationState: Ref<UseLocationState>
+  isTracking: Ref<boolean>
+  start: () => void
+  stop: () => void
+}
 ```
 
 ### Parameters
 
-- `value: string` lorem ipsa
+- `runOnMount: boolean` whether to start tracking the bar navigation location state on mount, `true` by default
 
 ### Returns
 
-- `value: Ref<string>` lorem ipsa
+- `locationState: Ref<object>` the location object
+- `isTracking: Ref<UseLocationState>` whether the location state is being currently tracked or not
+- `start: Function` the function used for starting the location tracking
+- `stop: Function` the function used for stopping the location tracking
 
 ## Usage
 
 ```html
-<template></template>
+<template>
+  <div>
+    <div>
+      locationState:
+      <pre>{{ JSON.stringify(locationState, null, 2) }}</pre>
+    </div>
+    <div>
+      <button @click="push">Fire push event</button>
+      <button @click="replace">Fire replace event</button>
+    </div>
+    <div>
+      <button @click="start" v-if="!isTracking">Start tracking location</button>
+      <button @click="stop" v-else>Stop tracking location</button>
+    </div>
+  </div>
+</template>
+
+<script lang="ts">
+  import Vue from 'vue'
+  import { useLocation } from 'vue-use-kit'
+
+  export default Vue.extend({
+    name: 'UseLocationDemo',
+    setup() {
+      let count = 0
+      const url = location.origin + location.pathname + location.search
+      const push = () => {
+        count++
+        history.pushState({ page: count }, '', `${url}&page=${count}`)
+      }
+      const replace = () => {
+        count--
+        history.replaceState({ page: count }, '', `${url}&page=${count}`)
+      }
+      const { locationState, isTracking, start, stop } = useLocation()
+      return { locationState, isTracking, start, stop, push, replace }
+    }
+  })
+</script>
 ```

src/components/useLocation/stories/useLocation.story.ts

@@ -17,7 +17,17 @@ const basicDemo = () => ({
         demo-name="UseLocationDemo.vue"
       >
         <template v-slot:title></template>
-        <template v-slot:intro></template>
+        <template v-slot:intro>
+          <p>
+            <strong>Try pressing the 'Fire push event' and 'Fire replace event' buttons</strong> to see the state change
+            on the fly. 
+          </p>
+          <p>
+            <strong>Please note that in this demo you won't see the browser's bar navigation change</strong> 
+            because this example is within an iframe. Click the "Open canvas in new tab" button on the 
+            top right hand corner to see the demo without iframe.
+          </p>
+        </template>
       </story-title>
       <demo />
     </div>`

src/components/useLocation/useLocation.spec.ts

@@ -1,12 +1,100 @@
-// import { mount } from '@src/helpers/test'
-// import { useLocation } from '@src/vue-use-kit'
+import { mount } from '@src/helpers/test'
+import { useLocation } from '@src/vue-use-kit'
 
 afterEach(() => {
   jest.clearAllMocks()
 })
 
+const testComponent = (onMount = true) => ({
+  template: `
+    <div>
+      <div id="isTracking" v-if="isTracking"></div>
+      <div id="locationState">{{JSON.stringify(locationState)}}</div>
+      <button id="start" @click="start"></button>
+      <button id="stop" @click="stop"></button>
+    </div>
+  `,
+  setup() {
+    const { locationState, isTracking, start, stop } = useLocation(onMount)
+    return { locationState, isTracking, start, stop }
+  }
+})
+
 describe('useLocation', () => {
-  it('should do something', () => {
-    // Add test here
+  const locationStateKeys = [
+    'trigger',
+    'state',
+    'length',
+    'hash',
+    'host',
+    'hostname',
+    'href',
+    'origin',
+    'pathname',
+    'port',
+    'protocol',
+    'search'
+  ]
+  const events = ['popstate', 'pushstate', 'replacestate']
+
+  it('should call popstate, pushstate and replacestate onMounted', async () => {
+    const addEventListenerSpy = jest.spyOn(window, 'addEventListener')
+    expect(addEventListenerSpy).not.toHaveBeenCalled()
+    const removeEventListenerSpy = jest.spyOn(window, 'removeEventListener')
+    const wrapper = mount(testComponent())
+    await wrapper.vm.$nextTick()
+    expect(addEventListenerSpy).toHaveBeenCalledTimes(events.length)
+    events.forEach(event => {
+      expect(addEventListenerSpy).toBeCalledWith(event, expect.any(Function))
+    })
+
+    // Destroy instance to check if the remove event listener is being called
+    wrapper.destroy()
+    expect(removeEventListenerSpy).toHaveBeenCalledTimes(events.length)
+    events.forEach(event => {
+      expect(removeEventListenerSpy).toBeCalledWith(event, expect.any(Function))
+    })
+  })
+
+  it('should call document.addEventListener again when start is called', async () => {
+    const addEventListenerSpy = jest.spyOn(window, 'addEventListener')
+    const wrapper = mount(testComponent())
+    expect(addEventListenerSpy).toHaveBeenCalledTimes(events.length)
+    wrapper.find('#stop').trigger('click')
+
+    // Wait for Vue to append #start in the DOM
+    await wrapper.vm.$nextTick()
+    wrapper.find('#start').trigger('click')
+    expect(addEventListenerSpy).toHaveBeenCalledTimes(events.length * 2)
+  })
+
+  it('should call document.removeEventListener when stop is called', async () => {
+    const removeEventListenerSpy = jest.spyOn(window, 'removeEventListener')
+    const wrapper = mount(testComponent())
+    wrapper.find('#stop').trigger('click')
+
+    // Wait for Vue to append #start in the DOM
+    await wrapper.vm.$nextTick()
+    expect(removeEventListenerSpy).toHaveBeenCalledTimes(events.length)
+  })
+
+  it('should show #isTracking when onMount is true', async () => {
+    const wrapper = mount(testComponent(true))
+    await wrapper.vm.$nextTick()
+    expect(wrapper.find('#isTracking').exists()).toBe(true)
+  })
+
+  it('should not show #isTracking when onMount is false', async () => {
+    const wrapper = mount(testComponent(false))
+    await wrapper.vm.$nextTick()
+    expect(wrapper.find('#isTracking').exists()).toBe(false)
+  })
+
+  it('should display the locationState object', async () => {
+    const wrapper = mount(testComponent(true))
+    await wrapper.vm.$nextTick()
+    locationStateKeys.forEach(locationKey => {
+      expect(wrapper.text().includes(locationKey)).toBe(true)
+    })
   })
 })

src/components/useLocation/useLocation.ts

@@ -1,5 +1,20 @@
 import { ref, onMounted, onUnmounted, Ref } from '@src/api'
 
+export interface UseLocationState {
+  trigger: string
+  state: any
+  length: number
+  hash: string
+  host: string
+  hostname: string
+  href: string
+  origin: string
+  pathname: string
+  port: string
+  protocol: string
+  search: string
+}
+
 // The history methods 'pushState' and 'replaceState' by default do not fire an event
 // unless it is coming from user interaction with the browser navigation bar,
 // so we are adding a patch to make them detectable
@@ -54,7 +69,7 @@ export function useLocation(runOnMount = true) {
     }
   }
   const isTracking = ref(false)
-  const locationState = ref(buildState('load'))
+  const locationState: Ref<UseLocationState> = ref(buildState('load'))
 
   const popState = () => (locationState.value = buildState('popstate'))
   const pushState = () => (locationState.value = buildState('pushstate'))
@@ -65,6 +80,8 @@ export function useLocation(runOnMount = true) {
 
     if (isTracking.value) return
     isTracking.value = true
+
+    locationState.value = buildState('start')
     window.addEventListener('popstate', popState)
     window.addEventListener('pushstate', pushState)
     window.addEventListener('replacestate', replaceState)

src/components/useMouse/useMouse.spec.ts

@@ -21,8 +21,8 @@ const testComponent = () => ({
 describe('useMouse', () => {
   it('should call document.addEventListener', async () => {
     const addEventListenerSpy = jest.spyOn(document, 'addEventListener')
-    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     expect(addEventListenerSpy).not.toHaveBeenCalled()
+    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     const wrapper = mount(testComponent())
     await wrapper.vm.$nextTick()
     expect(addEventListenerSpy).toHaveBeenCalledTimes(1)

src/components/useMouseElement/useMouseElement.spec.ts

@@ -38,8 +38,8 @@ const testComponent = () => ({
 describe('useMouseElement', () => {
   it('should call document.addEventListener', async () => {
     const addEventListenerSpy = jest.spyOn(document, 'addEventListener')
-    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     expect(addEventListenerSpy).not.toHaveBeenCalled()
+    const removeEventListenerSpy = jest.spyOn(document, 'removeEventListener')
     const wrapper = mount(testComponent())
     await wrapper.vm.$nextTick()
     expect(addEventListenerSpy).toHaveBeenCalledTimes(1)