From e87eaea3f5788fb346b647ca40b72a2e6fe44710 Mon Sep 17 00:00:00 2001 From: Shlomi Assaf Date: Wed, 18 Feb 2015 16:24:52 +0200 Subject: [PATCH 1/2] * Added the ability to create ad-hoc modelDefinitions. * Added the ability to "extend" models-config (choose overwrite/extend) --- lib/compiler.js | 98 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 80 insertions(+), 18 deletions(-) diff --git a/lib/compiler.js b/lib/compiler.js index 0a3ef7d..e653ab0 100644 --- a/lib/compiler.js +++ b/lib/compiler.js @@ -38,6 +38,11 @@ module.exports = function compile(options) { var modelsRootDir = options.modelsRootDir || appRootDir; var modelsConfig = options.models || ConfigLoader.loadModels(modelsRootDir, env); + + if (options.models && options.models['__extend'] === true){ + modelsConfig = _.extend(ConfigLoader.loadModels(modelsRootDir, env), modelsConfig); + delete modelsConfig["__extend"]; + } assertIsValidModelConfig(modelsConfig); var dsRootDir = options.dsRootDir || appRootDir; @@ -76,8 +81,10 @@ module.exports = function compile(options) { delete modelsConfig._meta; var modelSources = options.modelSources || modelsMeta.sources || ['./models']; + var modelDefinitions = options.modelDefinitions || []; + var modelInstructions = buildAllModelInstructions( - modelsRootDir, modelsConfig, modelSources); + modelsRootDir, modelsConfig, modelSources, modelDefinitions); // When executor passes the instruction to loopback methods, // loopback modifies the data. Since we are loading the data using `require`, @@ -181,8 +188,8 @@ function tryReadDir() { } } -function buildAllModelInstructions(rootDir, modelsConfig, sources) { - var registry = findModelDefinitions(rootDir, sources); +function buildAllModelInstructions(rootDir, modelsConfig, sources, modelDefinitions) { + var registry = findModelDefinitions(rootDir, sources, modelDefinitions); var modelNamesToBuild = addAllBaseModels(registry, Object.keys(modelsConfig)); @@ -263,9 +270,32 @@ function sortByInheritance(instructions) { }); } -function findModelDefinitions(rootDir, sources) { +function loadAdhocModelDefinitions(rootDir, modelDefinitions) { var registry = {}; + if (modelDefinitions.definitions) { + // if a master source file dir is set, load it. + var modelDefSrcDir = (modelDefinitions.sourceDir) ? resolveSourceDir(rootDir, modelDefinitions.sourceDir) : undefined; + var files = (!modelDefSrcDir) ? [] : tryReadDir(modelDefSrcDir); + + modelDefinitions.definitions.forEach(function(modelDef) { + var entry = loadModelDefinition(modelDefSrcDir || rootDir, modelDef, files); + var modelName = entry.definition.name; + if (!modelName) { + debug('Skipping ad-hoc model definition without Model name: %s', + path.relative(srcDir, fullPath)); + return; + } + registry[modelName] = entry; + }); + } + + return registry; +} + +function findModelDefinitions(rootDir, sources, modelDefinitions) { + var registry = loadAdhocModelDefinitions(rootDir, modelDefinitions); + sources.forEach(function(src) { var srcDir = resolveSourceDir(rootDir, src); if (!srcDir) { @@ -325,25 +355,56 @@ function resolveSourceDir(rootDir, sourceDir) { return undefined; } +/** + * Loads a module definition from a file or a ad-hoc object. + * @param rootDir + * @param jsonFile path to file or an object with 'definition' property and optional 'sourceFile' property. + * @param allFiles + * @returns {{definition: *, sourceFile: *}} + */ function loadModelDefinition(rootDir, jsonFile, allFiles) { - var definition = require(jsonFile); - var basename = path.basename(jsonFile, path.extname(jsonFile)); + var definition, + basename, + sourceFile, + sourceDir; + + if (typeof jsonFile === "string") { + definition = require(jsonFile); + basename = path.basename(jsonFile, path.extname(jsonFile)); + sourceDir = path.dirname(jsonFile); + } + else { + definition = jsonFile.definition; + basename = definition.name.toLowerCase(); //TODO: dasherize the name since "testModel" will be "test-model.js" (find the imp in SL code) + if (jsonFile.sourceFile) { + sourceFile = resolveSourceDir(rootDir, jsonFile.sourceFile); + sourceDir = path.dirname(sourceFile); + sourceFile = path.basename(sourceFile); + } + else { + sourceDir = rootDir; + } + } // find a matching file with a supported extension like `.js` or `.coffee` - var base; - var ext; - var validFileType; - var sourceFile = allFiles - .filter(function(f) { - ext = path.extname(f); - base = path.basename(f, ext); - validFileType = (ext !== '.node') && (ext !== '.json') && + + if (!sourceFile) { + var base; + var ext; + var validFileType; + + sourceFile = allFiles + .filter(function(f) { + ext = path.extname(f); + base = path.basename(f, ext); + validFileType = (ext !== '.node') && (ext !== '.json') && ((typeof require.extensions[ext]) === 'function'); - return validFileType && (base === basename); - })[0]; + return validFileType && (base === basename); + })[0]; + } try { - sourceFile = path.join(path.dirname(jsonFile), sourceFile); + sourceFile = path.join(sourceDir, sourceFile); sourceFile = require.resolve(sourceFile); } catch (err) { debug('Model source code not found: %s - %s', sourceFile, err.code || err); @@ -351,7 +412,7 @@ function loadModelDefinition(rootDir, jsonFile, allFiles) { } debug('Found model "%s" - %s %s', definition.name, - path.relative(rootDir, jsonFile), + (typeof jsonFile === "string") ? path.relative(rootDir, jsonFile) : 'ad-hoc', sourceFile ? path.relative(rootDir, sourceFile) : '(no source file)'); return { @@ -426,6 +487,7 @@ function resolveMiddlewarePath(rootDir, middleware) { } if (!fragment) { + require("compression"); resolved.sourceFile = require.resolve(pathName); return resolved; } From d39ccec274c62042f224e346562b57c5bf8af500 Mon Sep 17 00:00:00 2001 From: Shlomi Assaf Date: Wed, 18 Feb 2015 17:03:06 +0200 Subject: [PATCH 2/2] Fixed the location where models["__extend"] get deleted. When a models object is added to the options with and explicit "__extend" = false it would skip deletion of the property. moving the delete instruction will fix it. --- lib/compiler.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/compiler.js b/lib/compiler.js index e653ab0..d165624 100644 --- a/lib/compiler.js +++ b/lib/compiler.js @@ -41,8 +41,8 @@ module.exports = function compile(options) { if (options.models && options.models['__extend'] === true){ modelsConfig = _.extend(ConfigLoader.loadModels(modelsRootDir, env), modelsConfig); - delete modelsConfig["__extend"]; } + delete modelsConfig["__extend"]; assertIsValidModelConfig(modelsConfig); var dsRootDir = options.dsRootDir || appRootDir;