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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
use std::{
    convert::TryInto,
    fs::File,
    io::{BufRead, BufReader},
    path::Path,
    str::{Chars, FromStr},
};

use chrono::NaiveDate;

use crate::{
    error::Error,
    model::{
        datensatz::Datensatz,
        gemeinde::{GemeindeDaten, RegionalSchluessel},
        gemeindeverband::{GemeindeverbandDaten, GemeindeverbandSchluessel},
        kreis::KreisDaten,
        land::LandDaten,
        regierungsbezirk::RegierungsbezirkDaten,
        region::RegionDaten,
    },
};

/// Reader to read fields from a single data record (i.e. line). Specifically
/// this makes sure that data is read correctly as UTF-8.
pub struct FieldReader<'a> {
    chars: Chars<'a>,
}

impl<'a> FieldReader<'a> {
    /// Creates a new field reader from a single line. It expects the line to
    /// not contain any line terminator.
    pub fn new(line: &'a str) -> Self {
        FieldReader {
            chars: line.chars(),
        }
    }

    /// Reads a field of length `n` as string. `n` is in characters, not bytes.
    pub fn next(&mut self, n: usize) -> &str {
        let s = self.chars.as_str();

        // Count how many bytes need to be read, to read `n` UTF-8 characters.
        let mut nb = 0;
        for _ in 0..n {
            if let Some(c) = self.chars.next() {
                nb += c.len_utf8();
            } else {
                break;
            }
        }

        let s = &s[0..nb];

        tracing::trace!("read field: {:?}", s);

        s
    }

    pub fn next_opt(&mut self, n: usize) -> Option<&str> {
        let s = self.next(n);
        if s.chars().all(|c| c == ' ') {
            None
        } else {
            Some(s)
        }
    }

    /// Reads a field of length `n` and parses it as `T`.
    pub fn parse_next<T: FromStr>(&mut self, n: usize) -> Result<T, <T as FromStr>::Err> {
        self.next(n).parse()
    }

    pub fn parse_next_opt<T: FromStr>(
        &mut self,
        n: usize,
    ) -> Result<Option<T>, <T as FromStr>::Err> {
        self.next_opt(n).map(|s| s.parse()).transpose()
    }

    /// Skips `n` characters.
    pub fn skip(&mut self, n: usize) {
        for _ in 0..n {
            self.chars.next();
        }
    }
}

/// Parser for GV100AD files.
pub struct Parser<R> {
    reader: R,
}

impl Parser<BufReader<File>> {
    /// Creates a new parser from a file path.
    pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
        let reader = BufReader::new(File::open(path)?);
        Ok(Self::new(reader))
    }
}

impl<R: BufRead> Iterator for Parser<R> {
    type Item = Result<Datensatz, Error>;

    fn next(&mut self) -> Option<Self::Item> {
        self.parse_line().transpose()
    }
}

impl<R: BufRead> Parser<R> {
    /// Creates a new parser from a `BufRead`.
    pub fn new(reader: R) -> Self {
        Self { reader }
    }

    /// Parses the next data record (i.e. line).
    ///
    /// Returns `Ok(None)` if end of file is reached. Returns `Err(_)`, if an
    /// error occured, otherwise returns `Ok(Some(_))`, if a record was
    /// successfully read.
    pub fn parse_line(&mut self) -> Result<Option<Datensatz>, Error> {
        let mut buf = String::new();

        if self.reader.read_line(&mut buf)? == 0 {
            // EOF
            return Ok(None);
        }

        // Remove trailing line terminator.
        while buf.ends_with('\n') || buf.ends_with('\r') {
            buf.pop();
        }

        // Create field reader.
        let mut fields = FieldReader::new(&buf);

        // Read type (Satzart)
        let ty = fields.parse_next::<u8>(2)?;

        let record = match ty {
            10 => {
                // Landdaten

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let schluessel = fields.parse_next(2)?;

                fields.skip(10);

                let name = fields.next(50).trim().to_owned();

                let sitz_regierung = fields.next(50).trim().to_owned();

                Datensatz::Land(LandDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    sitz_regierung,
                })
            }
            20 => {
                // Regierungsbezirkdaten

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let schluessel = fields.parse_next(3)?;

                fields.skip(9);

                let name = fields.next(50).trim().to_owned();

                let sitz_verwaltung = fields.next(50).trim().to_owned();

                Datensatz::Regierungsbezirk(RegierungsbezirkDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    sitz_verwaltung,
                })
            }
            30 => {
                // Regionsdaten (nur Baden-Wuerttenberg)

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let schluessel = fields.parse_next(4)?;
                tracing::debug!(schluessel = ?schluessel);

                let name = fields.next(50).trim().to_owned();
                tracing::debug!(name = ?name);

                let sitz_verwaltung = fields.next(50).trim().to_owned();
                tracing::debug!(sitz_verwaltung = ?sitz_verwaltung);

                Datensatz::Region(RegionDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    sitz_verwaltung,
                })
            }
            40 => {
                // Kreisdaten

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let schluessel = fields.parse_next(5)?;
                tracing::debug!(schluessel = ?schluessel);

                fields.skip(7);

                let name = fields.next(50).trim().to_owned();
                tracing::debug!(name = ?name);

                let sitz_verwaltung = fields.next(50).trim().to_owned();
                tracing::debug!(sitz_verwaltung = ?sitz_verwaltung);

                let textkennzeichen = fields.parse_next::<u8>(2)?.try_into()?;
                tracing::debug!(textkennzeichen = ?textkennzeichen);

                Datensatz::Kreis(KreisDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    textkennzeichen,
                    sitz_verwaltung,
                })
            }
            50 => {
                // Gemeindeverbandsdaten

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let kreis_schluessel = fields.parse_next(5)?;
                tracing::debug!(kreis_schluessel = ?kreis_schluessel);

                fields.skip(3);

                let gemeindeverband = fields.parse_next(4)?;
                tracing::debug!(gemeindeverband = ?gemeindeverband);

                let schluessel = GemeindeverbandSchluessel::new(kreis_schluessel, gemeindeverband);

                let name = fields.next(50).trim().to_owned();
                tracing::debug!(name = ?name);

                let sitz_verwaltung = fields.next_opt(50).map(|s| s.trim().to_owned());
                tracing::debug!(sitz_verwaltung = ?sitz_verwaltung);

                let textkennzeichen = fields.parse_next::<u8>(2)?.try_into()?;
                tracing::debug!(textkennzeichen = ?textkennzeichen);

                Datensatz::Gemeindeverband(GemeindeverbandDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    textkennzeichen,
                    sitz_verwaltung,
                })
            }
            60 => {
                // Gemeindedaten

                let gebietsstand = parse_date(fields.next(8))?;
                tracing::debug!(gebietsstand = ?gebietsstand);

                let regional_schluessel = fields.parse_next::<RegionalSchluessel>(8)?;
                tracing::debug!(regional_schluessel = ?regional_schluessel);

                let gemeindeverband = fields.parse_next(4)?;
                tracing::debug!(gemeindeverband = ?gemeindeverband);

                let schluessel = regional_schluessel.to_gemeinde_schluessel(gemeindeverband);

                let name = fields.next(50).trim().to_owned();
                tracing::debug!(name = ?name);

                fields.skip(50);

                let textkennzeichen = fields.parse_next::<u8>(2)?.try_into()?;
                tracing::debug!(textkennzeichen = ?textkennzeichen);

                fields.skip(4);

                let area = fields.parse_next(11)?;
                tracing::debug!(area = ?area);

                let population_total = fields.parse_next(11)?;
                tracing::debug!(population_total = ?population_total);

                let population_male = fields.parse_next(11)?;
                tracing::debug!(population_male = ?population_male);

                fields.skip(4);

                let plz = fields.next(5).to_owned();
                tracing::debug!(plz = ?plz);

                let plz_unambiguous = fields.next_opt(5).is_none();
                tracing::debug!(plz_unambiguous = ?plz_unambiguous);

                fields.skip(2);

                let finanzamtbezirk = fields.parse_next_opt(4)?;
                tracing::debug!(finanzamtbezirk = ?finanzamtbezirk);

                let gerichtbarkeit = fields.parse_next_opt(4)?;
                tracing::debug!(gerichtbarkeit = ?gerichtbarkeit);

                let arbeitsargenturbezirk = fields.parse_next_opt(5)?;
                tracing::debug!(arbeitsargenturbezirk = ?arbeitsargenturbezirk);

                let bundestagswahlkreise = fields.parse_next_opt(6)?;
                tracing::debug!(bundestagswahlkreise = ?bundestagswahlkreise);
                //fields.skip(4);
                //fields.skip(20);

                Datensatz::Gemeinde(GemeindeDaten {
                    gebietsstand,
                    schluessel,
                    name,
                    textkennzeichen,
                    area,
                    population_total,
                    population_male,
                    plz,
                    plz_unambiguous,
                    finanzamtbezirk,
                    gerichtbarkeit,
                    arbeitsargenturbezirk,
                    bundestagswahlkreise,
                })
            }
            ty => return Err(Error::InvalidType(ty)),
        };

        tracing::debug!("{:#?}", record);

        Ok(Some(record))
    }
}

/// Parses date from a field. This is just year, month, day without any
/// seperators. German timezones apply.
pub fn parse_date(s: &str) -> Result<NaiveDate, Error> {
    Ok(NaiveDate::from_ymd(
        s[0..4].parse()?,
        s[4..6].parse()?,
        s[6..8].parse()?,
    ))
}

#[cfg(test)]
mod tests {
    use std::io::Cursor;

    use crate::model::{
        datensatz::Datensatz,
        gemeinde::{Bundestagswahlkreise, GemeindeSchluessel, GemeindeTextkennzeichen},
        gemeindeverband::{GemeindeverbandSchluessel, GemeindeverbandTextkennzeichen},
        kreis::{KreisSchluessel, KreisTextkennzeichen},
        land::LandSchluessel,
        regierungsbezirk::RegierungsbezirkSchluessel,
        region::RegionSchluessel,
    };

    use super::*;

    fn parse_single_line(line: &str) -> Datensatz {
        let mut parser = Parser::new(Cursor::new(line));
        let record = parser.parse_line().unwrap().unwrap();
        assert!(parser.parse_line().unwrap().is_none());
        record
    }

    #[test]
    fn it_parses_landdaten() {
        let l = "102021043010          Saarland                                          Saarbrücken, Landeshauptstadt                                                                                                                       ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Land(land) => {
                assert_eq!(land.gebietsstand, NaiveDate::from_ymd(2021, 04, 30));
                assert_eq!(land.schluessel, LandSchluessel::new(10));
                assert_eq!(land.name, "Saarland");
                assert_eq!(land.sitz_regierung, "Saarbrücken, Landeshauptstadt");
            }
            _ => panic!("Incorrect record type"),
        }
    }

    #[test]
    fn it_parses_regierungsbezirkdaten() {
        let l = "2020210430072         früher: Reg.-Bez. Trier                           Trier, Stadt                                                                                                                                        ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Regierungsbezirk(regierungsbezirk) => {
                assert_eq!(
                    regierungsbezirk.gebietsstand,
                    NaiveDate::from_ymd(2021, 04, 30)
                );
                assert_eq!(
                    regierungsbezirk.schluessel,
                    RegierungsbezirkSchluessel::new(LandSchluessel::new(7), 2)
                );
                assert_eq!(regierungsbezirk.name, "früher: Reg.-Bez. Trier");
                assert_eq!(regierungsbezirk.sitz_verwaltung, "Trier, Stadt");
            }
            _ => panic!("Incorrect record type"),
        }
    }

    #[test]
    fn it_parses_regiondaten() {
        let l = "30202104300811        Region Stuttgart                                  Stuttgart                                                                                                                                           ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Region(region) => {
                assert_eq!(region.gebietsstand, NaiveDate::from_ymd(2021, 04, 30));
                assert_eq!(
                    region.schluessel,
                    RegionSchluessel::new(
                        RegierungsbezirkSchluessel::new(LandSchluessel::new(8), 1),
                        1
                    )
                );
                assert_eq!(region.name, "Region Stuttgart");
                assert_eq!(region.sitz_verwaltung, "Stuttgart");
            }
            _ => panic!("Incorrect record type"),
        }
    }

    #[test]
    fn it_parses_kreisdaten() {
        let l = "402021043010041       Regionalverband Saarbrücken                       Saarbrücken, Landeshauptstadt                     45                                                                                                ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Kreis(kreis) => {
                assert_eq!(kreis.gebietsstand, NaiveDate::from_ymd(2021, 04, 30));
                assert_eq!(
                    kreis.schluessel,
                    KreisSchluessel::new_land(LandSchluessel::new(10), 41)
                );
                assert_eq!(kreis.name, "Regionalverband Saarbrücken");
                assert_eq!(kreis.sitz_verwaltung, "Saarbrücken, Landeshauptstadt");
                assert_eq!(kreis.textkennzeichen, KreisTextkennzeichen::Regionalverband);
            }
            _ => panic!("Incorrect record type"),
        }
    }

    #[test]
    fn it_parses_gemeindeverbanddaten() {
        let l = "502021043010041   0100Saarbrücken, Landeshauptstadt                                                                       50                                                                                                ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Gemeindeverband(gemeindeverband) => {
                assert_eq!(
                    gemeindeverband.gebietsstand,
                    NaiveDate::from_ymd(2021, 04, 30)
                );
                assert_eq!(
                    gemeindeverband.schluessel,
                    GemeindeverbandSchluessel::new(
                        KreisSchluessel::new_land(LandSchluessel::new(10), 41),
                        100
                    )
                );
                assert_eq!(gemeindeverband.name, "Saarbrücken, Landeshauptstadt");
                assert_eq!(gemeindeverband.sitz_verwaltung, None);
                assert_eq!(
                    gemeindeverband.textkennzeichen,
                    GemeindeverbandTextkennzeichen::VerbandsfreieGemeinde
                );
            }
            _ => panic!("Incorrect record type"),
        }
    }

    #[test]
    fn it_parses_gemeindedaten() {
        let l = "6020210430100411000100Saarbrücken, Landeshauptstadt                                                                       63    000000167520000018037400000089528    66111*****  1040110955501296                           ";
        let record = parse_single_line(l);

        match record {
            Datensatz::Gemeinde(gemeinde) => {
                assert_eq!(gemeinde.gebietsstand, NaiveDate::from_ymd(2021, 04, 30));
                assert_eq!(
                    gemeinde.schluessel,
                    GemeindeSchluessel::new(
                        GemeindeverbandSchluessel::new(
                            KreisSchluessel::new_land(LandSchluessel::new(10), 41),
                            100,
                        ),
                        100
                    )
                );
                assert_eq!(gemeinde.name, "Saarbrücken, Landeshauptstadt");
                assert_eq!(gemeinde.textkennzeichen, GemeindeTextkennzeichen::Stadt);
                assert_eq!(gemeinde.area, 16752);
                assert_eq!(gemeinde.population_total, 180374);
                assert_eq!(gemeinde.population_male, 89528);
                assert_eq!(gemeinde.plz, "66111");
                assert_eq!(gemeinde.plz_unambiguous, false);
                assert_eq!(gemeinde.finanzamtbezirk, Some(1040));
                let gerichtbarkeit = gemeinde.gerichtbarkeit.unwrap();
                assert_eq!(gerichtbarkeit.oberlandesgericht, "1");
                assert_eq!(gerichtbarkeit.landgericht, "1");
                assert_eq!(gerichtbarkeit.amtsgericht, "09");
                assert_eq!(gemeinde.arbeitsargenturbezirk, Some(55501));
                match gemeinde.bundestagswahlkreise {
                    Some(Bundestagswahlkreise::Single(n)) => assert_eq!(n, 296),
                    _ => panic!("Expected there to be a single Bundestagswahlkreis"),
                }
            }
            _ => panic!("Incorrect record type"),
        }
    }
}