ruSTLa 0.38.0

/*!
A submodule for testing hyperlink targets.

Copyright © 2020 Santtu Söderholm
*/

use super::*;

#[cfg(test)]
#[test]
fn footnote_01() {
    let src =
"
.. [1] Here is a paragraph
    with body indent.

    * Bullet list inside foonote

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { .. } => (),
        _ => panic!(),
    }

    match doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Paragraph { .. } => (),
        _ => panic!(),
    }

    match doctree
        .shared_child(0).unwrap()
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::BulletList { .. } => (),
        _ => panic!(),
    }
}

#[test]
fn footnote_02() {
    let src =
"
.. [1] Here is a paragraph

.. [1] Another footnote with the same label (and target).
        The duplicate label should generate a warning.

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();
    doctree.print_tree();

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { .. } => (),
        _ => panic!(),
    }

    match doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Paragraph { .. } => (),
        _ => panic!(),
    }

    match doctree
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::Footnote { .. } => (),
        _ => panic!(),
    }

    match doctree
        .shared_child(1).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Paragraph { .. } => (),
        _ => panic!(),
    }
}

#[test]
fn footnote_03() {
    let src =
"
.. [*] 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

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "*" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(2).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "‡" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(10).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "**" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(12).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "‡‡" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(20).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "***" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(28).unwrap().shared_data() {
        TreeNodeType::Footnote { label, .. } => {
            if label == "♦♦♦" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }
}

#[test]
fn footnote_04() {
    let src =
"
.. [2] 1
.. [#test-with-mixed] 2
.. [#] 3
.. [#second] 4
.. [#] 5

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            if label == "2" && target == "2" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "1");
            assert_eq!(label, "1");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(2).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "3");
            assert_eq!(target, "3");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(3).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "4");
            assert_eq!(target, "4");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(4).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "5");
            assert_eq!(target, "5");
        }
        _ => panic!(),
    }
}

#[test]
fn footnote_05() {
    let src =
"
.. [2] 1
.. [#test-with-mixed] 2
.. [*] .. [#nested] 4
.. [*] 5
.. [2] 5

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match &doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            if label == "2" && target == "2" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "1");
            assert_eq!(target, "1");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(2).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            if label == "*" && target == "*" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(2).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            assert_eq!(label, "3");
            assert_eq!(target, "3");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(3).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            if label == "†" && target == "†" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(4).unwrap().shared_data() {
        TreeNodeType::Footnote { label, target, .. } => {
            if label == "2" && target == "2" {
            } else {
                panic!()
            }
        }
        _ => panic!(),
    }
}

#[test]
fn citation_01() {
    let src =
"
.. [CIT2005] Citation

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match &doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Citation { label, .. } => {
            if !(label == "CIT2005") {
                panic!()
            }
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Paragraph { .. } => {}
        _ => panic!(),
    }
}

#[test]
fn citation_02() {
    let src =
"
.. [one] aaa
    .. [two] This line is a part of
    the paragraph started on previous line
       .. [three] This is a citation inside a block quote

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    match &doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Citation { label, .. } => {
            assert_eq!(label, "one");
        }
        _ => panic!(),
    }

    match &doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Paragraph { .. } => {}
        _ => panic!(),
    }

    match &doctree
        .shared_child(0).unwrap()
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::BlockQuote { body_indent } => {
            assert_eq!(*body_indent, 7);
        }
        _ => panic!(),
    }
}

#[test]
fn hyperlink_target_01() {
    let src =
"
.. _target1:
.. _target2:

Paragraph here. Please give me the labels \"target1\" and \"target2\".

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    if let Some(labels) = doctree
        .shared_child(0).unwrap().shared_target_label() {
        assert_eq!(labels.join("-").as_str(), "target1-target2")
    } else {
        panic!()
    }
}

#[test]
fn hyperlink_target_02() {
    let src =
"
* This here is a bulleted list

  .. _internal-target-referencing-below-item:

  .. _another-target-referencing-below-item:

* The above internal targets that belong to the
  previous list item should reference this item.

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();
    doctree.print_tree();

    if let Some(labels) = doctree
        .shared_child(0).unwrap()
        .shared_child(1).unwrap()
        .shared_target_label()
    {
        assert_eq!(
            labels.join("|").as_str(),
"internal-target-referencing-below-item|another-target-referencing-below-item"
        )
    } else {
        panic!()
    }
}

#[test]
fn hyperlink_target_03() {
    let src =
"
.. _an-external-hyperlink: https://www.address.fi//

.. _indirect_hyperlink: an-external-hyperlink_


"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();

    doctree.print_tree();

    eprintln!("Doctree targets: {:#?}\n", doctree.shared_targets());
    eprintln!("Doctree references: {:#?}\n", doctree.shared_references());

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::ExternalHyperlinkTarget { uri, target, .. } => {
            if target != "an-external-hyperlink" || uri != "https://www.address.fi//" {
                eprintln!("Target: {:#?}\nURI: {:#?}\n", target, uri);
                panic!()
            }
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::IndirectHyperlinkTarget {
            target,
            indirect_target,
            ..
        } => {
            if target != "indirect_hyperlink" || indirect_target != "an-external-hyperlink" {
                eprintln!(
"Target: {:#?}\nIndirect target: {:#?}\n",
                    target, indirect_target
                );
                panic!()
            }
        }
        _ => panic!(),
    }
}

#[test]
fn hyperlink_target_04() {
    let src =
"
.. __: https://www.address.fi//

.. __: anon-target-ref__

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();
    doctree.print_tree();

    eprintln!("Doctree targets: {:#?}", doctree.shared_targets());
    eprintln!("Doctree references: {:#?}", doctree.shared_references());

    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::ExternalHyperlinkTarget { target, uri, .. } => {
            assert_eq!(target, "[[-ANON-LABEL-1-]]");
            assert_eq!(uri, "https://www.address.fi//");
        }
        _ => panic!(),
    }

    match doctree
        .shared_child(1).unwrap().shared_data() {
        TreeNodeType::IndirectHyperlinkTarget {
            target,
            indirect_target,
            ..
        } => {
            assert_eq!(target, "[[-ANON-LABEL-2-]]");
            assert_eq!(indirect_target, "[[-ANON-LABEL-1-]]");
        }
        _ => panic!(),
    }
}

#[test]
fn hyperlink_target_05() {
    let src =
"
.. _target label:

A Section title
===============

.. _Target  for footnote:
.. _AnD AnotherOne:

.. [1] Here is a paragraph
  with body indent.

  * Bullet list inside foonote

"
    .lines()
    .map(|s| s.to_string())
    .collect::<Vec<String>>();

    let mut doctree = DocTree::new(PathBuf::from("test"));

    let mut parser = Parser::new(src, doctree, 0, 0, State::Body, 0);

    doctree = parser.parse().unwrap_tree();
    doctree = doctree.walk_to_root();
    doctree.print_tree();

    // Structural tests
    match doctree
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Section { .. } => {}
        _ => panic!(),
    }

    match doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap().shared_data() {
        TreeNodeType::Footnote { .. } => {}
        _ => panic!(),
    }

    // Target tests
    match doctree
        .shared_child(0).unwrap().shared_target_labels() {
        None => panic!(),
        Some(labels) => {
            if labels[0].as_str() != "target label" || labels[1].as_str() != "a section title" {
                panic!()
            }
        }
    }

    match doctree
        .shared_child(0).unwrap()
        .shared_child(0).unwrap()
        .shared_target_labels()
    {
        None => panic!(),
        Some(labels) => {
            if labels[0].as_str() != "target for footnote" || labels[1].as_str() != "and anotherone"
            {
                panic!()
            }
        }
    }
}