feat: add leoric_bone meta data to Bone (#324)

Co-authored-by: JimmyDaddy <[email protected]>

index.js

@@ -14,6 +14,7 @@ const Realm = require('./src/realm');
 const Decorators = require('./src/decorators');
 const Raw = require('./src/raw');
 const { MysqlDriver, PostgresDriver, SqliteDriver, AbstractDriver } = require('./src/drivers');
+const { isBone } = require('./src/utils');
 
 /**
  * @typedef {Object} RawSql
@@ -64,6 +65,7 @@ Object.assign(Realm, {
   SqliteDriver,
   AbstractDriver,
   Raw,
+  isBone,
 });
 
 module.exports = Realm;

src/bone.js

@@ -21,6 +21,7 @@ const {
   LEGACY_TIMESTAMP_COLUMN_MAP,
   ASSOCIATE_METADATA_MAP,
   TIMESTAMP_ATTRIBUTE_NAMES,
+  IS_LEORIC_BONE,
 } = require('./constants');
 
 const columnAttributesKey = Symbol('leoric#columns');
@@ -1715,4 +1716,6 @@ for (const getter of Spell_getters) {
   });
 }
 
+Reflect.defineMetadata(IS_LEORIC_BONE, true, Bone);
+
 module.exports = Bone;

src/constants.js

@@ -36,6 +36,8 @@ const ASSOCIATE_METADATA_MAP = {
   belongsTo: Symbol('belongsTo'),
 };
 
+const IS_LEORIC_BONE = Symbol('leoric#bone');
+
 module.exports = {
   AGGREGATOR_MAP,
   LEGACY_TIMESTAMP_MAP,
@@ -44,4 +46,5 @@ module.exports = {
   ASSOCIATE_METADATA_MAP,
   TIMESTAMP_ATTRIBUTE_NAMES,
   AGGREGATORS,
+  IS_LEORIC_BONE,
 };

src/realm.js

@@ -6,6 +6,7 @@ const path = require('path');
 const Bone = require('./bone');
 const { findDriver, AbstractDriver } = require('./drivers');
 const { camelCase } = require('./utils/string');
+const { isBone } = require('./utils');
 const sequelize = require('./adapters/sequelize');
 const Raw = require('./raw');
 const { LEGACY_TIMESTAMP_MAP } = require('./constants');
@@ -33,7 +34,7 @@ async function findModels(dir) {
     const extname = path.extname(entry.name);
     if (entry.isFile() && ['.js', '.mjs'].includes(extname)) {
       const model = require(path.join(dir, entry.name));
-      if (model.prototype instanceof Bone) models.push(model);
+      if (isBone(model)) models.push(model);
     }
   }
 

src/utils/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { performance } = require('perf_hooks');
+const { IS_LEORIC_BONE } = require('../constants');
 
 function isPlainObject(value) {
   return Object.prototype.toString.call(value) === '[object Object]';
@@ -43,10 +44,17 @@ const logger = {};
   };
 });
 
+function isBone(bone) {
+  if (!bone || (typeof bone !== 'object' && typeof bone !== 'function')) return false;
+  const metaValue = Reflect.getMetadata(IS_LEORIC_BONE, bone);
+  return metaValue === true;
+}
+
 module.exports = {
   isPlainObject,
   compose,
   getPropertyNames,
   calculateDuration,
   logger,
+  isBone,
 };

test/unit/utils/index.test.js

@@ -1,8 +1,8 @@
 'use strict';
 
 const assert = require('assert').strict;
-const { Bone } = require('../../..');
-const { compose, getPropertyNames, logger } = require('../../../src/utils');
+const { Bone, sequelize } = require('../../..');
+const { compose, getPropertyNames, logger, isBone } = require('../../../src/utils');
 
 describe('=> compose', function() {
   it('should return a default function if nothing to compose', function() {
@@ -71,3 +71,20 @@ describe('=> logger', function() {
     logger.log('foo');
   });
 });
+
+describe('=> isBone', () => {
+  it('should work', () => {
+    assert.equal(isBone(), false);
+    assert.equal(isBone(null), false);
+    assert.equal(isBone(1), false);
+    assert.equal(isBone(() => {}), false);
+    assert.equal(isBone({}), false);
+    assert.equal(isBone(Bone), true);
+    class Note {}
+    assert.equal(isBone(Note), false);
+    class Note1 extends Bone {}
+    assert.equal(isBone(Note1), true);
+    assert.equal(isBone(sequelize(Note1)), true);
+    assert.equal(isBone(sequelize(Note)), false);
+  });
+});