pagebreakediting.js 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import PageBreakEditing from '../src/pagebreakediting';
  7. import PageBreakCommand from '../src/pagebreakcommand';
  8. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  9. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  10. import { isWidget } from '@ckeditor/ckeditor5-widget/src/utils';
  11. import env from '@ckeditor/ckeditor5-utils/src/env';
  12. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  13. describe( 'PageBreakEditing', () => {
  14. let editor, model, view, viewDocument;
  15. testUtils.createSinonSandbox();
  16. beforeEach( () => {
  17. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  18. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  19. return VirtualTestEditor
  20. .create( {
  21. plugins: [ PageBreakEditing ]
  22. } )
  23. .then( newEditor => {
  24. editor = newEditor;
  25. model = editor.model;
  26. view = editor.editing.view;
  27. viewDocument = view.document;
  28. } );
  29. } );
  30. it( 'should have pluginName', () => {
  31. expect( PageBreakEditing.pluginName ).to.equal( 'PageBreakEditing' );
  32. } );
  33. it( 'should be loaded', () => {
  34. expect( editor.plugins.get( PageBreakEditing ) ).to.be.instanceOf( PageBreakEditing );
  35. } );
  36. it( 'should set proper schema rules', () => {
  37. expect( model.schema.checkChild( [ '$root' ], 'pageBreak' ) ).to.be.true;
  38. expect( model.schema.isObject( 'pageBreak' ) ).to.be.true;
  39. expect( model.schema.checkChild( [ '$root', 'pageBreak' ], '$text' ) ).to.be.false;
  40. expect( model.schema.checkChild( [ '$root', '$block' ], 'pageBreak' ) ).to.be.false;
  41. } );
  42. it( 'should register imageInsert command', () => {
  43. expect( editor.commands.get( 'pageBreak' ) ).to.be.instanceOf( PageBreakCommand );
  44. } );
  45. describe( 'conversion in data pipeline', () => {
  46. describe( 'model to view', () => {
  47. it( 'should convert', () => {
  48. setModelData( model, '<pageBreak></pageBreak>' );
  49. expect( editor.getData() ).to.equal(
  50. '<div class="page-break" style="page-break-after:always;"><span style="display:none;">&nbsp;</span></div>'
  51. );
  52. } );
  53. } );
  54. describe( 'view to model', () => {
  55. it( 'should convert the page break code element without `.page-break` class', () => {
  56. editor.setData(
  57. '<div style="page-break-after:always;">' +
  58. '<span style="display:none;">&nbsp;</span>' +
  59. '</div>'
  60. );
  61. expect( getModelData( model, { withoutSelection: true } ) )
  62. .to.equal( '<pageBreak></pageBreak>' );
  63. } );
  64. it( 'should convert the page break code element with `.page-break` class', () => {
  65. editor.setData(
  66. '<div class="page-break" style="page-break-after:always;">' +
  67. '<span style="display:none;">&nbsp;</span>' +
  68. '</div>'
  69. );
  70. expect( getModelData( model, { withoutSelection: true } ) )
  71. .to.equal( '<pageBreak></pageBreak>' );
  72. } );
  73. it( 'should not convert in wrong context', () => {
  74. model.schema.register( 'div', { inheritAllFrom: '$block' } );
  75. model.schema.addChildCheck( ( ctx, childDef ) => {
  76. if ( ctx.endsWith( '$root' ) && childDef.name == 'pageBreak' ) {
  77. return false;
  78. }
  79. } );
  80. editor.conversion.elementToElement( { model: 'div', view: 'div' } );
  81. editor.setData(
  82. '<div>' +
  83. '<div class="page-break" style="page-break-after:always;">' +
  84. '<span style="display:none;">&nbsp;</span>' +
  85. '</div>' +
  86. '</div>'
  87. );
  88. expect( getModelData( model, { withoutSelection: true } ) )
  89. .to.equal( '<div> </div>' );
  90. } );
  91. it( 'should not convert if outer div has wrong styles', () => {
  92. editor.setData( '<div class="page-break" style="page-break-after:auto;"><span style="display:none;">&nbsp;</span></div>' );
  93. expect( getModelData( model, { withoutSelection: true } ) )
  94. .to.equal( '' );
  95. } );
  96. it( 'should not convert if outer div has no children', () => {
  97. editor.setData( '<div class="page-break" style="page-break-after:always;"></div>' );
  98. expect( getModelData( model, { withoutSelection: true } ) )
  99. .to.equal( '' );
  100. } );
  101. it( 'should not convert if outer div has too many children', () => {
  102. editor.setData(
  103. '<div class="page-break" style="page-break-after:always;">' +
  104. '<span style="display:none;">&nbsp;</span>' +
  105. '<span style="display:none;">&nbsp;</span>' +
  106. '</div>'
  107. );
  108. expect( getModelData( model, { withoutSelection: true } ) )
  109. .to.equal( '' );
  110. } );
  111. it( 'should not convert if inner span has wrong styles', () => {
  112. editor.setData(
  113. '<div class="page-break" style="page-break-after:always;">' +
  114. '<span style="display:inline-block;">&nbsp;</span>' +
  115. '</div>'
  116. );
  117. expect( getModelData( model, { withoutSelection: true } ) )
  118. .to.equal( '' );
  119. } );
  120. it( 'should not convert if inner span has wrong styles', () => {
  121. editor.setData(
  122. '<div class="page-break" style="page-break-after:always;">' +
  123. '<span style="display:inline-block;">&nbsp;</span>' +
  124. '</div>'
  125. );
  126. expect( getModelData( model, { withoutSelection: true } ) )
  127. .to.equal( '' );
  128. } );
  129. it( 'should not convert if inner span has any children', () => {
  130. editor.setData(
  131. '<div class="page-break" style="page-break-after:always;">' +
  132. '<span style="display:none;">' +
  133. '<span>Foo</span>' +
  134. '</span>' +
  135. '</div>'
  136. );
  137. expect( getModelData( model, { withoutSelection: true } ) )
  138. .to.equal( '' );
  139. } );
  140. it( 'should not convert if inner span has text', () => {
  141. editor.setData(
  142. '<div class="page-break" style="page-break-after:always;">' +
  143. '<span style="display:none;">Foo</span>' +
  144. '</div>'
  145. );
  146. expect( getModelData( model, { withoutSelection: true } ) )
  147. .to.equal( '' );
  148. } );
  149. it( 'should not convert inner span if outer div was already consumed', () => {
  150. model.schema.register( 'section', { inheritAllFrom: '$block' } );
  151. editor.conversion.elementToElement( { model: 'section', view: 'section' } );
  152. model.schema.register( 'span', { inheritAllFrom: '$block' } );
  153. editor.model.schema.extend( '$text', { allowAttributes: 'foo' } );
  154. editor.conversion.attributeToElement( {
  155. model: 'foo',
  156. view: {
  157. name: 'span',
  158. styles: {
  159. display: 'none'
  160. }
  161. }
  162. } );
  163. editor.setData(
  164. '<section>' +
  165. '<div class="page-break" style="page-break-after:always;">' +
  166. '<span style="display:none;">&nbsp;</span>' +
  167. '</div>' +
  168. '<span style="display:none;">Foo</span>' +
  169. '</section>'
  170. );
  171. expect( getModelData( model, { withoutSelection: true } ) )
  172. .to.equal( '<pageBreak></pageBreak><section><$text foo="true">Foo</$text></section>' );
  173. } );
  174. it( 'should not convert if inner span has no children', () => {
  175. editor.setData( '<div class="page-break" style="page-break-after:always;"><span style="display:none;"></span></div>' );
  176. expect( getModelData( model, { withoutSelection: true } ) )
  177. .to.equal( '' );
  178. } );
  179. it( 'should not convert if inner span has other element as a child', () => {
  180. editor.setData(
  181. '<div class="page-break" style="page-break-after:always;">' +
  182. '<span style="display:none;">' +
  183. '<span></span>' +
  184. '</span>' +
  185. '</div>'
  186. );
  187. expect( getModelData( model, { withoutSelection: true } ) )
  188. .to.equal( '' );
  189. } );
  190. } );
  191. } );
  192. describe( 'conversion in editing pipeline', () => {
  193. describe( 'model to view', () => {
  194. it( 'should convert', () => {
  195. setModelData( model, '<pageBreak></pageBreak>' );
  196. expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
  197. '<div class="ck-widget page-break" contenteditable="false"><span class="page-break__label">Page break</span></div>'
  198. );
  199. } );
  200. it( 'converted element should be widgetized', () => {
  201. setModelData( model, '<pageBreak></pageBreak>' );
  202. const widget = viewDocument.getRoot().getChild( 0 );
  203. expect( widget.name ).to.equal( 'div' );
  204. expect( isPageBreakWidget( widget ) ).to.be.true;
  205. } );
  206. } );
  207. } );
  208. function isPageBreakWidget( viewElement ) {
  209. return !!viewElement.getCustomProperty( 'pageBreak' ) && isWidget( viewElement );
  210. }
  211. } );