@dhyasama/totem-models 12.11.0 → 12.12.0

package/lib/Financials.js

@@ -632,7 +632,7 @@ module.exports = function(mongoose, config) {
       query.populate('organization', 'name logoUrl');
       query.populate('customer', 'name logoUrl customer');
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -652,7 +652,7 @@ module.exports = function(mongoose, config) {
         match: { customer: customerId }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -672,7 +672,7 @@ module.exports = function(mongoose, config) {
       query.populate('customer');
       query.populate('snapshots.documents.document');
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       if (!result) { return null; }
       else if (!result.customer) { return null; }
 
@@ -705,7 +705,7 @@ module.exports = function(mongoose, config) {
         ]
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -734,7 +734,7 @@ module.exports = function(mongoose, config) {
         key: postmarkMessageId
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -812,7 +812,7 @@ module.exports = function(mongoose, config) {
         'recurring.adminReminders.sent': false
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -837,7 +837,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       var results = [];
 
       _.each(result, function(financial) {
@@ -892,7 +892,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       var results = [];
 
       _.each(result, function(financial) {
@@ -951,7 +951,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       var results = [];
 
       _.each(result, function(financial) {
@@ -1011,7 +1011,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      let financials = await query.lean({ virtuals: true });
+      let financials = await query;
       financials = financials || [];
 
       let results = [];
@@ -1075,7 +1075,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       var results = [];
 
       _.each(result, function(financial) {
@@ -1141,7 +1141,7 @@ module.exports = function(mongoose, config) {
         });
       }
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -1161,7 +1161,7 @@ module.exports = function(mongoose, config) {
       query.populate('customer', 'name logoUrl customer');
       query.populate('snapshots.notifications.stakeholders.sendTo.organization', 'name logoUrl customer');
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -1182,7 +1182,7 @@ module.exports = function(mongoose, config) {
         }
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 

package/lib/Flag.js

@@ -80,7 +80,7 @@ module.exports = function(mongoose, config) {
         '_id': id
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 

package/lib/Note.js

@@ -87,7 +87,7 @@ module.exports = function(mongoose, config) {
         'customer': options.CUSTOMER_ID
       });
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 

package/lib/Organization.js

@@ -638,6 +638,16 @@ module.exports = function(mongoose, config) {
   // Properties that are not persisted to the database
   ///////////////////////////////////////////////////////////////////////////////////////
 
+  const getOperatingData = function(self, field) {
+    const operating = self && self.operating ? self.operating : {};
+    const data = operating[field] || {};
+
+    return {
+      publicData: data.public || {},
+      privateData: data.private || []
+    };
+  };
+
   Organization.virtual('address.primary').get(function () {
     var addresses = this && this.contact && this.contact.address ? this.contact.address : [];
     var primary = _.find(addresses, function(address) {
@@ -706,15 +716,17 @@ module.exports = function(mongoose, config) {
   Organization.virtual('customer.deals.activeStatuses').get(function () {
 
     var self = this;
+    var customer = self && self.customer ? self.customer : {};
+    var deals = customer.deals || {};
 
     // Backwards schema compatibility
-    if (!self.customer.deals) return [];
+    if (!customer.deals) return [];
 
     // Deals aren't on for customer
-    else if (!self.customer.deals.active) return [];
+    else if (!deals.active) return [];
 
     // Get active status names and sort them
-    var statuses = _.filter(self.customer.deals.statuses, function(s) { return s.active; });
+    var statuses = _.filter(deals.statuses || [], function(s) { return s && s.active; });
     statuses = _.sortBy(statuses, 'order');
     statuses = _.pluck(statuses, 'name');
 
@@ -833,8 +845,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.closed.on').get(function () {
 
     const self = this;
-    const publicData = self.operating.closed.public || {};
-    const privateData = self.operating.closed.private || [];
+    const operatingData = getOperatingData(self, 'closed');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.closedOn) return publicData.closedOn;
     else if (privateData.length >= 1) {
@@ -848,8 +861,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.acquired.amount').get(function () {
 
     const self = this;
-    const publicData = self.operating.acquired.public || {};
-    const privateData = self.operating.acquired.private || [];
+    const operatingData = getOperatingData(self, 'acquired');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.amount) return publicData.amount;
     else if (privateData.length >= 1) {
@@ -863,8 +877,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.acquired.by').get(function () {
 
     const self = this;
-    const publicData = self.operating.acquired.public || {};
-    const privateData = self.operating.acquired.private || [];
+    const operatingData = getOperatingData(self, 'acquired');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.by) return publicData.by;
     else if (privateData.length >= 1) {
@@ -878,8 +893,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.acquired.on').get(function () {
 
     const self = this;
-    const publicData = self.operating.acquired.public || {};
-    const privateData = self.operating.acquired.private || [];
+    const operatingData = getOperatingData(self, 'acquired');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.acquiredOn) return publicData.acquiredOn;
     else if (privateData.length >= 1) {
@@ -893,8 +909,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.merged.with').get(function () {
 
     const self = this;
-    const publicData = self.operating.merged.public || {};
-    const privateData = self.operating.merged.private || [];
+    const operatingData = getOperatingData(self, 'merged');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.with) return publicData.with;
     else if (privateData.length >= 1) {
@@ -908,8 +925,9 @@ module.exports = function(mongoose, config) {
   Organization.virtual('operating.merged.on').get(function () {
 
     const self = this;
-    const publicData = self.operating.merged.public || {};
-    const privateData = self.operating.merged.private || [];
+    const operatingData = getOperatingData(self, 'merged');
+    const publicData = operatingData.publicData;
+    const privateData = operatingData.privateData;
 
     if (publicData.mergedOn) return publicData.mergedOn;
     else if (privateData.length >= 1) {
@@ -1114,7 +1132,7 @@ module.exports = function(mongoose, config) {
 
       let query = this.find({ $or: [ {'website': { $in : domains }}, {'websiteAliases': { $in : domains }} ], 'deleted': {$ne: true} });
 
-      const orgs = await query.lean({ virtuals: true });
+      const orgs = await query;
       if (!orgs) { return []; }
 
       let result = orgs;
@@ -1138,7 +1156,7 @@ module.exports = function(mongoose, config) {
       const result = await this
         .find({ 'funds': { $in : fundids }, 'deleted': {$ne: true} })
         .select('name logoUrl funds contact')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1160,7 +1178,7 @@ module.exports = function(mongoose, config) {
         if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { throw new Error('options.CUSTOMER_ID is not a valid ObjectId'); }
       }
 
-      const orgs = await this.find({ '_id': { $in : ids }}).lean({ virtuals: true });
+      const orgs = await this.find({ '_id': { $in : ids }});
       if (!orgs) { return []; }
 
       let result = orgs;
@@ -1199,7 +1217,7 @@ module.exports = function(mongoose, config) {
         .populate('chairs.first', 'name avatarUrl title')
         .populate('chairs.second', 'name avatarUrl title')
         .populate('funds', 'name hexColorCode abbreviation')
-        .lean({ virtuals: true });
+        ;
       if (!orgs) { return []; }
 
       const result = _.map(orgs, function(org) {
@@ -1224,7 +1242,7 @@ module.exports = function(mongoose, config) {
       const result = await this
         .find({ 'lps': lpid, 'deleted': {$ne: true} })
         .select('name logoUrl')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1251,7 +1269,7 @@ module.exports = function(mongoose, config) {
           'deleted': { $ne: true }
         })
         .select('-sources -customer')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1265,7 +1283,7 @@ module.exports = function(mongoose, config) {
     const run = async () => {
       if (!personIds) { throw new Error('personIds is required'); }
 
-      const result = await this.find({'people.person':  { $in : personIds } }).lean({ virtuals: true });
+      const result = await this.find({'people.person':  { $in : personIds } });
       return result;
     };
 
@@ -1277,7 +1295,7 @@ module.exports = function(mongoose, config) {
   Organization.statics.findBySlug = function findBySlug(slug, cb) {
 
     const run = async () => {
-      const result = await this.findOne({ slug: slug, 'deleted': {$ne: true} }).lean({ virtuals: true });
+      const result = await this.findOne({ slug: slug, 'deleted': {$ne: true} });
       return result;
     };
 
@@ -1289,7 +1307,7 @@ module.exports = function(mongoose, config) {
   Organization.statics.findBySlugs = function findBySlugs(slugs, cb) {
 
     const run = async () => {
-      const result = await this.find({ 'slug': { $in : slugs } }).lean({ virtuals: true });
+      const result = await this.find({ 'slug': { $in : slugs } });
       return result;
     };
 
@@ -1402,7 +1420,7 @@ module.exports = function(mongoose, config) {
             ],
           'deleted': { $ne: true }
         })
-        .lean({ virtuals: true });
+        ;
 
       const result = _.map(orgs, function(org) {
         return helpers.cleanOrg(org, options.CUSTOMER_ID);
@@ -1443,7 +1461,7 @@ module.exports = function(mongoose, config) {
             ],
           'deleted': { $ne: true }
         })
-        .lean({ virtuals: true });
+        ;
 
       const result = _.map(orgs, function(org) {
         return helpers.cleanOrg(org, options.CUSTOMER_ID);
@@ -1460,7 +1478,7 @@ module.exports = function(mongoose, config) {
   Organization.statics.findByDocument = function findByDocument(id, cb) {
 
     const run = async () => {
-      const result = await this.findOne({ 'documents': id }).lean({ virtuals: true });
+      const result = await this.findOne({ 'documents': id });
       return result;
     };
 
@@ -1498,7 +1516,7 @@ module.exports = function(mongoose, config) {
             ]}
         )
         .select('name logoUrl')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1522,7 +1540,7 @@ module.exports = function(mongoose, config) {
           }
         })
         .select('name logoUrl people')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1537,7 +1555,7 @@ module.exports = function(mongoose, config) {
       const result = await this
         .findOne({ 'funds': id, 'deleted': {$ne: true} })
         .select('name logoUrl')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1589,7 +1607,7 @@ module.exports = function(mongoose, config) {
         query.populate(lpPopulateOptions);
       }
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       if (options.isWorkerProcess) { return result; }
       else { return helpers.cleanOrg(result, options.CUSTOMER_ID); }
     };
@@ -1607,7 +1625,7 @@ module.exports = function(mongoose, config) {
       const query = this.findById(id);
       query.select('name aliases website websiteAliases logoUrl');
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       return result;
     };
 
@@ -1632,7 +1650,7 @@ module.exports = function(mongoose, config) {
       let query = this.find( {'_id': { $in : ids } } );
       query.populate('documents');
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       if (options.isWorkerProcess) { return result; }
       else { return _.map(result, function(r) { return helpers.cleanOrg(r, options.CUSTOMER_ID) }); }
     };
@@ -1659,7 +1677,7 @@ module.exports = function(mongoose, config) {
             ],
           'deleted': { $ne: true }
         })
-        .lean({ virtuals: true });
+        ;
 
       const result = _.map(orgs, function(org) {
         return helpers.cleanOrg(org, options.CUSTOMER_ID);
@@ -1693,7 +1711,7 @@ module.exports = function(mongoose, config) {
           },
         })
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       const filtered = _.filter(result, function(org) {
         return org.documents.length > 0;
       });
@@ -1719,7 +1737,7 @@ module.exports = function(mongoose, config) {
         .find( {'_id': { $in : orgIds } } )
         .select('_id valuations');
 
-      const orgs = await query.lean({ virtuals: true });
+      const orgs = await query;
       const result = _.map(orgs, function(org) {
         return helpers.cleanOrg(org, customerId);
       });
@@ -1756,7 +1774,7 @@ module.exports = function(mongoose, config) {
           }
         })
 
-      const result = await query.lean({ virtuals: true });
+      const result = await query;
       const filtered = _.filter(result, function(org) {
         return org.notes.length > 0;
       });
@@ -1775,7 +1793,7 @@ module.exports = function(mongoose, config) {
       const result = await this
         .find({'deleted': {$ne: true}})
         .select('name website websiteAliases')
-        .lean({ virtuals: true });
+        ;
       return result;
     };
 
@@ -1797,7 +1815,7 @@ module.exports = function(mongoose, config) {
       query.select('name logoUrl lps');
       query.populate('lps', 'name customer');
 
-      const orgs = await query.lean({ virtuals: true });
+      const orgs = await query;
       if (!orgs) { return []; }
 
       const result = _.map(orgs, function(org) {
@@ -1835,7 +1853,7 @@ module.exports = function(mongoose, config) {
       });
       query.sort({'createdOn':-1});
 
-      const org = await query.lean({ virtuals: true });
+      const org = await query;
       if (!org) { return []; }
 
       const result = helpers.cleanOrg(org, options.CUSTOMER_ID);
@@ -1866,11 +1884,11 @@ module.exports = function(mongoose, config) {
       });
 
       // get the org requested
-      const org = await query.lean({ virtuals: true });
+      const org = await query;
       if (!org) { return null; }
 
       // get the customer requesting org
-      const customer = await this.findById(options.CUSTOMER_ID).lean({ virtuals: true });
+      const customer = await this.findById(options.CUSTOMER_ID);
       if (!customer) { return null; }
 
       let current = [];
@@ -2167,7 +2185,7 @@ module.exports = function(mongoose, config) {
         .find(query)
         .populate('merged')
         .select('logoUrl name description related website')
-        .lean({ virtuals: true });
+        ;
       if (!orgs) return null;
 
       // remove related from top level

package/lib/Person.js

@@ -150,10 +150,11 @@ module.exports = function(mongoose, config) {
   /////////////
 
   Person.virtual('name.full').get(function () {
+    var personName = this && this.name ? this.name : {};
     var name = '';
-    if(this.name.first) name += this.name.first;
-    if(this.name.first && this.name.last) name += ' ';
-    if(this.name.last) name += this.name.last;
+    if(personName.first) name += personName.first;
+    if(personName.first && personName.last) name += ' ';
+    if(personName.last) name += personName.last;
     return name;
   });
 
@@ -539,7 +540,7 @@ module.exports = function(mongoose, config) {
       if (!person) { return null; }
 
       // get the customer's org
-      const customer = await Organization.findById(options.CUSTOMER_ID).lean({ virtuals: true });
+      const customer = await Organization.findById(options.CUSTOMER_ID);
       if (!customer) { return null; }
 
       let current = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhyasama/totem-models",
-  "version": "12.11.0",
+  "version": "12.12.0",
   "author": "Jason Reynolds",
   "license": "UNLICENSED",
   "description": "Models for Totem platform",

package/test/Organization.js

@@ -1157,8 +1157,7 @@ describe('Organization', function() {
         should.not.exist(err);
         should.exist(org);
 
-        Organization.findById(org._id).lean({ virtuals: true })
-          .then(function(result) {
+        Organization.findById(org._id)          .then(function(result) {
             should.exist(result);
             should.exist(result.address);
             should.exist(result.address.primary);
@@ -1195,8 +1194,7 @@ describe('Organization', function() {
 
         Organization.findById(org._id)
           .select('name')
-          .lean({ virtuals: true })
-          .then(function(result) {
+                    .then(function(result) {
             should.exist(result);
             should.exist(result.address);
             should.equal(result.address.primary, null);

package/test/Virtuals.js

@@ -0,0 +1,131 @@
+"use strict";
+
+var
+
+  should = require("should"),
+  mongoose = require("mongoose"),
+  config = require('./config')['test'];
+
+if (!mongoose.models.Organization) {
+  require('../index')(mongoose, config);
+}
+
+var Organization = mongoose.model('Organization');
+var Person = mongoose.model('Person');
+var LimitedPartner = mongoose.model('LimitedPartner');
+
+var applyVirtual = function(Model, path, doc) {
+  return Model.schema.virtualpath(path).applyGetters(undefined, doc);
+};
+
+describe('Virtuals', function() {
+
+  it('handles projected organization virtuals without parent branches', function() {
+
+    should.equal(applyVirtual(Organization, 'address.primary', { name: 'Org' }), null);
+    applyVirtual(Organization, 'customer.deals.activeStatuses', { name: 'Org' }).should.eql([]);
+    should.equal(applyVirtual(Organization, 'operating.closed.on', { name: 'Org' }), null);
+    should.equal(applyVirtual(Organization, 'operating.acquired.amount', { name: 'Org' }), 0);
+    should.equal(applyVirtual(Organization, 'operating.acquired.by', { name: 'Org' }), null);
+    should.equal(applyVirtual(Organization, 'operating.acquired.on', { name: 'Org' }), null);
+    should.equal(applyVirtual(Organization, 'operating.merged.with', { name: 'Org' }), null);
+    should.equal(applyVirtual(Organization, 'operating.merged.on', { name: 'Org' }), null);
+
+  });
+
+  it('returns organization virtual values when data exists', function() {
+
+    applyVirtual(Organization, 'address.primary', {
+      contact: {
+        address: [
+          { postalCode: '04101', primary: false },
+          { postalCode: '04412', primary: true }
+        ]
+      }
+    }).postalCode.should.equal('04412');
+
+    applyVirtual(Organization, 'customer.deals.activeStatuses', {
+      customer: {
+        deals: {
+          active: true,
+          statuses: [
+            { name: 'Diligence', order: 2, active: true },
+            { name: 'New', order: 1, active: true },
+            { name: 'Pass', order: 3, active: false }
+          ]
+        }
+      }
+    }).should.eql(['New', 'Diligence']);
+
+    applyVirtual(Organization, 'operating.acquired.amount', {
+      operating: {
+        acquired: {
+          public: { amount: 25 }
+        }
+      }
+    }).should.equal(25);
+
+  });
+
+  it('handles projected person virtuals without parent branches', function() {
+
+    applyVirtual(Person, 'name.full', { avatarUrl: '/x.png' }).should.equal('');
+    applyVirtual(Person, 'email.primary', { avatarUrl: '/x.png' }).should.equal('');
+    applyVirtual(Person, 'phone.primary', { avatarUrl: '/x.png' }).should.equal('');
+
+  });
+
+  it('returns person virtual values when data exists', function() {
+
+    applyVirtual(Person, 'name.full', {
+      name: {
+        first: 'Ada',
+        last: 'Lovelace'
+      }
+    }).should.equal('Ada Lovelace');
+
+    applyVirtual(Person, 'email.primary', {
+      contact: {
+        email: [{ email: 'ada@test.com', primary: true }]
+      }
+    }).should.equal('ada@test.com');
+
+    applyVirtual(Person, 'phone.primary', {
+      contact: {
+        phone: [{ number: '123', primary: true }]
+      }
+    }).should.equal('123');
+
+  });
+
+  it('handles projected limited partner virtuals without contact', function() {
+
+    applyVirtual(LimitedPartner, 'email.primary', { name: 'LP' }).should.equal('');
+    applyVirtual(LimitedPartner, 'phone.primary', { name: 'LP' }).should.equal('');
+    applyVirtual(LimitedPartner, 'address.primary', { name: 'LP' }).postalCode.should.equal('');
+
+  });
+
+  it('returns limited partner virtual values when data exists', function() {
+
+    applyVirtual(LimitedPartner, 'email.primary', {
+      contact: {
+        email: [{ email: 'lp@test.com', primary: true }]
+      }
+    }).should.equal('lp@test.com');
+
+    applyVirtual(LimitedPartner, 'phone.primary', {
+      contact: {
+        phone: [{ number: '456', primary: true }]
+      }
+    }).should.equal('456');
+
+    applyVirtual(LimitedPartner, 'address.primary', {
+      contact: {
+        address: [{ postalCode: '04412', primary: true }]
+      }
+    }).postalCode.should.equal('04412');
+
+  });
+
+});