[INTERNAL] resourceFactory: Add factory functions for Filter and Link readers

Eventually remove them from AbstractReader to remove the circular
dependency to sub-class.

Author: RandomByte

lib/AbstractReader.js

@@ -80,6 +80,7 @@ class AbstractReader {
 	 * @returns {Promise<@ui5/fs/readers/Filter>} Promise resolving with filter instance
 	 */
 	async filter(callback) {
+		console.warn("DEPRECATED CALL TO AbstractReader#filter - THIS FUNCTION WILL BE REMOVED IN THE NEXT RELEASE");
 		const {default: Filter} = await import("./readers/Filter.js");
 		return new Filter({
 			reader: this,
@@ -115,6 +116,7 @@ class AbstractReader {
 	 * @returns {Promise<@ui5/fs/readers/Link>} Promise resolving with reader instance
 	 */
 	async flatten(namespace) {
+		console.warn("DEPRECATED CALL TO AbstractReader#flatten - THIS FUNCTION WILL BE REMOVED IN THE NEXT RELEASE");
 		const {default: Link} = await import("./readers/Link.js");
 		return new Link({
 			reader: this,

lib/readers/Filter.js

@@ -5,7 +5,6 @@ import AbstractReader from "../AbstractReader.js";
  *
  * @public
  * @class
- * @hideconstructor
  * @alias @ui5/fs/readers/Filter
  * @extends @ui5/fs/AbstractReader
  */
@@ -22,8 +21,9 @@ class Filter extends AbstractReader {
 	/**
 	 * Constructor
 	 *
+ 	 * @public
 	 * @param {object} parameters Parameters
-	 * @param {@ui5/fs/AbstractReader} parameters.reader The resource reader to wrap
+	 * @param {@ui5/fs/AbstractReader} parameters.reader The resource reader or collection to wrap
 	 * @param {@ui5/fs/readers/Filter~callback} parameters.callback
 	 * 				Filter function. Will be called for every resource read through this reader.
 	 */

lib/readers/Link.js

@@ -5,30 +5,29 @@ import logger from "@ui5/logger";
 const log = logger.getLogger("resources:readers:Link");
 
 /**
- * A reader that allows modification of all resources passed through it.
+ * A reader that allows removing paths segments from all resources passed through it.
  *
  * @public
  * @class
- * @hideconstructor
  * @alias @ui5/fs/readers/Link
  * @extends @ui5/fs/AbstractReader
  */
 class Link extends AbstractReader {
 	/**
 	 * Path mapping for a [Link]{@link @ui5/fs/readers/Link}
 	 *
-	 * @private
+	 * @public
 	 * @typedef {object} @ui5/fs/readers/Link/PathMapping
-	 * @property {string} linkPath Input path to rewrite
-	 * @property {string} targetPath Path to rewrite to
+	 * @property {string} linkPath Path to match and replace in the requested path or pattern
+	 * @property {string} targetPath Path to use as a replacement in the request for the source reader
 	 */
 
 	/**
 	 * Constructor
 	 *
-	 * @private
+ 	 * @public
 	 * @param {object} parameters Parameters
-	 * @param {@ui5/fs/AbstractReader} parameters.reader The resource reader to wrap
+	 * @param {@ui5/fs/AbstractReader} parameters.reader The resource reader or collection to wrap
 	 * @param {@ui5/fs/readers/Link/PathMapping} parameters.pathMapping
 	 */
 	constructor({reader, pathMapping}) {

lib/resourceFactory.js

@@ -7,6 +7,8 @@ import ReaderCollection from "./ReaderCollection.js";
 import ReaderCollectionPrioritized from "./ReaderCollectionPrioritized.js";
 import Resource from "./Resource.js";
 import WriterCollection from "./WriterCollection.js";
+import Filter from "./readers/Filter.js";
+import Link from "./readers/Link.js";
 
 /**
  * @module @ui5/fs/resourceFactory
@@ -160,6 +162,59 @@ export function createWorkspace({reader, writer, virBasePath = "/", name = "vir
 	});
 }
 
+/**
+ * Create a [Filter-Reader]{@link @ui5/fs/readers/Filter} with the given reader.
+ * The provided callback is called for every resource that is retrieved through the
+ * reader and decides whether the resource shall be passed on or dropped.
+ *
+ * @public
+ * @param {object} parameters
+ * @param {@ui5/fs/AbstractReader} parameters.reader Single reader or collection of readers
+ * @param {@ui5/fs/readers/Filter~callback} parameters.callback
+ * 				Filter function. Will be called for every resource passed through this reader.
+ * @returns {@ui5/fs/readers/Filter} Reader instance
+ */
+export function createFilterReader(parameters) {
+	return new Filter(parameters);
+}
+
+/**
+ * Create a [Link-Reader]{@link @ui5/fs/readers/Filter} with the given reader.
+ * The provided path mapping allows
+ *
+ * @public
+ * @param {object} parameters
+ * @param {@ui5/fs/AbstractReader} parameters.reader Single reader or collection of readers
+ * @param {@ui5/fs/readers/Link/PathMapping} parameters.pathMapping
+ * @returns {@ui5/fs/readers/Link} Reader instance
+ */
+export function createLinkReader(parameters) {
+	return new Link(parameters);
+}
+
+/**
+ * Create a [Link-Reader]{@link @ui5/fs/readers/Link} where all requests are prefixed with
+ * <code>/resources/<namespace></code>.
+ *
+ * This simulates "flat" resource access, which is for example common for projects of type
+ * "application".
+ *
+ * @public
+ * @param {object} parameters
+ * @param {@ui5/fs/AbstractReader} parameters.reader Single reader or collection of readers
+ * @param {string} parameters.namespace Project namespace
+ * @returns {@ui5/fs/readers/Link} Reader instance
+ */
+export function createFlatReader({reader, namespace}) {
+	return new Link({
+		reader: reader,
+		pathMapping: {
+			linkPath: `/`,
+			targetPath: `/resources/${namespace}/`
+		}
+	});
+}
+
 /**
  * Normalizes virtual glob patterns by prefixing them with
  * a given virtual base directory path

test/lib/resources.js

@@ -4,7 +4,7 @@ import chaifs from "chai-fs";
 chai.use(chaifs);
 const assert = chai.assert;
 import sinon from "sinon";
-import {createAdapter} from "../../lib/resourceFactory.js";
+import {createAdapter, createFilterReader, createFlatReader, createLinkReader} from "../../lib/resourceFactory.js";
 
 test.afterEach.always((t) => {
 	sinon.restore();
@@ -37,7 +37,7 @@ test("Get resource from application.a (/index.html) and write it to /dest/ using
 	});
 });
 
-test("Filter resources", async (t) => {
+test("Legacy: Filter resources", async (t) => {
 	const source = createAdapter({
 		fsBasePath: "./test/fixtures/application.a/webapp",
 		virBasePath: "/app/"
@@ -54,6 +54,39 @@ test("Filter resources", async (t) => {
 	t.is(resources[0].getPath(), "/app/test.js", "Found correct resource");
 });
 
+test("Legacy: Flatten resources", async (t) => {
+	const source = createAdapter({
+		fsBasePath: "./test/fixtures/application.a/webapp",
+		virBasePath: "/resources/app/"
+	});
+	const transformedSource = await source.flatten("app");
+
+	const resources = await transformedSource.byGlob("**/*.js");
+	t.is(resources.length, 1, "Found one resource via transformer");
+	t.is(resources[0].getPath(), "/test.js", "Found correct resource");
+});
+
+
+test("Filter resources", async (t) => {
+	const source = createAdapter({
+		fsBasePath: "./test/fixtures/application.a/webapp",
+		virBasePath: "/app/"
+	});
+	const filteredSource = createFilterReader({
+		reader: source,
+		callback: (resource) => {
+			return resource.getPath().endsWith(".js");
+		}
+	});
+	const sourceResources = await source.byGlob("**");
+	t.is(sourceResources.length, 2, "Found two resources in source");
+
+	const resources = await filteredSource.byGlob("**");
+
+	t.is(resources.length, 1, "Found exactly one resource via filter");
+	t.is(resources[0].getPath(), "/app/test.js", "Found correct resource");
+});
+
 test("Transform resources", async (t) => {
 	const source = createAdapter({
 		fsBasePath: "./test/fixtures/application.a/webapp",
@@ -83,9 +116,30 @@ test("Flatten resources", async (t) => {
 		fsBasePath: "./test/fixtures/application.a/webapp",
 		virBasePath: "/resources/app/"
 	});
-	const transformedSource = await source.flatten("app");
+	const transformedSource = createFlatReader({
+		reader: source,
+		namespace: "app"
+	});
 
 	const resources = await transformedSource.byGlob("**/*.js");
 	t.is(resources.length, 1, "Found one resource via transformer");
 	t.is(resources[0].getPath(), "/test.js", "Found correct resource");
 });
+
+test("Link resources", async (t) => {
+	const source = createAdapter({
+		fsBasePath: "./test/fixtures/application.a/webapp",
+		virBasePath: "/resources/app/"
+	});
+	const transformedSource = createLinkReader({
+		reader: source,
+		pathMapping: {
+			linkPath: "/wow/this/is/a/beautiful/path/just/wow/",
+			targetPath: "/resources/"
+		}
+	});
+
+	const resources = await transformedSource.byGlob("**/*.js");
+	t.is(resources.length, 1, "Found one resource via transformer");
+	t.is(resources[0].getPath(), "/wow/this/is/a/beautiful/path/just/wow/app/test.js", "Found correct resource");
+});