Partially deprecated part of queryCollection’s API

Author: Zaydek Michels-Gualtieri

src/Editor/Types/index.js

@@ -15,7 +15,7 @@ import {
 } from "../components/components-text"
 
 // Enumerates types.
-export const enumerated = new Enum(
+const enumerated = new Enum(
 	"p",
 
 	"em",
@@ -36,7 +36,6 @@ export const components = {
 	[enumerated.a]:      A,
 }
 
-// TODO: Use NumberEnum
 const i = iota()
 
 // Maps types to sort orders for text components; render
@@ -54,5 +53,5 @@ export function sort(span) {
 	span.types.sort((T1, T2) => sortOrder[T1] - sortOrder[T2])
 }
 
-// Re-exports as enumerated as enum for Types.enum.
+// Exports enumerated as Types.enum.
 export { enumerated as enum }

src/Editor/useEditor/applyFormat.js

@@ -1,22 +1,14 @@
 import * as Types from "../Types"
 import methods from "./methods"
-import NumberEnum from "lib/enums/NumberEnum"
 import queryCollection from "./queryCollection"
 
-// Enumerates how to apply a format.
-const enumerated = new NumberEnum(
-	"plaintext",
-	"shouldNotApply",
-	"shouldApply",
-)
-
 // Tests whether to apply a format.
 const testShouldApply = collection => (T, P = {}) => {
 	if (T === "plaintext") {
-		return enumerated.plaintext
+		return "plaintext"
 	}
-	const didApply = collection.every(each => each.spans.every(each => each.types.indexOf(T) >= 0))
-	return didApply ? enumerated.shouldNotApply : enumerated.shouldApply
+	const didApply = collection.every(each => each.refs.spans.every(each => each.types.indexOf(T) >= 0))
+	return didApply ? "should-not-apply" : "should-apply"
 }
 
 // Applies a format to the current range.
@@ -26,34 +18,34 @@ const applyFormat = state => (T, P = {}) => {
 	const shouldApply = testShouldApply(collection)(T, P)
 	switch (shouldApply) {
 	// Plaintext:
-	case enumerated.plaintext:
+	case "plaintext":
 		for (const c of collection) {
-			for (const s of c.spans) {
+			for (const s of c.refs.spans) {
 				for (const T of s.types) {
 					s[T] = undefined
 				}
 				s.types.splice(0)
 			}
-			c.spans.map(each => Types.sort(each))
+			c.refs.spans.map(each => Types.sort(each))
 		}
 		break
-	// Should not apply:
-	case enumerated.shouldNotApply:
+	// Should not apply a format:
+	case "should-not-apply":
 		for (const c of collection) {
-			for (const s of c.spans) {
+			for (const s of c.refs.spans) {
 				const x = s.types.indexOf(T)
 				if (x >= 0) {
 					s.types.splice(x, 1)
 					s[T] = undefined
 				}
 			}
-			c.spans.map(each => Types.sort(each))
+			c.refs.spans.map(each => Types.sort(each))
 		}
 		break
-	// Should apply:
-	case enumerated.shouldApply:
+	// Should apply a format:
+	case "should-apply":
 		for (const c of collection) {
-			for (const s of c.spans) {
+			for (const s of c.refs.spans) {
 				const x = s.types.indexOf(T)
 				if (x === -1) {
 					s.types.push(T)
@@ -62,7 +54,7 @@ const applyFormat = state => (T, P = {}) => {
 					}
 				}
 			}
-			c.spans.map(each => Types.sort(each))
+			c.refs.spans.map(each => Types.sort(each))
 		}
 		break
 	default:

src/Editor/useEditor/queryCollection.js

@@ -1,6 +1,7 @@
 import offset from "./offset"
 
-// Queries a collection based on the current range.
+// Queries the current range as a collection. A collection
+// is an array of normalized elements and spans.
 function queryCollection(state) {
 	const e1 = state.elements.findIndex(each => each.key === state.range[0].key)
 	const e2 = state.elements.findIndex(each => each.key === state.range[1].key)
@@ -15,22 +16,15 @@ function queryCollection(state) {
 		// Span offsets:
 		const s1 = offset(each.props.spans, t1)
 		const s2 = offset(each.props.spans, t2)
-		// Push references and offsets:
 		collection.push({
 			refs: {
 				element: each,
 				spans: each.props.spans.slice(s1, s2),
-				// text: each.props.spans.reduce((acc, each) => acc += each.text, "").slice(t1, t2),
 			},
 			offsets: {
 				element: x,
 				spans: [s1, s2],
-				// text: [t1, t2],
 			},
-
-			// TODO: Deprecate
-			ref: each, // TODO: Rename to element?
-			spans: each.props.spans.slice(s1, s2),
 		})
 	}
 	return collection