oas3-gen 0.26.2

A rust type generator for OpenAPI v3.1.x specification.
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

use quote::quote;

use crate::generator::ast::Documentation;

#[test]
fn empty_documentation_produces_no_tokens() {
  let doc = Documentation::default();
  let tokens = quote! { #doc };
  assert!(tokens.is_empty());
}

#[test]
fn single_line_documentation() {
  let doc = Documentation::from_lines(["Corgi sploot documentation"]);
  let tokens = quote! { #doc };
  let expected = quote! { #[doc = " Corgi sploot documentation"] };
  assert_eq!(tokens.to_string(), expected.to_string());
}

#[test]
fn multi_line_documentation() {
  let doc = Documentation::from_lines(["Floof 1", "Floof 2"]);
  let tokens = quote! { #doc };
  let expected = quote! {
    #[doc = " Floof 1"]
    #[doc = " Floof 2"]
  };
  assert_eq!(tokens.to_string(), expected.to_string());
}

#[test]
fn from_optional_none_produces_empty() {
  let doc = Documentation::from_optional(None);
  let tokens = quote! { #doc };
  assert!(tokens.is_empty());
}

#[test]
fn from_optional_some_processes_text() {
  let text = "Bark".to_string();
  let doc = Documentation::from_optional(Some(&text));
  let expected = quote! { #[doc = " Bark"] };
  assert_eq!(quote! { #doc }.to_string(), expected.to_string());
}

#[test]
fn from_optional_handles_escaped_newlines() {
  let text = "Floof 1\\nFloof 2".to_string();
  let doc = Documentation::from_optional(Some(&text));
  let expected = quote! {
    #[doc = " Floof 1"]
    #[doc = " Floof 2"]
  };
  assert_eq!(quote! { #doc }.to_string(), expected.to_string());
}

#[test]
fn push_adds_line() {
  let mut doc = Documentation::from_lines(["Loaf"]);
  doc.push("Sploot");
  let expected = quote! {
    #[doc = " Loaf"]
    #[doc = " Sploot"]
  };
  assert_eq!(quote! { #doc }.to_string(), expected.to_string());
}

#[tokio::test]
async fn test_doc_lines_with_mdformat() {
  let mdformat_available = tokio::process::Command::new("mdformat")
    .arg("--version")
    .output()
    .await
    .is_ok_and(|o| o.status.success());

  if !mdformat_available {
    eprintln!("skipping test: mdformat not installed");
    return;
  }

  let input = r"## Blockquotes

> Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by John Gruber with Aaron Swartz.
>
>> Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.
";
  let expected = vec![
    "## Blockquotes",
    "",
    "> Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by",
    "> John Gruber with Aaron Swartz.",
    ">",
    "> > Markdown is often used to format readme files, for writing messages in online discussion forums,",
    "> > and to create rich text using a plain text editor.",
  ];
  let result = Documentation::build_async_format_with_mdformat(input).await;
  let lines: Vec<&str> = result.lines().collect();
  assert_eq!(lines, expected);
}