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
|
var _ = require('lodash');
var util = require('util');
var url = require('url');
var location = require('../utils/location');
var error = require('../utils/error');
var BackboneFile = require('./file');
/*
An article represent an entry in the Summary.
It's defined by a title, a reference, and children articles, the reference (ref) can be a filename + anchor or an external file (optional)
*/
function TOCArticle(summary, title, ref, articles, parent) {
this.summary = summary;
this.title = title;
this.parent = parent;
if (ref && location.isExternal(ref)) {
throw error.ParsingError(new Error('SUMMARY can only contains relative locations'));
}
if (!title) {
throw error.ParsingError(new Error('SUMMARY entries should have an non-empty title'));
}
var parts = url.parse(ref);
this.path = parts.pathname;
this.anchor = parts.hash;
this.articles = _.map(articles || [], function(article) {
if (article instanceof TOCArticle) return article;
return new TOCArticle(article.title, article.ref, article.articles, this);
}, this);
}
// Iterate over all articles in this articles
TOCArticle.prototype.walk = function(iter) {
_.each(this.articles, function(article) {
iter(article);
article.walk(iter);
});
};
// Return templating context for an article
TOCArticle.prototype.getContext = function() {
return {
title: this.title,
path: this.path
};
};
// Return true if is pointing to a file
TOCArticle.prototype.hasLocation = function() {
return Boolean(this.path);
};
// Return true if has children
TOCArticle.prototype.hasChildren = function() {
return this.articles.length > 0;
};
// Return true if has an article as parent
TOCArticle.prototype.hasParent = function() {
return (this.parent instanceof TOCArticle);
};
// Return next article in the TOC
TOCArticle.prototype.next = function() {
var parentsArticles = this.parent.articles;
var pos = _.findIndex(parentsArticles, this);
if ((pos + 1) >= parentsArticles.length) {
if (this.hasParent()) {
return this.parent.next();
} else {
return null;
}
} else {
// next has the same parent
return parentsArticles[pos + 1];
}
};
// Return previous article in the TOC
TOCArticle.prototype.prev = function() {
var parentsArticles = this.parent.articles;
var pos = _.findIndex(parentsArticles, this);
if ((pos - 1) < 0) {
if (this.hasParent()) {
return this.parent.prev();
} else {
return null;
}
} else {
// prev has the same parent
return parentsArticles[pos - 1];
}
};
/*
A part of a ToC is a composed of a tree of articles.
*/
function TOCPart(summary, part) {
var that = this;
this.summary = summary;
this.articles = _.map(part.articles || part.chapters, function(article) {
return new TOCArticle(that.summary, article.title, article.path, article.articles, this);
}, this);
}
// Iterate over all entries of the part
TOCPart.prototype.walk = function(iter) {
_.each(this.articles, function(article) {
if (iter(article) === false) {
return false;
}
article.walk(iter);
});
};
/*
A summary is composed of a list of parts, each composed wit a tree of articles.
*/
function Summary() {
BackboneFile.apply(this, arguments);
this.parts = [];
this._length = 0;
}
util.inherits(Summary, BackboneFile);
Summary.prototype.type = 'summary';
// Parse the summary content
Summary.prototype.parse = function(content) {
var that = this;
return this.parser.summary(content)
// TODO: update GitBook's parsers to return a list of parts
.then(function(part) {
that.parts = [new TOCPart(that, part)];
// Update count of articles
that._length = 0;
that.walk(function() {
that._length += 1;
});
});
};
// Iterate over all entries of the summary
// iter is called with an TOCArticle
Summary.prototype.walk = function(iter) {
_.each(this.parts, function(part) {
part.walk(iter);
});
};
// Find a specific article using a filter
Summary.prototype.find = function(filter) {
var result;
this.walk(function(article) {
if (filter(article)) {
result = article;
return false;
}
});
return result;
};
// Return the first TOCArticle for a specific page (or path)
Summary.prototype.getArticle = function(page) {
if (!_.isString(page)) page = page.path;
return this.find(function(article) {
return article.path == page;
});
};
// Return the count of articles in the summary
Summary.prototype.count = function() {
return this._length;
};
module.exports = Summary;
|
