| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals console */
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import MediaEmbedEditing from '../src/mediaembedediting';
- import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import normalizeHtml from '@ckeditor/ckeditor5-utils/tests/_utils/normalizehtml';
- describe( 'MediaEmbedEditing', () => {
- let editor, model, doc, view;
- const testProviders = {
- A: {
- name: 'A',
- url: /^foo\.com\/(\w+)/,
- html: match => `A, id=${ match[ 1 ] }`
- },
- B: {
- name: 'B',
- url: /^bar\.com\/(\w+)/,
- html: match => `B, id=${ match[ 1 ] }`
- },
- C: {
- name: 'C',
- url: /^\w+\.com\/(\w+)/,
- html: match => `C, id=${ match[ 1 ] }`
- },
- extraA: {
- name: 'extraA',
- url: /^foo\.com\/(\w+)/,
- html: match => `extraA, id=${ match[ 1 ] }`
- },
- extraB: {
- name: 'extraB',
- url: /^\w+\.com\/(\w+)/,
- html: match => `extraB, id=${ match[ 1 ] }`
- },
- previewLess: {
- name: 'preview-less',
- url: /^https:\/\/preview-less/
- },
- allowEverything: {
- name: 'allow-everything',
- url: /(.*)/,
- html: match => `allow-everything, id=${ match[ 1 ] }`
- }
- };
- afterEach( () => {
- sinon.restore();
- } );
- it( 'should be named', () => {
- expect( MediaEmbedEditing.pluginName ).to.equal( 'MediaEmbedEditing' );
- } );
- describe( 'constructor()', () => {
- describe( 'configuration', () => {
- describe( '#providers', () => {
- it( 'should warn when provider has no name', () => {
- const consoleWarnStub = sinon.stub( console, 'warn' );
- const provider = {
- url: /.*/
- };
- return createTestEditor( {
- providers: [ provider ]
- } ).then( () => {
- expect( consoleWarnStub.calledOnce ).to.equal( true );
- expect( consoleWarnStub.firstCall.args[ 0 ] ).to.match( /^media-embed-no-provider-name:/ );
- expect( consoleWarnStub.firstCall.args[ 1 ].provider ).to.deep.equal( provider );
- } );
- } );
- it( 'can override all providers', () => {
- return createTestEditor( {
- providers: []
- } ).then( editor => {
- editor.setData( '<figure class="media"><div data-oembed-url="foo.com"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal( '' );
- } );
- } );
- it( 'upcast media according to the order', () => {
- return createTestEditor( {
- providers: [
- testProviders.A,
- testProviders.B,
- testProviders.C
- ]
- } ).then( editor => {
- editor.setData( '<figure class="media"><div data-oembed-url="foo.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://foo.com/123">' +
- 'A, id=123' +
- '</div>' +
- '</figure>'
- );
- editor.setData( '<figure class="media"><div data-oembed-url="bar.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://bar.com/123">' +
- 'B, id=123' +
- '</div>' +
- '</figure>'
- );
- editor.setData( '<figure class="media"><div data-oembed-url="anything.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://anything.com/123">' +
- 'C, id=123' +
- '</div>' +
- '</figure>'
- );
- } );
- } );
- describe( 'default value', () => {
- beforeEach( () => {
- return createTestEditor()
- .then( newEditor => {
- editor = newEditor;
- view = editor.editing.view;
- } );
- } );
- describe( 'with preview', () => {
- it( 'upcasts the URL (dailymotion)', () => {
- testMediaUpcast( [
- 'https://www.dailymotion.com/video/foo',
- 'www.dailymotion.com/video/foo',
- 'dailymotion.com/video/foo'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; ">' +
- '<iframe src="https://www.dailymotion.com/embed/video/foo" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" width="480" height="270" allowfullscreen="" allow="autoplay">' +
- '</iframe>' +
- '</div>' );
- } );
- describe( 'spotify', () => {
- it( 'upcasts the URL (artist)', () => {
- testMediaUpcast( [
- 'https://www.open.spotify.com/artist/foo',
- 'www.open.spotify.com/artist/foo',
- 'open.spotify.com/artist/foo'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 126%;">' +
- '<iframe src="https://open.spotify.com/embed/artist/foo" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" allowtransparency="true" allow="encrypted-media">' +
- '</iframe>' +
- '</div>' );
- } );
- it( 'upcasts the URL (album)', () => {
- testMediaUpcast( [
- 'https://www.open.spotify.com/album/foo',
- 'www.open.spotify.com/album/foo',
- 'open.spotify.com/album/foo'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 126%;">' +
- '<iframe src="https://open.spotify.com/embed/album/foo" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" allowtransparency="true" allow="encrypted-media">' +
- '</iframe>' +
- '</div>' );
- } );
- it( 'upcasts the URL (track)', () => {
- testMediaUpcast( [
- 'https://www.open.spotify.com/track/foo',
- 'www.open.spotify.com/track/foo',
- 'open.spotify.com/track/foo'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 126%;">' +
- '<iframe src="https://open.spotify.com/embed/track/foo" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" allowtransparency="true" allow="encrypted-media">' +
- '</iframe>' +
- '</div>' );
- } );
- } );
- it( 'upcasts the URL (youtube)', () => {
- testMediaUpcast( [
- 'https://www.youtube.com/watch?v=foo',
- 'www.youtube.com/watch?v=foo',
- 'youtube.com/watch?v=foo',
- 'https://m.youtube.com/watch?v=foo',
- 'm.youtube.com/watch?v=foo',
- 'https://www.youtube.com/v/foo',
- 'www.youtube.com/v/foo',
- 'youtube.com/v/foo',
- 'https://m.youtube.com/v/foo',
- 'm.youtube.com/v/foo',
- 'https://www.youtube.com/embed/foo',
- 'www.youtube.com/embed/foo',
- 'youtube.com/embed/foo',
- 'https://youtu.be/foo',
- 'youtu.be/foo'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 56.2493%;">' +
- '<iframe src="https://www.youtube.com/embed/foo" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" allow="autoplay; encrypted-media" allowfullscreen="">' +
- '</iframe>' +
- '</div>' );
- } );
- // See: https://github.com/ckeditor/ckeditor5-media-embed/issues/26
- it( 'upcasts the URL that contains a dash (youtube)', () => {
- testMediaUpcast( [
- 'https://www.youtube.com/watch?v=euqbMkM-QQk'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 56.2493%;">' +
- '<iframe src="https://www.youtube.com/embed/euqbMkM-QQk" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" allow="autoplay; encrypted-media" allowfullscreen="">' +
- '</iframe>' +
- '</div>' );
- } );
- it( 'upcasts the URL (vimeo)', () => {
- testMediaUpcast( [
- 'https://www.vimeo.com/1234',
- 'www.vimeo.com/1234',
- 'vimeo.com/1234',
- 'https://www.vimeo.com/foo/foo/video/1234',
- 'www.vimeo.com/foo/foo/video/1234',
- 'vimeo.com/foo/foo/video/1234',
- 'https://www.vimeo.com/album/foo/video/1234',
- 'www.vimeo.com/album/foo/video/1234',
- 'vimeo.com/album/foo/video/1234',
- 'https://www.vimeo.com/channels/foo/1234',
- 'www.vimeo.com/channels/foo/1234',
- 'vimeo.com/channels/foo/1234',
- 'https://www.vimeo.com/groups/foo/videos/1234',
- 'www.vimeo.com/groups/foo/videos/1234',
- 'vimeo.com/groups/foo/videos/1234',
- 'https://www.vimeo.com/ondemand/foo/1234',
- 'www.vimeo.com/ondemand/foo/1234',
- 'vimeo.com/ondemand/foo/1234',
- 'https://www.player.vimeo.com/video/1234',
- 'www.player.vimeo.com/video/1234',
- 'player.vimeo.com/video/1234'
- ],
- '<div style="position: relative; padding-bottom: 100%; height: 0; padding-bottom: 56.2493%;">' +
- '<iframe src="https://player.vimeo.com/video/1234" ' +
- 'style="position: absolute; width: 100%; height: 100%; top: 0; left: 0;" ' +
- 'frameborder="0" webkitallowfullscreen="" mozallowfullscreen="" allowfullscreen="">' +
- '</iframe>' +
- '</div>' );
- } );
- } );
- describe( 'preview-less', () => {
- it( 'upcasts the URL (instagram)', () => {
- testMediaUpcast( [
- 'https://www.instagram.com/p/foo',
- 'www.instagram.com/p/foo',
- 'instagram.com/p/foo'
- ] );
- } );
- it( 'upcasts the URL (twitter)', () => {
- testMediaUpcast( [
- 'https://www.twitter.com/foo/bar',
- 'www.twitter.com/foo/bar',
- 'twitter.com/foo/bar'
- ] );
- } );
- it( 'upcasts the URL (google maps)', () => {
- testMediaUpcast( [
- 'https://www.google.com/maps/foo',
- 'www.google.com/maps/foo',
- 'google.com/maps/foo'
- ] );
- } );
- it( 'upcasts the URL (flickr)', () => {
- testMediaUpcast( [
- 'https://www.flickr.com/foo/bar',
- 'www.flickr.com/foo/bar',
- 'flickr.com/foo/bar'
- ] );
- } );
- it( 'upcasts the URL (facebook)', () => {
- testMediaUpcast( [
- 'https://www.facebook.com/foo/bar',
- 'www.facebook.com/foo/bar',
- 'facebook.com/foo/bar'
- ] );
- } );
- } );
- } );
- } );
- describe( '#extraProviders', () => {
- it( 'should warn when provider has no name', () => {
- const consoleWarnStub = sinon.stub( console, 'warn' );
- const provider = {
- url: /.*/
- };
- return createTestEditor( {
- extraProviders: [ provider ]
- } ).then( () => {
- expect( consoleWarnStub.calledOnce ).to.equal( true );
- expect( consoleWarnStub.firstCall.args[ 0 ] ).to.match( /^media-embed-no-provider-name:/ );
- expect( consoleWarnStub.firstCall.args[ 1 ].provider ).to.deep.equal( provider );
- } );
- } );
- it( 'extend #providers but with the lower priority', () => {
- return createTestEditor( {
- providers: [
- testProviders.A
- ],
- extraProviders: [
- testProviders.extraA,
- testProviders.extraB
- ]
- } ).then( editor => {
- editor.setData( '<figure class="media"><div data-oembed-url="foo.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://foo.com/123">' +
- 'A, id=123' +
- '</div>' +
- '</figure>'
- );
- editor.setData( '<figure class="media"><div data-oembed-url="anything.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://anything.com/123">' +
- 'extraB, id=123' +
- '</div>' +
- '</figure>'
- );
- } );
- } );
- } );
- describe( '#removeProviders', () => {
- it( 'removes #providers', () => {
- return createTestEditor( {
- providers: [
- testProviders.A,
- testProviders.B
- ],
- removeProviders: [ 'A' ]
- } ).then( editor => {
- editor.setData(
- '<figure class="media"><div data-oembed-url="foo.com/123"></div></figure>' +
- '<figure class="media"><div data-oembed-url="bar.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://bar.com/123">' +
- 'B, id=123' +
- '</div>' +
- '</figure>'
- );
- } );
- } );
- it( 'removes #extraProviders', () => {
- return createTestEditor( {
- providers: [],
- extraProviders: [
- testProviders.A,
- testProviders.B
- ],
- removeProviders: [ 'A' ]
- } ).then( editor => {
- editor.setData(
- '<figure class="media"><div data-oembed-url="foo.com/123"></div></figure>' +
- '<figure class="media"><div data-oembed-url="bar.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://bar.com/123">' +
- 'B, id=123' +
- '</div>' +
- '</figure>'
- );
- } );
- } );
- it( 'removes even when the name of the provider repeats', () => {
- return createTestEditor( {
- providers: [
- testProviders.A,
- testProviders.A
- ],
- extraProviders: [
- testProviders.A,
- testProviders.A,
- testProviders.B
- ],
- removeProviders: [ 'A' ]
- } ).then( editor => {
- editor.setData(
- '<figure class="media"><div data-oembed-url="foo.com/123"></div></figure>' +
- '<figure class="media"><div data-oembed-url="bar.com/123"></div></figure>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://bar.com/123">' +
- 'B, id=123' +
- '</div>' +
- '</figure>'
- );
- } );
- } );
- } );
- } );
- } );
- describe( 'init()', () => {
- const providerDefinitions = [
- testProviders.previewLess,
- testProviders.allowEverything
- ];
- it( 'should be loaded', () => {
- return createTestEditor()
- .then( newEditor => {
- expect( newEditor.plugins.get( MediaEmbedEditing ) ).to.be.instanceOf( MediaEmbedEditing );
- } );
- } );
- it( 'should set proper schema rules', () => {
- return createTestEditor()
- .then( newEditor => {
- model = newEditor.model;
- expect( model.schema.checkChild( [ '$root' ], 'media' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ '$root', 'media' ], 'url' ) ).to.be.true;
- expect( model.schema.isObject( 'media' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root', 'media' ], 'media' ) ).to.be.false;
- expect( model.schema.checkChild( [ '$root', 'media' ], '$text' ) ).to.be.false;
- expect( model.schema.checkChild( [ '$root', '$block' ], 'image' ) ).to.be.false;
- } );
- } );
- describe( 'conversion in the data pipeline', () => {
- describe( 'previewsInData=false', () => {
- beforeEach( () => {
- return createTestEditor( {
- providers: providerDefinitions
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- } );
- } );
- describe( 'model to view', () => {
- it( 'should convert', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<oembed url="https://ckeditor.com"></oembed>' +
- '</figure>' );
- } );
- it( 'should convert (no url)', () => {
- setModelData( model, '<media></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<oembed></oembed>' +
- '</figure>' );
- } );
- it( 'should convert (preview-less media)', () => {
- setModelData( model, '<media url="https://preview-less"></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<oembed url="https://preview-less"></oembed>' +
- '</figure>' );
- } );
- } );
- describe( 'view to model', () => {
- it( 'should convert media figure', () => {
- editor.setData( '<figure class="media"><oembed url="https://ckeditor.com"></oembed></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<media url="https://ckeditor.com"></media>' );
- } );
- it( 'should not convert if there is no media class', () => {
- editor.setData( '<figure class="quote">My quote</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if there is no oembed wrapper inside #1', () => {
- editor.setData( '<figure class="media"></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if there is no oembed wrapper inside #2', () => {
- editor.setData( '<figure class="media">test</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert when the wrapper has no data-oembed-url attribute', () => {
- editor.setData( '<figure class="media"><div></div></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert in the wrong context', () => {
- model.schema.register( 'blockquote', { inheritAllFrom: '$block' } );
- model.schema.addChildCheck( ( ctx, childDef ) => {
- if ( ctx.endsWith( '$root' ) && childDef.name == 'media' ) {
- return false;
- }
- } );
- editor.conversion.elementToElement( { model: 'blockquote', view: 'blockquote' } );
- editor.setData(
- '<blockquote><figure class="media"><oembed url="https://ckeditor.com"></oembed></figure></blockquote>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<blockquote></blockquote>' );
- } );
- it( 'should not convert if the oembed wrapper is already consumed', () => {
- editor.data.upcastDispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
- const img = data.viewItem.getChild( 0 );
- conversionApi.consumable.consume( img, { name: true } );
- }, { priority: 'high' } );
- editor.setData( '<figure class="media"><oembed url="https://ckeditor.com"></oembed></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if the figure is already consumed', () => {
- editor.data.upcastDispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.viewItem, { name: true, class: 'image' } );
- }, { priority: 'high' } );
- editor.setData( '<figure class="media"><oembed url="https://ckeditor.com"></oembed></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should discard the contents of the media', () => {
- editor.setData( '<figure class="media"><oembed url="https://ckeditor.com">foo bar</oembed></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<media url="https://ckeditor.com"></media>' );
- } );
- it( 'should not convert unknown media', () => {
- return createTestEditor( {
- providers: [
- testProviders.A
- ]
- } )
- .then( newEditor => {
- newEditor.setData(
- '<figure class="media"><oembed url="unknown.media"></oembed></figure>' +
- '<figure class="media"><oembed url="foo.com/123"></oembed></figure>' );
- expect( getModelData( newEditor.model, { withoutSelection: true } ) )
- .to.equal( '<media url="foo.com/123"></media>' );
- return newEditor.destroy();
- } );
- } );
- } );
- } );
- describe( 'previewsInData=true', () => {
- beforeEach( () => {
- return createTestEditor( {
- providers: providerDefinitions,
- previewsInData: true
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- } );
- } );
- describe( 'conversion in the data pipeline', () => {
- describe( 'model to view', () => {
- it( 'should convert', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<div data-oembed-url="https://ckeditor.com">' +
- 'allow-everything, id=https://ckeditor.com' +
- '</div>' +
- '</figure>' );
- } );
- it( 'should convert (no url)', () => {
- setModelData( model, '<media></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<oembed>' +
- '</oembed>' +
- '</figure>' );
- } );
- it( 'should convert (preview-less media)', () => {
- setModelData( model, '<media url="https://preview-less"></media>' );
- expect( editor.getData() ).to.equal(
- '<figure class="media">' +
- '<oembed url="https://preview-less"></oembed>' +
- '</figure>' );
- } );
- } );
- describe( 'view to model', () => {
- it( 'should convert media figure', () => {
- editor.setData(
- '<figure class="media">' +
- '<div data-oembed-url="https://ckeditor.com">' +
- 'allow-everything, id=https://cksource.com></iframe>' +
- '</div>' +
- '</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<media url="https://ckeditor.com"></media>' );
- } );
- it( 'should not convert if there is no media class', () => {
- editor.setData( '<figure class="quote">My quote</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if there is no oembed wrapper inside #1', () => {
- editor.setData( '<figure class="media"></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if there is no oembed wrapper inside #2', () => {
- editor.setData( '<figure class="media">test</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert in the wrong context', () => {
- model.schema.register( 'div', { inheritAllFrom: '$block' } );
- model.schema.addChildCheck( ( ctx, childDef ) => {
- if ( ctx.endsWith( '$root' ) && childDef.name == 'media' ) {
- return false;
- }
- } );
- editor.conversion.elementToElement( { model: 'div', view: 'div' } );
- editor.setData(
- '<div>' +
- '<figure class="media">' +
- '<div data-oembed-url="https://ckeditor.com">' +
- '<iframe src="this should be discarded"></iframe>' +
- '</div>' +
- '</figure>' +
- '</div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<div></div>' );
- } );
- it( 'should not convert if the oembed wrapper is already consumed', () => {
- editor.data.upcastDispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
- const img = data.viewItem.getChild( 0 );
- conversionApi.consumable.consume( img, { name: true } );
- }, { priority: 'high' } );
- editor.setData(
- '<div>' +
- '<figure class="media">' +
- '<div data-oembed-url="https://ckeditor.com">' +
- '<iframe src="this should be discarded"></iframe>' +
- '</div>' +
- '</figure>' +
- '</div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if the figure is already consumed', () => {
- editor.data.upcastDispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.viewItem, { name: true, class: 'image' } );
- }, { priority: 'high' } );
- editor.setData( '<figure class="media"><div data-oembed-url="https://ckeditor.com"></div></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should discard the contents of the media', () => {
- editor.setData(
- '<figure class="media">' +
- '<div data-oembed-url="https://ckeditor.com">' +
- 'foo bar baz' +
- '</div>' +
- '</figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<media url="https://ckeditor.com"></media>' );
- } );
- it( 'should not convert unknown media', () => {
- return createTestEditor( {
- providers: [
- testProviders.A
- ]
- } )
- .then( newEditor => {
- newEditor.setData(
- '<figure class="media">' +
- '<div data-oembed-url="foo.com/123"></div>' +
- '</figure>' +
- '<figure class="media">' +
- '<div data-oembed-url="unknown.media/123"></div>' +
- '</figure>' );
- expect( getModelData( newEditor.model, { withoutSelection: true } ) )
- .to.equal( '<media url="foo.com/123"></media>' );
- return newEditor.destroy();
- } );
- } );
- } );
- } );
- } );
- } );
- describe( 'conversion in the editing pipeline', () => {
- describe( 'previewsInData=false', () => {
- beforeEach( () => {
- return createTestEditor( {
- providers: providerDefinitions
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- } );
- } );
- test();
- } );
- describe( 'previewsInData=true', () => {
- beforeEach( () => {
- return createTestEditor( {
- providers: providerDefinitions,
- previewsInData: true
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- } );
- } );
- test();
- } );
- function test() {
- describe( 'model to view', () => {
- it( 'should convert', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://ckeditor.com">' +
- 'allow-everything, id=https://ckeditor.com' +
- '</div>' +
- '</figure>'
- );
- } );
- it( 'should convert the url attribute change', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- const media = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.setAttribute( 'url', 'https://cksource.com', media );
- } );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://cksource.com">' +
- 'allow-everything, id=https://cksource.com' +
- '</div>' +
- '</figure>'
- );
- } );
- it( 'should convert the url attribute removal', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- const media = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.removeAttribute( 'url', media );
- } );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) )
- .to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper">' +
- '</div>' +
- '</figure>'
- );
- } );
- it( 'should not convert the url attribute removal if is already consumed', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- const media = doc.getRoot().getChild( 0 );
- editor.editing.downcastDispatcher.on( 'attribute:url:media', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'attribute:url' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.removeAttribute( 'url', media );
- } );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://ckeditor.com">' +
- 'allow-everything, id=https://ckeditor.com' +
- '</div>' +
- '</figure>'
- );
- } );
- // Related to https://github.com/ckeditor/ckeditor5/issues/407.
- it( 'should not discard internals (e.g. UI) injected by other features when converting the url attribute', () => {
- setModelData( model, '<media url="https://ckeditor.com"></media>' );
- const media = doc.getRoot().getChild( 0 );
- editor.editing.view.change( writer => {
- const widgetViewElement = editor.editing.mapper.toViewElement( media );
- const externalUIElement = writer.createUIElement( 'div', null, function( domDocument ) {
- const domElement = this.toDomElement( domDocument );
- domElement.innerHTML = 'external UI';
- return domElement;
- } );
- writer.insert( writer.createPositionAt( widgetViewElement, 'end' ), externalUIElement );
- } );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://ckeditor.com">' +
- 'allow-everything, id=https://ckeditor.com' +
- '</div>' +
- '<div>external UI</div>' +
- '</figure>'
- );
- model.change( writer => {
- writer.setAttribute( 'url', 'https://cksource.com', media );
- } );
- expect( getViewData( view, { withoutSelection: true, renderUIElements: true } ) ).to.equal(
- '<figure class="ck-widget media" contenteditable="false">' +
- '<div class="ck-media__wrapper" data-oembed-url="https://cksource.com">' +
- 'allow-everything, id=https://cksource.com' +
- '</div>' +
- '<div>external UI</div>' +
- '</figure>'
- );
- } );
- } );
- }
- } );
- } );
- function testMediaUpcast( urls, expected ) {
- for ( const url of urls ) {
- editor.setData( `<figure class="media"><div data-oembed-url="${ url }"></div></figure>` );
- const viewData = getViewData( view, { withoutSelection: true, renderUIElements: true } );
- let expectedRegExp;
- const expectedUrl = url.match( /^https?:\/\// ) ? url : 'https://' + url;
- if ( expected ) {
- expectedRegExp = new RegExp(
- '<figure[^>]+>' +
- '<div[^>]+>' +
- normalizeHtml( expected ) +
- '</div>' +
- '</figure>' );
- } else {
- expectedRegExp = new RegExp(
- '<figure[^>]+>' +
- '<div[^>]+>' +
- '<div class="ck ck-media__placeholder ck-reset_all">' +
- '<div class="ck-media__placeholder__icon">.*</div>' +
- `<a class="ck-media__placeholder__url" href="${ expectedUrl }" rel="noopener noreferrer" target="_blank">` +
- `<span class="ck-media__placeholder__url__text">${ expectedUrl }</span>` +
- '<span class="ck ck-tooltip ck-tooltip_s">' +
- '<span class="ck ck-tooltip__text">Open media in new tab</span>' +
- '</span>' +
- '</a>' +
- '</div>' +
- '</div>' +
- '</figure>' );
- }
- expect( normalizeHtml( viewData ) ).to.match( expectedRegExp, `assertion for "${ url }"` );
- }
- }
- function createTestEditor( mediaEmbedConfig ) {
- return VirtualTestEditor
- .create( {
- plugins: [ MediaEmbedEditing ],
- mediaEmbed: mediaEmbedConfig
- } );
- }
- } );
|