easy-docx-template 0.2.4

create docx template
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

use std::collections::HashMap;
use serde_json::{to_string, Value};
use crate::utils::*;

/// # DOCX struct
///
/// create template for docx file
///
/// `file_name` - docx file input name
///
/// `content` - content of word file
///
/// `placeholder`/`placeholder_block`/`placeholder_images` - saving your placeholders
pub struct DOCX {
    pub content: HashMap<String, String>,
    pub file_name: String,
    pub placeholders: HashMap<String, Value>,
    pub placeholders_blocks: HashMap<String, String>,
    pub placeholder_images: HashMap<String, String>,
}

impl DOCX {
    /// Create new docx manager
    ///
    /// `file_name` input file name
    pub fn new(file_name: String) -> DOCX {
        DOCX {
            file_name,
            content: HashMap::new(),
            placeholders: HashMap::new(),
            placeholders_blocks: HashMap::new(),
            placeholder_images: HashMap::new(),
        }
    }

    /// Read DOCX file
    pub fn read(&mut self) {
        self.content = read_raw_docx(&self.file_name);
    }

    /// Add placeholders to DOCX
    ///
    /// `placeholder` - Placeholder
    ///
    /// `replaced_content` - value for placeholder
    pub fn add_placeholder<T>(&mut self, placeholder: &str, replaced_content: T) where Value: From<T> {
        self.placeholders.insert(placeholder.to_string(), Value::from(replaced_content));
    }

    /// Add placeholders from json
    ///
    /// `placeholders_content` - json data
    pub fn add_placeholders_from_json(&mut self, placeholders_content: &str) {
        let v: Value = serde_json::from_str(placeholders_content).unwrap();
        if let Value::Object(map) = v {
            process_json_map(self,"", &map);
        }
    }

    /// Add image placeholder
    ///
    /// `placeholder` id of image in docx
    /// `image` directory of image for replace
    pub fn add_image_placeholder(&mut self, placeholder: &str, image: &str) {
        let media_dir = "word/media/";
        self.placeholder_images.insert(format!("{}{}", media_dir, placeholder.to_string()), image.to_string());
    }

    /// Remove image placeholder
    ///
    /// `placeholder` - placeholder tag
    pub fn remove_image_placeholder(&mut self, placeholder: &str) {
        let media_dir = "word/media/";
        self.placeholder_images.remove(&format!("{}{}", media_dir, placeholder));
    }

    /// Init placeholders
    pub fn init_placeholders(&mut self) {
        let mut new_content = HashMap::new();
        self.placeholders = add_placeholder_helpers(&mut self.placeholders);
        let rendered = init_each_placeholders(self.content["word/document.xml"].clone(), &mut self.placeholders, false);
        self.content.remove("word/document.xml");
        self.content.insert("word/document.xml".to_string(), rendered);
        for (k, v) in &self.content {
            new_content.insert(k.to_string(), init_placeholders(&mut self.placeholders, v));
        }
        self.content = new_content;
    }

    /// save output file
    ///
    /// `output` - output
    pub fn save(&self, output: &str) {
        let result = render_docx(&self);
        std::fs::write(output, result).unwrap();
    }

    /// Render docx file
    ///
    /// You can use this in web
    pub fn render(&self) -> Vec<u8> {
        render_docx(&self)
    }
}