/** * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ /* global console, document, HTMLTextAreaElement, HTMLDivElement, HTMLButtonElement, Event */ import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; import HtmlEmbedEditing from '../src/htmlembedediting'; import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor'; import HtmlEmbedUpdateCommand from '../src/htmlembedupdatecommand'; import HtmlEmbedInsertCommand from '../src/htmlembedinsertcommand'; import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; import { isWidget } from '@ckeditor/ckeditor5-widget/src/utils'; describe( 'HtmlEmbedEditing', () => { let element, editor, model, view, viewDocument; testUtils.createSinonSandbox(); beforeEach( () => { element = document.createElement( 'div' ); document.body.appendChild( element ); return ClassicTestEditor .create( element, { plugins: [ HtmlEmbedEditing ] } ) .then( newEditor => { editor = newEditor; model = editor.model; view = editor.editing.view; viewDocument = view.document; } ); } ); afterEach( () => { return editor.destroy() .then( () => { element.remove(); } ); } ); it( 'should have pluginName', () => { expect( HtmlEmbedEditing.pluginName ).to.equal( 'HtmlEmbedEditing' ); } ); it( 'should be loaded', () => { expect( editor.plugins.get( HtmlEmbedEditing ) ).to.be.instanceOf( HtmlEmbedEditing ); } ); it( 'should set proper schema rules', () => { expect( model.schema.checkChild( [ '$root' ], 'rawHtml' ) ).to.be.true; expect( model.schema.checkAttribute( [ '$root', 'rawHtml' ], 'value' ) ).to.be.true; expect( model.schema.isObject( 'rawHtml' ) ).to.be.true; expect( model.schema.checkChild( [ '$root', 'rawHtml' ], '$text' ) ).to.be.false; expect( model.schema.checkChild( [ '$root', '$block' ], 'rawHtml' ) ).to.be.false; } ); describe( 'commands', () => { it( 'should register htmlEmbedUpdate command', () => { expect( editor.commands.get( 'htmlEmbedUpdate' ) ).to.be.instanceOf( HtmlEmbedUpdateCommand ); } ); it( 'should register htmlEmbedInsert command', () => { expect( editor.commands.get( 'htmlEmbedInsert' ) ).to.be.instanceOf( HtmlEmbedInsertCommand ); } ); } ); describe( 'config', () => { let htmlEmbed; beforeEach( () => { htmlEmbed = editor.config.get( 'htmlEmbed' ); } ); describe( 'htmlEmbed.previewsInData', () => { it( 'should be set to `false` by default', () => { expect( htmlEmbed.previewsInData ).to.equal( false ); } ); } ); describe( 'htmlEmbed.sanitizeHtml', () => { beforeEach( () => { sinon.stub( console, 'warn' ); } ); it( 'should return an object with cleaned html and a note whether something has changed', () => { expect( htmlEmbed.sanitizeHtml( 'foo' ) ).to.deep.equal( { html: 'foo', hasModified: false } ); } ); it( 'should return an input string (without any modifications)', () => { const unsafeHtml = ''; expect( htmlEmbed.sanitizeHtml( unsafeHtml ).html ).to.deep.equal( unsafeHtml ); } ); it( 'should display a warning when using the default sanitizer', () => { htmlEmbed.sanitizeHtml( 'foo' ); expect( console.warn.callCount ).to.equal( 1 ); expect( console.warn.firstCall.args[ 0 ] ).to.equal( 'html-embed-provide-sanitize-function' ); } ); } ); } ); describe( 'conversion in data pipeline', () => { describe( 'model to view', () => { it( 'should convert an empty `rawHtml` element', () => { setModelData( model, '[]' ); expect( editor.getData() ).to.equal( '
' ); } ); it( 'should put the HTML from the `value` attribute (in `rawHtml`) into the data', () => { setModelData( model, '[]' ); model.change( writer => { writer.setAttribute( 'value', 'Foo.', model.document.getRoot().getChild( 0 ) ); } ); expect( editor.getData() ).to.equal( '
' + 'Foo.' + '
' ); } ); } ); describe( 'view to model', () => { it( 'should convert innerHTML (single element) of div.raw-html-embed', () => { editor.setData( '
' + 'Foo.' + '
' ); const rawHtml = model.document.getRoot().getChild( 0 ); expect( rawHtml.getAttribute( 'value' ) ).to.equal( 'Foo.' ); } ); it( 'should convert innerHTML (single element with children) of div.raw-html-embed', () => { editor.setData( '
' + '

' + 'Foo B.' + 'Foo I.' + '

' + '
' ); const rawHtml = model.document.getRoot().getChild( 0 ); expect( rawHtml.getAttribute( 'value' ) ).to.equal( '

' + 'Foo B.' + 'Foo I.' + '

' ); } ); it( 'should convert innerHTML (few elements) of div.raw-html-embed', () => { editor.setData( '
' + 'Foo B.' + 'Foo I.' + 'Foo U.' + '
' ); const rawHtml = model.document.getRoot().getChild( 0 ); expect( rawHtml.getAttribute( 'value' ) ).to.equal( 'Foo B.' + 'Foo I.' + 'Foo U.' ); } ); it( 'should not convert in wrong context', () => { model.schema.register( 'div', { inheritAllFrom: '$block' } ); model.schema.addChildCheck( ( ctx, childDef ) => { if ( ctx.endsWith( '$root' ) && childDef.name == 'rawHtml' ) { return false; } } ); editor.conversion.elementToElement( { model: 'div', view: 'div' } ); editor.setData( '
' + '
' + 'Foo.' + '
' + '
' ); expect( getModelData( model, { withoutSelection: true } ) ) .to.equal( '
' ); } ); it( 'should not convert inner `div.raw-html-embed` that is a child of outer div.raw-html-embed', () => { editor.setData( '
' + '
' + 'Foo B.' + 'Foo I.' + 'Foo U.' + '
' + '
' ); const rawHtml = model.document.getRoot().getChild( 0 ); expect( rawHtml.getAttribute( 'value' ) ).to.equal( '
' + 'Foo B.' + 'Foo I.' + 'Foo U.' + '
' ); } ); } ); } ); describe( 'conversion in editing pipeline (model to view)', () => { describe( 'without previews (htmlEmbed.dataInPreviews=false)', () => { it( 'converted element should be widgetized', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); expect( widget.name ).to.equal( 'div' ); expect( isRawHtmlWidget( widget ) ).to.be.true; const rawHtmlContainer = widget.getChild( 0 ); expect( rawHtmlContainer ).to.not.be.undefined; } ); it( 'widget should not contain a class that informs about available preview mode', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); expect( widget.hasClass( 'raw-html--preview-enabled' ) ).to.equal( false ); } ); it( 'should render the toggle button and edit source elements', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); // Expecting two children: toggle button and editable textarea. expect( viewHtmlContainer.childCount ).to.equal( 2 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); expect( toggleIconElement.is( 'uiElement' ) ).to.equal( true ); expect( toggleIconElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLButtonElement ); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.is( 'uiElement' ) ).to.equal( true ); expect( sourceElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLTextAreaElement ); } ); it( 'source element should have a placeholder', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.getAttribute( 'placeholder' ) ).to.equal( 'Paste the raw code here.' ); } ); it( 'should update the edit source element when the `value` attribute has changed', () => { setModelData( model, '' ); model.change( writer => { writer.setAttribute( 'value', 'Foo.', model.document.getRoot().getChild( 0 ) ); } ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.getCustomProperty( 'domElement' ).value ).to.equal( 'Foo.' ); } ); it( 'should update the `value` attribute after applying changes in the edit source element', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const textarea = sourceElement.getCustomProperty( 'domElement' ); textarea.value = 'Foo.'; textarea.dispatchEvent( new Event( 'input' ) ); expect( model.document.getRoot().getChild( 0 ).getAttribute( 'value' ) ).to.equal( 'Foo.' ); } ); it( 'should show the HTML in the preview mode by default (source element should be disabled)', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const textarea = sourceElement.getCustomProperty( 'domElement' ); expect( textarea.disabled ).to.equal( true ); expect( textarea.value ).to.equal( 'Foo' ); } ); it( 'should allows modifying the source after clicking the toggle button', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleButtonElement = viewHtmlContainer.getChild( 0 ); toggleButtonElement.getCustomProperty( 'domElement' ).click(); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.getCustomProperty( 'domElement' ).disabled ).to.equal( false ); } ); it( 'should update the toggle button icon after switching to "edit source mode"', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleButtonElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleButtonElement.getCustomProperty( 'domElement' ); const toggleIconBeforeClick = toggleButton.innerHTML; toggleButton.click(); // Check whether the icon has been updated. expect( toggleButton.innerHTML ).to.not.equal( toggleIconBeforeClick ); } ); it( 'should disable the source element after clicking the toggle button when edit source mode is enabled', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleIconElement.getCustomProperty( 'domElement' ); // Switch to edit source mode. toggleButton.click(); // Switch to preview mode. toggleButton.click(); expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).disabled ).to.equal( true ); } ); it( 'should disable the source element after clicking the toggle button when edit source mode is enabled', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleButtonElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleButtonElement.getCustomProperty( 'domElement' ); // The icon before switching mode. const toggleIconBeforeClick = toggleButton.innerHTML; // Switch to edit source mode. toggleButton.click(); // The icon for edit source mode. const toggleIconAfterFirstClick = toggleButton.innerHTML; // Switch to preview mode. toggleButton.click(); // The first click: the icon has been changed. expect( toggleButton.innerHTML ).to.equal( toggleIconBeforeClick ); // The second click: the icon has been restored. expect( toggleButton.innerHTML ).to.not.equal( toggleIconAfterFirstClick ); } ); } ); describe( 'with previews (htmlEmbed.dataInPreviews=true)', () => { let element, editor, model, view, viewDocument, sanitizeHtml; testUtils.createSinonSandbox(); beforeEach( () => { element = document.createElement( 'div' ); document.body.appendChild( element ); // The default sanitize function without `console.warn`. sanitizeHtml = input => ( { html: input, hasChanged: false } ); return ClassicTestEditor .create( element, { plugins: [ HtmlEmbedEditing ], htmlEmbed: { previewsInData: true, sanitizeHtml } } ) .then( newEditor => { editor = newEditor; model = editor.model; view = editor.editing.view; viewDocument = view.document; } ); } ); afterEach( () => { return editor.destroy() .then( () => { element.remove(); } ); } ); it( 'converted element should be widgetized', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); expect( widget.name ).to.equal( 'div' ); expect( isRawHtmlWidget( widget ) ).to.be.true; const rawHtmlContainer = widget.getChild( 0 ); expect( rawHtmlContainer ).to.not.be.undefined; } ); it( 'widget should contain a class that informs about available preview mode', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); expect( widget.hasClass( 'raw-html--preview-enabled' ) ).to.equal( true ); } ); it( 'should render the toggle button, edit source and preview container elements', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); // Expecting three children: toggle button, editable textarea, and the preview container. expect( viewHtmlContainer.childCount ).to.equal( 3 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); expect( toggleIconElement.is( 'uiElement' ) ).to.equal( true ); expect( toggleIconElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLButtonElement ); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.is( 'uiElement' ) ).to.equal( true ); expect( sourceElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLTextAreaElement ); const previewElement = viewHtmlContainer.getChild( 2 ); expect( previewElement.is( 'rawElement' ) ).to.equal( true ); expect( previewElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLDivElement ); } ); it( 'source element should have a placeholder', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.getAttribute( 'placeholder' ) ).to.equal( 'Paste the raw code here.' ); } ); it( 'should update the source and preview elements when the `value` attribute has changed', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const previewElement = viewHtmlContainer.getChild( 2 ); // The preview container should be empty. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '' ); model.change( writer => { writer.setAttribute( 'value', 'Foo.', model.document.getRoot().getChild( 0 ) ); } ); expect( sourceElement.getCustomProperty( 'domElement' ).value ).to.equal( 'Foo.' ); expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( 'Foo.' ); } ); it( 'should update the `value` attribute after applying changes in the edit source element', () => { setModelData( model, '' ); const event = new Event( 'input' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const textarea = sourceElement.getCustomProperty( 'domElement' ); // The preview container should be empty. textarea.value = 'Foo.'; textarea.dispatchEvent( event ); expect( model.document.getRoot().getChild( 0 ).getAttribute( 'value' ) ).to.equal( 'Foo.' ); } ); it( 'should re-render the preview element after applying changes in the edit source element', () => { setModelData( model, '' ); const event = new Event( 'input' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const previewElement = viewHtmlContainer.getChild( 2 ); // The preview container should be empty. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '' ); const textarea = sourceElement.getCustomProperty( 'domElement' ); textarea.value = 'Foo.'; textarea.dispatchEvent( event ); expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( 'Foo.' ); } ); it( 'should render the HTML in the preview element by default', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); expect( widget.hasClass( 'raw-html--display-preview' ) ).to.equal( true ); const viewHtmlContainer = widget.getChild( 0 ); const sourceElement = viewHtmlContainer.getChild( 1 ); const textarea = sourceElement.getCustomProperty( 'domElement' ); expect( textarea.disabled ).to.equal( true ); expect( textarea.value ).to.equal( 'Foo' ); const previewElement = viewHtmlContainer.getChild( 2 ).getCustomProperty( 'domElement' ); expect( previewElement.innerHTML ).to.equal( 'Foo' ); } ); it( 'should allows modifying the source after clicking the toggle button', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); toggleIconElement.getCustomProperty( 'domElement' ).click(); const sourceElement = viewHtmlContainer.getChild( 1 ); expect( sourceElement.getCustomProperty( 'domElement' ).disabled ).to.equal( false ); expect( widget.hasClass( 'raw-html--display-preview' ) ).to.equal( false ); } ); it( 'should update the toggle button icon after switching to "edit source mode"', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleIconElement.getCustomProperty( 'domElement' ); const toggleIconBeforeClick = toggleButton.innerHTML; toggleButton.click(); // Check whether the icon has been updated. expect( toggleButton.innerHTML ).to.not.equal( toggleIconBeforeClick ); } ); it( 'should display preview element after clicking the toggle button when displaying edit source mode', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleIconElement.getCustomProperty( 'domElement' ); // Switch to edit source mode. toggleButton.click(); // Switch to preview mode. toggleButton.click(); expect( widget.hasClass( 'raw-html--display-preview' ) ).to.equal( true ); expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).disabled ).to.equal( true ); } ); it( 'should disable the source element after clicking the toggle button when edit source mode is enabled', () => { setModelData( model, '' ); const widget = viewDocument.getRoot().getChild( 0 ); const viewHtmlContainer = widget.getChild( 0 ); const toggleIconElement = viewHtmlContainer.getChild( 0 ); const toggleButton = toggleIconElement.getCustomProperty( 'domElement' ); // The icon before switching mode. const toggleIconBeforeClick = toggleButton.innerHTML; // Switch to edit source mode. toggleButton.click(); // The icon for edit source mode. const toggleIconAfterFirstClick = toggleButton.innerHTML; // Switch to preview mode. toggleButton.click(); // The first click: the icon has been changed. expect( toggleButton.innerHTML ).to.equal( toggleIconBeforeClick ); // The second click: the icon has been restored. expect( toggleButton.innerHTML ).to.not.equal( toggleIconAfterFirstClick ); } ); } ); } ); } ); function isRawHtmlWidget( viewElement ) { return !!viewElement.getCustomProperty( 'rawHtml' ) && isWidget( viewElement ); }