Remove extra menu separators (#11827)

* add function to remove leading/trailing separators

* change const  name for clarity

* add spec to check filtered separators

* clean method and add edge case spec per review
This commit is contained in:
shelley vohr 2018-02-05 12:55:12 -05:00 committed by Charles Kerr
parent e6a5990b95
commit 5240352326
2 changed files with 73 additions and 12 deletions

View file

@ -184,11 +184,13 @@ Menu.buildFromTemplate = function (template) {
}
const menu = new Menu()
const filtered = removeExtraSeparators(template)
const positioned = []
let idx = 0
// sort template by position
template.forEach(item => {
filtered.forEach(item => {
idx = (item.position) ? indexToInsertByPosition(positioned, item.position) : idx += 1
positioned.splice(idx, 0, item)
})
@ -262,6 +264,17 @@ function indexToInsertByPosition (items, position) {
return (query in queries) ? queries[query](idx) : idx
}
function removeExtraSeparators (items) {
// remove invisible items
let ret = items.filter(e => e.visible !== false)
// fold adjacent separators together
ret = ret.filter((e, idx, arr) => e.type !== 'separator' || idx === 0 || arr[idx - 1].type !== 'separator')
// remove edge separators
return ret.filter((e, idx, arr) => e.type !== 'separator' || (idx !== 0 && idx !== arr.length - 1))
}
function insertItemByType (item, pos) {
const types = {
normal: () => this.insertItem(pos, item.commandId, item.label),

View file

@ -87,15 +87,18 @@ describe('Menu module', () => {
it('should position at endof existing separator groups', () => {
const menu = Menu.buildFromTemplate([
{
type: 'separator',
id: 'numbers'
label: 'first',
id: 'first'
}, {
type: 'separator',
id: 'letters'
id: 'numbers'
}, {
label: 'a',
id: 'a',
position: 'endof=letters'
}, {
type: 'separator',
id: 'letters'
}, {
label: '1',
id: '1',
@ -118,14 +121,59 @@ describe('Menu module', () => {
position: 'endof=numbers'
}
])
assert.equal(menu.items[0].id, 'numbers')
assert.equal(menu.items[1].label, '1')
assert.equal(menu.items[2].label, '2')
assert.equal(menu.items[3].label, '3')
assert.equal(menu.items[4].id, 'letters')
assert.equal(menu.items[5].label, 'a')
assert.equal(menu.items[6].label, 'b')
assert.equal(menu.items[7].label, 'c')
assert.equal(menu.items[1].id, 'numbers')
assert.equal(menu.items[2].label, '1')
assert.equal(menu.items[3].label, '2')
assert.equal(menu.items[4].label, '3')
assert.equal(menu.items[5].id, 'letters')
assert.equal(menu.items[6].label, 'a')
assert.equal(menu.items[7].label, 'b')
assert.equal(menu.items[8].label, 'c')
})
it('should filter excess menu separators', () => {
const menuOne = Menu.buildFromTemplate([
{
type: 'separator'
}, {
label: 'a'
}, {
label: 'b'
}, {
label: 'c'
}, {
type: 'separator'
}
])
assert.equal(menuOne.items.length, 3)
assert.equal(menuOne.items[0].label, 'a')
assert.equal(menuOne.items[1].label, 'b')
assert.equal(menuOne.items[2].label, 'c')
const menuTwo = Menu.buildFromTemplate([
{
type: 'separator'
}, {
type: 'separator'
}, {
label: 'a'
}, {
label: 'b'
}, {
label: 'c'
}, {
type: 'separator'
}, {
type: 'separator'
}
])
assert.equal(menuTwo.items.length, 3)
assert.equal(menuTwo.items[0].label, 'a')
assert.equal(menuTwo.items[1].label, 'b')
assert.equal(menuTwo.items[2].label, 'c')
})
it('should create separator group if endof does not reference existing separator group', () => {