rsbadges 1.1.5

Create code badges from the comfort and safety of Rust
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323

// BSD 3-Clause License
//
// Copyright (c) 2021 RSBadges Authors
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
// OF SUCH DAMAGE.

//! Generate the correct SVG layout given badge information. This does not
//! generate the SVG itself.

use super::badge_type::*;
use super::format_helper::*;
/// Generate the correct layout information for a Plastic badge
pub(crate) fn plastic(badge: &Badge) -> Result<Layout, BadgeError> {
    let mut layout = Layout::default();

    // Normalize text
    let font = load_font(include_bytes!("PTSans-Regular.ttf"))?;
    let (label_text_norm, label_text_width) = get_text_dims(&font, &badge.label_text, 17.0);
    layout.label_text_norm = label_text_norm;
    layout.label_text_width = label_text_width;
    let (msg_text_norm, msg_text_width) = get_text_dims(&font, &badge.msg_text, 17.0);
    layout.msg_text_norm = msg_text_norm;
    layout.msg_text_width = msg_text_width;

    // Padding and spacing calculations
    let horiz_padding = 5.0;
    layout.badge_height = 18.0;

    // Logo padding and width
    let mut total_logo_width = 0.0;
    layout.logo_width = 0.0;
    layout.logo_padding = 0.0;
    if !badge.logo.is_empty() {
        if !badge.label_text.is_empty() {
            layout.logo_padding = 3.0;
        }
        let logo_height = 14.0;
        layout.logo_y = (layout.badge_height - logo_height) * 0.5;
        layout.logo_x = horiz_padding;
        layout.logo_width = 14.0;
        total_logo_width = layout.logo_width + layout.logo_padding;
    }

    // Label padding and width
    let label_text_margin = total_logo_width + 1.0;
    layout.label_total_width = 0.0;
    if !badge.label_text.is_empty() {
        layout.label_total_width =
            layout.label_text_width + (2.0 * horiz_padding) + total_logo_width;
    }
    layout.label_text_x = label_text_margin + (0.5 * layout.label_text_width) + horiz_padding;

    // Message padding and width
    let mut msg_text_margin = layout.label_total_width;
    if !badge.msg_text.is_empty() {
        msg_text_margin -= 1.0;
    }

    if badge.label_text.is_empty() {
        if !badge.logo.is_empty() {
            msg_text_margin += layout.logo_width + horiz_padding;
        } else {
            msg_text_margin += 1.0;
        }
    }

    layout.msg_total_width = layout.msg_text_width + (2.0 * horiz_padding);
    if !badge.logo.is_empty() && badge.label_text.is_empty() {
        layout.msg_total_width += layout.logo_width + horiz_padding - 1.0;
    }

    layout.msg_text_x = msg_text_margin + (0.5 * layout.msg_text_width) + horiz_padding;

    // Scale back up for the SVG
    layout.label_text_width *= 10.0;
    layout.msg_text_width *= 10.0;
    layout.label_text_x *= 10.0;
    layout.msg_text_x *= 10.0;

    // Color conversion to string
    layout.label_color = verify_color(&badge.label_color)?;
    layout.msg_color = verify_color(&badge.msg_color)?;

    Ok(layout)
}

/// Generate the correct layout information for a Flat or Square badge
pub(crate) fn flat_or_square(badge: &Badge) -> Result<Layout, BadgeError> {
    let mut layout = Layout::default();

    // Normalize text
    let font = load_font(include_bytes!("PTSans-Regular.ttf"))?;
    let (label_text_norm, label_text_width) = get_text_dims(&font, &badge.label_text, 17.0);
    layout.label_text_norm = label_text_norm;
    layout.label_text_width = label_text_width;
    let (msg_text_norm, msg_text_width) = get_text_dims(&font, &badge.msg_text, 17.0);
    layout.msg_text_norm = msg_text_norm;
    layout.msg_text_width = msg_text_width;

    // Padding and spacing calculations
    let horiz_padding = 5.0;
    layout.badge_height = 20.0;

    // Logo padding and width
    let mut total_logo_width = 0.0;
    layout.logo_width = 0.0;
    layout.logo_padding = 0.0;
    if !badge.logo.is_empty() {
        if !badge.label_text.is_empty() {
            layout.logo_padding = 3.0;
        }
        let logo_height = 14.0;
        layout.logo_y = (layout.badge_height - logo_height) * 0.5;
        layout.logo_x = horiz_padding;
        layout.logo_width = 14.0;
        total_logo_width = layout.logo_width + layout.logo_padding;
    }

    // Label padding and width
    let label_text_margin = total_logo_width + 1.0;
    layout.label_total_width = 0.0;
    if !badge.label_text.is_empty() {
        layout.label_total_width =
            layout.label_text_width + (2.0 * horiz_padding) + total_logo_width;
    }
    layout.label_text_x = label_text_margin + (0.5 * layout.label_text_width) + horiz_padding;

    // Message padding and width
    let mut msg_text_margin = layout.label_total_width;
    if !badge.msg_text.is_empty() {
        msg_text_margin -= 1.0;
    }

    if badge.label_text.is_empty() {
        if !badge.logo.is_empty() {
            msg_text_margin += layout.logo_width + horiz_padding;
        } else {
            msg_text_margin += 1.0;
        }
    }

    layout.msg_total_width = layout.msg_text_width + (2.0 * horiz_padding);
    if !badge.logo.is_empty() && badge.label_text.is_empty() {
        layout.msg_total_width += layout.logo_width + horiz_padding - 1.0;
    }

    layout.msg_text_x = msg_text_margin + (0.5 * layout.msg_text_width) + horiz_padding;

    // Scale back up for the SVG
    layout.label_text_width *= 10.0;
    layout.msg_text_width *= 10.0;
    layout.label_text_x *= 10.0;
    layout.msg_text_x *= 10.0;

    // Color conversion to string
    layout.label_color = verify_color(&badge.label_color)?;
    layout.msg_color = verify_color(&badge.msg_color)?;

    Ok(layout)
}

/// Generate the correct layout information for a "For the Badge" badge
pub(crate) fn for_the_badge(badge: &Badge) -> Result<Layout, BadgeError> {
    let mut layout = Layout::default();

    // Normalize text
    let font = load_font(include_bytes!("PTSans-Regular.ttf"))?;
    let (label_text_norm, label_text_width) =
        get_text_dims(&font, &badge.label_text.to_uppercase(), 14.0);
    layout.label_text_norm = label_text_norm;
    layout.label_text_width = label_text_width;
    let bold_font = load_font(include_bytes!("PTSans-Bold.ttf"))?;
    let (msg_text_norm, msg_text_width) =
        get_text_dims(&bold_font, &badge.msg_text.to_uppercase(), 17.0);
    layout.msg_text_norm = msg_text_norm;
    layout.msg_text_width = msg_text_width;

    // Padding and spacing calculations
    let horiz_padding = 9.0;
    layout.badge_height = 28.0;

    // Logo padding and width
    let mut total_logo_width = 0.0;
    layout.logo_width = 0.0;
    layout.logo_padding = 0.0;
    if !badge.logo.is_empty() {
        if !badge.label_text.is_empty() {
            layout.logo_padding = 3.0;
        }
        let logo_height = 14.0;
        layout.logo_y = (layout.badge_height - logo_height) * 0.5;
        layout.logo_x = horiz_padding;
        layout.logo_width = 14.0;
        total_logo_width = layout.logo_width + layout.logo_padding;
    }

    // Label padding and width
    // This logic is something else, lemme tell ya
    layout.label_total_width = layout.label_text_width + total_logo_width + 10.0;
    if !badge.label_text.is_empty() {
        layout.label_total_width += 10.0 + (2.0 * layout.label_text_norm.len() as f32)
    } else if !badge.logo.is_empty() {
        if !badge.label_text.is_empty() {
            layout.label_total_width += 7.0;
        } else {
            layout.label_total_width -= 7.0;
        }
    } else {
        layout.label_total_width -= 11.0;
    }

    layout.label_text_x = (layout.label_total_width + total_logo_width) / 2.0;
    layout.label_text_width = layout.label_total_width - (24.0 + total_logo_width);

    // Message padding and width
    layout.msg_total_width =
        layout.msg_text_width + 20.0 + (1.5 * layout.msg_text_norm.len() as f32);
    layout.msg_text_x = layout.label_total_width + (layout.msg_total_width / 2.0);
    layout.msg_text_width = layout.msg_total_width - 24.0;

    // Scale back up for the SVG
    layout.label_text_width *= 10.0;
    layout.msg_text_width *= 10.0;
    layout.label_text_x *= 10.0;
    layout.msg_text_x *= 10.0;

    // Color conversion to string
    if badge.label_text.is_empty() {
        layout.label_color = verify_color(&badge.msg_color)?;
    } else {
        layout.label_color = verify_color(&badge.label_color)?;
    }
    layout.msg_color = verify_color(&badge.msg_color)?;

    Ok(layout)
}

/// Generate the correct layout information for a Social badge
pub(crate) fn social(badge: &Badge) -> Result<Layout, BadgeError> {
    let mut layout = Layout::default();

    // Normalize text
    let font = load_font(include_bytes!("OpenSans-Regular.ttf"))?;
    let cap_label = uppercase_first_letter(&badge.label_text);
    let (label_text_norm, label_text_width) = get_text_dims(&font, &cap_label, 16.0);
    layout.label_text_norm = label_text_norm;
    layout.label_text_width = label_text_width;
    let (msg_text_norm, msg_text_width) = get_text_dims(&font, &badge.msg_text, 16.0);
    layout.msg_text_norm = msg_text_norm;
    layout.msg_text_width = msg_text_width;

    // Padding and spacing calculations
    let label_horiz_padding = 5.0;
    let msg_horiz_padding = 4.0;
    layout.badge_height = 20.0;

    // Logo padding and width
    let mut total_logo_width = 0.0;
    layout.logo_width = 0.0;
    layout.logo_padding = 0.0;
    if !badge.logo.is_empty() {
        if !badge.label_text.is_empty() {
            layout.logo_padding = 3.0;
        }
        let logo_height = 14.0;
        layout.logo_y = (layout.badge_height - logo_height) * 0.5;
        layout.logo_x = label_horiz_padding;
        layout.logo_width = 14.0;
        total_logo_width = layout.logo_width + layout.logo_padding;
    }

    // Label padding and width
    layout.label_rect_width =
        layout.label_text_width + total_logo_width + (2.0 * label_horiz_padding);
    layout.label_text_x = total_logo_width + (layout.label_text_width / 2.0) + label_horiz_padding;
    layout.label_total_width = layout.label_rect_width + 1.0;

    // Message padding and width
    let horiz_gutter = 6.0;
    layout.msg_rect_width = layout.msg_text_width + (2.0 * msg_horiz_padding);
    layout.msg_text_x = layout.label_rect_width + horiz_gutter + (layout.msg_rect_width / 2.0);
    layout.msg_bubble_x = layout.label_rect_width + horiz_gutter + 0.5;
    if layout.msg_text_norm.is_empty() {
        layout.msg_total_width = 0.0;
    } else {
        layout.msg_total_width = layout.msg_rect_width + horiz_gutter;
    }

    // Scale back up for the SVG
    layout.label_text_width *= 10.0;
    layout.msg_text_width *= 10.0;
    layout.label_text_x *= 10.0;
    layout.msg_text_x *= 10.0;

    // Color conversion to string
    layout.label_color = verify_color(&badge.label_color)?;
    layout.msg_color = verify_color(&badge.msg_color)?;

    Ok(layout)
}