Removed virtual naming convention

Zaydek Michels-Gualtieri · Zaydek Michels-Gualtieri · commit 303bf94413ab · 2020-07-10T06:09:31.000+09:00
diff --git a/src/Editor/components/elements.js b/src/Editor/components/elements.js
@@ -8,7 +8,7 @@ import toReact from "./toReact"
 const Element = ({ id, style, children, ...props }) => {
 	const ref = React.useRef(null)
 
-	// NOTE: React **does not** manage rendered children.
+	// NOTE: React does not manage rendered children.
 	React.useLayoutEffect(() => {
 		if (!ref.current) {
 			// No-op
diff --git a/src/Editor/model/Editor/Editor.js b/src/Editor/model/Editor/Editor.js
@@ -1,21 +1,15 @@
-import VirtualRange from "./VirtualRange"
+import Range from "./Range"
 import { immerable } from "immer"
 
 // Describes an editor.
 class Editor {
 	[immerable] = true
 
-	// Is read-only mode enabled?
-	//
 	// NOTE: DOMContentLoaded disables read-only mode.
 	isReadOnlyModeEnabled = true
-	// Is the active element?
 	isActiveElement = false
-	// Virtual elements.
 	elements = []
-	// Virtual range.
-	range = new VirtualRange()
-	// Render counter; use as an effect dependency.
+	range = new Range()
 	shouldRerender = 0
 
 	constructor(elements) {
diff --git a/src/Editor/model/Editor/Element.js b/src/Editor/model/Editor/Element.js
@@ -1,8 +1,8 @@
 import hash from "lib/hash"
 import { immerable } from "immer"
 
-// Describes a virtual element.
-class VirtualElement {
+// Describes an element.
+class Element {
 	[immerable] = true
 
 	type = ""
@@ -22,4 +22,4 @@ class VirtualElement {
 	}
 }
 
-export default VirtualElement
+export default Element
diff --git a/src/Editor/model/Editor/InlineElement.js b/src/Editor/model/Editor/InlineElement.js
@@ -1,5 +1,5 @@
-// Describes a virtual inline element.
-class VirtualInlineElement {
+// Describes an inline element.
+class InlineElement {
 	// Zero-to-many types.
 	types = []
 	// Zero-to-many props.
@@ -16,4 +16,4 @@ class VirtualInlineElement {
 	}
 }
 
-export default VirtualInlineElement
+export default InlineElement
diff --git a/src/Editor/model/Editor/MultilineElement.js b/src/Editor/model/Editor/MultilineElement.js
@@ -1,8 +1,23 @@
 import hash from "lib/hash"
 import { immerable } from "immer"
 
-// Describes a virtual multiline element.
-class VirtualMultilineElement {
+// Describes a multiline element.
+//
+// {
+//   props: {
+//     elements: [
+//       {
+//         props: {
+//           children: [
+//             ...
+//           ],
+//         },
+//       },
+//     ],
+//   },
+// }
+//
+class MultilineElement {
 	[immerable] = true
 
 	type = ""
@@ -22,4 +37,4 @@ class VirtualMultilineElement {
 	}
 }
 
-export default VirtualMultilineElement
+export default MultilineElement
diff --git a/src/Editor/model/Editor/Position.js b/src/Editor/model/Editor/Position.js
@@ -3,8 +3,9 @@ import {
 	produce,
 } from "immer"
 
-// Describes a virtual position.
-class VirtualPosition {
+// Describes a position; a start and end position compose a
+// range.
+class Position {
 	[immerable] = true
 
 	key = ""
@@ -30,4 +31,4 @@ class VirtualPosition {
 	}
 }
 
-export default VirtualPosition
+export default Position
diff --git a/src/Editor/model/Editor/Range.js b/src/Editor/model/Editor/Range.js
@@ -1,35 +1,42 @@
-import VirtualPosition from "./VirtualPosition"
+import Position from "./Position"
 
 import {
 	immerable,
 	produce,
 } from "immer"
 
-// Describes a virtual range.
+// Describes a range.
 class Range {
 	[immerable] = true
 
-	start = new VirtualPosition()
-	end = new VirtualPosition()
+	start = new Position()
+	end = new Position()
 
 	// Constructs from the current range, scoped to a tree and
 	// [contenteditable="true"] descendants.
 	static getCurrent(tree) {
 		// ...
 	}
 
-	// Returns whether virtual positions are collapsed.
+	// Computes whether the positions are collapsed.
 	get collapsed() {
 		return this.start.isEqualTo(this.end)
 	}
 
-	// Collapses virtual positions.
-	collapse() {
+	// Collapses end-to-start.
+	collapseToStart() {
 		return produce(this, draft => {
 			draft.end = draft.start
 		})
 	}
 
+	// Collapses start-to-end.
+	collapseToEnd() {
+		return produce(this, draft => {
+			draft.start = draft.end
+		})
+	}
+
 	// Converts to a range literal.
 	toRangeLiteral() {
 		// ...
diff --git a/src/Editor/model/Editor/__tests__/instanceof.test.js b/src/Editor/model/Editor/__tests__/instanceof.test.js
@@ -1,15 +1,15 @@
 import Editor from "../Editor"
-import VirtualElement from "../VirtualElement"
-import VirtualInlineElement from "../VirtualInlineElement"
-import VirtualMultilineElement from "../VirtualMultilineElement"
-import VirtualPosition from "../VirtualPosition"
-import VirtualRange from "../VirtualRange"
+import Element from "../Element"
+import InlineElement from "../InlineElement"
+import MultilineElement from "../MultilineElement"
+import Position from "../Position"
+import Range from "../Range"
 
 describe("", () => {
 	test("", () => expect(new Editor() instanceof Editor).toBeTruthy())
-	test("", () => expect(new VirtualElement() instanceof VirtualElement).toBeTruthy())
-	test("", () => expect(new VirtualInlineElement() instanceof VirtualInlineElement).toBeTruthy())
-	test("", () => expect(new VirtualMultilineElement() instanceof VirtualMultilineElement).toBeTruthy())
-	test("", () => expect(new VirtualPosition() instanceof VirtualPosition).toBeTruthy())
-	test("", () => expect(new VirtualRange() instanceof VirtualRange).toBeTruthy())
+	test("", () => expect(new Element() instanceof Element).toBeTruthy())
+	test("", () => expect(new InlineElement() instanceof InlineElement).toBeTruthy())
+	test("", () => expect(new MultilineElement() instanceof MultilineElement).toBeTruthy())
+	test("", () => expect(new Position() instanceof Position).toBeTruthy())
+	test("", () => expect(new Range() instanceof Range).toBeTruthy())
 })
diff --git a/src/Editor/model/Scanners/AbstractScanner.js b/src/Editor/model/Scanners/AbstractScanner.js
@@ -1,21 +1,19 @@
 import domUtils from "lib/domUtils"
+import Element from "../Editor/Element"
+import InlineElement from "../Editor/InlineElement"
 import JSONClone from "lib/JSONClone"
-import VirtualElement from "../Editor/VirtualElement"
-import VirtualInlineElement from "../Editor/VirtualInlineElement"
 
-// Describes an abstract scanner; a scanner implements scan
-// to scan virtual elements and children.
+// Describes an abstract scanner.
 class AbstractScanner {
 	// Scans types and props.
 	scanner = null
 
-	// Scans virtual children from an element.
 	scanChildren(element) {
 		const children = []
 		const recurse = (on, types = [], props = {}) => {
 			if (domUtils.isTextNode(on)) {
 				const value = on.nodeValue
-				children.push(new VirtualInlineElement({ types, props, value }))
+				children.push(new InlineElement({ types, props, value }))
 				return
 			}
 			for (const each of on.childNodes) {
@@ -36,14 +34,13 @@ class AbstractScanner {
 		return children
 	}
 
-	// Scans virtual elements from a tree.
 	scan(tree) {
 		const elements = []
 		for (const each of tree.children) {
 			const [T, P] = this.scanner(each)
 			switch (T) {
 			case "p":
-				elements.push(new VirtualElement({
+				elements.push(new Element({
 					type: T,
 					key: each.id,
 					props: {
diff --git a/src/Editor/model/Scanners/RenderedScanner.js b/src/Editor/model/Scanners/RenderedScanner.js
@@ -9,8 +9,9 @@ import AbstractScanner from "./AbstractScanner"
 class RenderedScanner extends AbstractScanner {
 	constructor() {
 		super()
+		const scanner = scanners.rendered
 		Object.assign(this, {
-			scanner: scanners.rendered,
+			scanner,
 		})
 	}
 }
diff --git a/src/Editor/model/Scanners/SemanticScanner.js b/src/Editor/model/Scanners/SemanticScanner.js
@@ -9,8 +9,9 @@ import AbstractScanner from "./AbstractScanner"
 class SemanticScanner extends AbstractScanner {
 	constructor() {
 		super()
+		const scanner = scanners.semantic
 		Object.assign(this, {
-			scanner: scanners.semantic,
+			scanner,
 		})
 	}
 }
diff --git a/src/Editor/model/Scanners/__tests__/scanners.test.js b/src/Editor/model/Scanners/__tests__/scanners.test.js
@@ -1,9 +1,9 @@
 import * as scanners from "../scanners"
+import InlineElement from "../../Editor/InlineElement"
 import React from "react"
 import RenderedScanner from "../RenderedScanner"
 import renderTree from "lib/renderTree"
 import SemanticScanner from "../SemanticScanner"
-import VirtualInlineElement from "../../Editor/VirtualInlineElement"
 
 describe("semantic", () => {
 	test("<i>", () => {
@@ -52,11 +52,11 @@ describe("semantic", () => {
 		const scanner = new SemanticScanner()
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldy" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldy" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 	test("<a><a> (2 of 2)", () => {
@@ -75,11 +75,11 @@ describe("semantic", () => {
 		const scanner = new SemanticScanner()
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "b" } }, value: "worldy" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
+			new InlineElement({ types: ["a"], props: { a: { href: "b" } }, value: "worldy" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 	test("*", () => {
@@ -103,10 +103,10 @@ describe("semantic", () => {
 		const scanner = new SemanticScanner()
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["code", "a", "strike", "strong", "em"], props: { a: { href: "https://google.com" } }, value: "world" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["code", "a", "strike", "strong", "em"], props: { a: { href: "https://google.com" } }, value: "world" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 })
@@ -158,11 +158,11 @@ describe("rendered", () => {
 		const scanner = new RenderedScanner()
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldy" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldy" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 	test("<span data-type='a'><span data-type='a'> (2 of 2)", () => {
@@ -181,11 +181,11 @@ describe("rendered", () => {
 		const scanner = new RenderedScanner()
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
-			new VirtualInlineElement({ types: ["a"], props: { a: { href: "b" } }, value: "worldy" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["a"], props: { a: { href: "a" } }, value: "worldx" }),
+			new InlineElement({ types: ["a"], props: { a: { href: "b" } }, value: "worldy" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 	test("*", () => {
@@ -209,10 +209,10 @@ describe("rendered", () => {
 		const scanner = new RenderedScanner(tree)
 		const children = scanner.scanChildren(tree)
 		expect(children).toEqual([
-			new VirtualInlineElement({ value: "Hello," }),
-			new VirtualInlineElement({ value: " " }),
-			new VirtualInlineElement({ types: ["code", "a", "strike", "strong", "em"], props: { a: { href: "https://google.com" } }, value: "world" }),
-			new VirtualInlineElement({ value: "!" }),
+			new InlineElement({ value: "Hello," }),
+			new InlineElement({ value: " " }),
+			new InlineElement({ types: ["code", "a", "strike", "strong", "em"], props: { a: { href: "https://google.com" } }, value: "world" }),
+			new InlineElement({ value: "!" }),
 		])
 	})
 })

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`import hash from "lib/hash"`
`2`	`2`	`import { immerable } from "immer"`
`3`	`3`
`4`		`-// Describes a virtual element.`
`5`		`-class VirtualElement {`
	`4`	`+// Describes an element.`
	`5`	`+class Element {`
`6`	`6`	`[immerable] = true`
`7`	`7`
`8`	`8`	`type = ""`
`@@ -22,4 +22,4 @@ class VirtualElement {`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
`25`		`-export default VirtualElement`
	`25`	`+export default Element`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		`-// Describes a virtual inline element.`
`2`		`-class VirtualInlineElement {`
	`1`	`+// Describes an inline element.`
	`2`	`+class InlineElement {`
`3`	`3`	`// Zero-to-many types.`
`4`	`4`	`types = []`
`5`	`5`	`// Zero-to-many props.`
`@@ -16,4 +16,4 @@ class VirtualInlineElement {`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
`19`		`-export default VirtualInlineElement`
	`19`	`+export default InlineElement`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,9 @@ import {`
`3`	`3`	`produce,`
`4`	`4`	`} from "immer"`
`5`	`5`
`6`		`-// Describes a virtual position.`
`7`		`-class VirtualPosition {`
	`6`	`+// Describes a position; a start and end position compose a`
	`7`	`+// range.`
	`8`	`+class Position {`
`8`	`9`	`[immerable] = true`
`9`	`10`
`10`	`11`	`key = ""`
`@@ -30,4 +31,4 @@ class VirtualPosition {`
`30`	`31`	`}`
`31`	`32`	`}`
`32`	`33`
`33`		`-export default VirtualPosition`
	`34`	`+export default Position`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,9 @@ import AbstractScanner from "./AbstractScanner"`
`9`	`9`	`class RenderedScanner extends AbstractScanner {`
`10`	`10`	`constructor() {`
`11`	`11`	`super()`
	`12`	`+ const scanner = scanners.rendered`
`12`	`13`	`Object.assign(this, {`
`13`		`- scanner: scanners.rendered,`
	`14`	`+ scanner,`
`14`	`15`	`})`
`15`	`16`	`}`
`16`	`17`	`}`