pagebreakediting.js 8.1 KB

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