Merge pull request #1389 from ckeditor/t/ckeditor5/742

Other: Renamed plural method names to singular and singular attribute names to plural. See ckeditor/ckeditor5#742. BREAKING CHANGES: Properties in `MatcherPattern`, view `ElementDefinition` and options for conversion utils have been renamed: `class` to `classes`, `style` to `styles`, `attribute` to `attributes`.
ckeditor · Apr 5, 2018 · 9465c82 · 9465c82
2 parents 3a348fd + 245ee42
commit 9465c82
Show file tree

Hide file tree

Showing 83 changed files with 878 additions and 870 deletions.
diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js
@@ -133,7 +133,7 @@ export default class Conversion {
 	 *			model: 'fancyParagraph',
 	 *			view: {
 	 *				name: 'p',
-	 *				class: 'fancy'
+	 *				classes: 'fancy'
 	 *			}
 	 *		} );
 	 *
@@ -145,7 +145,7 @@ export default class Conversion {
 	 *				'div',
 	 *				{
 	 *					// Any element with `display: block` style.
-	 *					style: {
+	 *					styles: {
 	 *						display: 'block'
 	 *					}
 	 *				}
@@ -177,7 +177,7 @@ export default class Conversion {
 	 *					// Those properties will be "consumed" during conversion.
 	 *					// See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more.
 	 *
-	 *					return { name: true, style: [ 'font-size' ] };
+	 *					return { name: true, styles: [ 'font-size' ] };
 	 *				}
 	 *
 	 *				return null;
@@ -220,7 +220,7 @@ export default class Conversion {
 	 *			model: 'bold',
 	 *			view: {
 	 *				name: 'span',
-	 *				class: 'bold'
+	 *				classes: 'bold'
 	 *			}
 	 *		} );
 	 *
@@ -235,13 +235,13 @@ export default class Conversion {
 	 *			view: {
 	 *				underline: {
 	 *					name: 'span',
-	 *					style: {
+	 *					styles: {
 	 *						'text-decoration': 'underline'
 	 *					}
 	 *				},
 	 *				lineThrough: {
 	 *					name: 'span',
-	 *					style: {
+	 *					styles: {
 	 *						'text-decoration': 'line-through'
 	 *					}
 	 *				}
@@ -256,11 +256,11 @@ export default class Conversion {
 	 *				'b',
 	 *				{
 	 *					name: 'span',
-	 *					class: 'bold'
+	 *					classes: 'bold'
 	 *				},
 	 *				{
 	 *					name: 'span',
-	 *					style: {
+	 *					styles: {
 	 *						'font-weight': 'bold'
 	 *					}
 	 *				},
@@ -274,7 +274,7 @@ export default class Conversion {
 	 *
 	 *						return {
 	 *							name: true,
-	 *							style: [ 'font-weight' ]
+	 *							styles: [ 'font-weight' ]
 	 *						};
 	 *					}
 	 *				}
@@ -291,13 +291,13 @@ export default class Conversion {
 	 *			view: {
 	 *				big: {
 	 *					name: 'span',
-	 *					style: {
+	 *					styles: {
 	 *						'font-size': '1.2em'
 	 *					}
 	 *				},
 	 *				small: {
 	 *					name: 'span',
-	 *					style: {
+	 *					styles: {
 	 *						'font-size': '0.8em'
 	 *					}
 	 *				}
@@ -323,7 +323,7 @@ export default class Conversion {
 	 *						// Those properties will be "consumed" during conversion.
 	 *						// See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more.
 	 *
-	 *						return { name: true, style: [ 'font-size' ] };
+	 *						return { name: true, styles: [ 'font-size' ] };
 	 *					}
 	 *
 	 *					return null;
@@ -348,7 +348,7 @@ export default class Conversion {
 	 *						// Those properties will be "consumed" during conversion.
 	 *						// See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more.
 	 *
-	 *						return { name: true, style: [ 'font-size' ] };
+	 *						return { name: true, styles: [ 'font-size' ] };
 	 *					}
 	 *
 	 *					return null;
@@ -440,12 +440,12 @@ export default class Conversion {
 	 *			},
 	 *			upcastAlso: {
 	 *				right: {
-	 *					style: {
+	 *					styles: {
 	 *						'text-align': 'right'
 	 *					}
 	 *				},
 	 *				center: {
-	 *					style: {
+	 *					styles: {
 	 *						'text-align': 'center'
 	 *					}
 	 *				}

diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js
@@ -32,7 +32,7 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep';
  *			model: 'fancyParagraph',
  *			view: {
  *				name: 'p',
- *				class: 'fancy'
+ *				classes: 'fancy'
  *			}
  *		} );
  *
@@ -73,7 +73,7 @@ export function downcastElementToElement( config ) {
  *			model: 'invert',
  *			view: {
  *				name: 'span',
- *				class: [ 'font-light', 'bg-dark' ]
+ *				classes: [ 'font-light', 'bg-dark' ]
  *			}
  *		} );
  *
@@ -85,13 +85,13 @@ export function downcastElementToElement( config ) {
  *			view: {
  *				big: {
  *					name: 'span',
- *					style: {
+ *					styles: {
  *						'font-size': '1.2em'
  *					}
  *				},
  *				small: {
  *					name: 'span',
- *					style: {
+ *					styles: {
  *						'font-size': '0.8em'
  *					}
  *				}
@@ -244,7 +244,7 @@ export function downcastAttributeToAttribute( config ) {
  *			model: 'search',
  *			view: {
  *				name: 'span',
- *				attribute: {
+ *				attributes: {
  *					'data-marker': 'search'
  *				}
  *			}
@@ -305,9 +305,9 @@ export function downcastMarkerToElement( config ) {
  * to a container element, it is the container element instance itself which applies values from highlight descriptor.
  * So, in a sense, converter takes care of stating what should be applied on what, while element decides how to apply that.
  *
- *		downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } );
+ *		downcastMarkerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  *
- *		downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' }, priority: 'high' } );
+ *		downcastMarkerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, priority: 'high' } );
  *
  * 		downcastMarkerToHighlight( {
  * 			model: 'comment',
@@ -316,7 +316,7 @@ export function downcastMarkerToElement( config ) {
  *	 			const commentType = data.markerName.split( ':' )[ 1 ];
  *
  *	 			return {
- *	 				class: [ 'comment', 'comment-' + commentType ]
+ *	 				classes: [ 'comment', 'comment-' + commentType ]
  *	 			};
  * 			}
  * 		} );
@@ -372,24 +372,24 @@ function _createViewElementFromDefinition( viewElementDefinition, viewWriter, vi
 	let element;
 
 	if ( viewElementType == 'container' ) {
-		element = viewWriter.createContainerElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) );
+		element = viewWriter.createContainerElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attributes ) );
 	} else if ( viewElementType == 'attribute' ) {
-		element = viewWriter.createAttributeElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) );
+		element = viewWriter.createAttributeElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attributes ) );
 	} else {
 		// 'ui'.
-		element = viewWriter.createUIElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) );
+		element = viewWriter.createUIElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attributes ) );
 	}
 
-	if ( viewElementDefinition.style ) {
-		const keys = Object.keys( viewElementDefinition.style );
+	if ( viewElementDefinition.styles ) {
+		const keys = Object.keys( viewElementDefinition.styles );
 
 		for ( const key of keys ) {
-			viewWriter.setStyle( key, viewElementDefinition.style[ key ], element );
+			viewWriter.setStyle( key, viewElementDefinition.styles[ key ], element );
 		}
 	}
 
-	if ( viewElementDefinition.class ) {
-		const classes = viewElementDefinition.class;
+	if ( viewElementDefinition.classes ) {
+		const classes = viewElementDefinition.classes;
 
 		if ( typeof classes == 'string' ) {
 			viewWriter.addClass( classes, element );
@@ -1000,8 +1000,8 @@ function _prepareDescriptor( highlightDescriptor, data, conversionApi ) {
 export function createViewElementFromHighlightDescriptor( descriptor ) {
 	const viewElement = new ViewAttributeElement( 'span', descriptor.attributes );
 
-	if ( descriptor.class ) {
-		viewElement._addClass( descriptor.class );
+	if ( descriptor.classes ) {
+		viewElement._addClass( descriptor.classes );
 	}
 
 	if ( descriptor.priority ) {

diff --git a/src/conversion/modelconsumable.js b/src/conversion/modelconsumable.js
@@ -21,8 +21,8 @@ import TextProxy from '../model/textproxy';
  * during conversion, when given part of model item is converted (i.e. the view element has been inserted into the view,
  * but without attributes), consumable value is removed from `ModelConsumable`.
  *
- * For model items, `ModelConsumable` stores consumable values of one of following types: `insert`, `addAttribute:<attributeKey>`,
- * `changeAttribute:<attributeKey>`, `removeAttribute:<attributeKey>`.
+ * For model items, `ModelConsumable` stores consumable values of one of following types: `insert`, `addattribute:<attributeKey>`,
+ * `changeattributes:<attributeKey>`, `removeattributes:<attributeKey>`.
  *
  * In most cases, it is enough to let {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}
  * gather consumable values, so there is no need to use
@@ -312,7 +312,7 @@ export default class ModelConsumable {
 
 // Returns a normalized consumable type name from given string. A normalized consumable type name is a string that has
 // at most one colon, for example: `insert` or `addMarker:highlight`. If string to normalize has more "parts" (more colons),
-// the other parts are dropped, for example: `addAttribute:bold:$text` -> `addAttribute:bold`.
+// the other parts are dropped, for example: `addattribute:bold:$text` -> `addattributes:bold`.
 //
 // @param {String} type Consumable type.
 // @returns {String} Normalized consumable type.

diff --git a/src/conversion/upcast-converters.js b/src/conversion/upcast-converters.js
@@ -31,15 +31,15 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep';
  *		upcastElementToElement( {
  *			view: {
  *				name: 'p',
- *				class: 'fancy'
+ *				classes: 'fancy'
  *			},
  *			model: 'fancyParagraph'
  *		} );
  *
  *		upcastElementToElement( {
  * 			view: {
  *				name: 'p',
- *				class: 'heading'
+ *				classes: 'heading'
  * 			},
  * 			model: ( viewElement, modelWriter ) => {
  * 				return modelWriter.createElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } );
@@ -83,15 +83,15 @@ export function upcastElementToElement( config ) {
  *		upcastElementToAttribute( {
  *			view: {
  *				name: 'span',
- *				class: 'bold'
+ *				classes: 'bold'
  *			},
  *			model: 'bold'
  *		} );
  *
  *		upcastElementToAttribute( {
  *			view: {
  *				name: 'span',
- *				class: [ 'styled', 'styled-dark' ]
+ *				classes: [ 'styled', 'styled-dark' ]
  *			},
  *			model: {
  *				key: 'styled',
@@ -102,7 +102,7 @@ export function upcastElementToElement( config ) {
  * 		upcastElementToAttribute( {
  *			view: {
  *				name: 'span',
- *				style: {
+ *				styles: {
  *					'font-size': /[\s\S]+/
  *				}
  *			},
@@ -250,7 +250,7 @@ export function upcastAttributeToAttribute( config ) {
  *		upcastElementToMarker( {
  *			view: {
  *				name: 'span',
- *				attribute: {
+ *				attributes: {
  *					'data-marker': 'search'
  *				}
  *			},
@@ -397,14 +397,16 @@ function _normalizeViewAttributeKeyValueConfig( config ) {
 	let normalized;
 
 	if ( key == 'class' || key == 'style' ) {
+		const keyName = key == 'class' ? 'classes' : 'styles';
+
 		normalized = {
-			[ key ]: config.view.value
+			[ keyName ]: config.view.value
 		};
 	} else {
 		const value = typeof config.view.value == 'undefined' ? /[\s\S]*/ : config.view.value;
 
 		normalized = {
-			attribute: {
+			attributes: {
 				[ key ]: value
 			}
 		};
@@ -498,7 +500,7 @@ function _onlyViewNameIsDefined( config ) {
 		return false;
 	}
 
-	return !config.view.class && !config.view.attribute && !config.view.style;
+	return !config.view.classes && !config.view.attributes && !config.view.styles;
 }
 
 // Helper function for to-model-attribute converter. Sets model attribute on given range. Checks {@link module:engine/model/schema~Schema}