bindtwostepcarettoattribute.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global document */
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
  8. import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute';
  9. import Position from '../../src/model/position';
  10. import Range from '../../src/model/range';
  11. import DomEventData from '../../src/view/observer/domeventdata';
  12. import { upcastElementToAttribute } from '../../src/conversion/upcast-converters';
  13. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  14. import { setData } from '../../src/dev-utils/model';
  15. describe( 'bindTwoStepCaretToAttribute()', () => {
  16. let editor, model, emitter, selection, viewDoc, preventDefaultSpy;
  17. beforeEach( () => {
  18. emitter = Object.create( DomEmitterMixin );
  19. return VirtualTestEditor.create().then( newEditor => {
  20. editor = newEditor;
  21. model = editor.model;
  22. selection = model.document.selection;
  23. viewDoc = editor.editing.view;
  24. preventDefaultSpy = sinon.spy();
  25. editor.model.schema.extend( '$text', {
  26. allowAttributes: [ 'a', 'b', 'c' ],
  27. allowIn: '$root'
  28. } );
  29. editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'a', model: 'a' } ) );
  30. editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'b', model: 'b' } ) );
  31. editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'c', model: 'c' } ) );
  32. bindTwoStepCaretToAttribute( editor, emitter, 'a' );
  33. } );
  34. } );
  35. afterEach( () => {
  36. return editor.destroy();
  37. } );
  38. describe( 'moving right', () => {
  39. it( 'should "enter" the text with attribute in two steps', () => {
  40. setData( model, '<$text c="true">foo[]</$text><$text a="true" b="true">bar</$text>' );
  41. // Gravity is not overridden, caret is at the beginning of the text but is "outside" of the text.
  42. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] );
  43. expect( selection.isGravityOverridden ).to.false;
  44. // Press right key.
  45. viewDoc.fire( 'keydown', getEventData( {
  46. keyCode: keyCodes.arrowright,
  47. preventDefault: preventDefaultSpy
  48. } ) );
  49. // Gravity is overridden, caret movement is blocked, selection at the beginning but "inside" the text.
  50. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] );
  51. expect( selection.isGravityOverridden ).to.true;
  52. sinon.assert.calledOnce( preventDefaultSpy );
  53. // Press right key.
  54. viewDoc.fire( 'keydown', getEventData( {
  55. keyCode: keyCodes.arrowright,
  56. preventDefault: preventDefaultSpy
  57. } ) );
  58. // Caret movement was not blocked this time (still once) so everything works normally.
  59. sinon.assert.calledOnce( preventDefaultSpy );
  60. } );
  61. it( 'should "leave" the text with attribute in two steps', () => {
  62. setData( model, '<$text a="true" b="true">bar[]</$text><$text c="true">foo</$text>' );
  63. // Gravity is not overridden, caret is at the end of the text but is "inside" of the text.
  64. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] );
  65. expect( selection.isGravityOverridden ).to.false;
  66. // Press right key.
  67. viewDoc.fire( 'keydown', getEventData( {
  68. keyCode: keyCodes.arrowright,
  69. preventDefault: preventDefaultSpy
  70. } ) );
  71. // Gravity is overridden, caret movement is blocked, selection at the beginning but "outside" the text.
  72. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] );
  73. expect( selection.isGravityOverridden ).to.true;
  74. sinon.assert.calledOnce( preventDefaultSpy );
  75. // Press right key.
  76. viewDoc.fire( 'keydown', getEventData( {
  77. keyCode: keyCodes.arrowright,
  78. preventDefault: preventDefaultSpy
  79. } ) );
  80. // Caret movement was not blocked this time (still once) so everything works normally.
  81. sinon.assert.calledOnce( preventDefaultSpy );
  82. } );
  83. it( 'should do nothing for not bound attribute (at the beginning)', () => {
  84. setData( model, '[]<$text c="true">foo</$text>' );
  85. viewDoc.fire( 'keydown', getEventData( {
  86. keyCode: keyCodes.arrowright,
  87. preventDefault: preventDefaultSpy
  88. } ) );
  89. sinon.assert.notCalled( preventDefaultSpy );
  90. expect( selection.isGravityOverridden ).to.false;
  91. } );
  92. it( 'should do nothing for not bound attribute (at the end)', () => {
  93. setData( model, '<$text c="true">foo[]</$text>' );
  94. viewDoc.fire( 'keydown', getEventData( {
  95. keyCode: keyCodes.arrowright,
  96. preventDefault: preventDefaultSpy
  97. } ) );
  98. sinon.assert.notCalled( preventDefaultSpy );
  99. expect( selection.isGravityOverridden ).to.false;
  100. } );
  101. } );
  102. describe( 'moving left', () => {
  103. it( 'should "enter" the text with attribute in two steps', () => {
  104. setData( model, '<$text>foo</$text><$text a="true" b="true">bar</$text><$text c="true">b[]iz</$text>' );
  105. // Gravity is not overridden, caret is a one character after the and of the text.
  106. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] );
  107. expect( selection.isGravityOverridden ).to.false;
  108. // Press left key.
  109. viewDoc.fire( 'keydown', getEventData( {
  110. keyCode: keyCodes.arrowleft,
  111. preventDefault: preventDefaultSpy
  112. } ) );
  113. // Caret movement was not blocked.
  114. sinon.assert.notCalled( preventDefaultSpy );
  115. // So we need to move caret one character left like it should be done in the real world.
  116. // Caret should ends up at the end of text with attribute but still outside of it.
  117. model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 6 ] ) ) ) );
  118. // Gravity is overridden.
  119. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] );
  120. expect( selection.isGravityOverridden ).to.true;
  121. // Press left key.
  122. viewDoc.fire( 'keydown', getEventData( {
  123. keyCode: keyCodes.arrowleft,
  124. preventDefault: preventDefaultSpy
  125. } ) );
  126. // Caret movement was blocked but now is "inside" the text.
  127. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] );
  128. expect( selection.isGravityOverridden ).to.false;
  129. sinon.assert.calledOnce( preventDefaultSpy );
  130. // Press left key.
  131. viewDoc.fire( 'keydown', getEventData( {
  132. keyCode: keyCodes.arrowleft,
  133. preventDefault: preventDefaultSpy
  134. } ) );
  135. // Caret movement was not blocked this time (still once) so everything works normally.
  136. sinon.assert.calledOnce( preventDefaultSpy );
  137. // And again we need to move the caret like it should be done in the real world to be shure that everything is
  138. // like it should to be.
  139. model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 5 ] ) ) ) );
  140. } );
  141. it( 'should "leave" the text with attribute in two steps', () => {
  142. setData( model, '<$text c="true">foo</$text><$text a="true" b="true">b[]ar</$text>' );
  143. // Gravity is not overridden, caret is a one character after the beginning of the text.
  144. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] );
  145. expect( selection.isGravityOverridden ).to.false;
  146. // Press left key.
  147. viewDoc.fire( 'keydown', getEventData( {
  148. keyCode: keyCodes.arrowleft,
  149. preventDefault: preventDefaultSpy
  150. } ) );
  151. // Caret movement was not blocked.
  152. sinon.assert.notCalled( preventDefaultSpy );
  153. // So we need to move caret one character left like it should be done in the real world.
  154. // Caret should ends up at the beginning of text with attribute but still inside of it.
  155. model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 3 ] ) ) ) );
  156. // Gravity is overridden, caret is at the beginning of the text and is "inside" of the text.
  157. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] );
  158. expect( selection.isGravityOverridden ).to.true;
  159. // Press left key.
  160. viewDoc.fire( 'keydown', getEventData( {
  161. keyCode: keyCodes.arrowleft,
  162. preventDefault: preventDefaultSpy
  163. } ) );
  164. // Gravity is not overridden, caret movement was blocked but now is "outside" the text.
  165. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] );
  166. expect( selection.isGravityOverridden ).to.false;
  167. sinon.assert.calledOnce( preventDefaultSpy );
  168. // Press left key.
  169. viewDoc.fire( 'keydown', getEventData( {
  170. keyCode: keyCodes.arrowleft,
  171. preventDefault: preventDefaultSpy
  172. } ) );
  173. // Caret movement was not blocked this time (still once) so everything works normally.
  174. sinon.assert.calledOnce( preventDefaultSpy );
  175. } );
  176. it( 'should do nothing for not bound attribute (at the beginning)', () => {
  177. setData( model, '<$text c="true">[]foo</$text>' );
  178. viewDoc.fire( 'keydown', getEventData( {
  179. keyCode: keyCodes.arrowright,
  180. preventDefault: preventDefaultSpy
  181. } ) );
  182. sinon.assert.notCalled( preventDefaultSpy );
  183. expect( selection.isGravityOverridden ).to.false;
  184. } );
  185. it( 'should do nothing for not bound attribute (at the end)', () => {
  186. setData( model, '<$text c="true">foo</$text>[]' );
  187. viewDoc.fire( 'keydown', getEventData( {
  188. keyCode: keyCodes.arrowright,
  189. preventDefault: preventDefaultSpy
  190. } ) );
  191. sinon.assert.notCalled( preventDefaultSpy );
  192. expect( selection.isGravityOverridden ).to.false;
  193. } );
  194. it( 'should do nothing when caret is at the beginning of block element', () => {
  195. setData( model, '[]foo', { lastRangeBackward: true } );
  196. expect( () => {
  197. viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowleft } ) );
  198. } ).to.not.throw();
  199. } );
  200. } );
  201. describe( 'mouse', () => {
  202. it( 'should not override gravity when selection is placed at the beginning of text', () => {
  203. setData( model, '<$text a="true">[]foo</$text>' );
  204. expect( selection.isGravityOverridden ).to.false;
  205. } );
  206. it( 'should not override gravity when selection is placed at the end of text', () => {
  207. setData( model, '<$text a="true">foo[]</$text>' );
  208. expect( selection.isGravityOverridden ).to.false;
  209. } );
  210. } );
  211. it( 'should do nothing when key other then arrow left and right is pressed', () => {
  212. setData( model, '<$text a="true">foo[]</$text>' );
  213. expect( () => {
  214. viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowup } ) );
  215. } ).to.not.throw();
  216. } );
  217. it( 'should do nothing for non-collapsed selection', () => {
  218. setData( model, '<$text c="true">fo[o]</$text><$text a="true" b="true">bar</$text>' );
  219. viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright } ) );
  220. expect( selection.isGravityOverridden ).to.false;
  221. } );
  222. function getEventData( data ) {
  223. data.target = document.body;
  224. return new DomEventData( viewDoc, data, { keyCode: data.keyCode } );
  225. }
  226. } );