SAP / ui5-fs / 317

pending completion

Build # 317

Build Type

push

travis-ci

Committed by

RandomByte

Commit Message

[INTERNAL] JSDoc: Refactor to use module: syntax and fix various docs

Run Details

171 of 221 branches covered (77.38%)

Branch coverage included in aggregate %.

33 of 40 new or added lines in 3 files covered. (82.5%)

11 existing lines in 2 files now uncovered.

449 of 515 relevant lines covered (87.18%)

59.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.35

/lib/Resource.js

const stream = require("stream");
const clone = require("clone");
const path = require("path");

const fnTrue = () => true;
const fnFalse = () => false;

/**
 * Resource
 *
 * @public
 * @memberof module:@ui5/fs
 */
class Resource {
        /**
         * The constructor.
         *
         * @public
         * @param {Object} parameters Parameters
         * @param {string} parameters.path Virtual path
         * @param {Object} [parameters.statInfo] File stat information
         * @param {Buffer} [parameters.buffer] Content of this resources as a Buffer instance
         *                                        (cannot be used in conjunction with parameters string, stream or createStream)
         * @param {string} [parameters.string] Content of this resources as a string
         *                                        (cannot be used in conjunction with parameters buffer, stream or createStream)
         * @param {Stream} [parameters.stream] Readable stream of the content of this resource
         *                                        (cannot be used in conjunction with parameters buffer, string or createStream)
         * @param {Function} [parameters.createStream] Function callback that returns a readable stream of the content
         *                                        of this resource (cannot be used in conjunction with parameters buffer, string or stream)
         */
        constructor({path, statInfo, buffer, string, createStream, stream, project}) {
                if (!path) {
                        throw new Error("Cannot create Resource: path parameter missing");
                }
                if (buffer && createStream || buffer && string || string && createStream || buffer && stream ||
                                string && stream || createStream && stream) {
                        throw new Error("Cannot create Resource: Please set only one content parameter. " +
                                "Buffer, string, stream or createStream");
                }

                this._path = path;
                this._name = this._getNameFromPath(path);
                this._project = project; // Experimental, internal parameter
                this._statInfo = statInfo || { // TODO
                        isFile: fnTrue,
                        isDirectory: fnFalse,
                        isBlockDevice: fnFalse,
                        isCharacterDevice: fnFalse,
                        isSymbolicLink: fnFalse,
                        isFIFO: fnFalse,
                        isSocket: fnFalse,
                        atimeMs: new Date().getTime(),
                        mtimeMs: new Date().getTime(),
                        ctimeMs: new Date().getTime(),
                        birthtimeMs: new Date().getTime(),
                        atime: new Date(),
                        mtime: new Date(),
                        ctime: new Date(),
                        birthtime: new Date()
                };

                this._createStream = createStream || null;
                this._stream = stream || null;
                this._buffer = buffer || null;
                if (string) {
                        this._buffer = Buffer.from(string, "utf8");
                }

                // Tracing:
                this._collections = [];
        }

        /**
         * Gets a buffer with the resource content.
         *
         * @public
         * @returns {Promise<Buffer>} A Promise resolving with a buffer of the resource content.
         */
        getBuffer() {
                return new Promise((resolve, reject) => {
                        if (this._buffer) {
                                resolve(this._buffer);
                        } else if (this._createStream || this._stream) {
                                resolve(this._getBufferFromStream());
                        } else {
                                reject(new Error(`Resource ${this._path} has no content`));
                        }
                });
        }

        /**
         * Sets a Buffer as content.
         *
         * @public
         * @param {Buffer} buffer A buffer instance
         */
        setBuffer(buffer) {
                this._createStream = null;
                // if (this._stream) { // TODO this may cause strange issues
                //         this._stream.destroy();
                // }
                this._stream = null;
                this._buffer = buffer;
        }

        /**
         * Gets a string with the resource content.
         *
         * @public
         * @returns {Promise<string>} A Promise resolving with a string of the resource content.
         */
        getString() {
                return this.getBuffer().then((buffer) => buffer.toString());
        }

        /**
         * Sets a String as content
         *
         * @public
         * @param {string} string A string
         */
        setString(string) {
                this.setBuffer(Buffer.from(string, "utf8"));
        }

        /**
         * Gets a readable stream for the resource content.
         *
         * @public
         * @returns {stream.Readable} A readable stream for the resource content.
         */
        getStream() {
                if (this._buffer) {
                        const bufferStream = new stream.PassThrough();
                        bufferStream.end(this._buffer);
                        return bufferStream;
                } else if (this._createStream || this._stream) {
                        return this._getStream();
                } else {
                        throw new Error(`Resource ${this._path} has no content`);
                }
        }

        /**
         * Sets a readable stream as content.
         *
         * @public
         * @param {stream.Readable} stream readable stream
         */
        setStream(stream) {
                this._buffer = null;
                this._createStream = null;
                // if (this._stream) { // TODO this may cause strange issues
                //         this._stream.destroy();
                // }
                this._stream = stream;
        }

        /**
         * Gets the resources path
         *
         * @public
         * @returns {string} (Virtual) path of the resource
         */
        getPath() {
                return this._path;
        }

        /**
         * Sets the resources path
         *
         * @public
         * @param {string} path (Virtual) path of the resource
         */
        setPath(path) {
                this._path = path;
                this._name = this._getNameFromPath(path);
        }

        /**
         * Gets the resources stat info.
         *
         * @public
         * @returns {fs.Stats} An object representing an fs.Stats instance
         */
        getStatInfo() {
                return this._statInfo;
        }

        _getNameFromPath(virPath) {
                return path.posix.basename(virPath);
        }

        /**
         * Adds a resource collection name that was involved in locating this resource.
         *
         * @param {string} name Resource collection name
         */
        pushCollection(name) {
                this._collections.push(name);
        }

        /**
         * Returns a clone of the resource.
         *
         * @public
         * @returns {Promise<module:@ui5/fs.Resource>} A promise resolving the resource.
         */
        clone() {
                const options = {
                        path: this._path,
                        statInfo: clone(this._statInfo)
                };

                const addContentOption = () => {
                        if (this._stream) {
                                return this._getBufferFromStream().then(function(buffer) {
                                        options.buffer = buffer;
                                });
                        } else {
                                if (this._createStream) {
                                        options.createStream = this._createStream;
                                } else if (this._buffer) {
                                        options.buffer = this._buffer;
                                }
                                return Promise.resolve();
                        }
                };

                return addContentOption().then(() => {
                        return new Resource(options);
                });
        }

        /**
         * Tracing: Get tree for printing out trace
         *
         * @returns {Object}
         */
        getPathTree() {
                const tree = {};

                let pointer = tree[this._path] = {};

                for (let i = this._collections.length - 1; i >= 0; i--) {
                        pointer = pointer[this._collections[i]] = {};
                }

                return tree;
        }

        /**
         * Returns the content as stream.
         *
         * @private
         * @returns {Function} The stream
         */
        _getStream() {
                if (this._createStream) {
                        return this._createStream();
                }
                return this._stream;
        }

        /**
         * Converts the buffer into a stream.
         *
         * @private
         * @returns {Promise<Buffer>} Promise resolving with buffer.
         */
        _getBufferFromStream() {
                return new Promise((resolve, reject) => {
                        const contentStream = this._getStream();
                        const buffers = [];
                        contentStream.on("data", (data) => {
                                buffers.push(data);
                        });
                        contentStream.on("error", (err) => {
                                reject(err);
                        });
                        contentStream.on("end", () => {
                                const buffer = Buffer.concat(buffers);
                                this.setBuffer(buffer);
                                resolve(buffer);
                        });
                });
        }
}

module.exports = Resource;

1	const stream = require("stream");	18✔
2	const clone = require("clone");	18✔
3	const path = require("path");	18✔
4
5	const fnTrue = () => true;	18✔
6	const fnFalse = () => false;	18✔
7
8	/**
9	* Resource
10	*
11	* @public
12	* @memberof module:@ui5/fs
13	*/
14	class Resource {
15	/**
16	* The constructor.
17	*
18	* @public
19	* @param {Object} parameters Parameters
20	* @param {string} parameters.path Virtual path
21	* @param {Object} [parameters.statInfo] File stat information
22	* @param {Buffer} [parameters.buffer] Content of this resources as a Buffer instance
23	* (cannot be used in conjunction with parameters string, stream or createStream)
24	* @param {string} [parameters.string] Content of this resources as a string
25	* (cannot be used in conjunction with parameters buffer, stream or createStream)
26	* @param {Stream} [parameters.stream] Readable stream of the content of this resource
27	* (cannot be used in conjunction with parameters buffer, string or createStream)
28	* @param {Function} [parameters.createStream] Function callback that returns a readable stream of the content
29	* of this resource (cannot be used in conjunction with parameters buffer, string or stream)
30	*/
31	constructor({path, statInfo, buffer, string, createStream, stream, project}) {
32	if (!path) {	552✔
33	throw new Error("Cannot create Resource: path parameter missing");	3✔
34	}
35	if (buffer && createStream \|\| buffer && string \|\| string && createStream \|\| buffer && stream \|\|	549✔
36	string && stream \|\| createStream && stream) {
37	throw new Error("Cannot create Resource: Please set only one content parameter. " +	3✔
38	"Buffer, string, stream or createStream");
39	}
40
41	this._path = path;	546✔
42	this._name = this._getNameFromPath(path);	546✔
43	this._project = project; // Experimental, internal parameter	546✔
44	this._statInfo = statInfo \|\| { // TODO	546✔
45	isFile: fnTrue,
46	isDirectory: fnFalse,
47	isBlockDevice: fnFalse,
48	isCharacterDevice: fnFalse,
49	isSymbolicLink: fnFalse,
50	isFIFO: fnFalse,
51	isSocket: fnFalse,
52	atimeMs: new Date().getTime(),
53	mtimeMs: new Date().getTime(),
54	ctimeMs: new Date().getTime(),
55	birthtimeMs: new Date().getTime(),
56	atime: new Date(),
57	mtime: new Date(),
58	ctime: new Date(),
59	birthtime: new Date()
60	};
61
62	this._createStream = createStream \|\| null;	546✔
63	this._stream = stream \|\| null;	546✔
64	this._buffer = buffer \|\| null;	546✔
65	if (string) {	546✔
66	this._buffer = Buffer.from(string, "utf8");	12✔
67	}
68
69	// Tracing:
70	this._collections = [];	546✔
71	}
72
73	/**
74	* Gets a buffer with the resource content.
75	*
76	* @public
77	* @returns {Promise<Buffer>} A Promise resolving with a buffer of the resource content.
78	*/
79	getBuffer() {
80	return new Promise((resolve, reject) => {	57✔
81	if (this._buffer) {	57✔
82	resolve(this._buffer);	36✔
83	} else if (this._createStream \|\| this._stream) {	21✔
84	resolve(this._getBufferFromStream());	18✔
85	} else {
86	reject(new Error(`Resource ${this._path} has no content`));	3✔
87	}
88	});
89	}
90
91	/**
92	* Sets a Buffer as content.
93	*
94	* @public
95	* @param {Buffer} buffer A buffer instance
96	*/
97	setBuffer(buffer) {
98	this._createStream = null;	24✔
99	// if (this._stream) { // TODO this may cause strange issues
100	// this._stream.destroy();
101	// }
102	this._stream = null;	24✔
103	this._buffer = buffer;	24✔
104	}
105
106	/**
107	* Gets a string with the resource content.
108	*
109	* @public
110	* @returns {Promise<string>} A Promise resolving with a string of the resource content.
111	*/
112	getString() {
113	return this.getBuffer().then((buffer) => buffer.toString());	24✔
114	}
115
116	/**
117	* Sets a String as content
118	*
119	* @public
120	* @param {string} string A string
121	*/
122	setString(string) {
123	this.setBuffer(Buffer.from(string, "utf8"));	3✔
124	}
125
126	/**
127	* Gets a readable stream for the resource content.
128	*
129	* @public
130	* @returns {stream.Readable} A readable stream for the resource content.
131	*/
132	getStream() {
133	if (this._buffer) {	9✔
134	const bufferStream = new stream.PassThrough();	3✔
135	bufferStream.end(this._buffer);	3✔
136	return bufferStream;	3✔
137	} else if (this._createStream \|\| this._stream) {	6✔
138	return this._getStream();	3✔
139	} else {
140	throw new Error(`Resource ${this._path} has no content`);	3✔
141	}
142	}
143
144	/**
145	* Sets a readable stream as content.
146	*
147	* @public
148	* @param {stream.Readable} stream readable stream
149	*/
150	setStream(stream) {
151	this._buffer = null;	6✔
152	this._createStream = null;	6✔
153	// if (this._stream) { // TODO this may cause strange issues
154	// this._stream.destroy();
155	// }
156	this._stream = stream;	6✔
157	}
158
159	/**
160	* Gets the resources path
161	*
162	* @public
163	* @returns {string} (Virtual) path of the resource
164	*/
165	getPath() {
166	return this._path;	462✔
167	}
168
169	/**
170	* Sets the resources path
171	*
172	* @public
173	* @param {string} path (Virtual) path of the resource
174	*/
175	setPath(path) {
176	this._path = path;	3✔
177	this._name = this._getNameFromPath(path);	3✔
178	}
179
180	/**
181	* Gets the resources stat info.
182	*
183	* @public
184	* @returns {fs.Stats} An object representing an fs.Stats instance
185	*/
186	getStatInfo() {
187	return this._statInfo;	18✔
188	}
189
190	_getNameFromPath(virPath) {
191	return path.posix.basename(virPath);	549✔
192	}
193
194	/**
195	* Adds a resource collection name that was involved in locating this resource.
196	*
197	* @param {string} name Resource collection name
198	*/
199	pushCollection(name) {
200	this._collections.push(name);	6✔
201	}
202
203	/**
204	* Returns a clone of the resource.
205	*
206	* @public
207	* @returns {Promise<module:@ui5/fs.Resource>} A promise resolving the resource.
208	*/
209	clone() {
210	const options = {	9✔
211	path: this._path,
212	statInfo: clone(this._statInfo)
213	};
214
215	const addContentOption = () => {	9✔
216	if (this._stream) {	9✔
217	return this._getBufferFromStream().then(function(buffer) {	3✔
218	options.buffer = buffer;	3✔
219	});
220	} else {
221	if (this._createStream) {	6✔
222	options.createStream = this._createStream;	3✔
223	} else if (this._buffer) {	3!
224	options.buffer = this._buffer;	3✔
225	}
226	return Promise.resolve();	6✔
227	}
228	};
229
230	return addContentOption().then(() => {	9✔
231	return new Resource(options);	9✔
232	});
233	}
234
235	/**
236	* Tracing: Get tree for printing out trace
237	*
238	* @returns {Object}
239	*/
240	getPathTree() {
241	const tree = {};	×
242
243	let pointer = tree[this._path] = {};	×
244
UNCOV 245	for (let i = this._collections.length - 1; i >= 0; i--) {	×
UNCOV 246	pointer = pointer[this._collections[i]] = {};	×
247	}
248
UNCOV 249	return tree;	×
250	}
251
252	/**
253	* Returns the content as stream.
254	*
255	* @private
256	* @returns {Function} The stream
257	*/
258	_getStream() {
259	if (this._createStream) {	24✔
260	return this._createStream();	18✔
261	}
262	return this._stream;	6✔
263	}
264
265	/**
266	* Converts the buffer into a stream.
267	*
268	* @private
269	* @returns {Promise<Buffer>} Promise resolving with buffer.
270	*/
271	_getBufferFromStream() {
272	return new Promise((resolve, reject) => {	21✔
273	const contentStream = this._getStream();	21✔
274	const buffers = [];	21✔
275	contentStream.on("data", (data) => {	21✔
276	buffers.push(data);	27✔
277	});
278	contentStream.on("error", (err) => {	21✔
UNCOV 279	reject(err);	×
280	});
281	contentStream.on("end", () => {	21✔
282	const buffer = Buffer.concat(buffers);	21✔
283	this.setBuffer(buffer);	21✔
284	resolve(buffer);	21✔
285	});
286	});
287	}
288	}
289
290	module.exports = Resource;	18✔

SAP / ui5-fs / 317

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous