pure-orm 2.1.0 → 2.2.0

package/README.md

@@ -76,7 +76,7 @@ class PersonDAO extends BaseDAO {
 And use it like this:
 
 ```javascript
-const person = personDAO.get(55);
+const person = await personDAO.get({ id: 55 });
 console.log(person);
 ```
 
@@ -100,7 +100,7 @@ Person {
       Job {
         id: 278,
         personId: 55,
-        employerId: 26
+        employerId: 26,
         startDate: '2021-01-01',
         endDate: '2021-12-31',
         employer: Employer {
@@ -115,11 +115,37 @@ Person {
 
 > This is a quick showcase. To see how to wire up this code, see the full [Practical Example](#practical-example) below.
 
-Things to note:
+### Things to Note:
 
-- Our DAO returns a single Person business object which is properly structured from the relational row records!
+- Our DAO returns a single Person business object which is properly structured from the many relational row records!
 - Our query is executed with a `one` method. The DAO methods for `one`, `oneOrNone`, `many`, `any` ensure their count against the number of generated top level business objects - not the number of relational row records the sql expression returns!
-- Rather than manually specifying our columns in the sql select expression, we use the business object's `getSQLSelectClause`. This is purely a convenience method which namespaces each column with the table name prefix to ensure column names don't collide. (You are welcome to do this by hand if you don't mind the tedium.)
+- Rather than manually specifying our columns in the sql select expression, we use the business object's `getSQLSelectClause`. This is purely a convenience method which namespaces each column with the table name prefix to ensure column names don't collide (for example, the person, job, and employer `id`s would collide if not namespaced, as would person and employer `name`s). You are welcome to do this by hand instead of using the convenience methods (as were used above), if you don't mind the tedium:
+  ```javascript
+  class PersonDAO extends BaseDAO {
+    get({ id }) {
+      // Example showing you can manually specific the select expression fields
+      // instead of using a business object's `getSQLSelectClause` convenience
+      // method. Note: you must namespace the field with table name and hashtag.
+      const query = `
+        SELECT
+          person.id as "person#id",
+          person.name as "person#name",
+          job.id as "job#id",
+          job.person_id: "job#person_id",
+          job.employer_id: "job#employer_id",
+          job.start_date: "job#start_date",
+          job.end_date: "job#end_date",
+          employer.id as "employer#id",
+          employer.name as "employer#name"
+        FROM person
+        JOIN job on person.id = job.person_id
+        JOIN employer on job.employer_id = employer.id
+        WHERE id = $(id)
+      `;
+      return this.one(query, { id });
+    }
+  }
+  ```
 
 ## Usage
 
@@ -160,18 +186,18 @@ const renderProfile = (req, res) => {
           endDate: '2020-12-31',
           employer: {
             id: 17,
-            name: 'Good Corp',
+            name: 'Good Corp'
           }
         },
         {
           id: 278,
           personId: 55,
-          employerId: 26
+          employerId: 26,
           startDate: '2021-01-01',
           endDate: '2021-12-31',
           employer: {
             id: 26,
-            name: 'Better Corp',
+            name: 'Better Corp'
           }
         }
       ]
@@ -233,7 +259,7 @@ const renderProfile = (req, res) => {
 -       {
 -         id: 278,
 -         personId: 55,
--         employerId: 26
+-         employerId: 26,
 -         startDate: '2021-01-01',
 -         endDate: '2021-12-31',
 -         employer: {
@@ -244,8 +270,7 @@ const renderProfile = (req, res) => {
 -     ]
 -   }
 - };
-+ const personId = req.params.id;
-+ const person = personDAO.get({personId});
++ const person = personDAO.get({ id: req.params.id });
   res.render('profile.html', person);
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pure-orm",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "src/index.js",
   "engines": {
     "node": ">=6"

package/src/bo/base-bo.js

@@ -156,14 +156,19 @@ module.exports = ({ getBusinessObjects }) =>
           const bo = nodeAlreadySeen || _bo;
           const isNodeAlreadySeen = !!nodeAlreadySeen;
           const nodePointingToIt = nodes.find(node => {
-            const index = Object.values(node.constructor.references).indexOf(
-              bo.constructor
-            );
-            if (index === -1) {
+            const indexes = Object.values(node.constructor.references)
+              .map((x, i) => (x === bo.constructor ? i : null))
+              .filter(x => x != null);
+            if (!indexes.length) {
               return false;
             }
-            const property = Object.keys(node.constructor.references)[index];
-            return node[property] === bo.id;
+            for (const index of indexes) {
+              const property = Object.keys(node.constructor.references)[index];
+              if (node[property] === bo.id) {
+                return true;
+              }
+            }
+            return false;
           });
           // For first obj type which is has an instance in nodes array,
           // get its index in nodes array

package/src/bo/base-bo.spec.js

@@ -18,6 +18,8 @@ const eight = require('../../test-utils/eight/results.json');
 const nine = require('../../test-utils/nine/results.json');
 const ten = require('../../test-utils/ten/results.json');
 const eleven = require('../../test-utils/eleven/results.json');
+const twelve = require('../../test-utils/twelve/results.json');
+const Prompt = require('../../test-utils/twelve/bo/prompt');
 
 test('Bo#parseFromDatabase where multiple rows reduce to one nested object (with all one-to-one or one-to-many tables)', () => {
   const order = Order.createOneFromDatabase(one);
@@ -528,3 +530,18 @@ test('Bo#parseFromDatabase 11', () => {
   // I'm insecure about the lack of tests so just going at it cause I can.
   // TODO add more later
 });
+
+// Issue occcurs in nestClump
+// Problem when a table references another model twice (two columns)
+test('Bo#parseFromDatabase 12', () => {
+  let prompt;
+  try {
+    // This failed when the bug was present
+    prompt = Prompt.createFromDatabase(twelve);
+  } catch (e) {
+    expect(e).not.toBeDefined();
+  }
+  expect(prompt).toBeDefined();
+  // Ideally the below should work
+  // expect(prompt.fromMember.id).toEqual(1);
+});

package/test-utils/twelve/bo/base.js

@@ -0,0 +1,5 @@
+const { createBaseBO } = require('pure-orm');
+const getBusinessObjects = require('../business-objects');
+
+const constructor = createBaseBO({ getBusinessObjects });
+module.exports = constructor;

package/test-utils/twelve/bo/member.js

@@ -0,0 +1,16 @@
+const Base = require('./base');
+const Members = require('./members');
+
+class Member extends Base {
+  get BoCollection() {
+    return Members;
+  }
+  static get tableName() {
+    return 'member';
+  }
+
+  static get sqlColumnsData() {
+    return ['id'];
+  }
+}
+module.exports = Member;

package/test-utils/twelve/bo/members.js

@@ -0,0 +1,9 @@
+const { BaseBoCollection } = require('../../../src/index');
+
+class Members extends BaseBoCollection {
+  static get Bo() {
+    return require('./member'); // eslint-disable-line
+  }
+}
+
+module.exports = Members;

package/test-utils/twelve/bo/prompt.js

@@ -0,0 +1,20 @@
+const Base = require('./base');
+const Prompts = require('./prompts');
+const Member = require('./member');
+
+class Prompt extends Base {
+  get BoCollection() {
+    return Prompts;
+  }
+  static get tableName() {
+    return 'prompt';
+  }
+  static get sqlColumnsData() {
+    return [
+      'id',
+      { column: 'for_member_id', references: Member },
+      { column: 'from_member_id', references: Member }
+    ];
+  }
+}
+module.exports = Prompt;

package/test-utils/twelve/bo/prompts.js

@@ -0,0 +1,9 @@
+const { BaseBoCollection } = require('../../../src/index');
+
+class Prompts extends BaseBoCollection {
+  static get Bo() {
+    return require('./prompt'); // eslint-disable-line
+  }
+}
+
+module.exports = Prompts;

package/test-utils/twelve/business-objects.js

@@ -0,0 +1,8 @@
+/* eslint-disable global-require */
+const getBusinessObjects = () => [
+  // These need to be imported here to get around circular dependencies
+  require('./bo/prompt'),
+  require('./bo/member')
+];
+
+module.exports = getBusinessObjects;

package/test-utils/twelve/results.json

@@ -0,0 +1,8 @@
+[
+  {
+    "prompt#id": 13,
+    "prompt#for_member_id": 336,
+    "prompt#from_member_id": 1,
+    "member#id": 1
+  }
+]