This repository has been archived by the owner on Jun 1, 2023. It is now read-only.
/
FormWizard.spec.js
459 lines (432 loc) · 16.8 KB
/
FormWizard.spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
import VueFormWizard, {TabContent as WizardTab, WizardStep, FormWizard} from './../../../src/index'
import {mount, createLocalVue} from 'vue-test-utils'
import sinon from 'sinon'
import Vue from 'vue'
import VueRouter from 'vue-router'
const localVue = createLocalVue()
localVue.use(VueFormWizard)
localVue.use(VueRouter)
const First = {template: '<div>First page</div>'}
const Second = {template: '<div>Second page</div>'}
const Third = {template: '<div>Third page</div>'}
const router = new VueRouter({
routes: [
{path: '/first', component: First},
{path: '/second', component: Second},
{path: '/third', component: Third}
]
})
const startIndex = 0
let validationMethod = sinon.stub()
validationMethod.returns(true)
let secondValidationMethod = sinon.stub()
let initialWizard = {
template: `<form-wizard :start-index="startIndex">
<tab-content title="Personal details"
icon="ti-user">
My first tab content
</tab-content>
<tab-content title="Additional Info"
v-if="showSecondStep"
icon="ti-settings">
My second tab content
</tab-content>
<tab-content title="Last step" v-if="showLastStep"
icon="ti-settings">
My third tab content
</tab-content>
</form-wizard>`,
data () {
return {
startIndex: startIndex,
showLastStep: true,
showSecondStep: true
}
}
}
let threeStepWizard = initialWizard
let routerWizard = {
template: `<form-wizard>
<tab-content title="Personal details"
route="/first"
icon="ti-user">
</tab-content>
<tab-content title="Additional Info"
route="/second"
icon="ti-settings">
</tab-content>
<tab-content title="Last step"
route="/third"
icon="ti-check">
</tab-content>
<router-view></router-view>
</form-wizard>`
}
const divSlot = `<div>
<tab-content title="Personal details"
icon="ti-user">
First
</tab-content>
<tab-content title="Additional Info"
icon="ti-settings">
Second
</tab-content>
<tab-content title="Last step"
icon="ti-settings">
Third
</tab-content>
</div>`
describe('FormWizard.vue', () => {
it('contains wizard class', () => {
const wizard = mount(threeStepWizard, {localVue})
wizard.hasClass('vue-form-wizard')
})
describe('renders', () => {
it('steps', (done) => {
const wizard = mount(threeStepWizard, {localVue})
Vue.nextTick(() => {
const steps = wizard.findAll(WizardStep)
const firsStep = steps.at(0)
expect(steps.length).to.equal(3)
expect(firsStep.hasClass('active'))
const stepTitle = firsStep.find('.stepTitle')
expect(stepTitle.is('span')).to.equal(true)
const stepText = stepTitle.text().trim()
expect(stepText).to.equal('Personal details')
done()
})
})
it('tabs', () => {
const wizard = mount(threeStepWizard, {localVue})
const tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
})
it('only one tab content', () => {
const wizard = mount(threeStepWizard, {localVue})
const tabs = wizard.findAll(WizardTab).wrappers
const activeTabs = tabs.filter((tab) => tab.vm.active)
const inactiveTabs = tabs.filter((tab) => !tab.vm.active)
expect(activeTabs.length).to.equal(1)
inactiveTabs.forEach((tab) => {
expect(tab.hasStyle('display', 'none')).to.equal(true)
})
})
it('slot wrapped in another tag', done => {
const wizard = mount(FormWizard, {
localVue,
slots: {
default: divSlot
}
})
Vue.nextTick(() => {
const tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
done()
})
})
it('less tabs when one tab is removed', (done) => {
const wizard = mount(threeStepWizard, {localVue})
const tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
wizard.setData({showLastStep: false})
Vue.nextTick(() => {
const newTabs = wizard.findAll(WizardTab)
expect(newTabs.length).to.equal(2)
done()
})
})
it('tabs in the same order when a tab before the active tab is removed', (done) => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
const tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
// navigate to last step
wizardInstance.vm.nextTab()
wizardInstance.vm.nextTab()
// remove second step
wizard.setData({showSecondStep: false})
Vue.nextTick(() => {
const newTabs = wizard.findAll(WizardTab)
expect(newTabs.length).to.equal(2)
const lastTab = newTabs.at(1)
expect(lastTab.vm.active).to.equal(true)
expect(lastTab.vm.title).to.equal('Last step')
done()
})
})
})
it('warns when start index is incorrect', () => {
let originalConsole = window.console
window.console = {warn: sinon.stub()}
const wizard = mount(FormWizard, {localVue, slots: {default: divSlot}, propsData: {startIndex: 15}})
expect(wizard.vm.activeTabIndex).to.not.equal(15)
expect(window.console.warn.called).to.equal(true)
window.console = originalConsole
})
it('resets wizard', () => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
let tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
wizardInstance.vm.nextTab()
wizardInstance.vm.nextTab()
const lastTab = tabs.at(2)
expect(lastTab.vm.active).to.equal(true)
expect(wizardInstance.vm.maxStep).to.equal(tabs.length - 1)
expect(wizardInstance.vm.activeTabIndex).to.equal(tabs.length - 1)
wizardInstance.vm.reset()
const firstTab = tabs.at(0)
expect(firstTab.vm.active).to.equal(true)
expect(wizardInstance.vm.maxStep).to.equal(0)
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
})
it('activates all steps', (done) => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
let tabs = wizard.findAll(WizardTab)
let maxStepIndex = tabs.length - 1
wizardInstance.vm.activateAll()
Vue.nextTick(() => {
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
expect(wizardInstance.vm.maxStep).to.equal(maxStepIndex)
// direct navigation should be available
wizardInstance.vm.navigateToTab(maxStepIndex)
expect(wizardInstance.vm.activeTabIndex).to.equal(maxStepIndex)
let steps = wizardInstance.findAll('.wizard-icon-circle')
expect(steps.hasClass('checked')).to.equal(true)
done()
})
})
describe('navigation', () => {
it('next tab is called', () => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
const nextButton = wizard.find('.wizard-footer-right span')
nextButton.trigger('click')
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
})
it('prev tab is called', (done) => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
const nextButton = wizard.find('.wizard-footer-right span')
nextButton.trigger('click')
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
Vue.nextTick(() => {
const backButton = wizardInstance.find('.wizard-footer-left span')
backButton.trigger('click')
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
done()
})
})
it('is restricted to unvisted tabs by click', () => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.navigateToTab(1)
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
})
it('starts at a given index', () => {
const wizard = mount(threeStepWizard, {localVue})
const tabs = wizard.findAll(WizardTab)
const activeTab = tabs.at(startIndex)
expect(activeTab.vm.active).to.equal(true)
const formWizard = wizard.find(FormWizard)
expect(formWizard.vm.activeTabIndex).to.equal(startIndex)
})
it('navigates to a visited tab', () => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
let tabs = wizard.findAll(WizardTab)
wizardInstance.vm.nextTab()
wizardInstance.vm.nextTab()
wizardInstance.vm.navigateToTab(0)
const firstTab = tabs.at(0)
expect(firstTab.vm.active).to.equal(true)
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
expect(wizardInstance.vm.maxStep).to.equal(tabs.length - 1)
wizardInstance.vm.navigateToTab(2)
expect(wizardInstance.vm.activeTabIndex).to.equal(2)
expect(wizardInstance.vm.maxStep).to.equal(tabs.length - 1)
})
it('active tab is prev when current active tab is removed', (done) => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
// navigate to last tab
wizardInstance.vm.nextTab()
wizardInstance.vm.nextTab()
const tabs = wizard.findAll(WizardTab)
expect(tabs.length).to.equal(3)
wizard.setData({showLastStep: false})
Vue.nextTick(() => {
const newTabs = wizard.findAll(WizardTab)
expect(newTabs.length).to.equal(2)
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
done()
})
})
it('with arrow keys on visited tabs', () => {
const wizard = mount(threeStepWizard, {localVue, attachToDocument: true})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
wizardInstance.vm.nextTab()
wizard.trigger('tab')
wizard.trigger('keyup.right')
wizard.trigger('keyup.left')
expect(wizardInstance.vm.activeTabIndex).to.equal(2)
})
})
describe('emits', () => {
it('on-complete upon last step', () => {
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
const nextButton = wizard.find('.wizard-footer-right span')
nextButton.trigger('click')
nextButton.trigger('click')
nextButton.trigger('click')
expect(wizardInstance.vm.activeTabIndex).to.equal(2)
expect(wizardInstance.emitted()['on-complete'].length).to.equal(1)
})
})
describe('validation with', () => {
beforeEach(() => {
threeStepWizard = {
template: `<form-wizard :validate-on-back="true">
<tab-content title="Personal details"
:before-change="validationMethod"
icon="ti-user">
My first tab content
</tab-content>
<tab-content title="Additional Info"
:before-change="secondValidationMethod"
icon="ti-settings">
My second tab content
</tab-content>
<tab-content title="Last step"
icon="ti-settings">
My third tab content
</tab-content>
</form-wizard>`,
methods: {
validationMethod,
secondValidationMethod
}
}
})
it('simple method', () => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(true)
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
expect(threeStepWizard.methods.validationMethod.called).to.equal(true)
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
})
it('simple method on back navigation', () => {
threeStepWizard.methods.secondValidationMethod = sinon.stub()
threeStepWizard.methods.secondValidationMethod.returns(true)
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
wizardInstance.vm.prevTab()
expect(threeStepWizard.methods.secondValidationMethod.called).to.equal(true)
})
it('falsy method', () => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(false)
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
expect(threeStepWizard.methods.validationMethod.called).to.equal(true)
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
})
it('promise', (done) => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(Promise.resolve(true))
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
expect(threeStepWizard.methods.validationMethod.called).to.equal(true)
Vue.nextTick(() => {
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
done()
})
})
it('failing promise', (done) => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(Promise.reject(false))
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
expect(threeStepWizard.methods.validationMethod.called).to.equal(true)
Vue.nextTick(() => {
expect(wizardInstance.vm.activeTabIndex).to.equal(0)
done()
})
})
})
describe('after change', () => {
beforeEach(() => {
threeStepWizard = {
template: `<form-wizard>
<tab-content title="Personal details"
:after-change="validationMethod"
icon="ti-user">
My first tab content
</tab-content>
<tab-content title="Additional Info"
:after-change="validationMethod"
icon="ti-settings">
My second tab content
</tab-content>
<tab-content title="Last step"
icon="ti-settings">
My third tab content
</tab-content>
</form-wizard>`,
methods: {
validationMethod,
}
}
})
it('simple method on after change', () => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(null)
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
expect(threeStepWizard.methods.validationMethod.should.have.been.called)
expect(wizardInstance.vm.activeTabIndex).to.equal(1)
})
it('simple method on back navigation after change', () => {
threeStepWizard.methods.validationMethod = sinon.stub()
threeStepWizard.methods.validationMethod.returns(null)
const wizard = mount(threeStepWizard, {localVue})
const wizardInstance = wizard.find(FormWizard)
wizardInstance.vm.nextTab()
wizardInstance.vm.prevTab()
expect(threeStepWizard.methods.validationMethod.should.have.been.called)
})
})
describe('with vue-router', ()=> {
it('renders correct tab contents', () => {
const wizard = mount(routerWizard, {localVue, router})
const wizardInstance = wizard.find(FormWizard)
let tabs = wizardInstance.findAll(WizardTab)
let firstTab = tabs.at(0)
expect(tabs.length).to.equal(3)
expect(firstTab.vm.route).to.equal(wizardInstance.vm.$route.path)
})
it('adapts to valid route changes when steps are visited', (done) => {
const wizard = mount(routerWizard, {localVue, router})
const wizardInstance = wizard.find(FormWizard)
let tabs = wizardInstance.findAll(WizardTab)
wizardInstance.vm.activateAll()
wizardInstance.vm.$router.push('/second')
Vue.nextTick(()=> {
let secondTab = tabs.at(1)
expect(secondTab.vm.route).to.equal(wizardInstance.vm.$route.path)
expect(secondTab.vm.active).to.equal(true)
done()
})
})
})
})