UNPKG

offshore

Version:
774 lines (773 loc) 23.4 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/offshore/query/finders/joins.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../../../prettify.css" /> <link rel="stylesheet" href="../../../../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../../../../index.html">all files</a> / <a href="index.html">lib/offshore/query/finders/</a> joins.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">89.58% </span> <span class="quiet">Statements</span> <span class='fraction'>86/96</span> </div> <div class='fl pad1y space-right2'> <span class="strong">75% </span> <span class="quiet">Branches</span> <span class='fraction'>39/52</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>12/12</span> </div> <div class='fl pad1y space-right2'> <span class="strong">91.67% </span> <span class="quiet">Lines</span> <span class='fraction'>77/84</span> </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">779×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">533×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-yes">533×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">533×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">246×</span> <span class="cline-any cline-yes">503×</span> <span class="cline-any cline-yes">251×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">246×</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-yes">1633×</span> <span class="cline-any cline-yes">1633×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1133×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes">1633×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1633×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-yes">3820×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">5030×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">8850×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1107×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1107×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">769×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">769×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">769×</span> <span class="cline-any cline-yes">1022×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1022×</span> <span class="cline-any cline-yes">168×</span> <span class="cline-any cline-yes">168×</span> <span class="cline-any cline-yes">168×</span> <span class="cline-any cline-yes">168×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">854×</span> <span class="cline-any cline-yes">854×</span> <span class="cline-any cline-yes">854×</span> <span class="cline-any cline-yes">854×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">769×</span> <span class="cline-any cline-yes">769×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1633×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-yes">1194×</span> <span class="cline-any cline-yes">1147×</span> <span class="cline-any cline-yes">1147×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">895×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/** * Module Dependencies */ &nbsp; var _ = require('lodash'); var utils = require('../../utils/helpers'); var hop = utils.object.hasOwnProperty; &nbsp; /** * Logic For Handling Joins inside a Query Results Object */ &nbsp; var Joins = module.exports = function(joins, values, identity, schema, collections) { &nbsp; this.identity = identity; &nbsp; // Hold Joins specified in the criteria this.joins = joins || <span class="branch-1 cbranch-no" title="branch not covered" >[];</span> &nbsp; // Hold the result values this.values = values || <span class="branch-1 cbranch-no" title="branch not covered" >[];</span> &nbsp; // Hold the overall schema this.schema = schema || <span class="branch-1 cbranch-no" title="branch not covered" >{};</span> &nbsp; // Hold all the Offshore collections so we can make models this.collections = collections || <span class="branch-1 cbranch-no" title="branch not covered" >{};</span> &nbsp; // Build up modelOptions this.modelOptions(); &nbsp; // Modelize values this.models = this.makeModels(); &nbsp; return this; }; &nbsp; /** * Build up Join Options that will be passed down to a Model instance. * * @api private */ &nbsp; Joins.prototype.modelOptions = function modelOptions() { &nbsp; var self = this; var joins; &nbsp; // Build Model Options, determines what associations to render in toObject this.options = { showJoins: !!this.joins }; &nbsp; // If no joins were used, just return <span class="missing-if-branch" title="if path not taken" >I</span>if (!this.joins) <span class="cstat-no" title="statement not covered" >return;</span> &nbsp; // Map out join names to pass down to the model instance joins = this.joins.filter(function(join) { &nbsp; // If the value is not being selected, don't add it to the array if (!join.select) return false; &nbsp; return join; }); &nbsp; // Map out join key names and attach to the options object. // For normal assoiciations, use the child table name that is being joined. For many-to-many // associations the child table name won't work so grab the alias used and use that for the // join name. It will be the one that is transformed. this.options.joins = joins.map(function(join) { var child = []; // If a junctionTable was not used, return the child table if (!join.junctionTable) return join.child; &nbsp; // Find the original alias for the join self.joins.forEach(function(j) { if (j.child !== join.parent) return; child.push(j.alias); }); &nbsp; // If a child was found, return it otherwise just return the original child join <span class="missing-if-branch" title="else path not taken" >E</span>if (child) return child; <span class="cstat-no" title="statement not covered" > return join.child;</span> }); &nbsp; // Flatten joins this.options.joins = _.uniq(_.flatten(this.options.joins)); }; &nbsp; /** * Transform Values into instantiated Models. * * @return {Array} * @api private */ &nbsp; Joins.prototype.makeModels = function makeModels() { &nbsp; var self = this; var models = []; var model; &nbsp; // If values are invalid (not an array), return them early. <span class="missing-if-branch" title="if path not taken" >I</span>if (!this.values || !this.values.forEach) <span class="cstat-no" title="statement not covered" >return this.values;</span> &nbsp; // Make each result an instance of model this.values.forEach(function(value) { model = self.modelize(value); models.push(model); }); &nbsp; return models; }; &nbsp; /** * Handle a single Result and inspect it's values for anything * that needs to become a Model instance. * * @param {Object} value * @return {Object} * @api private */ &nbsp; Joins.prototype.modelize = function modelize(value) { var self = this; &nbsp; // Look at each key in the object and see if it was used in a join Object.keys(value).forEach(function(key) { &nbsp; var joinKey = false; var attr, usedInJoin; &nbsp; // If showJoins wasn't set or no joins were found there is nothing to modelize <span class="missing-if-branch" title="if path not taken" >I</span>if (!self.options.showJoins || !self.options.joins) <span class="cstat-no" title="statement not covered" >return;</span> &nbsp; // Look at the schema for an attribute and check if it's a foreign key // or a virtual hasMany collection attribute &nbsp; // Check if there is a transformation on this attribute var transformer = self.collections[self.identity]._transformer._transformations; if (hop(transformer, key)) { attr = self.schema[transformer[key]]; } else { attr = self.schema[key]; } &nbsp; // If an attribute was found but it's not a model, this means it's a normal // key/value attribute and not an association so there is no need to modelize it. if (attr &amp;&amp; !attr.hasOwnProperty('model')) return; &nbsp; // If the attribute has a `model` property, the joinKey is the collection of the model if (attr &amp;&amp; attr.hasOwnProperty('model')) joinKey = attr.model; &nbsp; // If the attribute is a foreign key but it was not populated, just leave the foreign key // as it is and don't try and modelize it. if (joinKey &amp;&amp; self.options.joins.indexOf(joinKey) &lt; 0) return; &nbsp; // Check if the key was used in a join usedInJoin = self.checkForJoin(key); &nbsp; // If the attribute wasn't used in the join, don't turn it into a model instance. // NOTE: Not sure if this is correct or not? if (!usedInJoin.used) return; &nbsp; // If the attribute is an array of child values, for each one make a model out of it. <span class="missing-if-branch" title="else path not taken" >E</span>if (Array.isArray(value[key])) { &nbsp; var records = []; &nbsp; value[key].forEach(function(val) { var collection, model; &nbsp; // If there is a joinKey this means it's a belongsTo association so the collection // containing the proper model will be the name of the joinKey model. if (joinKey) { collection = self.collections[joinKey]; val = collection._transformer.unserialize(val); model = new collection._model(val, { showJoins: false }); return records.push(model); } &nbsp; // Otherwise look at the join used and determine which key should be used to get // the proper model from the collections. collection = self.collections[usedInJoin.join.child]; val = collection._transformer.unserialize(val); model = new collection._model(val, { showJoins: false }); return records.push(model); }); &nbsp; // Set the value to the array of model values value[key] = records; return; } <span class="cstat-no" title="statement not covered" > if (!_.isNull(value[key])) {</span> <span class="cstat-no" title="statement not covered" > if (_.isObject(value[key])) {</span> // If the value isn't an array it's a populated foreign key so modelize it and attach // it directly on the attribute <span class="cstat-no" title="statement not covered" > collection = self.collections[joinKey];</span> <span class="cstat-no" title="statement not covered" > value[key] = collection._transformer.unserialize(value[key]);</span> <span class="cstat-no" title="statement not covered" > value[key] = new collection._model(value[key], { showJoins: false });</span> } else { <span class="cstat-no" title="statement not covered" > value[key] = null;</span> } } }); &nbsp; return value; }; &nbsp; /** * Test if an attribute was used in a join. * Requires generating a key to test against an attribute because the model process * will be run before any transformations have taken place. * * @param {String} key * @return {Object} * @api private */ &nbsp; Joins.prototype.checkForJoin = function checkForJoin(key) { &nbsp; var generatedKey; var usedInJoin = false; var relatedJoin; &nbsp; // Loop through each join and see if the given key matches a join used this.joins.forEach(function(join) { if (join.alias !== key) return; usedInJoin = true; relatedJoin = join; }); &nbsp; return { used: usedInJoin, join: relatedJoin }; }; &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 17 2018 10:49:40 GMT+0200 (CEST) </div> </div> <script src="../../../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../../../sorter.js"></script> </body> </html>