forked from sentinel-hub/collections
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gulpfile.js
876 lines (743 loc) · 25.3 KB
/
gulpfile.js
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
/**
* Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in
* compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
'use strict';
var gulp = require('gulp');
var yaml = require('gulp-yaml');
var jsyaml = require('yaml');
var del = require('del');
var handlebars = require('handlebars');
var hb = require('gulp-hb');
var rename = require('gulp-rename');
var flatmap = require('gulp-flatmap');
var requireDir = require('require-dir');
var path = require('path');
var marked = require('marked');
var renderer = new marked.Renderer();
var browserSync = require('browser-sync');
var reload = browserSync.reload;
var fs = require('fs');
var _ = require('lodash');
var reduce = require('object.reduce');
var ndjson = require('ndjson');
let allDatasets;
const dataSourcesDirectory = './collections/';
// Overriding MD renderer to remove outside <p> tags
renderer.paragraph = function (text, level) {
return text;
};
var externalPages = [];
// Helper function to alpha sort DataAtWork sections
const sortDataAtWork = function (dataAtWork) {
for (var k in dataAtWork) {
if (!dataAtWork[k]) { return dataAtWork[k]; }
dataAtWork[k].sort((a, b) => {
if (a.Title.toUpperCase() < b.Title.toUpperCase()) {
return -1;
}
if (a.Title.toUpperCase() > b.Title.toUpperCase()) {
return 1;
}
return 0;
});
}
return dataAtWork;
};
// Helper function to grab datasets from JSON files
const getDatasets = function (ignoreRank=false) {
if (allDatasets && !ignoreRank) {
return allDatasets;
}
var datasets = requireDir('./_tmp');
var arr = [];
for (var k in datasets) {
// Handle deprecated datasets
if (datasets[k].Deprecated) {
continue;
}
// If we have no items in a category, remove it
for (var category in datasets[k].DataAtWork) {
if (!datasets[k].DataAtWork[category] || (datasets[k].DataAtWork[category] && datasets[k].DataAtWork[category] === 0)) {
delete datasets[k].DataAtWork[category];
}
}
// If we have no items at all, delete DataAtWork
if (_.flatMap(datasets[k].DataAtWork).length === 0) {
delete datasets[k].DataAtWork;
}
var dataset = datasets[k];
dataset.Slug = generateSlug(k);
dataset.rootUrl = process.env.COLLECTIONS_BROWSER_ROOT_URL;
dataset.githubRepo = process.env.GIT_HUB_COLLECTIONS_REPO;
dataset.githubBranch = process.env.GIT_HUB_COLLECTIONS_BRANCH;
arr.push(datasets[k]);
}
// Rank the datasets
arr = rankDatasets(arr, ignoreRank);
// Sort DataAtWork section by alpha
arr = arr.map((d) => {
if (d.DataAtWork) {
d.DataAtWork = sortDataAtWork(d.DataAtWork);
}
return d;
});
// Sort the Tags
arr = arr.map((d) => {
if (d.Tags) {
d.Tags = d.Tags.sort((a, b) => a.localeCompare(b));
}
return d;
});
if (ignoreRank) {
return arr.slice();
}
allDatasets = arr.slice();
return allDatasets;
};
// Helper function to get unique tags
const getUniqueTags = function (datasets) {
// Build up list of unique tags
let tags = [];
datasets.forEach((d) => {
d.Tags.forEach((t) => {
if (tags.includes(t) === false) {
tags.push(t);
}
});
});
return tags;
};
// Helper function to get unique dates
const getUniqueDates = function (datasets) {
// Build up list of unique tags
let dates = [];
datasets.forEach((d) => {
if (dates.includes(d.RegistryEntryAdded) === false) {
dates.push(d.RegistryEntryAdded);
}
});
// Sort by descending order
dates.sort();
dates.reverse();
return dates;
};
// Helper function to generate slug from file name
const generateSlug = function (file) {
return path.basename(file, '.json').toLowerCase();
};
// Helper function to rank the datasets in some order
const rankDatasets = function (datasets, ignoreRank) {
// Calculate rank
datasets = datasets.map((d) => {
d.rank = 0;
if (d['Tags'].includes('aws-pds')) { d.rank += 3; }
if (d['DataAtWork']) { d.rank += 1 * _.flatMap(d['DataAtWork']).length; }
return d;
});
// Order
if (ignoreRank) {
datasets = _.orderBy(datasets, ['Name'], ['asc']);
} else {
datasets = _.orderBy(datasets, ['rank', 'Name'], ['desc', 'asc']);
}
// Remove rank variable
datasets = datasets.map((d) => {
delete d.rank;
return d;
});
return datasets;
};
const convertMDtoHTML = function(mdFile, destDirectory) {
var htmlFile = path.basename(path.basename(mdFile, '.md'), '.MD').toLowerCase();
htmlFile += ".html";
if (fs.existsSync(path.join(destDirectory, htmlFile))) {
return false;
}
var mdContent = fs.readFileSync(mdFile, "utf-8");
var htmlContent = marked(mdContent, {renderer: renderer});
var templateData = {
baseURL: process.env.BASE_URL,
buildDate: new Date().toUTCString(),
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
var htmlHeader = handlebars.compile(fs.readFileSync('./_build/partials/header.hbs', 'utf-8'))(templateData);
var htmlFooter = handlebars.compile(fs.readFileSync('./_build/partials/footer.hbs', 'utf-8'))(templateData);
htmlContent = htmlHeader + htmlContent + htmlFooter;
fs.writeFileSync(path.join(destDirectory, htmlFile), htmlContent);
return true;
}
const copyDirectory = function(sourcePath, destPath, fileProcessingFunc) {
var files = fs.readdirSync(sourcePath);
if (!fs.existsSync(destPath)) {
fs.mkdirSync(destPath);
}
for (var i in files) {
var file = files[i];
var srcFileAbs = path.join(sourcePath, file);
var destFileAbs = path.join(destPath, file);
if (fs.lstatSync(srcFileAbs).isDirectory()) {
copyDirectory(srcFileAbs, path.join(destPath, file));
}
else if ((fileProcessingFunc == null) || !fileProcessingFunc(srcFileAbs)) {
if (!fs.existsSync(destFileAbs)) {
fs.writeFileSync(destFileAbs, fs.readFileSync(srcFileAbs));
}
}
}
}
const copyDirectoryWithMDProcessing = function(sourcePath, destPath) {
return copyDirectory(sourcePath, destPath, function(file) {
if (path.extname(file).toLowerCase() == '.md') {
convertMDtoHTML(file, destPath);
return true;
}
return false;
});
}
// Handlebars helper functions
const hbsHelpers = {
toJSON: function (obj) {
return new hb.handlebars.SafeString(JSON.stringify(obj));
},
checkLength: function (obj, len, options) {
if (_.flatMap(obj).length > len) {
return options.fn(this);
}
return options.inverse(this);
},
pickRandom: function (arr, len, options) {
let ret = '';
const shuffle = function (a) {
for (let i = a.length - 1; i > 0; i--) {
const j = Math.floor(Math.random() * (i + 1));
[a[i], a[j]] = [a[j], a[i]];
}
return a;
};
arr = shuffle(_.flatMap(arr));
arr = arr.slice(0, len);
arr = arr.forEach((a) => {
ret += options.fn(a);
});
return ret;
},
isEqual: function (v1, v2, options) {
if (v1 === v2) {
return options.fn(this);
}
return options.inverse(this);
},
md: function (str, escapeStr=false) {
// Keep from exiting if we have an undefined string
if (!str) {
return str;
}
var res = marked(str, {renderer: renderer});
if (escapeStr===true) {
res = res.replace(/\"/g, '\\\"');
}
return res;
},
mdExternal: function (data, escapeStr=false) {
// Keep from exiting if we have an undefined string
if (!data || !data.Title || !data.Path) {
return data;
}
var mdFile = data.Path;
var htmlFile = path.basename(path.basename(mdFile, '.md'), '.MD').toLowerCase();
htmlFile += ".html";
var dir = path.dirname(mdFile);
copyDirectoryWithMDProcessing(path.join(dataSourcesDirectory, dir), path.join("./_output/", dir));
return "<a href=\"" + process.env.COLLECTIONS_BROWSER_ROOT_URL + dir + "/" + htmlFile + "\">" + data.Title + "</a>";
},
escapeTag: function (str) {
// Keep from exiting if we have an undefined string
if (!str) {
return str;
}
return str.replace(/ /g, '-');
},
managedByRenderer: function (str, wantLogo=true) {
// Keep from exiting if we have an undefined string
if (!str) {
return str;
}
// Check to see if we have a markdown link
let logoPath, managedByURL, managedByName;
if (/\[(.*)\]\((.*)\)/.test(str)) {
managedByName = /\[(.*)\]/.exec(str)[1];
logoPath = `/img/logos/${managedByName.toLowerCase().replace(/ /g, '-').replace(/[.,+]/g, '')}-logo.png`;
managedByURL = /\((.*)\)/.exec(str)[1];
} else {
logoPath = `/img/logos/${str.toLowerCase().replace(/ /g, '-').replace(/[.,+]/g, '')}-logo.png`;
}
// Check to see if we have a logo and render that if we do
if (wantLogo && fs.existsSync(`_build/${logoPath}`)) {
return `<a href="${managedByURL}"><img src="${logoPath}" class="managed-by-logo" alt="${managedByName}"></a>`;
}
// No logo if we're here, just render markdown
return marked(str, {renderer: renderer});
},
urlListRenderer: function (urlListData) {
if (!urlListData) {
return "";
}
if (urlListData.Title) { // was a single resource, not a list
return "<p><a href=\"" + urlListData.URL + "\">" + urlListData.Title + "</a></li></p>";
}
var html = "<ul>";
for (var urlIndex in urlListData) {
var urlData = urlListData[urlIndex];
html += "<li><a href=\"" + urlData.URL + "\">" + urlData.Title + "</a></li>";
}
html += "</ul>\n";
return html;
},
tabelaricRenderer: function (tabelaricData) {
if (!tabelaricData) {
return "";
}
if (!tabelaricData.Table) {
return "<p>" + marked(tabelaricData, {renderer: renderer}) + "</p>"; // was a simple non-tabelaric string
}
var html = "";
var tableData = tabelaricData.Table;
html += "<table><thead><tr>";
var cols = [];
for (var colIndex in tableData.Columns) {
var colData = tableData.Columns[colIndex];
cols.push(colData.Name);
html += "<th>" + colData.Title + "</th>";
}
html += "</tr></thead><tbody>";
for (var rowIndex in tableData.Rows) {
html += "<tr>";
var rowData = tableData.Rows[rowIndex];
for (var colIndex in cols) {
var colName = cols[colIndex];
html += "<td>" + rowData[colName] + "</td>";
}
html += "</tr>";
}
html += "</tbody></table>\n";
return html;
},
toType: function (str) {
return str ? str.toLowerCase().replace(/\s/g, '-') : str;
},
arnToBucket: function (str) {
if (str) {
let bucket = str.split(":::", 2)[1];
if (String(bucket).endsWith('/')) {
return bucket;
} else {
return bucket + '/';
}
}
return str;
},
trimHTML: function(passedString, length) {
// This function will trim an HTML string to a desired length
// while keeping links intact.
const regexAllTags = /<[^>]*>/;
const regexIsTag = /<|>/;
const regexOpen = /<[^\/][^>]*>/;
const regexClose = /<\/[^>]*>/;
const regexAttribute = /<[^ ]*/;
let necessaryCount = 0;
if (passedString.replace(regexAllTags, "").length <= length) {
return passedString;
}
const split = passedString.split(regexAllTags);
let counter = '';
split.forEach(item => {
if (counter.length < length && counter.length + item.length >= length) {
necessaryCount = passedString.indexOf(item, counter.length)
+ item.substring(0, length - counter.length).length;
return;
}
counter += item;
});
if (necessaryCount == 0) {
necessaryCount = counter.length;
}
let x = passedString.match(regexIsTag, necessaryCount);
if (x != null && x[0] == ">") {
necessaryCount = x.index + 1;
}
let subs = passedString.substring(0, necessaryCount);
let openTags = subs.match(regexOpen) || [];
let closeTags = subs.match(regexClose) || [];
let OpenTags = [];
openTags.forEach(item => {
let trans = item.toString().match(regexAttribute)[0];
trans = '</' + trans.substring(1, trans.length - 1);
if (trans.charAt(trans.length-1) != '>') {
trans += '>';
}
OpenTags.push(trans);
});
closeTags.forEach((close, index) => {
OpenTags.splice(index, 1);
});
for (var i = OpenTags.length - 1; i >= 0; i--) {
subs += OpenTags[i];
}
subs += '...';
return subs;
}
};
exports.hbsHelpers = hbsHelpers; // exporting for testing purposes
// Clean _output directory
function clean () {
return del(['./_output/**/*', './_tmp/**/*']);
};
// Convert YAML to JSON
function yamlConvert () {
if (!fs.existsSync('./_tmp/')) {
fs.mkdirSync('./_tmp/');
}
var datasetFiles = fs.readdirSync(dataSourcesDirectory).filter(function(file) {
return path.extname(file).toLowerCase() === '.yaml';
});
for (var i in datasetFiles) {
var dataset = jsyaml.parse(fs.readFileSync(path.join(dataSourcesDirectory, datasetFiles[i]), 'utf8'));
var datasetName = path.basename(datasetFiles[i], '.yaml').toLowerCase();
fs.writeFileSync(`./_tmp/${datasetName}.json`, JSON.stringify(dataset));
}
return gulp.src('./_tmp/');
};
// Compile the top level ndjson and move to _output
function jsonOverview (cb) {
// Loop over each dataset JSON and save to in-memory string
const serialize = ndjson.serialize();
let json = '';
serialize.on('data', function(line) {
json += line;
});
const datasets = requireDir('./_tmp');
for (var k in datasets) {
serialize.write(datasets[k]);
}
serialize.end();
// Save string to file
fs.writeFileSync('./_output/index.ndjson', json);
return cb();
};
// Copy CSS files to _output
function css () {
return gulp.src('./_build/css/**/*.css')
.pipe(gulp.dest('./_output/css/'));
};
// Compile the RSS feed and move to _output
function rss () {
var templateData = {
datasets: getDatasets(),
baseURL: process.env.BASE_URL,
buildDate: new Date().toUTCString(),
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/rss.xml.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, handlebars: handlebars}))
.pipe(rename('rss.xml'))
.pipe(gulp.dest('./_output/'));
};
// Copy font files to _output
function fonts () {
return gulp.src('./_build/font/**/*')
.pipe(gulp.dest('./_output/font/'));
};
// Copy images to _output
function img () {
return gulp.src('./_build/img/**/*')
.pipe(gulp.dest('./_output/img/'));
};
// Compile the sitemap and move to _output
function htmlSitemap () {
// Build up sitemap items
let slugs = [];
const datasets = getDatasets();
datasets.forEach((d) => {
// Detail page
slugs.push(d.Slug);
// Tag pages
d.Tags.forEach((t) => {
if (slugs.includes(t) === false) {
slugs.push(`tag/${t.replace(/ /g, '-')}`);
slugs.push(`tag/${t.replace(/ /g, '-')}/usage-examples`);
}
});
});
var templateData = {
slugs: slugs,
baseURL: process.env.BASE_URL,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/sitemap.hbs')
.pipe(hb({data: templateData, handlebars: handlebars}))
.pipe(rename('sitemap.txt'))
.pipe(gulp.dest('./_output/'));
};
// Compile JS and move to _output
function js () {
// HBS templating
var templateData = {
datasets: getDatasets(),
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
const options = {
helpers: hbsHelpers
};
return gulp.src('./_build/**/*.js')
.pipe(hb({data: templateData, helpers: hbsHelpers, handlebars: handlebars}))
.pipe(gulp.dest('./_output/'));
};
// Compile overview page and move to _output
function htmlOverview () {
const datasets = getDatasets();
// Do some work to alter the datasets data for display
datasets.map((d) => {
d.examplesCount = d['DataAtWork'] ? _.flatMap(d['DataAtWork']).length : 0;
return d;
});
// HBS templating
var templateData = {
datasets: datasets,
isHome: true,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/index.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename('index.html'))
.pipe(gulp.dest('./_output/'));
};
// Compile redirect pages and move to _output
function htmlRedirects (cb) {
const file = fs.readFileSync('./_build/config.yaml', 'utf8');
const config = jsyaml.parse(file);
// Exit if we have no redirects
if (!config.redirects) {
return cb();
}
// Create redirect page for each
config.redirects.forEach((r) => {
// HBS templating
const templateData = {
target: r.target,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/redirect.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`${r.source}`))
.pipe(gulp.dest('./_output/'));
});
return cb();
};
// Compile the usage examples page and move to _output
function htmlExamples () {
const templateData = {
datasets: getDatasets(),
isHome: false,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
// Handle pretty name for data at work field
templateData.datasets.forEach((d) => {
if (d.DataAtWork && d.DataAtWork['Tools & Applications']) {
d.DataAtWork.Tools = d.DataAtWork['Tools & Applications'];
delete d.DataAtWork['Tools & Applications'];
}
});
return gulp.src('./_build/examples.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename('index.html'))
.pipe(gulp.dest('./_output/usage-examples/'));
};
// Compile tag usage examples pages and move to _output
function htmlTagUsage (cb) {
const datasets = getDatasets();
// Build up list of unique tags
const tags = getUniqueTags(datasets);
// Loop over each tag and build the page
tags.forEach((t) => {
// Filter out datasets without a matching tag
let filteredDatasets = datasets.filter((d) => {
return d.Tags.includes(t);
});
// HBS templating
var templateData = {
datasets: filteredDatasets,
isHome: false,
tag: t,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/examples.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`tag/${t.replace(/ /g, '-')}/usage-examples/index.html`))
.pipe(gulp.dest('./_output/'));
});
return cb();
};
// Compile detail pages and move to _output
function htmlDetail () {
return gulp.src('./_tmp/*.json')
.pipe(flatmap(function (stream, file) {
var templateData = JSON.parse(file.contents.toString('utf8'));
templateData.rootUrl = process.env.COLLECTIONS_BROWSER_ROOT_URL;
templateData.githubRepo = process.env.GIT_HUB_COLLECTIONS_REPO;
templateData.githubBranch = process.env.GIT_HUB_COLLECTIONS_BRANCH;
// If we have no DataAtWork, remove it
if (!templateData.DataAtWork || (templateData.DataAtWork && _.compact(_.flatMap(templateData.DataAtWork)).length === 0)) {
delete templateData.DataAtWork;
}
// Sort DataAtWork entries by alpha and handle naming
if (templateData.DataAtWork) {
sortDataAtWork(templateData.DataAtWork);
// Handle pretty name for data at work field
if (templateData.DataAtWork['Tools & Applications']) {
templateData.DataAtWork.Tools = templateData.DataAtWork['Tools & Applications'];
delete templateData.DataAtWork['Tools & Applications'];
}
}
// Sort Tags
if (templateData.Tags) {
templateData.Tags.sort((a, b) => a.localeCompare(b))
}
// Generate slug
const slug = generateSlug(file.path);
templateData.Slug = slug;
// Add link to other datasets managed by dataset owner, default to search
if (templateData.ManagedBy) {
let managedByName = templateData.ManagedBy;
// Check if ManagedBy is using Markdown
if (/\[(.*)\]\((.*)\)/.test(templateData.ManagedBy)) {
managedByName = /\[(.*)\]/.exec(templateData.ManagedBy)[1];
}
templateData.managedByLink = `${process.env.COLLECTIONS_BROWSER_ROOT_URL}?search=managedBy:${managedByName.toLowerCase()}`;
templateData.managedByName = managedByName;
}
copyDirectoryWithMDProcessing(`./collections/${slug}`, `./_output/${slug}`);
// Render
return gulp.src('./_build/detail.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`${slug}/index.html`))
.pipe(gulp.dest('./_output/'));
}));
};
// Compile tag pages and move to _output
function htmlTag (cb) {
const datasets = getDatasets();
// Build up list of unique tags
const tags = getUniqueTags(datasets);
// Loop over each tag and build the page
tags.forEach((t) => {
// Filter out datasets without a matching tag
let filteredDatasets = datasets.filter((d) => {
return d.Tags.includes(t);
});
// HBS templating
var templateData = {
datasets: filteredDatasets,
isHome: false,
tag: t,
tagURL: t.replace(/ /g, '-'),
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/index.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`tag/${t.replace(/ /g, '-')}/index.html`))
.pipe(gulp.dest('./_output/'));
});
return cb();
};
// Compile page for when datasets were added
function htmlAdditions (cb) {
const datasets = getDatasets();
// Build up list of unique tags
const dates = getUniqueDates(datasets);
var filteredDatasets = {};
reduce(dates, function(acc, key) {
// Filter out datasets without a matching tag
acc[key] = datasets.filter((d) => {
return d.RegistryEntryAdded == key;
});
return acc;
}, filteredDatasets);
// HBS templating
var templateData = {
datasets: filteredDatasets,
isHome: false,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/changelogindex.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`change-log/index.html`))
.pipe(gulp.dest('./_output/'));
};
// Compile providers page and move to _output
function htmlProviders (cb) {
const logos = fs.readdirSync('./_build/img/logos').map((c) => {
return `img/logos/${c}`;
});
// HBS templating
const templateData = {
Providers: logos,
rootUrl: process.env.COLLECTIONS_BROWSER_ROOT_URL,
githubRepo: process.env.GIT_HUB_COLLECTIONS_REPO,
githubBranch: process.env.GIT_HUB_COLLECTIONS_BRANCH
};
return gulp.src('./_build/providers.hbs')
.pipe(hb({data: templateData, helpers: hbsHelpers, partials: ['./_build/partials/*'], handlebars: handlebars}))
.pipe(rename(`/providers.html`))
.pipe(gulp.dest('./_output/'));
};
// Server with live reload
exports.serve = gulp.series(clean, gulp.parallel(css, fonts, img, yamlConvert), jsonOverview, js, rss, gulp.parallel(htmlAdditions, htmlDetail, htmlOverview, htmlSitemap, htmlExamples, htmlTag, htmlTagUsage, htmlProviders), htmlRedirects, function () {
browserSync({
port: 3000,
server: {
baseDir: ['_output']
}
});
// watch for changes and add a debounce for _output changes
var timer;
gulp.watch([
'_output/**/*'
]).on('change', function () {
clearTimeout(timer);
timer = setTimeout(function () {
reload();
}, 500);
});
gulp.watch('_build/**/*', gulp.series('default'));
});
exports.build = gulp.series(clean, gulp.parallel(css, fonts, img, yamlConvert), jsonOverview, js, rss, gulp.parallel(htmlAdditions, htmlDetail, htmlOverview, htmlSitemap, htmlExamples, htmlTag, htmlTagUsage, htmlProviders), htmlRedirects);
exports.default = exports.build;