substance/test/DocumentIndex.test.js

Substance is a JavaScript library for web-based content editing. It provides building blocks for realizing custom text editors and web-based publishing system. It is developed to power our online editing platform [Substance](http://substance.io).

import { DocumentIndex } from 'substance'
import { test, spy } from 'substance-test'
import fixture from './shared/createTestArticle'
import simple from './fixture/simple'

test('DocumentIndex: index should have been warmed up with existing nodes.', t => {
  const { doc, index } = _setup()
  const N = doc.getNodes().size
  t.equal(index.select.callCount, N, 'index.select() should have been called for all nodes')
  t.equal(index.create.callCount, N, 'index.create() should have been called for all nodes')
  t.end()
})

test('DocumentIndex: index should be updated correctly when creating a node.', t => {
  const { doc, index } = _setup()
  _reset(index)
  const p = doc.create({ type: 'paragraph', id: 'test' })
  t.equal(index.create.callCount, 1, 'index.create() should have been called')
  t.deepEqual(index.create.args, [p], '.. with correct arguments')
  t.end()
})

test('DocumentIndex: index should be updated correctly when deleting a node.', t => {
  const { doc, index } = _setup()
  _reset(index)
  const p1 = doc.get('p1')
  doc.delete('p1')
  t.equal(index.delete.callCount, 1, 'index.delete() should have been called')
  t.deepEqual(index.delete.args, [p1], '.. with correct arguments')
  t.end()
})

test('DocumentIndex: index should be updated correctly when setting a node property.', t => {
  const { doc, index } = _setup()
  _reset(index)
  doc.set(['body', 'nodes'], ['p1', 'p2', 'p3'])
  t.equal(index.update.callCount, 1, 'index.update() should have been called')
  t.deepEqual(index.update.args, [doc.get('body'), ['body', 'nodes'], ['p1', 'p2', 'p3'], ['p1', 'p2', 'p3', 'p4']], '.. with correct arguments')
  t.end()
})

test('DocumentIndex: index should be updated correctly when updating a node property.', t => {
  const { doc, index } = _setup()
  _reset(index)
  const body = doc.get('body')
  body.remove('p4')
  t.equal(index.update.callCount, 1, 'index.update() should have been called')
  t.deepEqual(index.update.args, [doc.get('body'), ['body', 'nodes'], ['p1', 'p2', 'p3'], ['p1', 'p2', 'p3', 'p4']], '.. with correct arguments')
  t.end()
})

class TestIndex extends DocumentIndex {
  clear () {}
  select () { return true }
  create () {}
  delete () {}
  update () {}
}

const methods = ['select', 'create', 'delete', 'update']

function _setup () {
  const doc = fixture(simple)
  const index = new TestIndex()
  methods.forEach(m => spy(index, m))
  doc.addIndex('test', index)
  return { doc, index }
}

function _reset (index) {
  methods.forEach(m => index[m].reset())
}