scanning 2.1.0

A barcode-encoding library
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

//! Functionality for generating JSON representations of barcodes.
//!
//! This is useful for passing encoded data to third-party systems in a conventional format.
//!
//! Output will be of the format:
//! ```javascript
//! {
//!   "height": 10,
//!   "xdim": 1,
//!   "encoding": [1, 0, 0, 1, 1, 0, ...],
//! }
//! ```

use crate::error::Result;
#[cfg(not(feature = "std"))]
use alloc::{format, string::String};

/// The JSON  barcode generator type.
#[derive(Copy, Clone, Debug)]
pub struct JSON {
    /// The height of the barcode.
    pub height: usize,
    /// The X dimension. Specifies the width of the "narrow" bars.
    pub xdim: usize,
}

impl Default for JSON {
    fn default() -> Self {
        Self::new()
    }
}

impl JSON {
    /// Returns a new JSON with default values.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            height: 10,
            xdim: 1,
        }
    }

    /// Generates the given barcode.
    ///
    /// Returns a `Result<String, Error>` indicating success.
    ///
    /// # Errors
    ///
    /// This function will return an error if the barcode data cannot be processed
    /// into a valid JSON representation.
    pub fn generate<T: AsRef<[u8]>>(&self, barcode: T) -> Result<String> {
        let mut bits = barcode.as_ref().iter().fold(String::new(), |acc, &b| {
            let n = match b {
                0 => "0",
                _ => "1",
            };

            acc + n + ","
        });

        // Kill trailing comma.
        bits.pop();

        let output = format!(
            "{{\"height\":{},\"xdim\":{},\"encoding\":[{}]}}",
            self.height, self.xdim, bits
        );

        Ok(output)
    }
}

#[cfg(test)]
mod tests {
    use crate::generators::json::*;
    use crate::sym::codabar::*;
    use crate::sym::code11::*;
    use crate::sym::code128::*;
    use crate::sym::code39::*;
    use crate::sym::code93::*;
    use crate::sym::ean13::*;
    use crate::sym::ean8::*;
    use crate::sym::ean_supp::*;
    use crate::sym::tf::*;

    #[test]
    fn ean_13_as_json() {
        let ean13 = EAN13::new("750103131130").expect("Failed to create EAN13 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&ean13.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,0,1,1,0,0,0,1,0,1,0,0,1,1,1,0,0,1,1,0,0,1,0,1,0,0,1,1,1,0,1,1,1,1,0,1,0,1,1,0,0,1,1,0,1,0,1,0,1,0,0,0,0,1,0,1,1,0,0,1,1,0,1,1,0,0,1,1,0,1,0,0,0,0,1,0,1,1,1,0,0,1,0,1,1,1,0,1,0,0,1,0,1]}".trim());
    }

    #[test]
    fn ean_13_as_json_small_height_double_width() {
        let ean13 = EAN13::new("750103131130").expect("Failed to create EAN13 barcode");
        let json = JSON { height: 6, xdim: 2 };
        let generated = json
            .generate(&ean13.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":6,\"xdim\":2,\"encoding\":[1,0,1,0,1,1,0,0,0,1,0,1,0,0,1,1,1,0,0,1,1,0,0,1,0,1,0,0,1,1,1,0,1,1,1,1,0,1,0,1,1,0,0,1,1,0,1,0,1,0,1,0,0,0,0,1,0,1,1,0,0,1,1,0,1,1,0,0,1,1,0,1,0,0,0,0,1,0,1,1,1,0,0,1,0,1,1,1,0,1,0,0,1,0,1]}".trim());
    }

    #[test]
    fn ean_8_as_json() {
        let ean8 = EAN8::new("1234567").expect("Failed to create EAN8 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&ean8.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,0,0,1,1,0,0,1,0,0,1,0,0,1,1,0,1,1,1,1,0,1,0,1,0,0,0,1,1,0,1,0,1,0,1,0,0,1,1,1,0,1,0,1,0,0,0,0,1,0,0,0,1,0,0,1,1,1,0,0,1,0,1,0,1]}".trim());
    }

    #[test]
    fn ean_8_as_json_small_height_double_width() {
        let ean8 = EAN8::new("1234567").expect("Failed to create EAN8 barcode");
        let json = JSON { height: 5, xdim: 2 };
        let generated = json
            .generate(&ean8.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":5,\"xdim\":2,\"encoding\":[1,0,1,0,0,1,1,0,0,1,0,0,1,0,0,1,1,0,1,1,1,1,0,1,0,1,0,0,0,1,1,0,1,0,1,0,1,0,0,1,1,1,0,1,0,1,0,0,0,0,1,0,0,0,1,0,0,1,1,1,0,0,1,0,1,0,1]}".trim());
    }

    #[test]
    fn code_93_as_json() {
        let code93 = Code93::new("MONKEYMAGIC").expect("Failed to create Code93 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&code93.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,0,1,1,1,1,0,1,0,1,0,0,1,1,0,0,1,0,0,1,0,1,1,0,0,1,0,1,0,0,0,1,1,0,1,0,0,0,1,1,0,1,0,1,1,0,0,1,0,0,1,0,1,0,0,1,1,0,1,1,0,1,0,1,0,0,1,1,0,0,1,1,0,1,0,1,0,0,0,1,0,1,1,0,1,0,0,0,1,0,1,1,0,0,0,1,0,1,1,0,1,0,0,0,1,0,1,0,0,1,1,0,1,1,0,1,0,1,0,0,1,0,0,0,1,0,1,0,1,1,1,1,0,1]}".trim());
    }

    #[test]
    fn code_93_as_json_small_height_double_weight() {
        let code93 = Code93::new("1234").expect("Failed to create Code93 barcode");
        let json = JSON { height: 7, xdim: 2 };
        let generated = json
            .generate(&code93.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":7,\"xdim\":2,\"encoding\":[1,0,1,0,1,1,1,1,0,1,0,1,0,0,1,0,0,0,1,0,1,0,0,0,1,0,0,1,0,1,0,0,0,0,1,0,1,0,0,1,0,1,0,0,0,1,0,0,0,1,1,0,1,0,1,0,1,0,0,0,0,1,0,1,0,1,0,1,1,1,1,0,1]}".trim());
    }

    #[test]
    fn code_39_as_json() {
        let code39 = Code39::new("TEST8052").expect("Failed to create Code39 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&code39.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,0,1,0,1,1,0,1,1,0,1,0,1,0,1,0,1,1,0,1,1,0,0,1,0,1,1,0,1,0,1,1,0,0,1,0,1,0,1,0,1,1,0,1,0,1,1,0,0,1,0,1,0,1,0,1,1,0,1,1,0,0,1,0,1,1,0,1,0,0,1,0,1,1,0,1,0,1,0,1,0,0,1,1,0,1,1,0,1,0,1,1,0,1,0,0,1,1,0,1,0,1,0,1,0,1,1,0,0,1,0,1,0,1,1,0,1,0,0,1,0,1,1,0,1,1,0,1]}".trim());
    }

    #[test]
    fn code_39_as_json_small_height_double_weight() {
        let code39 = Code39::new("1234").expect("Failed to create Code39 barcode");
        let json = JSON { height: 7, xdim: 2 };
        let generated = json
            .generate(&code39.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":7,\"xdim\":2,\"encoding\":[1,0,0,1,0,1,1,0,1,1,0,1,0,1,1,0,1,0,0,1,0,1,0,1,1,0,1,0,1,1,0,0,1,0,1,0,1,1,0,1,1,0,1,1,0,0,1,0,1,0,1,0,1,0,1,0,0,1,1,0,1,0,1,1,0,1,0,0,1,0,1,1,0,1,1,0,1]}".trim());
    }

    #[test]
    fn codabar_as_json() {
        let codabar = Codabar::new("A98B").expect("Failed to create Codabar barcode");
        let json = JSON::new();
        let generated = json
            .generate(&codabar.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,1,0,0,1,0,0,1,0,1,1,0,1,0,0,1,0,1,0,1,0,0,1,1,0,1,0,1,0,1,0,1,0,0,1,0,0,1,1]}".trim());
    }

    #[test]
    fn codabar_as_json_small_height_double_weight() {
        let codabar = Codabar::new("A40156B").expect("Failed to create Codabar barcode");
        let json = JSON { height: 7, xdim: 2 };
        let generated = json
            .generate(&codabar.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":7,\"xdim\":2,\"encoding\":[1,0,1,1,0,0,1,0,0,1,0,1,0,1,1,0,1,0,0,1,0,1,0,1,0,1,0,0,1,1,0,1,0,1,0,1,1,0,0,1,0,1,1,0,1,0,1,0,0,1,0,1,0,0,1,0,1,0,1,1,0,1,0,1,0,0,1,0,0,1,1]}".trim());
    }

    #[test]
    fn code_128_as_json() {
        let code128 =
            Code128::new("HELLO", CharacterSet::A).expect("Failed to create Code128 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&code128.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,1,0,1,0,0,0,0,1,0,0,1,1,0,0,0,1,0,1,0,0,0,1,0,0,0,1,1,0,1,0,0,0,1,0,0,0,1,1,0,1,1,1,0,1,0,0,0,1,1,0,1,1,1,0,1,0,0,0,1,1,1,0,1,1,0,1,1,0,1,0,0,0,1,0,0,0,1,1,0,0,0,1,1,1,0,1,0,1,1]}".trim());
    }

    #[test]
    fn code_128_as_json_small_height_double_weight() {
        let code128 =
            Code128::new("HELLO", CharacterSet::A).expect("Failed to create Code128 barcode");
        let json = JSON { height: 7, xdim: 2 };
        let generated = json
            .generate(&code128.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":7,\"xdim\":2,\"encoding\":[1,1,0,1,0,0,0,0,1,0,0,1,1,0,0,0,1,0,1,0,0,0,1,0,0,0,1,1,0,1,0,0,0,1,0,0,0,1,1,0,1,1,1,0,1,0,0,0,1,1,0,1,1,1,0,1,0,0,0,1,1,1,0,1,1,0,1,1,0,1,0,0,0,1,0,0,0,1,1,0,0,0,1,1,1,0,1,0,1,1]}".trim());
    }

    #[test]
    fn ean2_as_json() {
        let ean2 = EANSUPP::new("34").expect("Failed to create EAN2 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&ean2.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(
            generated,
            "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,1,0,1,0,0,0,0,1,0,1,0,1,0,0,0,1,1]}"
                .trim()
        );
    }

    #[test]
    fn ean5_as_json() {
        let ean5 = EANSUPP::new("50799").expect("Failed to create EAN5 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&ean5.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,1,0,1,1,0,0,0,1,0,1,0,1,0,0,1,1,1,0,1,0,0,1,0,0,0,1,0,1,0,0,0,1,0,1,1,0,1,0,0,0,1,0,1,1]}".trim());
    }

    #[test]
    fn itf_as_json() {
        let itf = TF::interleaved("12345").expect("Failed to create ITF barcode");
        let json = JSON::new();
        let generated = json
            .generate(&itf.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,0,1,1,1,0,1,0,0,0,1,0,1,0,1,1,1,0,0,0,1,1,1,0,1,1,1,0,1,0,0,0,1,0,1,0,0,0,1,1,1,0,1,0,1,1,1,0,1,0,0,0,1,0,0,0,1,1,0,1]}".trim());
    }

    #[test]
    fn code11_as_json() {
        let code11 = Code11::new("111-999-8").expect("Failed to create Code11 barcode");
        let json = JSON::new();
        let generated = json
            .generate(&code11.encode()[..])
            .expect("Failed to generate JSON");

        assert_eq!(generated, "{\"height\":10,\"xdim\":1,\"encoding\":[1,0,1,1,0,0,1,0,1,1,0,1,0,1,1,0,1,1,0,1,0,1,1,0,1,1,0,1,0,1,1,0,1,0,1,1,0,1,0,1,1,0,1,0,1,0,1,1,0,1,0,1,0,1,1,0,1,0,1,0,1,0,1,1,0,1,0,1,1,0,1,0,0,1,0,1,0,1,0,1,1,0,1,0,1,1,0,0,1]}".trim());
    }
}