/**
* All writing related code here. This is so that we can separate the async code from sync code
* for testability
*/
var qfs = require('q-fs');
var Q = require('qq');
var OUTPUT_DIR = 'build/docs/';
var fs = require('fs');
exports.output = output;
function output(file, content) {
var fullPath = OUTPUT_DIR + file;
var dir = parent(fullPath);
return Q.when(exports.makeDir(dir), function(error) {
qfs.write(fullPath, exports.toString(content));
});
};
//recursively create directory
exports.makeDir = function(p) {
var parts = p.split(/\//);
var path = ".";
// Recursively rebuild directory structure
return qfs.exists(p).
then(function createPart(exists) {
if(!exists && parts.length) {
path += "/" + parts.shift();
return qfs.exists(path).then(function(exists) {
if (!exists) {
return qfs.makeDirectory(path).then(createPart, createPart);
} else {
return createPart();
}
});
}
});
};
exports.copyTemplate = function(filename) {
return exports.copy('docs/src/templates/' + filename, filename);
};
/* Copy files from one place to another.
* @param from{string} path of the source file to be copied
* @param to{string} path of where the copied file should be stored
* @param transform{function=} transfromation function to be applied before return
*/
exports.copy = function(from, to, transform) {
var args = Array.prototype.slice.call(arguments, 3);
// We have to use binary reading, Since some characters are unicode.
return qfs.read(from, 'b').then(function(content) {
if (transform) {
args.unshift(content.toString());
content = transform.apply(null, args);
}
return output(to, content);
});
};
exports.symlink = symlink;
function symlink(from, to) {
return qfs.exists(to).then(function(exists) {
if (!exists) {
return qfs.symbolicLink(to, from);
}
});
}
exports.symlinkTemplate = symlinkTemplate;
function symlinkTemplate(filename) {
var dest = OUTPUT_DIR + filename,
dirDepth = dest.split('/').length,
src = Array(dirDepth).join('../') + 'docs/src/templates/' + filename;
return symlink(src, dest);
}
/* Replace placeholders in content accordingly
* @param content{string} content to be modified
* @param replacements{obj} key and value pairs in which key will be replaced with value in content
*/
exports.replace = function(content, replacements) {
for(key in replacements) {
content = content.replace(key, replacements[key]);
}
return content;
}
exports.copyDir = function copyDir(dir) {
return qfs.listTree('docs/' + dir).then(function(files) {
files.forEach(function(file) {
exports.copy(file, file.replace(/^docs\//, ''));
});
});
};
exports.merge = function(srcs, to) {
return merge(srcs.map(function(src) { return 'docs/src/templates/' + src; }), to);
};
function merge(srcs, to) {
var contents = [];
//Sequentially read file
var done;
srcs.forEach(function(src) {
done = Q.when(done, function(content) {
if(content) contents.push(content);
return qfs.read(src, 'b');
});
});
// write to file
return Q.when(done, function(content) {
contents.push(content);
return output(to, contents.join('\n'));
});
}
//----------------------- Synchronous Methods ----------------------------------
function parent(file) {
var parts = file.split('/');
parts.pop();
return parts.join('/');
}
exports.toString = function toString(obj) {
switch (typeof obj) {
case 'string':
return obj;
case 'object':
if (obj instanceof Array) {
obj.forEach(function(value, key) {
obj[key] = toString(value);
});
return obj.join('');
} else if (obj.constructor.name == 'Buffer'){
// do nothing it is Buffer Object
} else {
return JSON.stringify(obj);
}
}
return obj;
};
function noop() {};
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
|