pure-orm 2.0.0 → 2.3.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/examples/order-more/bo/customer.js

@@ -0,0 +1,18 @@
+const Base = require('./base');
+const Customers = require('./customers');
+
+class Customer extends Base {
+  get BoCollection() {
+    return Customers;
+  }
+
+  static get tableName() {
+    return 'customer';
+  }
+
+  static get sqlColumnsData() {
+    return ['id', 'email'];
+  }
+}
+
+module.exports = Customer;

package/examples/order-more/bo/customers.js

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

package/examples/order-more/bo/line-item.js

@@ -0,0 +1,33 @@
+const Base = require('./base');
+const LineItems = require('./line-items');
+const ProductVariant = require('./product-variant');
+const Order = require('./order');
+
+class LineItem extends Base {
+  get BoCollection() {
+    return LineItems;
+  }
+
+  static get tableName() {
+    return 'line_item';
+  }
+
+  static get sqlColumnsData() {
+    return [
+      'id',
+      { column: 'product_variant_id', references: ProductVariant },
+      { column: 'order_id', references: Order },
+      'fulfillment_status_id',
+      'fulfillable_quantity',
+      'fulfillment_service',
+      'grams',
+      'price',
+      'quantity',
+      'requires_shipping',
+      'taxable',
+      'total_discount'
+    ];
+  }
+}
+
+module.exports = LineItem;

package/examples/order-more/bo/line-items.js

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

package/examples/order-more/bo/order.js

@@ -0,0 +1,49 @@
+const BaseBo = require('./base');
+const Orders = require('./orders');
+const UtmSource = require('./utm-source');
+const Customer = require('./customer');
+const PhysicalAddress = require('./physical-address');
+
+class Order extends BaseBo {
+  get BoCollection() {
+    return Orders;
+  }
+
+  static get tableName() {
+    return 'order';
+  }
+
+  static get sqlColumnsData() {
+    return [
+      'id',
+      'email',
+      { column: 'customer_id', references: Customer },
+      { column: 'shipping_address_id', references: PhysicalAddress },
+      { column: 'billing_address_id', references: PhysicalAddress },
+      'browser_ip',
+      'browser_user_agent',
+      'kujo_imported_date',
+      'created_date',
+      'cancel_reason',
+      'cancelled_date',
+      'closed_date',
+      'processed_date',
+      'updated_date',
+      'note',
+      'subtotal_price',
+      'taxes_included',
+      'total_discounts',
+      'total_price',
+      'total_tax',
+      'total_weight',
+      'order_status_url',
+      { column: 'utm_source_id', references: UtmSource },
+      'utm_medium_id',
+      'utm_campaign',
+      'utm_content',
+      'utm_term'
+    ];
+  }
+}
+
+module.exports = Order;

package/examples/order-more/bo/orders.js

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

package/examples/order-more/bo/parcel-event.js

@@ -0,0 +1,19 @@
+const Base = require('./base');
+const ParcelEvents = require('./parcel-events');
+const Parcel = require('./parcel');
+
+class ParcelEvent extends Base {
+  get BoCollection() {
+    return ParcelEvents;
+  }
+
+  static get tableName() {
+    return 'parcel_event';
+  }
+
+  static get sqlColumnsData() {
+    return ['id', { column: 'parcel_id', references: Parcel }, 'eta', 'status'];
+  }
+}
+
+module.exports = ParcelEvent;

package/examples/order-more/bo/parcel-events.js

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

package/examples/order-more/bo/parcel-line-item.js

@@ -0,0 +1,24 @@
+const Base = require('./base');
+const ParcelLineItems = require('./parcel-line-items');
+const LineItem = require('./line-item');
+const Parcel = require('./parcel');
+
+class ParcelLineItem extends Base {
+  get BoCollection() {
+    return ParcelLineItems;
+  }
+
+  static get tableName() {
+    return 'parcel_line_item';
+  }
+
+  static get sqlColumnsData() {
+    return [
+      'id',
+      { column: 'line_item_id', references: LineItem },
+      { column: 'parcel_id', references: Parcel }
+    ];
+  }
+}
+
+module.exports = ParcelLineItem;

package/examples/order-more/bo/parcel-line-items.js

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

package/examples/order-more/bo/parcel.js

@@ -0,0 +1,18 @@
+const BaseBo = require('./base');
+const Parcels = require('./parcels');
+
+class Parcel extends BaseBo {
+  get BoCollection() {
+    return Parcels;
+  }
+
+  static get tableName() {
+    return 'parcel';
+  }
+
+  static get sqlColumnsData() {
+    return ['id'];
+  }
+}
+
+module.exports = Parcel;

package/examples/order-more/bo/parcels.js

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

package/examples/order-more/bo/physical-address.js

@@ -0,0 +1,30 @@
+const Base = require('./base');
+const PhysicalAddresses = require('./physical-addresses');
+
+class PhysicalAddress extends Base {
+  get BoCollection() {
+    return PhysicalAddresses;
+  }
+
+  static get tableName() {
+    return 'physical_address';
+  }
+
+  static get sqlColumnsData() {
+    return [
+      'id',
+      'address1',
+      'address2',
+      'city',
+      'province',
+      'zip',
+      'country',
+      'province_code',
+      'country_code',
+      'latitude',
+      'longitude'
+    ];
+  }
+}
+
+module.exports = PhysicalAddress;

package/examples/order-more/bo/physical-addresses.js

@@ -0,0 +1,12 @@
+const { BaseBoCollection } = require('../../../src/index');
+
+class PhysicalAddresses extends BaseBoCollection {
+  static get displayName() {
+    return 'physicalAddresses';
+  }
+  static get Bo() {
+    return require('./physical-address'); // eslint-disable-line
+  }
+}
+
+module.exports = PhysicalAddresses;

package/examples/order-more/bo/refund.js

@@ -0,0 +1,28 @@
+const Base = require('./base');
+const Order = require('./order');
+const Refunds = require('./refunds');
+
+class Refund extends Base {
+  get BoCollection() {
+    return Refunds;
+  }
+
+  static get tableName() {
+    return 'refund';
+  }
+
+  static get sqlColumnsData() {
+    return [
+      'id',
+      { column: 'order_id', references: Order },
+      'shopify_id',
+      'created_date',
+      'processed_date',
+      'kujo_imported_date',
+      'amount',
+      'note',
+      'restock'
+    ];
+  }
+}
+module.exports = Refund;

package/examples/order-more/bo/refunds.js

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

package/examples/order-more/bo/utm-medium.js

@@ -0,0 +1,13 @@
+const Base = require('./base');
+
+class UtmMedium extends Base {
+  static get tableName() {
+    return 'utm_medium';
+  }
+
+  static get sqlColumnsData() {
+    return ['id', 'value', 'label'];
+  }
+}
+
+module.exports = UtmMedium;

package/examples/order-more/bo/utm-source.js

@@ -0,0 +1,13 @@
+const Base = require('./base');
+
+class UtmSource extends Base {
+  static get tableName() {
+    return 'utm_source';
+  }
+
+  static get sqlColumnsData() {
+    return ['id', 'value', 'label', 'internal'];
+  }
+}
+
+module.exports = UtmSource;

package/examples/order-more/business-objects.js

@@ -10,7 +10,17 @@ const getBusinessObjects = () => [
   require('./bo/color'),
   require('./bo/gender'),
   require('./bo/shipment'),
-  require('./bo/shipment-actual-product-variant')
+  require('./bo/shipment-actual-product-variant'),
+  require('./bo/refund'),
+  require('./bo/order'),
+  require('./bo/line-item'),
+  require('./bo/customer'),
+  require('./bo/physical-address'),
+  require('./bo/utm-source'),
+  require('./bo/utm-medium'),
+  require('./bo/parcel-line-item'),
+  require('./bo/parcel'),
+  require('./bo/parcel-event')
 ];
 
 module.exports = getBusinessObjects;

package/package.json

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

package/src/bo/base-bo.js

@@ -147,7 +147,6 @@ module.exports = ({ getBusinessObjects }) =>
 
       // Wowzer is this both CPU and Memory inefficient
       clump.forEach(array => {
-        const oldestParentType = array[0].constructor;
         array.forEach(_bo => {
           const nodeAlreadySeen = nodes.find(
             x =>
@@ -157,22 +156,36 @@ 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
+          const indexOfOldestParent = array.reduce((answer, obj) => {
+            if (answer != null) {
+              return answer;
+            }
+            const index = nodes.findIndex(
+              n => n.constructor === obj.constructor
+            );
+            if (index !== -1) {
+              return index;
+            }
+            return null;
+          }, null);
           const parentHeirarchy = [
-            ...nodes
-              .slice(
-                0,
-                nodes.findIndex(n => n.constructor === oldestParentType) + 1
-              )
-              .reverse(),
+            ...nodes.slice(0, indexOfOldestParent + 1).reverse(),
             root
           ];
           const nodeItPointsTo = parentHeirarchy.find(parent => {
@@ -197,7 +210,7 @@ module.exports = ({ getBusinessObjects }) =>
             // shown to be the parent (of parcel_events).
             const ec = bo[nodePointingToIt.BoCollection.displayName];
             if (ec && ec.models.find(m => m === nodePointingToIt)) {
-              // nodes = [bo, ...nodes];
+              nodes = [bo, ...nodes];
               return;
             }
           }
@@ -270,13 +283,13 @@ module.exports = ({ getBusinessObjects }) =>
     getSqlInsertParts() {
       const columns = this.constructor.sqlColumns
         .filter(
-          (column, index) => this[this.constructor.columns[index]] != null
+          (column, index) => this[this.constructor.columns[index]] !== void 0
         )
         .map(col => `"${col}"`)
         .join(', ');
       const values = this.constructor.columns
         .map(column => this[column])
-        .filter(value => value != null);
+        .filter(value => value !== void 0);
       const valuesVar = values.map((value, index) => `$${index + 1}`);
       return { columns, values, valuesVar };
     }
@@ -284,14 +297,14 @@ module.exports = ({ getBusinessObjects }) =>
     getSqlUpdateParts(on = 'id') {
       const clauseArray = this.constructor.sqlColumns
         .filter(
-          (sqlColumn, index) => this[this.constructor.columns[index]] != null
+          (sqlColumn, index) => this[this.constructor.columns[index]] !== void 0
         )
         .map((sqlColumn, index) => `"${sqlColumn}" = $${index + 1}`);
       const clause = clauseArray.join(', ');
       const idVar = `$${clauseArray.length + 1}`;
       const _values = this.constructor.columns
         .map(column => this[column])
-        .filter(value => value != null);
+        .filter(value => value !== void 0);
       const values = [..._values, this[on]];
       return { clause, idVar, values };
     }