Skip to content

Commit

Permalink
fix plain serializer handling empty blocks, fixes #1090 (#1091)
Browse files Browse the repository at this point in the history 
* fix plain serializer handling empty blocks, fixes #1090

* clean up block list test
  • Loading branch information
@ianstormtaylor
ianstormtaylor authored Sep 8, 2017
1 parent 3e2e533 commit 1b406c3
Show file tree
Hide file tree
Showing 23 changed files with 326 additions and 20 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.txt]
insert_final_newline = false
trim_trailing_whitespace = false
11 changes: 3 additions & 8 deletions src/serializers/plain.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

import Block from '../models/block'
import Raw from '../serializers/raw'

/**
Expand Down Expand Up @@ -58,9 +59,6 @@ function serialize(state) {

/**
* Serialize a `node` to plain text.
* For blocks, or document, it recursively calls itself
* to aggregate the text.
* For other types of nodes, it uses the .text property
*
* @param {Node} node
* @return {String}
Expand All @@ -69,12 +67,9 @@ function serialize(state) {
function serializeNode(node) {
if (
(node.kind == 'document') ||
(node.kind == 'block' && node.nodes.size > 0 && node.nodes.first().kind == 'block')
(node.kind == 'block' && Block.isBlockList(node.nodes))
) {
return node.nodes
.map(n => serializeNode(n))
.filter(text => text != '')
.join('\n')
return node.nodes.map(serializeNode).join('\n')
} else {
return node.text
}
Expand Down
43 changes: 43 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-multiple-empty/input.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

import { Block, Character, Document, State, Text } from '../../../../../..'

export default State.create({
document: Document.create({
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'o' },
{ text: 'n' },
{ text: 'e' },
])
}
])
},
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList()
}
])
},
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'h' },
{ text: 'r' },
{ text: 'e' },
{ text: 'e' },
])
}
])
},
])
})
})
3 changes: 3 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-multiple-empty/output.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
one

three
47 changes: 47 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-multiple/input.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

import { Block, Character, Document, State, Text } from '../../../../../..'

export default State.create({
document: Document.create({
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'o' },
{ text: 'n' },
{ text: 'e' },
])
}
])
},
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'w' },
{ text: 'o' },
])
}
])
},
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'h' },
{ text: 'r' },
{ text: 'e' },
{ text: 'e' },
])
}
])
},
])
})
})
1 change: 1 addition & 0 deletions ...s/plain/serialize/block-nested/output.txt → ...plain/serialize/block-multiple/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
one
two
three
33 changes: 32 additions & 1 deletion ...res/plain/serialize/block-nested/input.js → ...lize/block-nested-multiple-empty/input.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

import { Block, Character, Document, Inline, Mark, State, Text } from '../../../../../..'
import { Block, Character, Document, State, Text } from '../../../../../..'

export default State.create({
document: Document.create({
Expand Down Expand Up @@ -37,6 +37,37 @@ export default State.create({
])
}
])
},
{
type: 'quote',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList()
}
])
},
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'f' },
{ text: 'o' },
{ text: 'u' },
{ text: 'r' },
])
}
])
}
])
}
])
}
])
})
Expand Down
4 changes: 4 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-nested-multiple-empty/output.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
one
two

four
80 changes: 80 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-nested-multiple/input.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@

import { Block, Character, Document, State, Text } from '../../../../../..'

export default State.create({
document: Document.create({
nodes: Block.createList([
{
type: 'quote',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'o' },
{ text: 'n' },
{ text: 'e' }
])
}
])
},
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'w' },
{ text: 'o' }
])
}
])
}
])
}
])
},
{
type: 'quote',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'h' },
{ text: 'r' },
{ text: 'e' },
{ text: 'e' },
])
}
])
},
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'f' },
{ text: 'o' },
{ text: 'u' },
{ text: 'r' },
])
}
])
}
])
}
])
}
])
})
})
4 changes: 4 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-nested-multiple/output.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
one
two
three
four
90 changes: 90 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-nested-nested-multiple/input.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@

import { Block, Character, Document, State, Text } from '../../../../../..'

export default State.create({
document: Document.create({
nodes: Block.createList([
{
type: 'quote',
nodes: Block.createList([
{
type: 'quote',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'o' },
{ text: 'n' },
{ text: 'e' },
])
}
])
},
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'w' },
{ text: 'o' },
])
}
])
}
])
},
])
},
{
type: 'quote',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 't' },
{ text: 'h' },
{ text: 'r' },
{ text: 'e' },
{ text: 'e' },
])
}
])
}
])
},
{
type: 'paragraph',
nodes: Block.createList([
{
type: 'paragraph',
nodes: Text.createList([
{
characters: Character.createList([
{ text: 'f' },
{ text: 'o' },
{ text: 'u' },
{ text: 'r' },
])
}
])
}
])
},
])
},
])
}
])
})
})
4 changes: 4 additions & 0 deletions test/serializers/fixtures/plain/serialize/block-nested-nested-multiple/output.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
one
two
three
four
2 changes: 1 addition & 1 deletion test/serializers/fixtures/plain/serialize/block-nested-with-inline-nested/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
one
two
two
2 changes: 1 addition & 1 deletion test/serializers/fixtures/plain/serialize/block-nested-with-inlines/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
onetwo
onetwo
2 changes: 1 addition & 1 deletion test/serializers/fixtures/plain/serialize/block-with-data/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
one
one
2 changes: 1 addition & 1 deletion test/serializers/fixtures/plain/serialize/block-with-is-void/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@


2 changes: 1 addition & 1 deletion test/serializers/fixtures/plain/serialize/block/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
one
one
Loading

0 comments on commit 1b406c3

Please sign in to comment.