1 | 'use strict';
|
2 |
|
3 | var Base = require('base');
|
4 | var debug = require('debug')('base:templates:list');
|
5 | var plugin = require('./plugins');
|
6 | var Group = require('./group');
|
7 | var utils = require('./utils');
|
8 |
|
9 |
|
10 |
|
11 |
|
12 |
|
13 | module.exports = exports = List;
|
14 |
|
15 |
|
16 |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 | function List(options) {
|
30 | if (!(this instanceof List)) {
|
31 | return new List(options);
|
32 | }
|
33 |
|
34 | Base.call(this);
|
35 |
|
36 | this.is('list');
|
37 | this.define('isCollection', true);
|
38 | this.use(utils.option());
|
39 | this.use(utils.plugin());
|
40 | this.init(options || {});
|
41 | }
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 | plugin.static(Base, List, 'List');
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 | List.prototype.init = function(opts) {
|
54 | debug('initalizing');
|
55 |
|
56 |
|
57 | this.define('Item', opts.Item || List.Item);
|
58 | this.define('View', opts.View || List.View);
|
59 |
|
60 |
|
61 | this.use(plugin.init);
|
62 | this.use(plugin.renameKey());
|
63 | this.use(plugin.context);
|
64 | this.use(utils.engines());
|
65 | this.use(utils.helpers());
|
66 | this.use(utils.routes());
|
67 | this.use(plugin.item('item', 'Item', {emit: false}));
|
68 | this.use(plugin.item('view', 'View', {emit: false}));
|
69 |
|
70 |
|
71 | plugin.is(this.Item);
|
72 | plugin.is(this.View);
|
73 |
|
74 | this.queue = [];
|
75 | this.items = [];
|
76 | this.keys = [];
|
77 |
|
78 |
|
79 | if (Array.isArray(opts) || opts.isList) {
|
80 | this.options = opts.options || {};
|
81 | this.addList(opts.items || opts);
|
82 |
|
83 | } else if (opts.isCollection) {
|
84 | this.options = opts.options;
|
85 | this.addItems(opts.views);
|
86 |
|
87 | } else {
|
88 | this.options = opts;
|
89 | }
|
90 | };
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 | List.prototype.addItem = function(key, value) {
|
109 | var item = this.item(key, value);
|
110 | utils.setInstanceNames(item, 'Item');
|
111 |
|
112 | debug('adding item "%s"', item.key);
|
113 |
|
114 | if (this.options.pager === true) {
|
115 | List.addPager(item, this.items);
|
116 | }
|
117 |
|
118 | this.keys.push(item.key);
|
119 | if (typeof item.use === 'function') {
|
120 | this.run(item);
|
121 | }
|
122 |
|
123 | this.extendItem(item);
|
124 | this.emit('load', item, this);
|
125 | this.emit('item', item, this);
|
126 |
|
127 | this.items.push(item);
|
128 | return item;
|
129 | };
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 |
|
145 |
|
146 | List.prototype.setItem = function(/*key, value*/) {
|
147 | this.addItem.apply(this, arguments);
|
148 | return this;
|
149 | };
|
150 |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 | List.prototype.addItems = function(items) {
|
167 | if (Array.isArray(items)) {
|
168 | return this.addList.apply(this, arguments);
|
169 | }
|
170 |
|
171 | this.emit('addItems', items);
|
172 | if (this.loaded) {
|
173 | this.loaded = false;
|
174 | return this;
|
175 | }
|
176 |
|
177 | this.visit('addItem', items);
|
178 | return this;
|
179 | };
|
180 |
|
181 |
|
182 |
|
183 |
|
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 | List.prototype.addList = function(list, fn) {
|
196 | this.emit.call(this, 'addList', list);
|
197 | if (this.loaded) {
|
198 | this.loaded = false;
|
199 | return this;
|
200 | }
|
201 |
|
202 | if (!Array.isArray(list)) {
|
203 | throw new TypeError('expected list to be an array.');
|
204 | }
|
205 |
|
206 | if (typeof fn !== 'function') {
|
207 | fn = utils.identity;
|
208 | }
|
209 |
|
210 | var len = list.length, i = -1;
|
211 | while (++i < len) {
|
212 | var item = list[i];
|
213 | fn(item);
|
214 | this.addItem(item.path, item);
|
215 | }
|
216 | return this;
|
217 | };
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 | List.prototype.hasItem = function(key) {
|
233 | return this.getIndex(key) !== -1;
|
234 | };
|
235 |
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 | List.prototype.getIndex = function(key) {
|
249 | if (typeof key === 'undefined') {
|
250 | throw new Error('expected a string or instance of Item');
|
251 | }
|
252 |
|
253 | if (List.isItem(key)) {
|
254 | key = key.key;
|
255 | }
|
256 |
|
257 | var idx = this.keys.indexOf(key);
|
258 | if (idx !== -1) {
|
259 | return idx;
|
260 | }
|
261 |
|
262 | idx = this.keys.indexOf(this.renameKey(key));
|
263 | if (idx !== -1) {
|
264 | return idx;
|
265 | }
|
266 |
|
267 | var items = this.items;
|
268 | var len = items.length;
|
269 |
|
270 | while (len--) {
|
271 | var item = items[len];
|
272 | var prop = this.renameKey(key, item);
|
273 | if (utils.matchFile(prop, item)) {
|
274 | return len;
|
275 | }
|
276 | }
|
277 | return -1;
|
278 | };
|
279 |
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 | List.prototype.getItem = function(key) {
|
293 | var idx = this.getIndex(key);
|
294 | if (idx !== -1) {
|
295 | return this.items[idx];
|
296 | }
|
297 | };
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
|
311 | List.prototype.getView = function() {
|
312 | return this.getItem.apply(this, arguments);
|
313 | };
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 | List.prototype.deleteItem = function(item) {
|
326 | var idx = this.getIndex(item);
|
327 | if (idx !== -1) {
|
328 | this.items.splice(idx, 1);
|
329 | this.keys.splice(idx, 1);
|
330 | }
|
331 | return this;
|
332 | };
|
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 |
|
344 | List.prototype.extendItem = function(item) {
|
345 | plugin.view(this, item);
|
346 | return this;
|
347 | };
|
348 |
|
349 |
|
350 |
|
351 |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 | List.prototype.groupBy = function() {
|
364 | var args = [].slice.call(arguments);
|
365 | var fn = utils.groupBy;
|
366 |
|
367 |
|
368 | args.unshift(this.items.slice());
|
369 |
|
370 |
|
371 | return new Group(fn.apply(fn, args));
|
372 | };
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 | List.prototype.sortBy = function() {
|
390 | var args = [].slice.call(arguments);
|
391 | var last = args[args.length - 1];
|
392 | var opts = this.options.sort || {};
|
393 |
|
394 |
|
395 | if (last && typeof last === 'object' && !Array.isArray(last)) {
|
396 | opts = utils.extend({}, opts, args.pop());
|
397 | }
|
398 |
|
399 |
|
400 | args.unshift(this.items.slice());
|
401 | args.push(opts);
|
402 |
|
403 |
|
404 | var items = utils.sortBy.apply(utils.sortBy, args);
|
405 | var list = new List(this.options);
|
406 | list.addItems(items);
|
407 | return list;
|
408 | };
|
409 |
|
410 |
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 |
|
417 | List.prototype.resolveLayout = function(item) {
|
418 | if (utils.isRenderable(item) && typeof item.layout === 'undefined') {
|
419 | return this.option('layout');
|
420 | }
|
421 | return item.layout;
|
422 | };
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 |
|
431 |
|
432 |
|
433 |
|
434 |
|
435 |
|
436 |
|
437 | List.prototype.paginate = function() {
|
438 | var args = [].slice.call(arguments);
|
439 | var fn = utils.paginationator;
|
440 |
|
441 |
|
442 | args.unshift(this.items.slice());
|
443 |
|
444 |
|
445 | var items = fn.apply(fn, args);
|
446 | return items.pages;
|
447 | };
|
448 |
|
449 |
|
450 |
|
451 |
|
452 |
|
453 |
|
454 |
|
455 |
|
456 |
|
457 | List.addPager = function addPager(item, items) {
|
458 | item.data.pager = {};
|
459 | item.data.pager.index = items.length;
|
460 | utils.define(item.data.pager, 'current', item);
|
461 |
|
462 | if (items.length) {
|
463 | var prev = items[items.length - 1];
|
464 | utils.define(item.data.pager, 'prev', prev);
|
465 | utils.define(prev.data.pager, 'next', item);
|
466 | }
|
467 | };
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 | utils.define(List, 'Item', require('vinyl-item'));
|
474 | utils.define(List, 'View', require('vinyl-view'));
|