view-to-model-converters.js 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ViewConversionDispatcher from '/ckeditor5/engine/conversion/viewconversiondispatcher.js';
  7. import ViewContainerElement from '/ckeditor5/engine/view/containerelement.js';
  8. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  9. import ViewText from '/ckeditor5/engine/view/text.js';
  10. import ModelSchema from '/ckeditor5/engine/model/schema.js';
  11. import ModelDocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
  12. import ModelElement from '/ckeditor5/engine/model/element.js';
  13. import ModelText from '/ckeditor5/engine/model/text.js';
  14. import { convertToModelFragment, convertText } from '/ckeditor5/engine/conversion/view-to-model-converters.js';
  15. let dispatcher, schema, objWithContext;
  16. beforeEach( () => {
  17. schema = new ModelSchema();
  18. schema.registerItem( 'paragraph', '$block' );
  19. schema.allow( { name: '$text', inside: '$root' } );
  20. objWithContext = { context: [ '$root' ] };
  21. dispatcher = new ViewConversionDispatcher( { schema } );
  22. } );
  23. describe( 'convertText', () => {
  24. it( 'should return converter converting ViewText to ModelText', () => {
  25. const viewText = new ViewText( 'foobar' );
  26. dispatcher.on( 'text', convertText() );
  27. const result = dispatcher.convert( viewText, objWithContext );
  28. expect( result ).to.be.instanceof( ModelText );
  29. expect( result.data ).to.equal( 'foobar' );
  30. } );
  31. it( 'should not convert already consumed texts', () => {
  32. const viewText = new ViewText( 'foofuckbafuckr' );
  33. // Default converter for elements. Returns just converted children. Added with lowest priority.
  34. dispatcher.on( 'text', convertText(), 'lowest' );
  35. // Added with normal priority. Should make the above converter not fire.
  36. dispatcher.on( 'text', ( evt, data, consumable ) => {
  37. if ( consumable.consume( data.input ) ) {
  38. data.output = new ModelText( data.input.data.replace( /fuck/gi, '****' ) );
  39. }
  40. } );
  41. const result = dispatcher.convert( viewText, objWithContext );
  42. expect( result ).to.be.instanceof( ModelText );
  43. expect( result.data ).to.equal( 'foo****ba****r' );
  44. } );
  45. it( 'should not convert text if it is wrong with schema', () => {
  46. schema.disallow( { name: '$text', inside: '$root' } );
  47. const viewText = new ViewText( 'foobar' );
  48. dispatcher.on( 'text', convertText() );
  49. let result = dispatcher.convert( viewText, objWithContext );
  50. expect( result ).to.be.null;
  51. result = dispatcher.convert( viewText, { context: [ '$block' ] } );
  52. expect( result ).to.be.instanceof( ModelText );
  53. expect( result.data ).to.equal( 'foobar' );
  54. } );
  55. it( 'should support unicode', () => {
  56. const viewText = new ViewText( 'நிலைக்கு' );
  57. dispatcher.on( 'text', convertText() );
  58. const result = dispatcher.convert( viewText, objWithContext );
  59. expect( result ).to.be.instanceof( ModelText );
  60. expect( result.data ).to.equal( 'நிலைக்கு' );
  61. } );
  62. } );
  63. describe( 'convertToModelFragment', () => {
  64. it( 'should return converter converting whole ViewDocumentFragment to ModelDocumentFragment', () => {
  65. const viewFragment = new ViewDocumentFragment( [
  66. new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ),
  67. new ViewText( 'bar' )
  68. ] );
  69. // To get any meaningful results we have to actually convert something.
  70. dispatcher.on( 'text', convertText() );
  71. // This way P element won't be converted per-se but will fire converting it's children.
  72. dispatcher.on( 'element', convertToModelFragment() );
  73. dispatcher.on( 'documentFragment', convertToModelFragment() );
  74. const result = dispatcher.convert( viewFragment, objWithContext );
  75. expect( result ).to.be.instanceof( ModelDocumentFragment );
  76. expect( result.maxOffset ).to.equal( 6 );
  77. expect( result.getChild( 0 ).data ).to.equal( 'foobar' );
  78. } );
  79. it( 'should not convert already consumed (converted) changes', () => {
  80. const viewP = new ViewContainerElement( 'p', null, new ViewText( 'foo' ) );
  81. // To get any meaningful results we have to actually convert something.
  82. dispatcher.on( 'text', convertText() );
  83. // Default converter for elements. Returns just converted children. Added with lowest priority.
  84. dispatcher.on( 'element', convertToModelFragment(), 'lowest' );
  85. // Added with normal priority. Should make the above converter not fire.
  86. dispatcher.on( 'element:p', ( evt, data, consumable, conversionApi ) => {
  87. if ( consumable.consume( data.input, { name: true } ) ) {
  88. data.output = new ModelElement( 'paragraph' );
  89. data.context.push( data.output );
  90. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, data ) );
  91. data.context.pop();
  92. }
  93. } );
  94. const result = dispatcher.convert( viewP, objWithContext );
  95. expect( result ).to.be.instanceof( ModelElement );
  96. expect( result.name ).to.equal( 'paragraph' );
  97. expect( result.maxOffset ).to.equal( 3 );
  98. expect( result.getChild( 0 ).data ).to.equal( 'foo' );
  99. } );
  100. } );