fs/lib/AbstractReader.js

  1. const randomInt = require("random-int");
  2. const Trace = require("./tracing/Trace");
  4. /**
  5.  * Abstract resource locator
  6.  *
  7.  * @public
  8.  * @abstract
  9.  * @memberof module:@ui5/fs
  10.  */
  11. class AbstractReader {
  12. 	/**
  13. 	 * The constructor.
  14. 	 *
  15. 	 * @public
  16. 	 */
  17. 	constructor() {
  18. 		if (new.target === AbstractReader) {
  19. 			throw new TypeError("Class 'AbstractReader' is abstract");
  20. 		}
  21. 	}
  23. 	/**
  24. 	 * Locates resources by matching glob patterns.
  25. 	 *
  26. 	 * @example
  27. 	 * byGlob("**‏/*.{html,htm}");
  28. 	 * byGlob("**‏/.library");
  29. 	 * byGlob("/pony/*");
  30. 	 *
  31. 	 * @public
  32. 	 * @param {string|string[]} virPattern glob pattern as string or array of glob patterns for
  33. 	 * 										virtual directory structure
  34. 	 * @param {object} [options] glob options
  35. 	 * @param {boolean} [options.nodir=true] Do not match directories
  36. 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
  37. 	 */
  38. 	byGlob(virPattern, options = {nodir: true}) {
  39. 		const trace = new Trace(virPattern);
  40. 		return this._byGlob(virPattern, options, trace).then(function(result) {
  41. 			trace.printReport();
  42. 			return result;
  43. 		}).then((resources) => {
  44. 			if (resources.length > 1) {
  45. 				// Pseudo randomize result order to prevent consumers from relying on it:
  46. 				// Swap the first object with a randomly chosen one
  47. 				const x = 0;
  48. 				const y = randomInt(0, resources.length - 1);
  49. 				// Swap object at index "x" with  "y"
  50. 				resources[x] = [resources[y], resources[y]=resources[x]][0];
  51. 			}
  52. 			return resources;
  53. 		});
  54. 	}
  56. 	/**
  57. 	 * Locates resources by matching a given path.
  58. 	 *
  59. 	 * @public
  60. 	 * @param {string} virPath Virtual path
  61. 	 * @param {object} [options] Options
  62. 	 * @param {boolean} [options.nodir=true] Do not match directories
  63. 	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
  64. 	 */
  65. 	byPath(virPath, options = {nodir: true}) {
  66. 		const trace = new Trace(virPath);
  67. 		return this._byPath(virPath, options, trace).then(function(resource) {
  68. 			trace.printReport();
  69. 			return resource;
  70. 		});
  71. 	}
  73. 	/**
  74. 	 * Locates resources by one or more glob patterns.
  75. 	 *
  76. 	 * @abstract
  77. 	 * @protected
  78. 	 * @param {string|string[]} virPattern glob pattern as string or an array of
  79. 	 *         glob patterns for virtual directory structure
  80. 	 * @param {object} options glob options
  81. 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
  82. 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
  83. 	 */
  84. 	_byGlob(virPattern, options, trace) {
  85. 		throw new Error("Not implemented");
  86. 	}
  88. 	/**
  89. 	 * Locate resources by matching a single glob pattern.
  90. 	 *
  91. 	 * @abstract
  92. 	 * @protected
  93. 	 * @param {string} pattern glob pattern
  94. 	 * @param {object} options glob options
  95. 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
  96. 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
  97. 	 */
  98. 	_runGlob(pattern, options, trace) {
  99. 		throw new Error("Not implemented");
  100. 	}
  102. 	/**
  103. 	 * Locates resources by path.
  104. 	 *
  105. 	 * @abstract
  106. 	 * @protected
  107. 	 * @param {string} virPath Virtual path
  108. 	 * @param {object} options Options
  109. 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
  110. 	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
  111. 	 */
  112. 	_byPath(virPath, options, trace) {
  113. 		throw new Error("Not implemented");
  114. 	}
  115. }
  117. module.exports = AbstractReader;