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

Commit

Permalink
Changed: Rename attributes 'type' to 'listType' and 'indent' to 'list…
Browse files Browse the repository at this point in the history 
…Indent'.
  • Loading branch information
@jodator
jodator committed Jun 5, 2018
1 parent 9da2f34 commit 1d24fee
Show file tree
Hide file tree
Showing 8 changed files with 919 additions and 909 deletions.
98 changes: 49 additions & 49 deletions src/converters.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ 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' )
!consumable.test( data.item, 'attribute:listType' ) ||
!consumable.test( data.item, 'attribute:listIndent' )
) {
return;
}

consumable.consume( data.item, 'insert' );
consumable.consume( data.item, 'attribute:type' );
consumable.consume( data.item, 'attribute:indent' );
consumable.consume( data.item, 'attribute:listType' );
consumable.consume( data.item, 'attribute:listIndent' );

const modelItem = data.item;
const viewItem = generateLiInUl( modelItem, conversionApi );
Expand Down Expand Up @@ -79,7 +79,7 @@ export function modelViewRemove( evt, data, conversionApi ) {
// 4. Bring back nested list that was in the removed <li>.
const modelItem = conversionApi.mapper.toModelElement( viewItem );

hoistNestedLists( modelItem.getAttribute( 'indent' ) + 1, data.position, removeRange.start, viewItem, conversionApi );
hoistNestedLists( modelItem.getAttribute( 'listIndent' ) + 1, data.position, removeRange.start, viewItem, conversionApi );

// 5. Unbind removed view item and all children.
for ( const child of ViewRange.createIn( removed ).getItems() ) {
Expand All @@ -101,7 +101,7 @@ export function modelViewRemove( evt, data, conversionApi ) {
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewChangeType( evt, data, conversionApi ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:type' ) ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:listType' ) ) {
return;
}

Expand Down Expand Up @@ -138,7 +138,7 @@ export function modelViewChangeType( evt, data, conversionApi ) {
* @param {Object} conversionApi Conversion interface.
*/
export function modelViewChangeIndent( evt, data, conversionApi ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:indent' ) ) {
if ( !conversionApi.consumable.consume( data.item, 'attribute:listIndent' ) ) {
return;
}

Expand Down Expand Up @@ -331,7 +331,7 @@ export function modelViewMergeAfter( evt, data, conversionApi ) {
/**
* A view-to-model converter that converts `<li>` view elements into `listItem` model elements.
*
* To set correct values of the `type` and `indent` attributes the converter:
* To set correct values of the `listType` and `indent` attributes the converter:
* * checks `<li>`'s parent,
* * stores and increases the `conversionApi.store.indent` value when `<li>`'s sub-items are converted.
*
Expand All @@ -350,11 +350,11 @@ export function viewModelConverter( evt, data, conversionApi ) {

// 2. Handle `listItem` model element attributes.
conversionStore.indent = conversionStore.indent || 0;
writer.setAttribute( 'indent', conversionStore.indent, listItem );
writer.setAttribute( 'listIndent', conversionStore.indent, listItem );

// Set 'bulleted' as default. If this item is pasted into a context,
const type = data.viewItem.parent && data.viewItem.parent.name == 'ol' ? 'numbered' : 'bulleted';
writer.setAttribute( 'type', type, listItem );
writer.setAttribute( 'listType', type, listItem );

// `listItem`s created recursively should have bigger indent.
conversionStore.indent++;
Expand Down Expand Up @@ -570,19 +570,19 @@ export function viewToModelPosition( evt, data ) {
* In an example below, there is a correct list structure.
* Then the middle element will be removed so the list structure will become incorrect:
*
* <listItem type="bulleted" indent=0>Item 1</listItem>
* <listItem type="bulleted" indent=1>Item 2</listItem> <--- this is removed.
* <listItem type="bulleted" indent=2>Item 3</listItem>
* <listItem listType="bulleted" listIndent=0>Item 1</listItem>
* <listItem listType="bulleted" listIndent=1>Item 2</listItem> <--- this is removed.
* <listItem listType="bulleted" listIndent=2>Item 3</listItem>
*
* List structure after the middle element removed:
*
* <listItem type="bulleted" indent=0>Item 1</listItem>
* <listItem type="bulleted" indent=2>Item 3</listItem>
* <listItem listType="bulleted" listIndent=0>Item 1</listItem>
* <listItem listType="bulleted" listIndent=2>Item 3</listItem>
*
* Should become:
*
* <listItem type="bulleted" indent=0>Item 1</listItem>
* <listItem type="bulleted" indent=1>Item 3</listItem> <--- note that indent got post-fixed.
* <listItem listType="bulleted" listIndent=0>Item 1</listItem>
* <listItem listType="bulleted" listIndent=1>Item 3</listItem> <--- note that indent got post-fixed.
*
* @param {module:engine/model/model~Model} model The data model.
* @param {module:engine/model/writer~Writer} writer The writer to do changes with.
Expand All @@ -602,14 +602,14 @@ export function modelChangePostFixer( model, writer ) {
// In case of renamed element.
const item = entry.position.nodeAfter;

if ( item.hasAttribute( 'indent' ) ) {
writer.removeAttribute( 'indent', item );
if ( item.hasAttribute( 'listIndent' ) ) {
writer.removeAttribute( 'listIndent', item );

applied = true;
}

if ( item.hasAttribute( 'type' ) ) {
writer.removeAttribute( 'type', item );
if ( item.hasAttribute( 'listType' ) ) {
writer.removeAttribute( 'listType', item );

applied = true;
}
Expand All @@ -620,9 +620,9 @@ export function modelChangePostFixer( model, writer ) {
_addListToFix( posAfter );
} else if ( entry.type == 'remove' && entry.name == 'listItem' ) {
_addListToFix( entry.position );
} else if ( entry.type == 'attribute' && entry.attributeKey == 'indent' ) {
} else if ( entry.type == 'attribute' && entry.attributeKey == 'listIndent' ) {
_addListToFix( entry.range.start );
} else if ( entry.type == 'attribute' && entry.attributeKey == 'type' ) {
} else if ( entry.type == 'attribute' && entry.attributeKey == 'listType' ) {
_addListToFix( entry.range.start );
}
}
Expand Down Expand Up @@ -667,7 +667,7 @@ export function modelChangePostFixer( model, writer ) {
let fixBy = null;

while ( item && item.is( 'listItem' ) ) {
const itemIndent = item.getAttribute( 'indent' );
const itemIndent = item.getAttribute( 'listIndent' );

if ( itemIndent > maxIndent ) {
let newIndent;
Expand All @@ -683,12 +683,12 @@ export function modelChangePostFixer( model, writer ) {
newIndent = itemIndent - fixBy;
}

writer.setAttribute( 'indent', newIndent, item );
writer.setAttribute( 'listIndent', newIndent, item );

applied = true;
} else {
fixBy = null;
maxIndent = item.getAttribute( 'indent' ) + 1;
maxIndent = item.getAttribute( 'listIndent' ) + 1;
}

item = item.nextSibling;
Expand All @@ -700,23 +700,23 @@ export function modelChangePostFixer( model, writer ) {
let prev = null;

while ( item && item.is( 'listItem' ) ) {
const itemIndent = item.getAttribute( 'indent' );
const itemIndent = item.getAttribute( 'listIndent' );

if ( prev && prev.getAttribute( 'indent' ) > itemIndent ) {
if ( prev && prev.getAttribute( 'listIndent' ) > itemIndent ) {
typesStack = typesStack.slice( 0, itemIndent + 1 );
}

if ( itemIndent != 0 ) {
if ( typesStack[ itemIndent ] ) {
const type = typesStack[ itemIndent ];

if ( item.getAttribute( 'type' ) != type ) {
writer.setAttribute( 'type', type, item );
if ( item.getAttribute( 'listType' ) != type ) {
writer.setAttribute( 'listType', type, item );

applied = true;
}
} else {
typesStack[ itemIndent ] = item.getAttribute( 'type' );
typesStack[ itemIndent ] = item.getAttribute( 'listType' );
}
}

Expand All @@ -733,18 +733,18 @@ export function modelChangePostFixer( model, writer ) {
*
* Example:
*
* <listItem type="bulleted" indent=0>A</listItem>
* <listItem type="bulleted" indent=1>B^</listItem>
* // At ^ paste: <listItem type="bulleted" indent=4>X</listItem>
* // <listItem type="bulleted" indent=5>Y</listItem>
* <listItem type="bulleted" indent=2>C</listItem>
* <listItem listType="bulleted" listIndent=0>A</listItem>
* <listItem listType="bulleted" listIndent=1>B^</listItem>
* // At ^ paste: <listItem listType="bulleted" listIndent=4>X</listItem>
* // <listItem listType="bulleted" listIndent=5>Y</listItem>
* <listItem listType="bulleted" listIndent=2>C</listItem>
*
* Should become:
*
* <listItem type="bulleted" indent=0>A</listItem>
* <listItem type="bulleted" indent=1>BX</listItem>
* <listItem type="bulleted" indent=2>Y/listItem>
* <listItem type="bulleted" indent=2>C</listItem>
* <listItem listType="bulleted" listIndent=0>A</listItem>
* <listItem listType="bulleted" listIndent=1>BX</listItem>
* <listItem listType="bulleted" listIndent=2>Y/listItem>
* <listItem listType="bulleted" listIndent=2>C</listItem>
*
* @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
* @param {Array} args Arguments of {@link module:engine/model/model~Model#insertContent}.
Expand Down Expand Up @@ -773,13 +773,13 @@ export function modelIndentPasteFixer( evt, [ content, selection ] ) {
// First list item in `data` has indent equal to 0 (it is a first list item). It should have indent equal
// to the indent of reference item. We have to fix the first item and all of it's children and following siblings.
// Indent of all those items has to be adjusted to reference item.
const indentChange = refItem.getAttribute( 'indent' );
const indentChange = refItem.getAttribute( 'listIndent' );

// Fix only if there is anything to fix.
if ( indentChange > 0 ) {
// Adjust indent of all "first" list items in inserted data.
while ( item && item.is( 'listItem' ) ) {
item._setAttribute( 'indent', item.getAttribute( 'indent' ) + indentChange );
item._setAttribute( 'listIndent', item.getAttribute( 'listIndent' ) + indentChange );

item = item.nextSibling;
}
Expand All @@ -794,7 +794,7 @@ export function modelIndentPasteFixer( evt, [ content, selection ] ) {
function generateLiInUl( modelItem, conversionApi ) {
const mapper = conversionApi.mapper;
const viewWriter = conversionApi.writer;
const listType = modelItem.getAttribute( 'type' ) == 'numbered' ? 'ol' : 'ul';
const listType = modelItem.getAttribute( 'listType' ) == 'numbered' ? 'ol' : 'ul';
const viewItem = createViewListItemElement( viewWriter );

const viewList = viewWriter.createContainerElement( listType, null );
Expand All @@ -815,11 +815,11 @@ function getSiblingListItem( modelItemOrPosition, options ) {
const sameIndent = !!options.sameIndent;
const smallerIndent = !!options.smallerIndent;

const indent = modelItemOrPosition instanceof ModelElement ? modelItemOrPosition.getAttribute( 'indent' ) : options.indent;
const indent = modelItemOrPosition instanceof ModelElement ? modelItemOrPosition.getAttribute( 'listIndent' ) : options.listIndent;
let item = modelItemOrPosition instanceof ModelElement ? modelItemOrPosition.previousSibling : modelItemOrPosition.nodeBefore;

while ( item && item.name == 'listItem' ) {
const itemIndent = item.getAttribute( 'indent' );
const itemIndent = item.getAttribute( 'listIndent' );

if ( ( sameIndent && indent == itemIndent ) || ( smallerIndent && indent > itemIndent ) ) {
return item;
Expand Down Expand Up @@ -859,7 +859,7 @@ function injectViewList( modelItem, injectedItem, conversionApi ) {
const refItem = getSiblingListItem( modelItem, { sameIndent: true, smallerIndent: true } );
const prevItem = modelItem.previousSibling;

if ( refItem && refItem.getAttribute( 'indent' ) == modelItem.getAttribute( 'indent' ) ) {
if ( refItem && refItem.getAttribute( 'listIndent' ) == modelItem.getAttribute( 'listIndent' ) ) {
// There is a list item with same indent - we found same-level sibling.
// Break the list after it. Inserted view item will be inserted in the broken space.
const viewItem = mapper.toViewElement( refItem );
Expand Down Expand Up @@ -915,7 +915,7 @@ function injectViewList( modelItem, injectedItem, conversionApi ) {
for ( const child of nextViewList.getChildren() ) {
const modelChild = mapper.toModelElement( child );

if ( modelChild && modelChild.getAttribute( 'indent' ) > modelItem.getAttribute( 'indent' ) ) {
if ( modelChild && modelChild.getAttribute( 'listIndent' ) > modelItem.getAttribute( 'listIndent' ) ) {
lastSubChild = child;
} else {
break;
Expand Down Expand Up @@ -944,14 +944,14 @@ function hoistNestedLists( nextIndent, modelRemoveStartPosition, viewRemoveStart
const prevModelItem = getSiblingListItem( modelRemoveStartPosition, {
sameIndent: true,
smallerIndent: true,
indent: nextIndent
listIndent: nextIndent
} );

const mapper = conversionApi.mapper;
const viewWriter = conversionApi.writer;

// Indent of found element or `null` if the element has not been found.
const prevIndent = prevModelItem ? prevModelItem.getAttribute( 'indent' ) : null;
const prevIndent = prevModelItem ? prevModelItem.getAttribute( 'listIndent' ) : null;

let insertPosition;

Expand Down
16 changes: 8 additions & 8 deletions src/indentcommand.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default class IndentCommand extends Command {
let next = lastItem.nextSibling;

// Check all items after last indented item, as long as their indent is bigger than indent of that item.
while ( next && next.name == 'listItem' && next.getAttribute( 'indent' ) > lastItem.getAttribute( 'indent' ) ) {
while ( next && next.name == 'listItem' && next.getAttribute( 'listIndent' ) > lastItem.getAttribute( 'listIndent' ) ) {
itemsToChange.push( next );

next = next.nextSibling;
Expand All @@ -75,7 +75,7 @@ export default class IndentCommand extends Command {
}

for ( const item of itemsToChange ) {
const indent = item.getAttribute( 'indent' ) + this._indentBy;
const indent = item.getAttribute( 'listIndent' ) + this._indentBy;

// If indent is lower than 0, it means that the item got outdented when it was not indented.
// This means that we need to convert that list item to paragraph.
Expand All @@ -87,7 +87,7 @@ export default class IndentCommand extends Command {
}
// If indent is >= 0, change the attribute value.
else {
writer.setAttribute( 'indent', indent, item );
writer.setAttribute( 'listIndent', indent, item );
}
}
} );
Expand All @@ -111,18 +111,18 @@ export default class IndentCommand extends Command {
if ( this._indentBy > 0 ) {
// Cannot indent first item in it's list. Check if before `listItem` is a list item that is in same list.
// To be in the same list, the item has to have same attributes and cannot be "split" by an item with lower indent.
const indent = listItem.getAttribute( 'indent' );
const type = listItem.getAttribute( 'type' );
const indent = listItem.getAttribute( 'listIndent' );
const type = listItem.getAttribute( 'listType' );

let prev = listItem.previousSibling;

while ( prev && prev.is( 'listItem' ) && prev.getAttribute( 'indent' ) >= indent ) {
if ( prev.getAttribute( 'indent' ) == indent ) {
while ( prev && prev.is( 'listItem' ) && prev.getAttribute( 'listIndent' ) >= indent ) {
if ( prev.getAttribute( 'listIndent' ) == indent ) {
// The item is on the same level.
// If it has same type, it means that we found a preceding sibling from the same list.
// If it does not have same type, it means that `listItem` is on different list (this can happen only
// on top level lists, though).
return prev.getAttribute( 'type' ) == type;
return prev.getAttribute( 'listType' ) == type;
}

prev = prev.previousSibling;
Expand Down

0 comments on commit 1d24fee

Please sign in to comment.