pagebreakediting.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  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 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( '<pageBreak></pageBreak>' );
  97. } );
  98. it( 'should convert if outer div has page-break-before style', () => {
  99. editor.setData( '<div class="page-break" style="page-break-before:always;"></div>' );
  100. expect( getModelData( model, { withoutSelection: true } ) )
  101. .to.equal( '<pageBreak></pageBreak>' );
  102. } );
  103. it( 'should convert if outer div has page-break-after style', () => {
  104. editor.setData( '<div class="page-break" style="page-break-after:always;"></div>' );
  105. expect( getModelData( model, { withoutSelection: true } ) )
  106. .to.equal( '<pageBreak></pageBreak>' );
  107. } );
  108. it( 'should convert if page-break-after style is on br element', () => {
  109. editor.setData( '<br style="page-break-after:always;"/>' );
  110. expect( getModelData( model, { withoutSelection: true } ) )
  111. .to.equal( '<pageBreak></pageBreak>' );
  112. } );
  113. it( 'should convert if page-break-before style is on br element', () => {
  114. editor.setData( '<br style="page-break-after:always;"/>' );
  115. expect( getModelData( model, { withoutSelection: true } ) )
  116. .to.equal( '<pageBreak></pageBreak>' );
  117. } );
  118. it( 'should not convert if outer div has too many children', () => {
  119. editor.setData(
  120. '<div class="page-break" style="page-break-after:always;">' +
  121. '<span style="display:none;">&nbsp;</span>' +
  122. '<span style="display:none;">&nbsp;</span>' +
  123. '</div>'
  124. );
  125. expect( getModelData( model, { withoutSelection: true } ) )
  126. .to.equal( '' );
  127. } );
  128. it( 'should not convert if inner span has wrong styles', () => {
  129. editor.setData(
  130. '<div class="page-break" style="page-break-after:always;">' +
  131. '<span style="display:inline-block;">&nbsp;</span>' +
  132. '</div>'
  133. );
  134. expect( getModelData( model, { withoutSelection: true } ) )
  135. .to.equal( '' );
  136. } );
  137. it( 'should not convert if inner span has any children', () => {
  138. editor.setData(
  139. '<div class="page-break" style="page-break-after:always;">' +
  140. '<span style="display:none;">' +
  141. '<span>Foo</span>' +
  142. '</span>' +
  143. '</div>'
  144. );
  145. expect( getModelData( model, { withoutSelection: true } ) )
  146. .to.equal( '' );
  147. } );
  148. it( 'should not convert if inner span has text', () => {
  149. editor.setData(
  150. '<div class="page-break" style="page-break-after:always;">' +
  151. '<span style="display:none;">Foo</span>' +
  152. '</div>'
  153. );
  154. expect( getModelData( model, { withoutSelection: true } ) )
  155. .to.equal( '' );
  156. } );
  157. it( 'should not convert inner span if outer div was already consumed', () => {
  158. model.schema.register( 'section', { inheritAllFrom: '$block' } );
  159. editor.conversion.elementToElement( { model: 'section', view: 'section' } );
  160. model.schema.register( 'span', { inheritAllFrom: '$block' } );
  161. editor.model.schema.extend( '$text', { allowAttributes: 'foo' } );
  162. editor.conversion.attributeToElement( {
  163. model: 'foo',
  164. view: {
  165. name: 'span',
  166. styles: {
  167. display: 'none'
  168. }
  169. }
  170. } );
  171. editor.setData(
  172. '<section>' +
  173. '<div class="page-break" style="page-break-after:always;">' +
  174. '<span style="display:none;">&nbsp;</span>' +
  175. '</div>' +
  176. '<span style="display:none;">Foo</span>' +
  177. '</section>'
  178. );
  179. expect( getModelData( model, { withoutSelection: true } ) )
  180. .to.equal( '<pageBreak></pageBreak><section><$text foo="true">Foo</$text></section>' );
  181. } );
  182. it( 'should not convert if inner span has no children', () => {
  183. editor.setData( '<div class="page-break" style="page-break-after:always;"><span style="display:none;"></span></div>' );
  184. expect( getModelData( model, { withoutSelection: true } ) )
  185. .to.equal( '' );
  186. } );
  187. it( 'should not convert if inner span has other element as a child', () => {
  188. editor.setData(
  189. '<div class="page-break" style="page-break-after:always;">' +
  190. '<span style="display:none;">' +
  191. '<span></span>' +
  192. '</span>' +
  193. '</div>'
  194. );
  195. expect( getModelData( model, { withoutSelection: true } ) )
  196. .to.equal( '' );
  197. } );
  198. } );
  199. } );
  200. describe( 'conversion in editing pipeline', () => {
  201. describe( 'model to view', () => {
  202. it( 'should convert', () => {
  203. setModelData( model, '<pageBreak></pageBreak>' );
  204. expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
  205. '<div class="ck-widget page-break" contenteditable="false"><span class="page-break__label">Page break</span></div>'
  206. );
  207. } );
  208. it( 'converted element should be widgetized', () => {
  209. setModelData( model, '<pageBreak></pageBreak>' );
  210. const widget = viewDocument.getRoot().getChild( 0 );
  211. expect( widget.name ).to.equal( 'div' );
  212. expect( isPageBreakWidget( widget ) ).to.be.true;
  213. } );
  214. } );
  215. } );
  216. function isPageBreakWidget( viewElement ) {
  217. return !!viewElement.getCustomProperty( 'pageBreak' ) && isWidget( viewElement );
  218. }
  219. } );