summaryrefslogtreecommitdiffstats
path: root/lib/models/output.js
blob: 0f008ecfd5ee5eed6ada0664ee22a132b25b6deb (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
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
var Immutable = require('immutable');

var Book = require('./book');
var LocationUtils = require('../utils/location');

var Output = Immutable.Record({
    book:       Book(),

    // Name of the generator being used
    generator:  String(),

    // Map of plugins to use (String -> Plugin)
    plugins:    Immutable.OrderedMap(),

    // Map pages to generation (String -> Page)
    pages:      Immutable.OrderedMap(),

    // List assets (String)
    assets:     Immutable.List(),

    // Option for the generation
    options:    Immutable.Map(),

    // Internal state for the generation
    state:      Immutable.Map()
});

Output.prototype.getBook = function() {
    return this.get('book');
};

Output.prototype.getGenerator = function() {
    return this.get('generator');
};

Output.prototype.getPlugins = function() {
    return this.get('plugins');
};

Output.prototype.getPages = function() {
    return this.get('pages');
};

Output.prototype.getOptions = function() {
    return this.get('options');
};

Output.prototype.getAssets = function() {
    return this.get('assets');
};

Output.prototype.getState = function() {
    return this.get('state');
};

/**
    Return a page byt its file path

    @param {String} filePath
    @return {Page|undefined}
*/
Output.prototype.getPage = function(filePath) {
    filePath = LocationUtils.normalize(filePath);

    var pages = this.getPages();
    return pages.get(filePath);
};

/**
    Get root folder for output

    @return {String}
*/
Output.prototype.getRoot = function() {
    return this.getOptions().get('root');
};

/**
    Update state of output

    @param {Map} newState
    @return {Output}
*/
Output.prototype.setState = function(newState) {
    return this.set('state', newState);
};

/**
    Update options

    @param {Map} newOptions
    @return {Output}
*/
Output.prototype.setOptions = function(newOptions) {
    return this.set('options', newOptions);
};

/**
    Return logegr for this output (same as book)

    @return {Logger}
*/
Output.prototype.getLogger = function() {
    return this.getBook().getLogger();
};

module.exports = Output;