Replace onDidChange with an enhanced version of onDidChangeText

package.json

@@ -1,6 +1,6 @@
 {
  "name": "text-buffer",
- "version": "13.6.1",
+ "version": "13.7.0-did-change-event-1",
  "description": "A container for large mutable strings with annotated regions",
  "main": "./lib/text-buffer",
  "scripts": {

spec/marker-layer-spec.coffee

@@ -183,7 +183,7 @@ describe "MarkerLayer", ->
  displayLayerDidChange = false
 
  changeCount = 0
- buffer.onDidChangeText ->
+ buffer.onDidChange ->
  changeCount++
 
  updateCount = 0

spec/text-buffer-io-spec.js

@@ -193,18 +193,12 @@ describe('TextBuffer IO', () => {
  fs.writeFileSync(filePath, 'abcdXefg', 'utf8')
 
  {
- const subscription = buffer.onDidChange(() => {
- subscription.dispose()
- buffer.setText('')
- })
- }
-
- {
- const subscription = buffer.onDidChangeText(({changes}) => {
+ const subscription = buffer.onDidChange(({changes}) => {
  subscription.dispose()
  expect(changes.length).toBe(1)
- expect(changes[0].oldText).toBe('abcdefg')
- expect(changes[0].newText).toBe('')
+ expect(changes[0].oldText).toBe('')
+ expect(changes[0].newText).toBe('X')
+ buffer.setText('')
  })
  }
 
@@ -218,6 +212,9 @@ describe('TextBuffer IO', () => {
 
  expect(buffer.getText()).toBe('')
 
+ buffer.undo()
+ expect(buffer.getText()).toBe('abcdXefg')
+
  buffer.undo()
  expect(buffer.getText()).toBe('abcdefg')
 
@@ -257,7 +254,6 @@ describe('TextBuffer IO', () => {
  const changeEvents = []
  buffer.onWillChange(() => changeEvents.push(['will-change']))
  buffer.onDidChange((event) => changeEvents.push(['did-change', event]))
- buffer.onDidChangeText((event) => changeEvents.push(['did-change-text', event]))
 
  buffer.save().then(() => {
  expect(buffer.isModified()).toBe(false)
@@ -881,11 +877,7 @@ describe('TextBuffer IO', () => {
  expect(buffer.getText()).toEqual('abcde')
  events.push(['will-change'])
  })
- buffer.onDidChange((event) => {
- expect(buffer.getText()).toEqual(newText)
- events.push(['did-change', event])
- })
- buffer.onDidChangeText((event) => events.push(['did-change-text', event]))
+ buffer.onDidChange((event) => events.push(['did-change', event]))
  buffer.onDidReload((event) => events.push(['did-reload']))
 
  const markerB = buffer.markRange(Range(Point(0, 1), Point(0, 2)))
@@ -915,12 +907,6 @@ describe('TextBuffer IO', () => {
  'did-change', {
  oldRange: Range(Point(0, 0), Point(0, 5)),
  newRange: Range(Point(0, 0), Point(0, newText.length)),
- oldText: 'abcde',
- newText: newText
- }
- ],
- [
- 'did-change-text', {
  changes: [
  {
  oldRange: Range(Point.ZERO, Point.ZERO),
@@ -952,7 +938,6 @@ describe('TextBuffer IO', () => {
  const events = []
  buffer.onWillChange(() => events.push(['will-change']))
  buffer.onDidChange((event) => events.push(['did-change', event]))
- buffer.onDidChangeText((event) => events.push(['did-change-text', event]))
 
  const subscription = buffer.onDidReload(() => {
  subscription.dispose()
@@ -967,12 +952,6 @@ describe('TextBuffer IO', () => {
  'did-change', {
  oldRange: Range(Point(0, 3), Point(0, 5)),
  newRange: Range(Point(0, 3), Point(0, 7)),
- oldText: 'de',
- newText: ' de '
- }
- ],
- [
- 'did-change-text', {
  changes: [
  {
  oldRange: Range(Point(0, 3), Point(0, 3)),
@@ -1000,7 +979,6 @@ describe('TextBuffer IO', () => {
  buffer.onWillReload((event) => events.push(event))
  buffer.onDidReload((event) => events.push(event))
  buffer.onDidChange((event) => events.push(event))
- buffer.onDidChangeText((event) => events.push(event))
  buffer.onDidConflict((event) => events.push(event))
 
  fs.writeFileSync(buffer.getPath(), 'abcde')
@@ -1019,7 +997,6 @@ describe('TextBuffer IO', () => {
  const changeEvents = []
  buffer.onWillChange(() => changeEvents.push('will-change'))
  buffer.onDidChange((event) => changeEvents.push('did-change'))
- buffer.onDidChangeText((event) => changeEvents.push('did-change-text'))
 
  // We debounce file system change events to avoid redundant loads. But
  // for large files, another file system change event may occur *after* the
@@ -1049,9 +1026,9 @@ describe('TextBuffer IO', () => {
  }, buffer.fileChangeDelay + 50)
  }, buffer.fileChangeDelay + 50)
 
- const subscription = buffer.onDidChangeText(() => {
+ const subscription = buffer.onDidChange(() => {
  if (buffer.getText() === 'abcdef') {
- expect(changeEvents).toEqual(['will-change', 'did-change', 'did-change-text'])
+ expect(changeEvents).toEqual(['will-change', 'did-change'])
  subscription.dispose()
  done()
  }

spec/text-buffer-spec.coffee

@@ -97,22 +97,27 @@ describe "TextBuffer", ->
  expect(buffer.getText()).toEqual "hey\nyou're old\r\nhow are you doing?"
 
  describe "after a change", ->
- it "notifies, in order, decoration layers, display layers, ::onDidChange observers and display layer ::onDidChangeSync observers with the relevant details", ->
+ it "notifies, in order, decoration layers, display layers, and display layer ::onDidChangeSync observers with the relevant details", ->
  events = []
- textDecorationLayer1 = {bufferDidChange: (e) -> events.push({source: textDecorationLayer1, event: e})}
- textDecorationLayer2 = {bufferDidChange: (e) -> events.push({source: textDecorationLayer2, event: e})}
+ textDecorationLayer1 = {
+ bufferDidChange: (e) -> events.push({source: 'decoration-layer-1', event: e})
+ }
+ textDecorationLayer2 = {
+ bufferDidChange: (e) -> events.push({source: 'decoration-layer-2', event: e}),
+ jasmineToString: -> '<TextDecorationLayer2>'
+ }
  displayLayer1 = buffer.addDisplayLayer()
  displayLayer2 = buffer.addDisplayLayer()
  spyOn(displayLayer1, 'bufferDidChange').and.callFake (e) ->
- events.push({source: displayLayer1, event: e})
+ events.push({source: 'display-layer-1', event: e})
  DisplayLayer.prototype.bufferDidChange.call(displayLayer1, e)
  spyOn(displayLayer2, 'bufferDidChange').and.callFake (e) ->
- events.push({source: displayLayer2, event: e})
+ events.push({source: 'display-layer-2', event: e})
  DisplayLayer.prototype.bufferDidChange.call(displayLayer2, e)
- buffer.onDidChange (e) -> events.push({source: buffer, event: e})
  buffer.registerTextDecorationLayer(textDecorationLayer1)
  buffer.registerTextDecorationLayer(textDecorationLayer1) # insert a duplicate decoration layer
  buffer.registerTextDecorationLayer(textDecorationLayer2)
+ buffer.onDidChange (e) -> events.push({source: 'buffer', event: JSON.parse(JSON.stringify(e))})
 
  disposable = displayLayer1.onDidChangeSync ->
  disposable.dispose()
@@ -128,17 +133,31 @@ describe "TextBuffer", ->
  oldText: "a", newText: "abc",
  }
  expect(events).toEqual [
- {source: textDecorationLayer1, event: changeEvent1},
- {source: textDecorationLayer2, event: changeEvent1},
- {source: displayLayer1, event: changeEvent1},
- {source: displayLayer2, event: changeEvent1},
- {source: buffer, event: changeEvent1},
-
- {source: textDecorationLayer1, event: changeEvent2},
- {source: textDecorationLayer2, event: changeEvent2},
- {source: displayLayer1, event: changeEvent2},
- {source: displayLayer2, event: changeEvent2},
- {source: buffer, event: changeEvent2}
+ {source: 'decoration-layer-1', event: changeEvent1},
+ {source: 'decoration-layer-2', event: changeEvent1},
+ {source: 'display-layer-1', event: changeEvent1},
+ {source: 'display-layer-2', event: changeEvent1},
+
+ {source: 'decoration-layer-1', event: changeEvent2},
+ {source: 'decoration-layer-2', event: changeEvent2},
+ {source: 'display-layer-1', event: changeEvent2},
+ {source: 'display-layer-2', event: changeEvent2},
+
+ {
+ source: 'buffer',
+ event: {
+ oldRange: Range(Point(0, 2), Point(2, 3)),
+ newRange: Range(Point(0, 2), Point(2, 4)),
+ changes: [
+ {
+ oldRange: Range(Point(0, 2), Point(2, 3)),
+ newRange: Range(Point(0, 2), Point(2, 4)),
+ oldText: "llo\nworld\r\nhow",
+ newText: "y there\r\ncabct\nwhat"
+ }
+ ]
+ }
+ }
  ]
 
  it "returns the newRange of the change", ->
@@ -214,8 +233,8 @@ describe "TextBuffer", ->
  }])
 
  it "still emits text change events (regression)", (done) ->
-didChangeTextEvents = []
- buffer.onDidChangeText (event) -> didChangeTextEvents.push(event)
+didChangeEvents = []
+ buffer.onDidChange (event) -> didChangeEvents.push(event)
 
  buffer.onDidStopChanging ({changes}) ->
  assertChangesEqual(changes, [{
@@ -227,17 +246,17 @@ describe "TextBuffer", ->
  done()
 
  buffer.setTextInRange([[0, 0], [0, 1]], 'y', {undo: 'skip'})
- expect(didChangeTextEvents.length).toBe(1)
- assertChangesEqual(didChangeTextEvents[0].changes, [{
+ expect(didChangeEvents.length).toBe(1)
+ assertChangesEqual(didChangeEvents[0].changes, [{
  oldRange: [[0, 0], [0, 1]],
  newRange: [[0, 0], [0, 1]],
  oldText: 'h',
  newText: 'y'
  }])
 
  buffer.transact -> buffer.setTextInRange([[0, 0], [0, 1]], 'z', {undo: 'skip'})
- expect(didChangeTextEvents.length).toBe(2)
- assertChangesEqual(didChangeTextEvents[1].changes, [{
+ expect(didChangeEvents.length).toBe(2)
+ assertChangesEqual(didChangeEvents[1].changes, [{
  oldRange: [[0, 0], [0, 1]],
  newRange: [[0, 0], [0, 1]],
  oldText: 'y',
@@ -266,28 +285,28 @@ describe "TextBuffer", ->
  expect(changeEvents[1].newText).toBe "ms\r\ndo you\r\nlike\r\ndirt"
 
  buffer.setTextInRange([[5, 1], [5, 3]], '\r')
- expect(changeEvents[2]).toEqual({
+ expect(changeEvents[2].changes).toEqual([{
  oldRange: [[5, 1], [5, 3]],
  newRange: [[5, 1], [6, 0]],
  oldText: 'ik',
  newText: '\r\n'
- })
+ }])
 
  buffer.undo()
- expect(changeEvents[3]).toEqual({
+ expect(changeEvents[3].changes).toEqual([{
  oldRange: [[5, 1], [6, 0]],
  newRange: [[5, 1], [5, 3]],
  oldText: '\r\n',
  newText: 'ik'
- })
+ }])
 
  buffer.redo()
- expect(changeEvents[4]).toEqual({
+ expect(changeEvents[4].changes).toEqual([{
  oldRange: [[5, 1], [5, 3]],
  newRange: [[5, 1], [6, 0]],
  oldText: 'ik',
  newText: '\r\n'
- })
+ }])
 
  describe "when the range's start row has no line ending (because it's the last line of the buffer)", ->
  describe "when the buffer contains no newlines", ->
@@ -2245,7 +2264,7 @@ describe "TextBuffer", ->
  buffer.setText('\n')
  expect(buffer.isEmpty()).toBeFalsy()
 
- describe "::onWillChange", ->
+ describe "::onWillChange(callback)", ->
  it "notifies observers before a transaction, an undo or a redo", ->
  changeCount = 0
  expectedText = ''
@@ -2282,14 +2301,14 @@ describe "TextBuffer", ->
  buffer.revertToCheckpoint(checkpoint)
  expect(changeCount).toBe(5)
 
- describe "::onDidChangeText(callback)", ->
+ describe "::onDidChange(callback)", ->
  beforeEach ->
  filePath = require.resolve('./fixtures/sample.js')
  buffer = TextBuffer.loadSync(filePath)
 
  it "notifies observers after a transaction, an undo or a redo", ->
  textChanges = []
- buffer.onDidChangeText ({changes}) -> textChanges.push(changes...)
+ buffer.onDidChange ({changes}) -> textChanges.push(changes...)
 
  buffer.insert([0, 0], "abc")
  buffer.delete([[0, 0], [0, 1]])
@@ -2383,12 +2402,12 @@ describe "TextBuffer", ->
 
  it "doesn't notify observers after an empty transaction", ->
  didChangeTextSpy = jasmine.createSpy()
- buffer.onDidChangeText(didChangeTextSpy)
+ buffer.onDidChange(didChangeTextSpy)
  buffer.transact(->)
  expect(didChangeTextSpy).not.toHaveBeenCalled()
 
  it "doesn't throw an error when clearing the undo stack within a transaction", ->
- buffer.onDidChangeText(didChangeTextSpy = jasmine.createSpy())
+ buffer.onDidChange(didChangeTextSpy = jasmine.createSpy())
  expect(-> buffer.transact(-> buffer.clearUndoStack())).not.toThrowError()
  expect(didChangeTextSpy).not.toHaveBeenCalled()
 
@@ -2457,8 +2476,8 @@ describe "TextBuffer", ->
  ])
  done()
 
- it "provides the correct changes when the buffer is mutated in the onDidChangeText callback", (done) ->
- buffer.onDidChangeText ({changes}) ->
+ it "provides the correct changes when the buffer is mutated in the onDidChange callback", (done) ->
+ buffer.onDidChange ({changes}) ->
  switch changes[0].newText
  when 'a'
  buffer.insert(changes[0].newRange.end, 'b')

src/helpers.js

@@ -93,6 +93,15 @@ class TextChange {
  this.oldText = oldText
  this.newText = newText
  }
+
+ isEqual (other) {
+ return (
+ this.oldRange.isEqual(other.oldRange) &&
+ this.newRange.isEqual(other.newRange) &&
+ this.oldText === other.oldText &&
+ this.newText === other.newText
+ )
+ }
 }
 
 Object.defineProperty(TextChange.prototype, 'start', {