blob: e269b14df7312368b701256f7788e35f0f2fe2e9 (
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
108
109
|
const Immutable = require('immutable');
const error = require('../utils/error');
const File = require('./file');
const GlossaryEntry = require('./glossaryEntry');
const parsers = require('../parsers');
const Glossary = Immutable.Record({
file: File(),
entries: Immutable.OrderedMap()
});
Glossary.prototype.getFile = function() {
return this.get('file');
};
Glossary.prototype.getEntries = function() {
return this.get('entries');
};
/**
Return an entry by its name
@param {String} name
@return {GlossaryEntry}
*/
Glossary.prototype.getEntry = function(name) {
const entries = this.getEntries();
const id = GlossaryEntry.nameToID(name);
return entries.get(id);
};
/**
Render glossary as text
@return {Promise<String>}
*/
Glossary.prototype.toText = function(parser) {
const file = this.getFile();
const entries = this.getEntries();
parser = parser ? parsers.getByExt(parser) : file.getParser();
if (!parser) {
throw error.FileNotParsableError({
filename: file.getPath()
});
}
return parser.renderGlossary(entries.toJS());
};
/**
Add/Replace an entry to a glossary
@param {Glossary} glossary
@param {GlossaryEntry} entry
@return {Glossary}
*/
Glossary.addEntry = function addEntry(glossary, entry) {
const id = entry.getID();
let entries = glossary.getEntries();
entries = entries.set(id, entry);
return glossary.set('entries', entries);
};
/**
Add/Replace an entry to a glossary by name/description
@param {Glossary} glossary
@param {GlossaryEntry} entry
@return {Glossary}
*/
Glossary.addEntryByName = function addEntryByName(glossary, name, description) {
const entry = new GlossaryEntry({
name,
description
});
return Glossary.addEntry(glossary, entry);
};
/**
Create a glossary from a list of entries
@param {String} filename
@param {Array|List} entries
@return {Glossary}
*/
Glossary.createFromEntries = function createFromEntries(file, entries) {
entries = entries.map(function(entry) {
if (!(entry instanceof GlossaryEntry)) {
entry = new GlossaryEntry(entry);
}
return [entry.getID(), entry];
});
return new Glossary({
file,
entries: Immutable.OrderedMap(entries)
});
};
module.exports = Glossary;
|
