Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Aligned to changes in ckeditor5-engine #97

Merged
merged 1 commit into from
Feb 20, 2018
Merged

Aligned to changes in ckeditor5-engine #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 13 additions & 25 deletions src/converters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ import { createViewListItemElement } from './utils';
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewInsertion( evt, data, consumable, conversionApi ) {
export function modelViewInsertion( evt, data, conversionApi ) {
const consumable = conversionApi.consumable;

if ( !consumable.test( data.item, 'insert' ) ||
!consumable.test( data.item, 'attribute:type' ) ||
!consumable.test( data.item, 'attribute:indent' )
Expand All @@ -52,7 +53,6 @@ export function modelViewInsertion( evt, data, consumable, conversionApi ) {
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewRemove( evt, data, conversionApi ) {
Expand Down Expand Up @@ -98,11 +98,10 @@ export function modelViewRemove( evt, data, conversionApi ) {
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewChangeType( evt, data, consumable, conversionApi ) {
if ( !consumable.consume( data.item, 'attribute:type' ) ) {
export function modelViewChangeType( evt, data, conversionApi ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:type' ) ) {
return;
}

Expand All @@ -126,7 +125,7 @@ export function modelViewChangeType( evt, data, consumable, conversionApi ) {

// 4. Consumable insertion of children inside the item. They are already handled by re-building the item in view.
for ( const child of data.item.getChildren() ) {
consumable.consume( child, 'insert' );
conversionApi.consumable.consume( child, 'insert' );
}
}

Expand All @@ -136,11 +135,10 @@ export function modelViewChangeType( evt, data, consumable, conversionApi ) {
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewChangeIndent( evt, data, consumable, conversionApi ) {
if ( !consumable.consume( data.item, 'attribute:indent' ) ) {
export function modelViewChangeIndent( evt, data, conversionApi ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:indent' ) ) {
return;
}

Expand All @@ -158,15 +156,8 @@ export function modelViewChangeIndent( evt, data, consumable, conversionApi ) {
const removeRange = ViewRange.createOn( viewList );
viewWriter.remove( removeRange );

// TODO: get rid of `removePosition` when conversion is done on `changesDone`.
let removePosition;

if ( viewListPrev && viewListPrev.nextSibling ) {
removePosition = mergeViewLists( viewWriter, viewListPrev, viewListPrev.nextSibling );
}

if ( !removePosition ) {
removePosition = removeRange.start;
mergeViewLists( viewWriter, viewListPrev, viewListPrev.nextSibling );
}

// 3. Bring back nested list that was in the removed <li>.
Expand All @@ -177,7 +168,7 @@ export function modelViewChangeIndent( evt, data, consumable, conversionApi ) {

// 5. Consume insertion of children inside the item. They are already handled by re-building the item in view.
for ( const child of data.item.getChildren() ) {
consumable.consume( child, 'insert' );
conversionApi.consumable.consume( child, 'insert' );
}
}

Expand All @@ -203,10 +194,9 @@ export function modelViewChangeIndent( evt, data, consumable, conversionApi ) {
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewSplitOnInsert( evt, data, consumable, conversionApi ) {
export function modelViewSplitOnInsert( evt, data, conversionApi ) {
if ( data.item.name != 'listItem' ) {
let viewPosition = conversionApi.mapper.toViewPosition( data.range.start );

Expand Down Expand Up @@ -325,7 +315,6 @@ export function modelViewSplitOnInsert( evt, data, consumable, conversionApi ) {
* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data Additional information about the change.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewMergeAfter( evt, data, conversionApi ) {
Expand All @@ -349,7 +338,6 @@ export function modelViewMergeAfter( evt, data, conversionApi ) {
* @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data An object containing conversion input and a placeholder for conversion output and possibly other values.
* @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface to be used by the callback.
*/
export function viewModelConverter( evt, data, conversionApi ) {
Expand Down Expand Up @@ -423,7 +411,7 @@ export function viewModelConverter( evt, data, conversionApi ) {
* @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data An object containing conversion input and a placeholder for conversion output and possibly other values.
* @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface to be used by the callback.
*/
export function cleanList( evt, data, conversionApi ) {
if ( conversionApi.consumable.test( data.viewItem, { name: true } ) ) {
Expand All @@ -444,7 +432,7 @@ export function cleanList( evt, data, conversionApi ) {
* @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Object} data An object containing conversion input and a placeholder for conversion output and possibly other values.
* @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
* @param {Object} conversionApi Conversion interface to be used by the callback.
*/
export function cleanListItem( evt, data, conversionApi ) {
if ( conversionApi.consumable.test( data.viewItem, { name: true } ) ) {
Expand Down
16 changes: 8 additions & 8 deletions tests/listengine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3297,13 +3297,13 @@ describe( 'ListEngine', () => {

describe( 'other', () => {
it( 'model insert converter should not fire if change was already consumed', () => {
editor.editing.downcastDispatcher.on( 'insert:listItem', ( evt, data, consumable, conversionApi ) => {
consumable.consume( data.item, 'attribute:type' );
consumable.consume( data.item, 'attribute:indent' );
editor.editing.downcastDispatcher.on( 'insert:listItem', ( evt, data, conversionApi ) => {
conversionApi.consumable.consume( data.item, 'attribute:type' );
conversionApi.consumable.consume( data.item, 'attribute:indent' );

const converter = insertElement( ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'p' ) );

return converter( evt, data, consumable, conversionApi );
return converter( evt, data, conversionApi );
}, { priority: 'highest' } );

// Paragraph is needed, otherwise selection throws.
Expand All @@ -3328,8 +3328,8 @@ describe( 'ListEngine', () => {
} );

it( 'model change type converter should not fire if change was already consumed', () => {
editor.editing.downcastDispatcher.on( 'attribute:type', ( evt, data, consumable ) => {
consumable.consume( data.item, 'attribute:type' );
editor.editing.downcastDispatcher.on( 'attribute:type', ( evt, data, conversionApi ) => {
conversionApi.consumable.consume( data.item, 'attribute:type' );
}, { priority: 'highest' } );

setModelData( model, '<listItem indent="0" type="bulleted"></listItem>' );
Expand All @@ -3342,8 +3342,8 @@ describe( 'ListEngine', () => {
} );

it( 'model change indent converter should not fire if change was already consumed', () => {
editor.editing.downcastDispatcher.on( 'attribute:indent', ( evt, data, consumable ) => {
consumable.consume( data.item, 'attribute:indent' );
editor.editing.downcastDispatcher.on( 'attribute:indent', ( evt, data, conversionApi ) => {
conversionApi.consumable.consume( data.item, 'attribute:indent' );
}, { priority: 'highest' } );

setModelData( model, '<listItem indent="0" type="bulleted">a</listItem><listItem indent="0" type="bulleted">b</listItem>' );
Expand Down