Refactor graph module structure

Author: RandomByte

lib/graph/projectGraphFromDirectory.js renamed to lib/generateProjectGraph.js

@@ -1,17 +1,17 @@
-const projectGraphBuilder = require("./projectGraphBuilder");
-const ui5Framework = require("./providers/ui5Framework");
-const log = require("@ui5/logger").getLogger("graph:projectGraphFromDirectory");
+const projectGraphBuilder = require("./graph/providers/projectGraphBuilder");
+const ui5Framework = require("./graph/helpers/ui5Framework");
+const log = require("@ui5/logger").getLogger("generateProjectGraph");
 
 /**
  * Helper module to create a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph}
  * from a directory
  *
  * @public
- * @alias module:@ui5/project.graph.projectGraphFromTree
+ * @alias module:@ui5/project.generateProjectGraph
  * @param {TreeNode} tree Dependency tree as returned by a translator
  * @returns {module:@ui5/project.graph.ProjectGraph} A new project graph instance
  */
-const projectGraphFromDirectory = {
+const generateProjectGraph = {
 	/**
 	 * Generates a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph} by resolving
 	 * dependencies from package.json files and configuring projects from ui5.yaml files
@@ -26,9 +26,9 @@ const projectGraphFromDirectory = {
 	 * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
 	 * @returns {Promise<module:@ui5/project.graph.ProjectGraph>} Promise resolving to a Project Graph instance
 	 */
-	usingNpm: async function({cwd = ".", rootConfiguration, rootConfigPath, versionOverride}) {
+	usingNodePackageDependencies: async function({cwd = ".", rootConfiguration, rootConfigPath, versionOverride}) {
 		log.verbose(`Creating project graph using npm provider...`);
-		const NpmProvider = require("./providers/npm");
+		const NpmProvider = require("./graph/providers/NodePackageDependencies");
 
 		const provider = new NpmProvider({
 			cwd: cwd,
@@ -44,7 +44,7 @@ const projectGraphFromDirectory = {
 	},
 
 	/**
-	 * Generates a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph} from on a
+	 * Generates a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph} from a
 	 * YAML file following the structure of the
 	 * [@ui5/project.graph.projectGraphFromTree]{@link module:@ui5/project.graph.projectGraphFromTree} API
 	 *
@@ -57,23 +57,49 @@ const projectGraphFromDirectory = {
 	 */
 	usingStaticFile: async function({cwd = ".", filePath, versionOverride}) {
 		log.verbose(`Creating project graph using static file...`);
-		const staticTranslator = require("../translators/static");
-		const DependencyTreeProvider = require("./providers/DependencyTree");
+		const staticTranslator = require("./translators/static");
 
-		const tree = await staticTranslator.generateDependencyTree(null, {
+		const dependencyTree = await staticTranslator.generateDependencyTree(null, {
 			parameters: [filePath] // *sigh*
 		});
 
+		const DependencyTreeProvider = require("./graph/providers/DependencyTree");
 		const provider = new DependencyTreeProvider({
-			tree
+			dependencyTree
 		});
 
 		const projectGraph = await projectGraphBuilder(provider);
 
 		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride});
 
+		return projectGraph;
+	},
+
+	/**
+	 * Generates a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph} from a
+	 * YAML file following the structure of the
+	 * [@ui5/project.graph.projectGraphFromTree]{@link module:@ui5/project.graph.projectGraphFromTree} API
+	 *
+	 * @public
+	 * @param {object} options
+	 * @param {module:@ui5/project.graph.providers.DependencyTree.TreeNode} options.dependencyTree
+	 * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
+	 * @returns {Promise<module:@ui5/project.graph.ProjectGraph>} Promise resolving to a Project Graph instance
+	 */
+	usingObject: async function({dependencyTree, versionOverride}) {
+		log.verbose(`Creating project graph using object...`);
+
+		const DependencyTreeProvider = require("./graph/providers/DependencyTree");
+		const dependencyTreeProvider = new DependencyTreeProvider({
+			dependencyTree
+		});
+
+		const projectGraph = await projectGraphBuilder(dependencyTreeProvider);
+
+		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride});
+
 		return projectGraph;
 	}
 };
 
-module.exports = projectGraphFromDirectory;
+module.exports = generateProjectGraph;

lib/graph/providers/ui5Framework.js renamed to lib/graph/helpers/ui5Framework.js

@@ -1,6 +1,6 @@
 const Module = require("../Module");
 const ProjectGraph = require("../ProjectGraph");
-const log = require("@ui5/logger").getLogger("graph:providers:ui5Framework");
+const log = require("@ui5/logger").getLogger("graph:helpers:ui5Framework");
 
 class ProjectProcessor {
 	constructor({libraryMetadata}) {

lib/graph/projectGraphFromTree.js

@@ -17,14 +17,15 @@ class DependencyTree {
 	 * from a dependency tree as returned by translators.
 	 *
 	 * @public
-	 * @alias module:@ui5/project.graph.projectGraphFromTree
-	 * @param {TreeNode} tree Dependency tree as returned by a translator
+	 * @alias module:@ui5/project.graph.providers.DependencyTree
+	 * @param {object} parameters
+	 * @param {TreeNode} parameters.dependencyTree Dependency tree as returned by a translator
 	 */
-	constructor(tree) {
-		if (!tree) {
-			throw new Error(`Failed to instantiate DependencyTree provider: Missing parameter 'tree'`);
+	constructor({dependencyTree}) {
+		if (!dependencyTree) {
+			throw new Error(`Failed to instantiate DependencyTree provider: Missing parameter 'dependencyTree'`);
 		}
-		this._tree= tree;
+		this._tree = dependencyTree;
 	}
 
 	async getRootNode() {

lib/graph/providers/DependencyTree.js

@@ -5,14 +5,14 @@ const {promisify} = require("util");
 const fs = require("graceful-fs");
 const realpath = promisify(fs.realpath);
 const resolveModulePath = promisify(require("resolve"));
-const log = require("@ui5/logger").getLogger("graph:providers:npm");
+const log = require("@ui5/logger").getLogger("graph:providers:NodePackageDependencies");
 
 // Packages to consider:
 // * https://github.com/npm/read-package-json-fast
 // * https://github.com/npm/name-from-folder ?
 
 
-class Npm {
+class NodePackageDependencies {
 	/**
 	 * Generates a project graph from npm modules
 	 *
@@ -145,4 +145,4 @@ class Npm {
 	}
 }
 
-module.exports = Npm;
+module.exports = NodePackageDependencies;

lib/graph/providers/npm.js renamed to lib/graph/providers/NodePackageDependencies.js

@@ -1,8 +1,8 @@
 const path = require("path");
-const Module = require("./Module");
-const ProjectGraph = require("./ProjectGraph");
-const ShimCollection = require("./ShimCollection");
-const log = require("@ui5/logger").getLogger("graph:projectGraphBuilder");
+const Module = require("../Module");
+const ProjectGraph = require("../ProjectGraph");
+const ShimCollection = require("../ShimCollection");
+const log = require("@ui5/logger").getLogger("graph:providers:projectGraphBuilder");
 
 function _handleExtensions(graph, shimCollection, extensions) {
 	extensions.forEach((extension) => {
@@ -64,8 +64,8 @@ function _handleExtensions(graph, shimCollection, extensions) {
  */
 
 /**
- * Helper module to create a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph}
- * from a dependency tree as returned by translators.
+ * Generic helper module to create a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph}.
+ * For example from a dependency tree as returned by the legacy "translators".
  *
  * @public
  * @alias module:@ui5/project.graph.projectGraphBuilder

lib/graph/projectGraphBuilder.js renamed to lib/graph/providers/projectGraphBuilder.js

@@ -52,20 +52,18 @@ const Normalizer = {
 	 * @param {object} [options]
 	 * @param {string} [options.cwd] Current working directory
 	 * @param {string} [options.configPath] Path to configuration file
-	 * @param {string} [options.translatorName] Translator to use
-	 * @param {object} [options.translatorOptions] Options to pass to translator
+	 * @param {object} [options.dependencyTree] Translator to use
+	 * @param {string} [options.dependencyTreeFilePath] Translator to use
 	 * @param {object} [options.frameworkOptions] Options to pass to the framework installer
 	 * @param {string} [options.frameworkOptions.versionOverride]
 	 *		Framework version to use instead of the one defined in the root project
 	 * framework
 	 * @returns {Promise<module:@ui5/project.graph.ProjectGraph>} Promise resolving to a Project Graph instance
 	 */
 	generateProjectGraph: async function(options = {}) {
-		// const projectGraphFromTree = require("./graph/projectGraphFromTree");
-		// const tree = await Normalizer.generateDependencyTree(options);
-		const projectGraphFromDirectory = require("./graph/projectGraphFromDirectory");
+		const generateProjectGraph = require("./generateProjectGraph");
 
-		const projectGraph = await projectGraphFromDirectory.usingNpm({
+		const projectGraph = await generateProjectGraph.usingNodePackageDependencies({
 			rootConfigPath: options.configPath,
 			versionOverride: options.versionOverride
 		});