html_export 0.1.1

Basic struct & enums to html file conversion crate
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
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

use crate::{
    element::{Element, HtmlElement, HtmlElementConfig},
    tags::TagType,
};

/// Defines the form's configs.
///
/// - `method` : The form's optional method. If the value is None, this attribute is ignored.
/// - `action` : The form's action url. If the value is None, this attribute is ignored.
pub struct FormConfig {
    pub method: Option<String>,
    pub action: Option<String>,
}

pub trait AsForm {
    fn as_form_field(&self) -> Option<Element>;
}

/// Wraps the given fields in a `<fieldset>`.
///
/// - `fields` : The fields to wrap.
/// - `legend` : The fieldset's legend content.
/// - `fieldset_config` : The fieldset's html configs.
/// - `legend_config` : The fieldset's legend html configs.
pub fn wrap_fields_in_fieldset(
    fields: Vec<Element>,
    legend: String,
    fieldset_config: HtmlElementConfig,
    legend_config: HtmlElementConfig,
) -> Element {
    let mut fieldset = Element::Element(HtmlElement::new(TagType::FieldSet, fieldset_config));
    let legend =
        Element::Element(HtmlElement::new(TagType::Legend, legend_config)) + Element::Text(legend);
    fieldset += legend;
    for field in fields {
        fieldset += field;
    }
    fieldset
}

/// Wraps an entity in a `<fieldset>`.
///
/// - `entity` : The entity to wrap. The entity must implement the `AsForm` trait.
/// - `legend` : The fieldset's legend content.
/// - `fieldset_config` : The fieldset's html configs.
/// - `legend_config` : The fieldset's legend html configs.
pub fn wrap_entity_in_fieldsets<T>(
    entity: &T,
    legend: String,
    fieldset_config: HtmlElementConfig,
    legend_config: HtmlElementConfig,
) -> Option<Element>
where
    T: AsForm,
{
    if let Some(field) = entity.as_form_field() {
        let mut fieldset = Element::Element(HtmlElement::new(TagType::FieldSet, fieldset_config));
        let legend = Element::Element(HtmlElement::new(TagType::Legend, legend_config))
            + Element::Text(legend);
        fieldset += legend;
        fieldset += field;
        Some(fieldset)
    } else {
        None
    }
}

/// Wraps entities in a `<fieldset>`.
///
/// - `entities` : The entities to wrap. The entities must implement the `AsForm` trait.
/// - `legend` : The fieldset's legend content.
/// - `fieldset_config` : The fieldset's html configs.
/// - `legend_config` : The fieldset's legend html configs.
pub fn wrap_entities_in_fieldset<T>(
    entities: &Vec<T>,
    legend: String,
    fieldset_config: HtmlElementConfig,
    legend_config: HtmlElementConfig,
) -> Option<Element>
where
    T: AsForm,
{
    let mut has_element = false;
    let mut fieldset = Element::Element(HtmlElement::new(TagType::FieldSet, fieldset_config));
    let legend =
        Element::Element(HtmlElement::new(TagType::Legend, legend_config)) + Element::Text(legend);
    fieldset += legend;
    for entity in entities {
        if let Some(field) = entity.as_form_field() {
            has_element = true;
            fieldset += field;
        }
    }
    if has_element {
        Some(fieldset)
    } else {
        None
    }
}

/// Creates a `<form>` with the given elements.
///
/// - `fields` : The form's fields.
/// - `form_config` : The form's configs.
/// - `html_config` : The form's html configs.
pub fn create_form(
    fields: Vec<Element>,
    form_config: FormConfig,
    html_config: HtmlElementConfig,
) -> Option<Element> {
    if fields.is_empty() {
        return None;
    }
    let mut cfg = html_config;
    if let Some(method) = form_config.method {
        cfg = cfg.set_attribute("method".to_string(), Some(method));
    }
    if let Some(action) = form_config.action {
        cfg = cfg.set_attribute("action".to_string(), Some(action));
    }
    let mut form = Element::Element(HtmlElement::new(TagType::Form, cfg));
    for field in fields {
        form += field;
    }
    Some(form)
}

impl FormConfig {
    /// Creates a default object.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the form's method.
    ///
    /// - `method` : The form's method.
    pub fn with_method(mut self, method: String) -> Self {
        self.method = Some(method);
        self
    }

    /// Sets the form's action.
    ///
    /// - `action` : The form's action.
    pub fn with_action(mut self, action: String) -> Self {
        self.action = Some(action);
        self
    }
}

impl Default for FormConfig {
    fn default() -> Self {
        Self {
            method: None,
            action: None,
        }
    }
}