1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
/*
* Copyright (c) 2023 R3BL LLC
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use constants::*;
use nom::{branch::alt,
bytes::complete::{is_not, tag},
character::complete::{anychar, digit1, space0},
combinator::{map, opt, recognize, verify},
multi::{many0, many1},
sequence::{preceded, terminated, tuple},
IResult};
use crate::*;
/// Public API for parsing a smart list block in markdown.
pub fn parse_block_smart_list(
input: &str,
) -> IResult<&str, (Lines<'_>, BulletKind, usize)> {
let (remainder, smart_list_ir) = parse_smart_list(input)?;
let indent = smart_list_ir.indent;
let bullet_kind = smart_list_ir.bullet_kind;
let mut output_lines: Lines<'_> =
List::with_capacity(smart_list_ir.content_lines.len());
for (index, line) in smart_list_ir.content_lines.iter().enumerate() {
// Parse the line as a markdown text. Take special care of checkboxes if they show up at the
// start of the line.
let (_, fragments_in_line) = {
let parse_checkbox_policy = {
let checked = format!("{}{}", CHECKED, SPACE);
let unchecked = format!("{}{}", UNCHECKED, SPACE);
if line.content.starts_with(&checked)
|| line.content.starts_with(&unchecked)
{
CheckboxParsePolicy::ParseCheckbox
} else {
CheckboxParsePolicy::IgnoreCheckbox
}
};
parse_block_markdown_text_opt_eol_with_checkbox_policy(
line.content,
parse_checkbox_policy,
)?
};
// Mark is first line or not (to show or hide bullet).
let is_first_line = index == 0;
// Insert bullet marker before the line.
let mut it = match bullet_kind {
BulletKind::Ordered(number) => {
list![MdLineFragment::OrderedListBullet {
indent,
number,
is_first_line
}]
}
BulletKind::Unordered => list![MdLineFragment::UnorderedListBullet {
indent,
is_first_line
}],
};
if fragments_in_line.is_empty() {
// If the line is empty, then we need to insert a blank line.
it.push(MdLineFragment::Plain(""));
} else {
// Otherwise, we can just append the fragments.
it += fragments_in_line;
}
output_lines.push(it);
}
Ok((remainder, (output_lines, bullet_kind, indent)))
}
/// Tests things that are final output (and not at the IR level).
#[cfg(test)]
mod tests_parse_block_smart_list {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
#[test]
fn test_with_unicode() {
let input = "- straight 😃 foo bar baz\n";
let result = parse_block_smart_list(input);
let remainder = result.as_ref().unwrap().0;
let output = &result.as_ref().unwrap().1;
assert_eq2!(remainder, "");
assert_eq2!(
output,
&(
list![list![
MdLineFragment::UnorderedListBullet {
indent: 0,
is_first_line: true
},
MdLineFragment::Plain("straight 😃 foo bar baz"),
],],
BulletKind::Unordered,
0
)
);
}
#[test]
fn test_parse_block_smart_list_with_checkbox() {
// Valid unchecked.
{
let input = ["- [ ] todo"].join("\n");
let result = parse_block_smart_list(&input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
let first_line = lines.first().unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
first_line,
&list![
MdLineFragment::UnorderedListBullet {
indent: 0,
is_first_line: true
},
MdLineFragment::Checkbox(false),
MdLineFragment::Plain(" todo"),
]
);
}
// Valid checked.
{
let input = ["- [x] done"].join("\n");
let result = parse_block_smart_list(&input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
let first_line = lines.first().unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
first_line,
&list![
MdLineFragment::UnorderedListBullet {
indent: 0,
is_first_line: true
},
MdLineFragment::Checkbox(true),
MdLineFragment::Plain(" done"),
]
);
}
// Invalid unchecked.
{
let input = ["- [ ]todo"].join("\n");
let result = parse_block_smart_list(&input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
let first_line = lines.first().unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
first_line,
&list![
MdLineFragment::UnorderedListBullet {
indent: 0,
is_first_line: true
},
MdLineFragment::Plain("[ ]"),
MdLineFragment::Plain("todo"),
]
);
}
// Invalid checked.
{
let input = ["- [x]done"].join("\n");
let result = parse_block_smart_list(&input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
let first_line = lines.first().unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
first_line,
&list![
MdLineFragment::UnorderedListBullet {
indent: 0,
is_first_line: true
},
MdLineFragment::Plain("[x]"),
MdLineFragment::Plain("done"),
]
);
}
}
#[test]
fn test_valid_ul_list_1() {
let input = "- foo\n bar baz\n";
let expected = list! {
list![
MdLineFragment::UnorderedListBullet { indent: 0, is_first_line: true },
MdLineFragment::Plain("foo"),
],
list![
MdLineFragment::UnorderedListBullet { indent: 0, is_first_line: false },
MdLineFragment::Plain("bar baz"),
],
};
let result = parse_block_smart_list(input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
assert_eq2!(remainder, "");
assert_eq2!(lines, expected);
}
#[test]
fn test_valid_ul_list_2() {
let input = "- foo\n bar baz\n- foo1\n bar1 baz1\n";
let expected = list! {
list![
MdLineFragment::UnorderedListBullet { indent: 0, is_first_line: true },
MdLineFragment::Plain("foo"),
],
list![
MdLineFragment::UnorderedListBullet { indent: 0, is_first_line: false },
MdLineFragment::Plain("bar baz"),
],
};
let result = parse_block_smart_list(input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
assert_eq2!(remainder, "- foo1\n bar1 baz1\n");
assert_eq2!(lines, expected);
}
#[test]
fn test_valid_ol_list_1() {
let input = "1. foo\n bar baz\n";
let expected = list! {
list![
MdLineFragment::OrderedListBullet { indent: 0 , number: 1, is_first_line: true },
MdLineFragment::Plain("foo"),
],
list![
MdLineFragment::OrderedListBullet { indent: 0 , number: 1, is_first_line: false },
MdLineFragment::Plain("bar baz"),
],
};
let result = parse_block_smart_list(input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
assert_eq2!(remainder, "");
assert_eq2!(lines, expected);
}
#[test]
fn test_valid_ol_list_2() {
let input = "1. foo\n bar baz\n1. foo\n bar baz\n";
let expected = list! {
list![
MdLineFragment::OrderedListBullet { indent: 0 , number: 1, is_first_line: true },
MdLineFragment::Plain("foo"),
],
list![
MdLineFragment::OrderedListBullet { indent: 0 , number: 1, is_first_line: false },
MdLineFragment::Plain("bar baz"),
],
};
let result = parse_block_smart_list(input);
let remainder = result.as_ref().unwrap().0;
let (lines, _bullet_kind, _indent) = result.unwrap().1;
assert_eq2!(remainder, "1. foo\n bar baz\n");
assert_eq2!(lines, expected);
}
}
/// Tests things that are final output (and not at the IR level).
#[cfg(test)]
mod tests_parse_smart_lists_in_markdown {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
#[test]
fn test_parse_valid_md_ol_with_indent() {
let input = [
"start",
"1. ol1",
" 2. ol2",
" ol2.1",
" 3. ol3",
" ol3.1",
" ol3.2",
"end",
"",
]
.join("\n");
let expected_output = [
"start",
"[ ┊1.│ol1┊ ]",
"[ ┊ 2.│ol2┊ → ┊ │ol2.1┊ ]",
"[ ┊ 3.│ol3┊ → ┊ │ol3.1┊ → ┊ │ol3.2┊ ]",
"end",
];
let result = parse_markdown(input.as_str());
let remainder = result.as_ref().unwrap().0;
let md_doc: MdDocument<'_> = result.unwrap().1;
// md_doc.console_log_fg();
// remainder.console_log_bg();
assert_eq2!(remainder, "");
md_doc.items.iter().zip(expected_output.iter()).for_each(
|(element, test_str)| {
let lhs = element.pretty_print_debug();
let rhs = test_str.to_string();
assert_eq2!(lhs, rhs);
},
);
}
#[test]
fn test_parse_valid_md_ul_with_indent() {
let input = [
"start",
"- ul1",
" - ul2",
" ul2.1",
" - ul3",
" ul3.1",
" ul3.2",
"end",
"",
]
.join("\n");
let expected_output = [
"start",
"[ ┊─┤ul1┊ ]",
"[ ┊───┤ul2┊ → ┊ │ul2.1┊ ]",
"[ ┊─────┤ul3┊ → ┊ │ul3.1┊ → ┊ │ul3.2┊ ]",
"end",
];
let result = parse_markdown(input.as_str());
let remainder = result.as_ref().unwrap().0;
let md_doc: MdDocument<'_> = result.unwrap().1;
// md_doc.console_log_fg();
// remainder.console_log_bg();
assert_eq2!(remainder, "");
md_doc.items.iter().zip(expected_output.iter()).for_each(
|(element, test_str)| {
let lhs = element.pretty_print_debug();
let rhs = test_str.to_string();
assert_eq2!(lhs, rhs);
},
);
}
#[test]
fn test_parse_valid_md_multiline_no_indent() {
let input = vec![
"start",
"- ul1",
"- ul2",
" ul2.1",
" ",
"- ul3",
" ul3.1",
" ul3.2",
"1. ol1",
"2. ol2",
" ol2.1",
"3. ol3",
" ol3.1",
" ol3.2",
"- [ ] todo",
"- [x] done",
"end",
"",
]
.join("\n");
let expected_output = [
"start",
"[ ┊─┤ul1┊ ]",
"[ ┊─┤ul2┊ → ┊ │ul2.1┊ ]",
" ",
"[ ┊─┤ul3┊ → ┊ │ul3.1┊ → ┊ │ul3.2┊ ]",
"[ ┊1.│ol1┊ ]",
"[ ┊2.│ol2┊ → ┊ │ol2.1┊ ]",
"[ ┊3.│ol3┊ → ┊ │ol3.1┊ → ┊ │ol3.2┊ ]",
"[ ┊─┤[ ] todo┊ ]",
"[ ┊─┤[x] done┊ ]",
"end",
];
let result = parse_markdown(input.as_str());
let remainder = result.as_ref().unwrap().0;
let md_doc: MdDocument<'_> = result.unwrap().1;
md_doc.console_log_fg();
remainder.console_log_bg();
assert_eq2!(remainder, "");
md_doc.items.iter().zip(expected_output.iter()).for_each(
|(element, test_str)| {
let lhs = element.pretty_print_debug();
let rhs = test_str.to_string();
assert_eq2!(lhs, rhs);
},
);
}
#[test]
fn test_parse_valid_md_no_indent() {
let input = [
"start",
"- ul1",
"- ul2",
"1. ol1",
"2. ol2",
"- [ ] todo",
"- [x] done",
"end",
"",
]
.join("\n");
let expected_output = [
"start",
"[ ┊─┤ul1┊ ]",
"[ ┊─┤ul2┊ ]",
"[ ┊1.│ol1┊ ]",
"[ ┊2.│ol2┊ ]",
"[ ┊─┤[ ] todo┊ ]",
"[ ┊─┤[x] done┊ ]",
"end",
];
let result = parse_markdown(input.as_str());
let remainder = result.as_ref().unwrap().0;
let md_doc: MdDocument<'_> = result.unwrap().1;
// md_doc.console_log_fg();
// remainder.console_log_bg();
assert_eq2!(remainder, "");
md_doc.items.iter().zip(expected_output.iter()).for_each(
|(element, test_str)| {
let lhs = element.pretty_print_debug();
let rhs = test_str.to_string();
assert_eq2!(lhs, rhs);
},
);
}
}
/// Holds a single list item for a given indent level. This may contain multiple lines which are
/// stored in the `content_lines` field. Take a look at [parse_smart_list] for more details.
#[derive(Clone, Debug, PartialEq)]
pub struct SmartListIR<'a> {
/// Spaces before the bullet (for all the lines in this list).
pub indent: usize,
/// Unordered or ordered.
pub bullet_kind: BulletKind,
/// Does not contain any bullets.
pub content_lines: Vec<SmartListLine<'a>>,
}
#[derive(Clone, Debug, PartialEq)]
pub struct SmartListLine<'a> {
/// Spaces before the bullet (for all the lines in this list).
pub indent: usize,
/// Unordered or ordered.
pub bullet_str: &'a str,
/// Does not contain any bullets or any spaces for the indent prefix.
pub content: &'a str,
}
impl<'a> SmartListLine<'a> {
pub fn new(indent: usize, bullet_str: &'a str, content: &'a str) -> Self {
Self {
indent,
bullet_str,
content,
}
}
}
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum BulletKind {
Ordered(usize),
Unordered,
}
/// First line of `input` looks like this.
///
/// ```text
/// ╭─ Unordered ──────────────────┬───── Ordered ───────────────────╮
/// │" - foobar" │" 100. foobar" │
/// │ ░░░░▓▓░░░░░░ │ ░░░░▓▓▓▓▓░░░░░░ │
/// │ ┬──┬┬┬┬────┬ │ ┬──┬┬───┬┬────┬ │
/// │ ╰──╯╰╯╰────╯ │ ╰──╯╰───╯╰────╯ │
/// │ │ │ └─→ first line content│ │ │ └─→ first line content│
/// │ │ └→ bullet.len(): 2 │ │ └→ bullet.len(): 4 │
/// │ └→ indent: 4 │ └→ indent: 4 │
/// ╰──────────────────────────────┴─────────────────────────────────╯
/// ```
///
/// Rest of the lines of `input` look like this.
///
/// ```text
/// ╭─ Unordered ──────────────────┬───── Ordered ───────────────────╮
/// │" foobar" │" foobar" │
/// │ ░░░░▓▓░░░░░░ │ ░░░░▓▓▓▓▓░░░░░░ │
/// │ ┬──┬┬┬┬────┬ │ ┬──┬┬───┬┬────┬ │
/// │ ╰──╯╰╯╰────╯ │ ╰──╯╰───╯╰────╯ │
/// │ │ │ └─→ first line content│ │ │ └─→ first line content│
/// │ │ └→ bullet.len(): 2 │ │ └→ bullet.len(): 4 │
/// │ └→ indent: 4 │ └→ indent: 4 │
/// ╰──────────────────────────────┴─────────────────────────────────╯
/// ```
#[rustfmt::skip]
pub fn parse_smart_list(
input: &str
) -> IResult</* remainder */ &str, SmartListIR<'_>> {
// Match empty spaces & count them into indent.
let (input, indent) = map(
space0,
|it: &str| it.len()
)(input)?;
// Indent has to be multiple of the base width, otherwise it's not a list item.
if indent % LIST_PREFIX_BASE_WIDTH != 0 {
return Err(nom::Err::Error(nom::error::Error::new(
"Indent must be a multiple of LIST_PREFIX_INDENT_SIZE",
nom::error::ErrorKind::Fail,
)));
}
// Match the bullet: Ordered => "123. " or Unordered => "- ".
let (input, bullet) =
recognize(
alt((
tag(UNORDERED_LIST_PREFIX),
terminated(digit1, tag(ORDERED_LIST_PARTIAL_PREFIX)),
))
)(input)?;
// Decide which kind of list item this is based on `bullet`.
let bullet_kind = if bullet.starts_with(|c: char| c.is_ascii_digit()) {
let number_str = bullet.trim_end_matches(ORDERED_LIST_PARTIAL_PREFIX);
let number_usize = number_str.parse::<usize>().or(
Err(nom::Err::Error(nom::error::Error::new(
"Ordered list number must be usize",
nom::error::ErrorKind::Fail,
)))
)?;
BulletKind::Ordered(number_usize)
} else {
BulletKind::Unordered
};
// Match the rest of the line & other lines that have the same indent.
let (input, content_lines) = parse_smart_list_content_lines(input, indent, bullet)?;
// Return the result.
Ok((
input,
SmartListIR { indent, bullet_kind, content_lines },
))
}
mod verify_rest {
use super::*;
/// Return true if:
/// - No ul items (at any indent).
/// - No other ol items with same indent + number.
/// - No other ol items with any indent or number.
pub fn list_contents_does_not_start_with_list_prefix(it: &str) -> bool {
let result: IResult<&str, &str> = recognize(alt((
tag(UNORDERED_LIST_PREFIX),
terminated(digit1, tag(ORDERED_LIST_PARTIAL_PREFIX)),
)))(it.trim_start());
let starts_with_list_prefix = result.is_ok();
!starts_with_list_prefix
}
fn count_whitespace_at_start(it: &str) -> usize {
let mut count: usize = 0;
for c in it.chars() {
if c == SPACE_CHAR {
count += 1;
} else {
break;
}
}
count
}
/// - Eg: " - ul2", indent: 0, my_bullet_str_len: 2 => true
/// - Eg: " ul2.1", indent: 2, my_bullet_str_len: 4 => true
/// - Eg: " u13.1", indent: 4, my_bullet_str_len: 6 => true
pub fn must_start_with_correct_num_of_spaces(it: &str, my_bullet_str: &str) -> bool {
let it_spaces_at_start = count_whitespace_at_start(it);
it_spaces_at_start == my_bullet_str.len()
}
}
#[rustfmt::skip]
pub fn parse_smart_list_content_lines<'a>(
input: &'a str,
indent: usize,
bullet: &'a str,
) -> IResult</* remainder */ &'a str, /* lines */ Vec<SmartListLine<'a>>> {
let indent_padding = SPACE.repeat(indent);
let indent_padding = indent_padding.as_str();
match input.find(NEW_LINE) {
// Keep the first line. There may be more than 1 line.
Some(first_line_end) => {
let first = &input[..first_line_end];
let input = &input[first_line_end+1..];
// Match the rest of the lines.
let (remainder, rest) = many0(
tuple((
verify(
// FIRST STEP: Match the ul or ol list item line.
preceded(
// Match the indent.
tag(indent_padding),
// Match the rest of the line.
/* output */ alt((
is_not(NEW_LINE),
recognize(many1(anychar)),
)),
),
// SECOND STEP: Verify it to make sure no ul or ol list prefix.
|it: &str| {
// `it` must not *just* have spaces.
if it.trim_start().is_empty() {
return false;
}
// `it` must start w/ *exactly* the correct number of spaces.
if !verify_rest::must_start_with_correct_num_of_spaces(it, bullet) {
return false;
}
// `it` must not start w/ the ul list prefix.
// `it` must not start w/ the ol list prefix.
verify_rest::list_contents_does_not_start_with_list_prefix(it)
}
),
opt(tag(NEW_LINE)),
))
)(input)?;
// Convert `rest` into a Vec<&str> that contains the output lines.
let output_lines: Vec<SmartListLine<'_>> = {
let mut it = Vec::with_capacity(rest.len() + 1);
it.push(SmartListLine {
indent,
bullet_str: bullet,
content: first
});
it.extend(rest.iter().map(
// Skip "bullet's width" number of spaces at the start of the line.
|(rest_line_content, _)|
SmartListLine {
indent,
bullet_str: bullet,
content: &rest_line_content[bullet.len()..]
})
);
it
};
Ok((remainder, output_lines))
}
None => {
// Keep the first line. There are no more lines.
Ok(("", vec![SmartListLine {
indent,
bullet_str: bullet,
content: input
}]))
}
}
}
#[cfg(test)]
mod tests_parse_list_item {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
#[test]
fn test_invalid_ul_list() {
let input = " -";
let actual = parse_smart_list(input);
assert_eq2!(actual.is_err(), true);
}
#[test]
fn test_valid_ul_list() {
// 1 item.
{
let input = "- foo";
let actual = parse_smart_list(input);
assert_eq2!(
actual,
Ok((
"",
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![SmartListLine::new(0, "- ", "foo")],
}
))
);
}
// 2 items.
{
let input = "- foo\n bar";
let actual = parse_smart_list(input);
assert_eq2!(
actual,
Ok((
"",
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![
SmartListLine::new(0, "- ", "foo"),
SmartListLine::new(0, "- ", "bar"),
],
}
))
);
}
}
#[test]
fn test_invalid_ol_list() {
let input = " 1.";
let actual = parse_smart_list(input);
assert_eq2!(actual.is_err(), true);
}
#[test]
fn test_valid_ol_list() {
// 1 item.
{
let input = "1. foo";
let actual = parse_smart_list(input);
assert_eq2!(
actual,
Ok((
"",
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Ordered(1),
content_lines: vec![SmartListLine::new(0, "1. ", "foo")],
}
))
);
}
// 2 items.
{
let input = "1. foo\n bar";
let result = parse_smart_list(input);
assert_eq2!(
result,
Ok((
"",
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Ordered(1),
content_lines: vec![
SmartListLine::new(0, "1. ", "foo"),
SmartListLine::new(0, "1. ", "bar"),
],
}
))
);
}
}
}
#[cfg(test)]
mod tests_list_item_lines {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
/// One line: "- foo".
#[test]
fn test_one_line() {
let input = "- foo";
let (remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![SmartListLine::new(0, "- ", "foo")],
}
);
}
/// One line (with trailing newline): "- foo\n".
#[test]
fn test_one_line_trailing_newline() {
let input = "- foo\n";
let (remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![SmartListLine::new(0, "- ", "foo")]
}
);
}
/// 2 lines (last line is empty): "- foo\n\n".
#[test]
fn test_two_lines_last_is_empty() {
let input = "- foo\n\n";
let actual = parse_smart_list(input);
let (remainder, actual) = actual.unwrap();
assert_eq2!(remainder, "\n");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![SmartListLine::new(0, "- ", "foo")]
}
);
}
/// 2 lines: "- foo\n bar baz".
#[test]
fn test_two_lines() {
let input = "- foo\n bar baz";
let (remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![
SmartListLine::new(0, "- ", "foo"),
SmartListLine::new(0, "- ", "bar baz"),
]
}
);
}
/// 3 lines (last line is empty): "- foo\n bar baz\n".
#[test]
fn test_three_lines_last_is_empty() {
let input = "- foo\n bar baz\n";
let (remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![
SmartListLine::new(0, "- ", "foo"),
SmartListLine::new(0, "- ", "bar baz"),
]
}
);
}
/// 3 lines: "- foo\n bar baz\n qux".
#[test]
fn test_three_lines() {
let input = "- foo\n bar baz\n qux";
let (remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(remainder, "");
assert_eq2!(
actual,
SmartListIR {
indent: 0,
bullet_kind: BulletKind::Unordered,
content_lines: vec![
SmartListLine::new(0, "- ", "foo"),
SmartListLine::new(0, "- ", "bar baz"),
SmartListLine::new(0, "- ", "qux"),
]
}
);
}
}
#[cfg(test)]
mod tests_bullet_kinds {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
#[test]
fn test_bullet_kinds() {
// Unordered.
{
let input = "- foo";
let (_remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(actual.bullet_kind, BulletKind::Unordered);
}
// Ordered.
{
let input = "1. foo";
let (_remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(actual.bullet_kind, BulletKind::Ordered(1));
}
}
}
#[cfg(test)]
mod tests_parse_indents {
use r3bl_rs_utils_core::assert_eq2;
use super::*;
#[test]
fn test_indent() {
// Indent = 0 Ok.
{
let input = "- foo";
let (_remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(actual.indent, 0);
assert_eq2!(actual.bullet_kind, BulletKind::Unordered);
}
// Indent = 1 Fail.
{
let input = " - foo";
let result = parse_smart_list(input);
assert_eq2!(
result.err(),
Some(nom::Err::Error(nom::error::Error::new(
"Indent must be a multiple of LIST_PREFIX_INDENT_SIZE",
nom::error::ErrorKind::Fail,
)))
);
}
// Indent = 2 Ok.
{
let input = " - foo";
let (_remainder, actual) = parse_smart_list(input).unwrap();
assert_eq2!(actual.indent, 2);
assert_eq2!(actual.bullet_kind, BulletKind::Unordered);
}
}
}