Rename stable: true to avoidOverlay: false and fix tests

As part of the test fixes, I’m honoring the `autoscroll: false` option in `insertText` and `insertNewline` to avoid inadvertently scrolling the editor during tests when the editor is modified.
cebjyre · Nov 28, 2016 · f4c45c1 · f4c45c1
1 parent f9ef678
commit f4c45c1
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 20 deletions.
diff --git a/spec/text-editor-presenter-spec.coffee b/spec/text-editor-presenter-spec.coffee
@@ -2501,13 +2501,13 @@ describe "TextEditorPresenter", ->
               pixelPosition: {top: 1 * 10, left: 26 * 10 + gutterWidth - scrollLeft}
             }
 
-            expectStateUpdate presenter, -> editor.insertText('a')
+            expectStateUpdate presenter, -> editor.insertText('abc', autoscroll: false)
             expectValues stateForOverlay(presenter, decoration), {
               item: item
               pixelPosition: {top: 1 * 10, left: windowWidth - itemWidth}
             }
 
-            expectStateUpdate presenter, -> editor.insertText('b')
+            expectStateUpdate presenter, -> editor.insertText('d', autoscroll: false)
             expectValues stateForOverlay(presenter, decoration), {
               item: item
               pixelPosition: {top: 1 * 10, left: windowWidth - itemWidth}
@@ -2528,18 +2528,17 @@ describe "TextEditorPresenter", ->
             }
 
             expectStateUpdate presenter, ->
-              editor.insertNewline()
-              presenter.setScrollTop(scrollTop) # I'm fighting the editor
+              editor.insertNewline(autoscroll: false)
 
             expectValues stateForOverlay(presenter, decoration), {
               item: item
               pixelPosition: {top: 6 * 10 - scrollTop - itemHeight, left: gutterWidth}
             }
 
-          it "does not slide horizontally when set to stable", ->
+          it "when avoidOverflow is false, does not move horizontally when overflowing the editor's scrollView horizontally", ->
             scrollLeft = 20
             marker = editor.markBufferPosition([0, 26], invalidate: 'never')
-            decoration = editor.decorateMarker(marker, {type: 'overlay', item, stable: true})
+            decoration = editor.decorateMarker(marker, {type: 'overlay', item, avoidOverflow: false})
 
             presenter = buildPresenter({scrollLeft, windowWidth, windowHeight, contentFrameWidth, boundingClientRect, gutterWidth})
             expectStateUpdate presenter, ->
@@ -2550,16 +2549,16 @@ describe "TextEditorPresenter", ->
               pixelPosition: {top: 1 * 10, left: 26 * 10 + gutterWidth - scrollLeft}
             }
 
-            expectStateUpdate presenter, -> editor.insertText('a')
+            expectStateUpdate presenter, -> editor.insertText('a', autoscroll: false)
             expectValues stateForOverlay(presenter, decoration), {
               item: item
-              pixelPosition: {top: 1 * 10, left: 26 * 10 + gutterWidth - scrollLeft}
+              pixelPosition: {top: 1 * 10, left: 27 * 10 + gutterWidth - scrollLeft}
             }
 
-          it "does not flip vertically when set to stable", ->
+          it "when avoidOverflow is false, does not flip vertically when overflowing the editor's scrollView vertically", ->
             scrollTop = 10
             marker = editor.markBufferPosition([5, 0], invalidate: 'never')
-            decoration = editor.decorateMarker(marker, {type: 'overlay', item, stable: true})
+            decoration = editor.decorateMarker(marker, {type: 'overlay', item, avoidOverflow: false})
 
             presenter = buildPresenter({scrollTop, windowWidth, windowHeight, contentFrameWidth, boundingClientRect, gutterWidth})
             expectStateUpdate presenter, ->
@@ -2571,12 +2570,11 @@ describe "TextEditorPresenter", ->
             }
 
             expectStateUpdate presenter, ->
-              editor.insertNewline()
-              presenter.setScrollTop(scrollTop) # I'm fighting the editor
+              editor.insertNewline(autoscroll: false)
 
             expectValues stateForOverlay(presenter, decoration), {
               item: item
-              pixelPosition: {top: 6 * 10 - scrollTop, left: gutterWidth}
+              pixelPosition: {top: 7 * 10 - scrollTop, left: gutterWidth}
             }
 
           describe "when the overlay item has a margin", ->

diff --git a/src/selection.coffee b/src/selection.coffee
@@ -366,7 +366,7 @@ class Selection extends Model
   insertText: (text, options={}) ->
     oldBufferRange = @getBufferRange()
     wasReversed = @isReversed()
-    @clear()
+    @clear(options)
 
     autoIndentFirstLine = false
     precedingText = @editor.getTextInRange([[oldBufferRange.start.row, 0], oldBufferRange.start])
@@ -403,7 +403,7 @@ class Selection extends Model
     else if options.autoDecreaseIndent and NonWhitespaceRegExp.test(text)
       @editor.autoDecreaseIndentForBufferRow(newBufferRange.start.row)
 
-    @autoscroll() if @isLastSelection()
+    @autoscroll() if options.autoscroll ? @isLastSelection()
 
     newBufferRange
 

diff --git a/src/text-editor-presenter.coffee b/src/text-editor-presenter.coffee
@@ -451,7 +451,7 @@ class TextEditorPresenter
     for decoration in @model.getOverlayDecorations()
       continue unless decoration.getMarker().isValid()
 
-      {item, position, class: klass, stable} = decoration.getProperties()
+      {item, position, class: klass, avoidOverflow} = decoration.getProperties()
       if position is 'tail'
         screenPosition = decoration.getMarker().getTailScreenPosition()
       else
@@ -466,8 +466,7 @@ class TextEditorPresenter
       if overlayDimensions = @overlayDimensions[decoration.id]
         {itemWidth, itemHeight, contentMargin} = overlayDimensions
 
-        if not stable
-
+        if avoidOverflow isnt false
           rightDiff = left + itemWidth + contentMargin - @windowWidth
           left -= rightDiff if rightDiff > 0
 

diff --git a/src/text-editor.coffee b/src/text-editor.coffee
@@ -1085,8 +1085,8 @@ class TextEditor extends Model
     )
 
   # Essential: For each selection, replace the selected text with a newline.
-  insertNewline: ->
-    @insertText('\n')
+  insertNewline: (options) ->
+    @insertText('\n', options)
 
   # Essential: For each selection, if the selection is empty, delete the character
   # following the cursor. Otherwise delete the selected text.