docql 0.3.2

Generate static HTML documentation for GraphQL APIs.
Documentation 
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

use super::schema;
use handlebars::{
    Context, Handlebars, Helper, HelperDef, HelperResult, Output, RenderContext, RenderError,
};

pub struct TypeRefRenderer<'a> {
    _schema: &'a schema::Schema,
}

impl<'a> TypeRefRenderer<'a> {
    pub fn new(schema: &'a schema::Schema) -> Self {
        Self { _schema: schema }
    }

    pub fn render_type_ref(
        &self,
        type_ref: &schema::TypeRef,
        out: &mut dyn Output,
    ) -> Result<(), std::io::Error> {
        match &type_ref.kind {
            schema::Kind::List => {
                out.write("[")?;
                if let Some(ref of_type) = type_ref.of_type {
                    self.render_type_ref(of_type, out)?;
                } else {
                    out.write("?")?;
                }
                out.write("]")?;
            }
            schema::Kind::NonNull => {
                if let Some(ref of_type) = type_ref.of_type {
                    self.render_type_ref(of_type, out)?;
                } else {
                    out.write("?")?;
                }
                out.write("!")?;
            }
            k => {
                let o = format!(
                    r#"<a class="{}" href="{}.{}.html">{}</a>"#,
                    k.prefix(),
                    k.prefix(),
                    type_ref.name.as_deref().unwrap(),
                    type_ref.name.as_deref().unwrap()
                );
                out.write(&o)?;
            }
        }

        Ok(())
    }
}

impl HelperDef for TypeRefRenderer<'_> {
    fn call<'reg: 'rc, 'rc>(
        &self,
        h: &Helper,
        _: &Handlebars,
        _: &Context,
        _: &mut RenderContext,
        out: &mut dyn Output,
    ) -> HelperResult {
        let param = h.param(0).unwrap();

        let type_ref: schema::TypeRef = serde_json::from_value(param.value().clone())?;

        self.render_type_ref(&type_ref, out)?;

        Ok(())
    }
}

#[derive(Default)]
pub struct Docblock;

impl HelperDef for Docblock {
    fn call<'reg: 'rc, 'rc>(
        &self,
        h: &Helper,
        _: &Handlebars,
        _: &Context,
        _: &mut RenderContext,
        out: &mut dyn Output,
    ) -> HelperResult {
        use pulldown_cmark::{html, Options, Parser};

        let param = h.param(0).unwrap();

        let doc = param
            .value()
            .as_str()
            .ok_or_else(|| RenderError::new("Parameter to docblock was not a string"))?;

        let mut options = Options::empty();
        options.insert(Options::ENABLE_STRIKETHROUGH);
        options.insert(Options::ENABLE_TABLES);
        let parser = Parser::new_ext(doc, options);
        let mut html_output = String::new();
        html::push_html(&mut html_output, parser);

        out.write(&html_output)?;
        Ok(())
    }
}

#[derive(Default)]
pub struct Kind;

impl HelperDef for Kind {
    fn call<'reg: 'rc, 'rc>(
        &self,
        h: &Helper,
        _: &Handlebars,
        _: &Context,
        _: &mut RenderContext,
        out: &mut dyn Output,
    ) -> HelperResult {
        let param = h.param(0).unwrap();

        let kind: schema::Kind = serde_json::from_value(param.value().clone())?;

        out.write(&kind.prefix())?;
        Ok(())
    }
}