view-to-model-converters.js 5.1 KB

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