summaryrefslogtreecommitdiffstats
path: root/lib/models/summary.js
blob: 4ab2d680d972580329eaf1e6c959342af9ec9a90 (plain)
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
var Immutable = require('immutable');

var File = require('./file');
var SummaryPart = require('./summaryPart');
var SummaryArticle = require('./summaryArticle');

var Summary = Immutable.Record({
    file:       File(),
    parts:      Immutable.List()
});

Summary.prototype.getFile = function() {
    return this.get('file');
};

Summary.prototype.getParts = function() {
    return this.get('parts');
};

/**
    Return a part/article by its level

    @param {String} level
    @return {Part|Article}
*/
Summary.prototype.getByLevel = function(level) {
    return SummaryArticle.getByLevel(this, level, 'getParts');
};

/**
    Return an article by its path

    @param {String} filePath
    @return {Part|Article}
*/
Summary.prototype.getByPath = function(filePath) {
    // todo

    return undefined;
};

/**
    Create a new summary for a list of parts

    @param {Lust|Array} parts
    @return {Summary}
*/
Summary.createFromParts = function createFromParts(file, parts) {
    parts = parts.map(function(part, i) {
        if (part instanceof SummaryPart) {
            return part;
        }

        return SummaryPart.create(part, i);
    });

    return new Summary({
        file: file,
        parts: new Immutable.List(parts)
    });
};

module.exports = Summary;