offshore

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/offshore.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/</a> offshore.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 87.3% Statements 110/126 </div> <div class='fl pad1y space-right2'> 67.39% Branches 31/46 </div> <div class='fl pad1y space-right2'> 100% Functions 27/27 </div> <div class='fl pad1y space-right2'> 93.86% Lines 107/114 </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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318</td><td class="line-coverage quiet">2× 2× 2× 2× 2× 2× 2×           2×   181×           181×     181×   181×                 2×     2×   2×                                   2×     302×   302×                             2× 180×     180× 180× 180×     180×                   180×     180×     180×     180×     1× 320× 320× 320×         320×   320×     180×   180×     180×         180× 180×     180×   180× 320× 18×     180× 180× 180×             180× 180×   180× 320×     320×   320× 1477× 2×       320× 320×     320× 320× 320× 320×     180×         180× 180× 320× 320× 1578× 1578× 1× 1×   1×           180×         180× 182× 182× 182×     182×     22× 34×       22×     22× 22×       22× 122× 122× 121×     122× 122×       22× 22× 22×           180× 180× 180× 180×                       2× 9×   9× 10×     10×   10×                   2× 180×                                                       180× 320× 320×         180×   320×      </td><td class="text"><pre class="prettyprint lang-js">var _ = require('lodash'); var async = require('async'); var Schema = require('offshore-schema'); var Connections = require('./offshore/connections'); var CollectionLoader = require('./offshore/collection/loader'); var COLLECTION_DEFAULTS = require('./offshore/collection/defaults'); var hasOwnProperty = require('./offshore/utils/helpers').object.hasOwnProperty;   /** * Offshore */   var Offshore = module.exports = function() {   Iif(!(this instanceof Offshore)) { return new Offshore(); }   // Keep track of all the collections internally so we can build associations // between them when needed. this._collections = [];   // Keep track of all the active connections used by collections this._connections = {};   return this; };   /* *********************************************************** * Modules that can be extended ***********************************************************/   // Collection to be extended in your application Offshore.Collection = require('./offshore/collection');   // Model Instance, returned as query results Offshore.Model = require('./offshore/model');   Offshore.Transaction = require('./offshore/query/transaction');   /* *********************************************************** * Prototype Methods ***********************************************************/   /** * loadCollection * * Loads a new Collection. It should be an extended Offshore.Collection * that contains your attributes, instance methods and class methods. * * @param {Object} collection * @return {Object} internal models dictionary * @api public */   Offshore.prototype.loadCollection = function(collection) {   // Cache collection this._collections.push(collection);   return this._collections; };   /** * initialize * * Creates an initialized version of each Collection and auto-migrates depending on * the Collection configuration. * * @param {Object} config object containing adapters * @param {Function} callback * @return {Array} instantiated collections * @api public */   Offshore.prototype.initialize = function(options, cb) { var self = this;   // Ensure a config object is passed in containing adapters Iif (!options) throw new Error('Usage Error: function(options, callback)'); Iif (!options.adapters) throw new Error('Options object must contain an adapters object'); Iif (!options.connections) throw new Error('Options object must contain a connections object');   // Allow collections to be passed in to the initialize method Iif (options.collections) { for (var collection in options.collections) { this.loadCollection(options.collections[collection]); }   // Remove collections from the options after they have been loaded delete options.collections; }   // Cache a reference to instantiated collections this.collections = {};   // Build up all the connections used by the collections this.connections = new Connections(options.adapters, options.connections);   // Grab config defaults or set them to empty var defaults = _.merge({}, COLLECTION_DEFAULTS, options.defaults);   // Build a schema map this.schema = new Schema(this._collections, this.connections, defaults);   // Load a Collection into memory function loadCollection(item, next) { var loader = new CollectionLoader(item, self.connections, defaults); var collection = loader.initialize(self); Iif (options.compat) { collection[options.compat] = self; } // Store the instantiated collection so it can be used // internally to create other records self.collections[collection.identity.toLowerCase()] = collection;   next(); }   this.cache = require('./offshore/core/cache');   async.auto({ // initialize cache initializeCache: function(next) { self.cache.initialize(options.cache, next); },   // Load all the collections into memory loadCollections: function(next) { async.each(self._collections, loadCollection, function(err) { Iif (err) return next(err);   // Migrate Junction Tables var junctionTables = [];   Object.keys(self.schema).forEach(function(table) { if (!self.schema[table].junctionTable) return; junctionTables.push(Offshore.Collection.extend(self.schema[table])); });   async.each(junctionTables, loadCollection, function(err) { Iif (err) return next(err); next(null, self.collections); }); }); },   // Build up Collection Schemas buildCollectionSchemas: ['loadCollections', function(next, results) { var collections = self.collections; var schemas = {};   Object.keys(collections).forEach(function(key) { var collection = collections[key];   // Remove hasMany association keys var schema = _.clone(collection._schema.schema);   Object.keys(schema).forEach(function(key) { if (hasOwnProperty(schema[key], 'type')) return; delete schema[key]; });   // Grab JunctionTable flag var meta = collection.meta || {}; meta.junctionTable = hasOwnProperty(collection.offshore.schema[collection.identity], 'junctionTable') ? collection.offshore.schema[collection.identity].junctionTable : false;   schemas[collection.identity] = collection; schemas[collection.identity].definition = schema; schemas[collection.identity].attributes = collection._attributes; schemas[collection.identity].meta = meta; });   next(null, schemas); }],   //initalize association criteria validator initializeAssociationCriteria: ['buildCollectionSchemas', function(next) { var collections = self.collections; _.keys(collections).forEach(function(collectionName) { var collection = collections[collectionName]; _.keys(collection._attributes).forEach(function(key) { var attr = collection._attributes[key]; if (hasOwnProperty(attr, 'criteria')) { Eif (hasOwnProperty(attr, 'collection')) { collection._validator.associations[key].initialize(attr.collection, attr.criteria); } Iif (hasOwnProperty(attr, 'model')) { collection._validator.associations[key].initialize(attr.model, attr.criteria); } } }); }); next(); }],   // Register the Connections with an adapter registerConnections: ['buildCollectionSchemas', function(next, results) { async.each(Object.keys(self.connections), function(item, nextItem) { var connection = self.connections[item]; var config = {}; var usedSchemas = {};   // Check if the connection's adapter has a register connection method if (!hasOwnProperty(connection._adapter, 'registerConnection')) return nextItem();   // Copy all values over to a tempory object minus the adapter definition Object.keys(connection.config).forEach(function(key) { config[key] = connection.config[key]; });   // Set an identity on the connection config.identity = item;   // register default connections var collections = connection._collections; Iif (connection.config && connection.config.default) { collections = self.connections.default._collections; } // Grab the schemas used on this connection collections.forEach(function(coll) { var identity = coll; if (hasOwnProperty(self.collections[coll].__proto__, 'tableName')) { identity = self.collections[coll].__proto__.tableName; }   var schema = results.buildCollectionSchemas[coll]; usedSchemas[identity] = schema; });   // Call the registerConnection method connection._adapter.registerConnection(config, usedSchemas, function(err) { Iif (err) return nextItem(err); nextItem(); }); }, next); }]   }, function(err) { Iif (err) return cb(err); self.bootstrap(function(err) { Iif (err) return cb(err); cb(null, { collections: self.collections, connections: self.connections }); }); });   };   /** * Teardown * * Calls the teardown method on each connection if available. */   Offshore.prototype.teardown = function teardown(cb) { var self = this;   async.each(Object.keys(this.connections), function(item, next) { var connection = self.connections[item];   // Check if the adapter has a teardown method implemented Iif (!hasOwnProperty(connection._adapter, 'teardown')) return next();   connection._adapter.teardown(item, next); }, cb); };   /** * Bootstrap * * Auto-migrate all collections */   Offshore.prototype.bootstrap = function bootstrap(cb) { var self = this;   // // TODO: // Come back to this -- see https://github.com/balderdashy/offshore/issues/259 // (the stuff in this file works fine-- the work would be structural changes elsewhere) //   // // Use the schema to get a list of junction tables idents // // and then determine which are "logical" collections // // (i.e. everything EXCEPT junction tables) // var junctionTableIdents = _(this.schema).filter({junctionTable: true}).pluck('identity').value(); // var logicalCollections = _(this.collections).omit(junctionTableIdents).value();   // // Flatten logical collections obj into an array for convenience // var toBeSynced = _.reduce(logicalCollections, function(logicals,coll,ident) { // logicals.push(coll); // return logicals; // }, []);   // // console.log(junctionTableIdents); // // console.log(Object.keys(logicalCollections)); // // console.log('\n', // // 'Migrating collections ::', // // _(toBeSynced).pluck('identity').value() // // );   // For now: var toBeSynced = _.reduce(this.collections, function(resources, collection, ident) { resources.push(collection); return resources; }, []);   // Run auto-migration strategies on each collection // async.each(toBeSynced, function(collection, next) { async.eachSeries(toBeSynced, function(collection, next) { // async.eachLimit(toBeSynced, 9, function(collection, next) { collection.sync(next); }, cb); };  </pre></td></tr> </table></pre> <div class='push'></div> </div> <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>