Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugs in breakToText #1590

Merged
merged 1 commit into from
Oct 20, 2020
Merged

Bugs in breakToText #1590

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
53 changes: 10 additions & 43 deletions packages/app/obojobo-document-engine/__tests__/oboeditor/util/keydown-util.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { Transforms } from 'slate'
import { Transforms, Point } from 'slate'
import { ReactEditor } from 'slate-react'
jest.mock('slate-react')

import KeyDownUtil from 'src/scripts/oboeditor/util/keydown-util'

describe('KeyDown Util', () => {
beforeEach(() => {
jest.clearAllMocks()
})
test('deleteEmptyParent', () => {
jest.spyOn(Transforms, 'removeNodes').mockReturnValue(true)
jest.spyOn(Transforms, 'move').mockReturnValue(true)
Expand Down Expand Up @@ -316,7 +319,6 @@ describe('KeyDown Util', () => {

test('breakToText inserts text', () => {
jest.spyOn(Transforms, 'insertNodes').mockReturnValue(true)
jest.spyOn(Transforms, 'collapse').mockReturnValue(true)

const editor = {
children: [
Expand All @@ -342,7 +344,6 @@ describe('KeyDown Util', () => {

expect(event.preventDefault).toHaveBeenCalled()
expect(Transforms.insertNodes).toHaveBeenCalled()
expect(Transforms.collapse).toHaveBeenCalled()

// make sure the inserted node is correct type
const insertedNode = Transforms.insertNodes.mock.calls[0][1]
Expand All @@ -351,9 +352,9 @@ describe('KeyDown Util', () => {
expect(insertedNode.children[0].children[0]).toEqual({ text: '' })
})

test('breakToText converts to text', () => {
jest.spyOn(Transforms, 'setNodes').mockReturnValue(true)
jest.spyOn(Transforms, 'collapse').mockReturnValue(true)
test('breakToText skips when multile node are selected', () => {
jest.spyOn(Point, 'isBefore').mockReturnValue(false)
jest.spyOn(Point, 'equals').mockReturnValue(false)

const editor = {
children: [
Expand All @@ -363,8 +364,8 @@ describe('KeyDown Util', () => {
}
],
selection: {
anchor: { path: [0, 0], offset: 1 },
focus: { path: [0, 0], offset: 1 }
anchor: { path: [0, 0], offset: 4 },
focus: { path: [0, 0], offset: 4 }
},
isInline: () => false,
isVoid: () => false
Expand All @@ -378,40 +379,6 @@ describe('KeyDown Util', () => {
KeyDownUtil.breakToText(event, editor, [editor.children[0], [0]], true)

expect(event.preventDefault).toHaveBeenCalled()
expect(Transforms.setNodes).toHaveBeenCalled()
expect(Transforms.collapse).toHaveBeenCalled()
})

test('breakToText converts to text when selection is at the start of a node', () => {
jest.spyOn(Transforms, 'setNodes').mockReturnValue(true)
jest.spyOn(Transforms, 'collapse').mockReturnValue(true)
jest.spyOn(Transforms, 'select').mockReturnValue(true)

const editor = {
children: [
{
type: 'mockNode',
children: [{ text: 'some' }]
}
],
selection: {
anchor: { path: [0, 0], offset: 0 },
focus: { path: [0, 0], offset: 0 }
},
isInline: () => false,
isVoid: () => false
}

const event = {
preventDefault: jest.fn()
}

KeyDownUtil.breakToText(event, editor, [editor.children[0], [0]], true)

expect(event.preventDefault).toHaveBeenCalled()
expect(Transforms.insertNodes).toHaveBeenCalled()
expect(Transforms.setNodes).toHaveBeenCalled()
expect(Transforms.select).toHaveBeenCalled()
expect(Transforms.collapse).toHaveBeenCalled()
expect(Transforms.insertNodes).not.toHaveBeenCalled()
})
})
88 changes: 28 additions & 60 deletions packages/app/obojobo-document-engine/src/scripts/oboeditor/util/keydown-util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Text, Editor, Transforms, Range, Path, Element, Point } from 'slate'
import { Text, Editor, Transforms, Range, Path, Element, Point, Node } from 'slate'

const TEXT_NODE = 'ObojoboDraft.Chunks.Text'
const TEXT_LINE_NODE = 'ObojoboDraft.Chunks.Text.TextLine'
Expand Down Expand Up @@ -75,76 +75,44 @@ const KeyDownUtil = {
},
breakToText: (event, editor, entry) => {
const [node, nodePath] = entry
const nodeRange = Editor.range(editor, nodePath)
const nodeEnd = Editor.end(editor, nodeRange)
const nodeEnd = Editor.end(editor, [...nodePath, node.children.length - 1])
const selectionEnd = Editor.end(editor, editor.selection)
const nodeStart = Editor.start(editor, nodeRange)
const selectionStart = Editor.start(editor, editor.selection)
const toStartOfNode = {
anchor: selectionStart,
focus: nodeStart
}

event.preventDefault()

const toEndOfNode = {
anchor: selectionEnd,
focus: nodeEnd
}
// When multiple nodes are selected, only split the last node.
if (Point.isBefore(selectionEnd, nodeEnd) || Point.equals(selectionEnd, nodeEnd)) {
const textRange = {
anchor: selectionEnd,
focus: nodeEnd
}

// If the Range is collapsed at the end of the node, just insert text
if (Range.isCollapsed(toEndOfNode)) {
return Transforms.insertNodes(
editor,
{
type: TEXT_NODE,
content: {},
children: [
{
type: TEXT_NODE,
subtype: TEXT_LINE_NODE,
content: { indent: 0, align: 'left' },
children: [{ text: '' }]
}
]
},
{ split: true }
)
}
const toEndOfNode = {
anchor: selectionStart,
focus: nodeEnd
}

if (Range.isCollapsed(toStartOfNode)) {
// Duplicate the node that's being split
const newNode = { ...node }
const newTexts = Node.fragment(editor, textRange)
const newNode = {
type: TEXT_NODE,
content: { triggers: [] },
children: [
{
type: TEXT_NODE,
subtype: TEXT_LINE_NODE,
content: { indent: 0, align: 'left' },
children: [...newTexts[0].children]
}
]
}

// Insert the duplicate below this node
Transforms.insertNodes(editor, newNode, { at: toEndOfNode })

// Transform the duplicated node to a text node
const nextPath = [...nodePath]
nextPath[nextPath.length - 1]++
Transforms.setNodes(editor, { type: TEXT_NODE, content: {} }, { at: nextPath })

// Move the selection to the start of the duplicated (now text) node
Transforms.select(editor, nextPath)
Transforms.collapse(editor, 'start')

return
// Move the cursor to the beginning of the duplicated (now text) node
Transforms.select(editor, selectionStart)
Transforms.move(editor, { distance: 1, unit: 'offset' })
}

// Set the heading after the selection to text
Transforms.setNodes(
editor,
{
type: TEXT_NODE,
content: {}
},
{
at: toEndOfNode,
split: true
}
)
Transforms.delete(editor, { at: Range.intersection(nodeRange, editor.selection) })
return Transforms.collapse(editor, { edge: 'end' })
}
}

Expand Down