Skip to content

Fixing logic and adding unit tests #439

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

Merged
leandroBorgesFerreira merged 1 commit into from
Apr 30, 2025
Merged

Fixing logic and adding unit tests #439

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
13 changes: 11 additions & 2 deletions ..._import_document/src/commonMain/kotlin/io/writeopia/sdk/import/markdown/MarkdownParser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ object MarkdownParser {

fun parse(lines: List<String>): List<StoryStepApi> {
var acc = -1
// Take care when moving the code, order matters for comparations!
return lines.map { it.trim() }
.filter { it.isNotEmpty() }
.mapIndexed { i, trimmed ->
acc++
when {
Expand Down Expand Up @@ -85,8 +85,17 @@ object MarkdownParser {
)
}

trimmed.startsWith("[] ") || trimmed.startsWith("-[] ") -> {
val type = StoryTypes.CHECK_ITEM.type
StoryStepApi(
type = StoryTypeApi(type.name, type.number),
text = trimmed.drop(3).trimStart(),
position = acc
)
}

trimmed.startsWith("- ") || trimmed.startsWith("* ") -> {
val type = StoryTypes.TEXT.type
val type = StoryTypes.UNORDERED_LIST_ITEM.type
StoryStepApi(
type = StoryTypeApi(type.name, type.number),
text = trimmed.drop(2).trimStart(),
Expand Down
56 changes: 56 additions & 0 deletions ...pia_import_document/src/commonTest/kotlin/io/writeopia/sdk/imports/test/MarkdownParser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,60 @@ class MarkdownParserTest {

assertEquals(results.first().type.number, StoryTypes.TITLE.type.number)
}

@Test
fun `empty lines should not be removed`() {
val sample = listOf(
"# Sample Markdown Document",
"",
"Welcome to this **Markdown** example!",
)

val expected = listOf(
StoryTypes.TITLE.type.number to "Sample Markdown Document",
StoryTypes.TEXT.type.number to "",
StoryTypes.TEXT.type.number to "Welcome to this **Markdown** example!",
)

val results = MarkdownParser.parse(sample)
assertEquals(results.size, 3)
val parsedResults = results.map { storyStepApi ->
storyStepApi.type.number to storyStepApi.text
}

// It is necessary to compare like this because the ids won't match.
assertEquals(expected, parsedResults)
}

@Test
fun `all types should be parsed`() {
val sample = listOf(
"# Sample Markdown Document",
"",
"[] Checkitem",
"-[] Checkitem2",
"- Item list",
"#",
"---",
)

val expected = listOf(
StoryTypes.TITLE.type.number to "Sample Markdown Document",
StoryTypes.TEXT.type.number to "",
StoryTypes.CHECK_ITEM.type.number to "Checkitem",
StoryTypes.CHECK_ITEM.type.number to "Checkitem2",
StoryTypes.UNORDERED_LIST_ITEM.type.number to "Item list",
StoryTypes.TEXT.type.number to "",
StoryTypes.DIVIDER.type.number to null,
)

val results = MarkdownParser.parse(sample)
assertEquals(results.size, 7)
val parsedResults = results.map { storyStepApi ->
storyStepApi.type.number to storyStepApi.text
}

// It is necessary to compare like this because the ids won't match.
assertEquals(expected, parsedResults)
}
}