-
Notifications
You must be signed in to change notification settings - Fork 0
/
bethyw.cpp
532 lines (414 loc) · 16.7 KB
/
bethyw.cpp
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
530
/*
+---------------------------------------+
| BETH YW? WELSH GOVERNMENT DATA PARSER |
+---------------------------------------+
AUTHOR: 956213
This file contains all the helper functions for initialising and running
Beth Yw? In languages such as Java, this would be a class, but we really
don't need a class here. Classes are for modelling data, and so forth, but
here the code is pretty much a sequential block of code (BethYw::run())
calling a series of helper functions.
TODO: This file contains numerous functions you must implement. Each one
is denoted with a TODO in the block comment. Note that some code has been
provided in some functions to get you started, but you should read through
this code and make sure it is safe and complete. You may need to remove or
modify the provided code to get your program to work fully. You may implement
additional functions not specified.
*/
#include <iostream>
#include <string>
#include <tuple>
#include <unordered_set>
#include <vector>
#include "lib_cxxopts.hpp"
#include "datasets.h"
#include "bethyw.h"
#include "input.h"
/*
Run Beth Yw?, parsing the command line arguments, importing the data,
and outputting the requested data to the standard output/error.
Hint: cxxopts.parse() throws exceptions you'll need to catch. Read the cxxopts
documentation for more information.
@param argc
Number of program arguments
@param argv
Program arguments
@return
Exit code
*/
int BethYw::run(int argc, char *argv[]) {
try {
auto cxxopts = BethYw::cxxoptsSetup();
auto args = cxxopts.parse(argc, argv);
// Print the help usage if requested
if (args.count("help")) {
std::cerr << cxxopts.help() << std::endl;
return 0;
}
// Parse data directory argument
std::string dir = args["dir"].as<std::string>() + DIR_SEP;
// Parse other arguments and import data
std::vector<BethYw::InputFileSource> datasetsToImport;
if (args.count("datasets")) {
datasetsToImport = BethYw::parseDatasetsArg(args);
} else {
for (const auto & i : BethYw::InputFiles::DATASETS) {
datasetsToImport.push_back(i);
}
}
std::unordered_set<std::string> areasFilter;
if (args.count("areas")) {
areasFilter = BethYw::parseAreasArg(args);
} else {
areasFilter.clear();
}
std::unordered_set<std::string> measuresFilter;
if (args.count("measures")) {
measuresFilter = BethYw::parseMeasuresArg(args);
} else {
measuresFilter.clear();
}
std::tuple<unsigned int, unsigned int> yearsFilter;
if (args.count("years")) {
yearsFilter = BethYw::parseYearsArg(args);
} else {
yearsFilter = std::pair<unsigned int, unsigned int>(0,0);
}
Areas data = Areas();
loadAreas(data, dir, areasFilter);
BethYw::loadDatasets(data,
dir,
datasetsToImport,
areasFilter,
measuresFilter,
yearsFilter);
if (args.count("json")) {
// The output as JSON
std::cout << data.toJSON() << std::endl;
} else {
// The output as tables
std::cout << data << std::endl;
}
return 0;
} catch (std::invalid_argument& iaError) {
std::cerr << iaError.what() << std::endl;
return 1;
} catch (std::runtime_error& rtError) {
std::cerr << "Error importing dataset:" << std::endl;
std::cerr << rtError.what() << std::endl;
return 2;
}
}
/*
This function sets up and returns a valid cxxopts object. You do not need to
modify this function.
@return
A constructed cxxopts object
@example
auto cxxopts = BethYw::cxxoptsSetup();
auto args = cxxopts.parse(argc, argv);
*/
cxxopts::Options BethYw::cxxoptsSetup() {
cxxopts::Options cxxopts(
"bethyw",
"Student ID: " + STUDENT_NUMBER + "\n\n"
"This program is designed to parse official Welsh Government"
" statistics data files.\n");
cxxopts.add_options()(
"dir",
"Directory for input data passed in as files",
cxxopts::value<std::string>()->default_value("datasets"))(
"d,datasets",
"The dataset(s) to import and analyse as a comma-separated list of codes "
"(omit or set to 'all' to import and analyse all datasets)",
cxxopts::value<std::vector<std::string>>())(
"a,areas",
"The areas(s) to import and analyse as a comma-separated list of "
"authority codes (omit or set to 'all' to import and analyse all areas)",
cxxopts::value<std::vector<std::string>>())(
"m,measures",
"Select a subset of measures from the dataset(s) "
"(omit or set to 'all' to import and analyse all measures)",
cxxopts::value<std::vector<std::string>>())(
"y,years",
"Focus on a particular year (YYYY) or "
"inclusive range of years (YYYY-ZZZZ)",
cxxopts::value<std::string>()->default_value("0"))(
"j,json",
"Print the output as JSON instead of tables.")(
"h,help",
"Print usage.");
return cxxopts;
}
/*
TODO: BethYw::parseDatasetsArg(args)
Parse the datasets argument passed into the command line.
The datasets argument is optional, and if it is not included, all datasets
should be imported. If it is included, it should be a comma-separated list of
datasets to import. If the argument contains the value "all"
(case-insensitive), all datasets should be imported.
This function validates the passed in dataset names against the codes in
DATASETS array in the InputFiles namespace in datasets.h. If an invalid code
is entered, throw a std::invalid_argument with the message:
No dataset matches key: <input code>
where <input name> is the name supplied by the user through the argument.
@param args
Parsed program arguments
@return
A std::vector of BethYw::InputFileSource instances to import
@throws
std::invalid_argument if the argument contains an invalid dataset with
message: No dataset matches key <input code>
@example
auto cxxopts = BethYw::cxxoptsSetup();
auto args = cxxopts.parse(argc, argv);
auto datasetsToImport = BethYw::parseDatasetsArg(args);
*/
std::vector<BethYw::InputFileSource> BethYw::parseDatasetsArg(
cxxopts::ParseResult& args) {
// This function is incomplete, but to get you started...
// You may want to delete much of these // comments too!
// Retrieve all valid datasets, see datasets.h
size_t numDatasets = InputFiles::NUM_DATASETS;
auto &allDatasets = InputFiles::DATASETS;
// Create the container for the return type
std::vector<InputFileSource> datasetsToImport;
// You can get the std::vector of arguments from cxxopts like this.
// Note that this function will throw an exception if datasets is not set as
// an argument. Check the documentation! Read it and understand it.
auto inputDatasets = args["datasets"].as<std::vector<std::string>>();
// You now need to compare the strings in this vector to the keys in
// allDatasets above. Populate datasetsToImport with the values
// from allDatasets above and then return a vector
// You'll want to ignore/remove the following lines of code, they simply
// import all datasets (for now) as an example to get you started
//for(unsigned int i = 0; i < numDatasets; i++)
//datasetsToImport.push_back(allDatasets[i]);
for (auto & code : inputDatasets) {
std::transform(code.begin(), code.end(), code.begin(), ::tolower);
bool matchFound = false;
if (code == "all") {
datasetsToImport.clear();
for (unsigned int i = 0; i < numDatasets; i++) {
datasetsToImport.push_back(allDatasets[i]);
}
return datasetsToImport;
}
for (unsigned int j = 0; j < numDatasets; j++) {
if (code == allDatasets[j].CODE) {
matchFound = true;
datasetsToImport.push_back(allDatasets[j]);
break;
}
}
if (!matchFound) {
throw std::invalid_argument("No dataset matches key: " + code);
}
}
return datasetsToImport;
}
/*
TODO: BethYw::parseAreasArg(args)
Parses the areas command line argument, which is optional. If it doesn't
exist or exists and contains "all" as value (any case), all areas should be
imported, i.e., the filter should be an empty set.
Unlike datasets we can't check the validity of the values as it depends
on each individual file imported (which hasn't happened until runtime).
Therefore, we simply fetch the list of areas and later pass it to the
Areas::populate() function.
The filtering of inputs should be case insensitive.
@param args
Parsed program arguments
@return
An std::unordered_set of std::strings corresponding to specific areas
to import, or an empty set if all areas should be imported.
@throws
std::invalid_argument if the argument contains an invalid areas value with
message: Invalid input for area argument
*/
std::unordered_set<std::string> BethYw::parseAreasArg(
cxxopts::ParseResult& args) {
// The unordered set you will return
std::unordered_set<std::string> areas;
// Retrieve the areas argument like so:
auto temp = args["areas"].as<std::vector<std::string>>();
for (auto & area : temp) {
if (area == "all") {
areas.clear();
return areas;
} else {
areas.insert(area);
}
}
return areas;
}
/*
TODO: BethYw::parseMeasuresArg(args)
Parse the measures command line argument, which is optional. If it doesn't
exist or exists and contains "all" as value (any case), all measures should
be imported.
Unlike datasets we can't check the validity of the values as it depends
on each individual file imported (which hasn't happened until runtime).
Therefore, we simply fetch the list of measures and later pass it to the
Areas::populate() function.
The filtering of inputs should be case insensitive.
@param args
Parsed program arguments
@return
An std::unordered_set of std::strings corresponding to specific measures
to import, or an empty set if all measures should be imported.
@throws
std::invalid_argument if the argument contains an invalid measures value
with the message: Invalid input for measures argument
*/
std::unordered_set<std::string> BethYw::parseMeasuresArg(
cxxopts::ParseResult& args) {
// The unordered set you will return
std::unordered_set<std::string> measures;
// Retrieve the measures argument like so:
auto temp = args["measures"].as<std::vector<std::string>>();
for (auto & measure : temp) {
std::transform(measure.begin(), measure.end(), measure.begin(), ::tolower);
if (measure == "all") {
measures.clear();
return measures;
} else {
measures.insert(measure);
}
}
return measures;
}
/*
TODO: BethYw::parseYearsArg(args)
Parse the years command line argument. Years is either a four digit year
value, or two four digit year values separated by a hyphen (i.e. either
YYYY or YYYY-ZZZZ).
This should be parsed as two integers and inserted into a std::tuple,
representing the start and end year (inclusive). If one or both values are 0,
then there is no to be applied. If no year argument is given return
<0,0> (i.e. to import all years). You will have to search
the web for how to construct std::tuple objects!
@param args
Parsed program arguments
@return
A std::tuple containing two unsigned ints
@throws
std::invalid_argument if the argument contains an invalid years value with
the message: Invalid input for years argument
*/
std::tuple<unsigned int, unsigned int> BethYw::parseYearsArg(
cxxopts::ParseResult& args) {
// get args as string
auto temp = args["years"].as<std::string>();
if (temp.empty()) {
return std::make_tuple(0,0);
}
//check max length and all valid chars
if (temp.find_first_not_of("0123456789-") == std::string::npos && temp.length() <= 9) {
//check for '-'
if (temp.find_first_of('-') == std::string::npos) {
//check min length & return
if (temp.length() == 4 || temp == "0") {
return std::make_tuple(stoi(temp), stoi(temp));
}
} else {
//remove '-'
size_t pos = temp.find('-');
temp.erase(pos,1);
//check for extra '-' and final valid lengths
if (temp.find_first_not_of("0123456789") == std::string::npos) {
if (temp == "00") {
return std::make_tuple(0,0);
}
if (temp.length() == 8) {
return std::make_tuple(stoi(temp.substr(0, 4)), stoi(temp.substr(4)));
}
}
}
}
//throw anything else
throw std::invalid_argument("Invalid input for years argument");
}
/*
TODO: BethYw::loadAreas(areas, dir, areasFilter)
Load the areas.csv file from the directory `dir`. Parse the file and
create the appropriate Area objects inside the Areas object passed to
the function in the `areas` argument.
areas.csv is guaranteed to be formatted as:
Local authority code,Name (eng),Name (cym)
Hint: To implement this function. First you will need create an InputFile
object with the filename of the areas file, open it, and then pass reference
to the stream to the Areas::populate() function.
Hint 2: you can retrieve the specific filename for a dataset, e.g. for the
areas.csv file, from the InputFileSource's FILE member variable
@param areas
An Areas instance that should be modified (i.e. the populate() function
in the instance should be called)
@param dir
Directory where the areas.csv file is
@param areasFilter
An unordered set of areas to filter, or empty to import all areas
@return
void
@example
Areas areas();
BethYw::loadAreas(areas, "data", BethYw::parseAreasArg(args));
*/
void BethYw::loadAreas(Areas &areas, std::string &dir, std::unordered_set<std::string> &areasFilter) {
InputFile input(dir + "areas.csv");
auto &is = input.open();
auto cols = BethYw::InputFiles::AREAS.COLS;
areas.populate(is, BethYw::SourceDataType::AuthorityCodeCSV, cols, &areasFilter, NULL, NULL);
}
/*
TODO: BethYw::loadDatasets(areas,
dir,
datasetsToImport,
areasFilter,
measuresFilter,
yearsFilter)
Import datasets from `datasetsToImport` as files in `dir` into areas, and
filtering them with the `areasFilter`, `measuresFilter`, and `yearsFilter`.
The actual filtering will be done by the Areas::populate() function, thus
you need to merely pass pointers on to these flters.
This function should promise not to throw an exception. If there is an
error/exception thrown in any function called by thus function, catch it and
output 'Error importing dataset:', followed by a new line and then the output
of the what() function on the exception.
@param areas
An Areas instance that should be modified (i.e. datasets loaded into it)
@param dir
The directory where the datasets are
@param datasetsToImport
A vector of InputFileSource objects
@param areasFilter
An unordered set of areas (as authority codes encoded in std::strings)
to filter, or empty to import all areas
@param measuresFilter
An unordered set of measures (as measure codes encoded in std::strings)
to filter, or empty to import all measures
@param yearsFilter
An two-pair tuple of unsigned ints corresponding to the range of years
to import, which should both be 0 to import all years.
@return
void
@example
Areas areas();
BethYw::loadDatasets(
areas,
"data",
BethYw::parseDatasetsArgument(args),
BethYw::parseAreasArg(args),
BethYw::parseMeasuresArg(args),
BethYw::parseYearsArg(args));
*/
void BethYw::loadDatasets(Areas &areas, std::string &dir, const std::vector<InputFileSource>& datasetsToImport,
std::unordered_set<std::string> &areasFilter, std::unordered_set<std::string> &measuresFilter,
std::tuple<unsigned int, unsigned int> &yearsFilter) {
for (const InputFileSource &source : datasetsToImport) {
InputFile input(dir + source.FILE);
auto &is = input.open();
auto cols = source.COLS;
areas.populate(is, source.PARSER, cols, &areasFilter, &measuresFilter, &yearsFilter);
}
}