Merge pull request #35 from SoftwareBrothers/beta

Beta

Author: wojtek-krysiak

migrations/20181211174223-create-user.js

@@ -26,6 +26,9 @@ module.exports = {
       email: {
         type: Sequelize.STRING,
       },
+      arrayed: {
+        type: Sequelize.ARRAY(Sequelize.STRING),
+      },
       createdAt: {
         allowNull: false,
         type: Sequelize.DATE,

models/user.js

@@ -11,6 +11,7 @@ module.exports = (sequelize, DataTypes) => {
       allowNull: false,
       validate: { isEmail: true },
     },
+    arrayed: DataTypes.ARRAY(DataTypes.STRING),
   }, {})
   User.associate = function (models) {
     User.hasMany(models.Post, { foreignKey: 'userId' })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "admin-bro-sequelizejs",
-  "version": "0.4.4",
+  "version": "0.5.0-beta.2",
   "description": "Sequelize adapter for AdminBro",
   "main": "index.js",
   "scripts": {
@@ -26,29 +26,31 @@
     }
   },
   "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
+    "@semantic-release/git": "^9.0.0",
+    "@types/mocha": "^7.0.2",
     "admin-bro": "^2.2.0",
     "chai": "^4.2.0",
     "eslint": "^5.10.0",
     "eslint-config-airbnb-base": "^13.1.0",
     "eslint-plugin-import": "^2.14.0",
     "factory-girl": "^5.0.4",
+    "husky": "^4.2.5",
     "lodash": "^4.17.11",
     "mocha": "^5.2.0",
     "mongoose": "^5.3.15",
     "nyc": "^12.0.2",
     "pg": "^7.7.1",
+    "semantic-release": "^17.0.7",
+    "semantic-release-jira-releases-sb": "^0.7.2",
     "sequelize": "^4.42.0",
     "sequelize-cli": "^5.4.0",
     "sinon": "^7.1.1",
-    "sinon-chai": "^3.3.0",
-    "husky": "^4.2.5",
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "semantic-release": "^17.0.7",
-    "semantic-release-jira-releases-sb": "^0.7.2",
-    "@semantic-release/git": "^9.0.0"
+    "sinon-chai": "^3.3.0"
   },
   "dependencies": {
-    "escape-regexp": "0.0.1"
+    "escape-regexp": "0.0.1",
+    "flat": "^5.0.0"
   }
 }

spec/database.spec.js

@@ -12,6 +12,7 @@ describe('Database', function () {
       firstName: Sequelize.STRING,
       lastName: Sequelize.STRING,
       email: Sequelize.STRING,
+      arrayed: Sequelize.ARRAY(Sequelize.STRING),
     }, {})
   })
 

spec/property.spec.js

@@ -12,6 +12,18 @@ describe('Property', function () {
     db.sequelize.close()
   })
 
+  describe('#isArray', function () {
+    it('returns false for regular (not arrayed) property', function () {
+      const property = new Property(this.rawAttributes.email)
+      expect(property.isArray()).to.equal(false)
+    })
+
+    it('returns true for array property', function () {
+      const property = new Property(this.rawAttributes.arrayed)
+      expect(property.isArray()).to.equal(true)
+    })
+  })
+
   describe('#type', function () {
     it('returns correct string type', function () {
       const property = new Property(this.rawAttributes.firstName)
@@ -27,6 +39,11 @@ describe('Property', function () {
       const property = new Property(this.rawAttributes.createdAt)
       expect(property.type()).to.equal('datetime')
     })
+
+    it('returns string when property is an array of strings', function () {
+      const property = new Property(this.rawAttributes.arrayed)
+      expect(property.type()).to.equal('string')
+    })
   })
 
   describe('#availableValues', function () {

spec/resource.spec.js

@@ -50,7 +50,7 @@ describe('Resource', function () {
 
   describe('#properties', function () {
     it('returns all properties', function () {
-      const length = 7 // there are 7 properties in the User model (4 regular + __v and _id)
+      const length = 8 // there are 8 properties in the User model (5 regular + __v and _id)
       expect(this.resource.properties()).to.have.lengthOf(length)
     })
   })
@@ -59,6 +59,17 @@ describe('Resource', function () {
     it('returns given property', function () {
       expect(this.resource.property('email')).to.be.an.instanceOf(Property)
     })
+
+    it('returns null when property doesn\'t exit', function () {
+      expect(this.resource.property('some.imagine.property')).to.be.null
+    })
+
+    it('returns nested property for array field', function () {
+      const property = this.resource.property('arrayed.1')
+
+      expect(property).to.be.an.instanceOf(Property)
+      expect(property.type()).to.equal('string')
+    })
   })
 
   describe('#findMany', function () {

src/property.js

@@ -1,5 +1,10 @@
 const { BaseProperty } = require('admin-bro')
 
+/**
+ * @type {Array<[string, import('admin-bro').PropertyType]>}
+ *
+ * @var {[type]}
+ */
 const TYPES_MAPPING = [
   ['STRING', 'string'],
   ['TEXT', 'string'],
@@ -49,7 +54,7 @@ class Property extends BaseProperty {
   }
 
   reference() {
-    return this.sequelizePath.references && this.sequelizePath.references.model
+    return !this.isArray() && this.sequelizePath.references && this.sequelizePath.references.model
   }
 
   availableValues() {
@@ -58,9 +63,22 @@ class Property extends BaseProperty {
       : null
   }
 
+  isArray() {
+    return this.sequelizePath.type.constructor.name === 'ARRAY'
+  }
+
+  /**
+   * @returns {import('admin-bro').PropertyType}
+   */
   type() {
+    let sequelizeType = this.sequelizePath.type
+
+    if (this.isArray()) {
+      sequelizeType = sequelizeType.type
+    }
+
     const key = TYPES_MAPPING.find(element => (
-      this.sequelizePath.type.constructor.name === element[0]
+      sequelizeType.constructor.name === element[0]
     ))
 
     if (this.reference()) {
@@ -71,6 +89,10 @@ class Property extends BaseProperty {
     return type || 'string'
   }
 
+  isSortable() {
+    return this.type() !== 'mixed' && !this.isArray()
+  }
+
   isRequired() {
     return !(typeof this.sequelizePath.allowNull === 'undefined'
       || this.sequelizePath.allowNull === true)

src/resource.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-param-reassign */
-
+const { unflatten } = require('flat')
 const { BaseResource, BaseRecord } = require('admin-bro')
 const { Op } = require('sequelize')
 
@@ -50,6 +50,16 @@ class Resource extends BaseResource {
   }
 
   property(path) {
+    const nested = path.split('.')
+
+    // if property is an array return the array property
+    if (nested.length > 1 && this.rawAttributes()[nested[0]]) {
+      return new Property(this.rawAttributes()[nested[0]])
+    }
+
+    if (!this.rawAttributes()[path]) {
+      return null
+    }
     return new Property(this.rawAttributes()[path])
   }
 
@@ -116,8 +126,9 @@ class Resource extends BaseResource {
 
   async create(params) {
     const parsedParams = this.parseParams(params)
+    const unflattedParams = unflatten(parsedParams)
     try {
-      const record = await this.SequelizeModel.create(parsedParams)
+      const record = await this.SequelizeModel.create(unflattedParams)
       return record.toJSON()
     } catch (error) {
       if (error.name === SEQUELIZE_VALIDATION_ERROR) {
@@ -129,8 +140,9 @@ class Resource extends BaseResource {
 
   async update(id, params) {
     const parsedParams = this.parseParams(params)
+    const unflattedParams = unflatten(parsedParams)
     try {
-      await this.SequelizeModel.update(parsedParams, {
+      await this.SequelizeModel.update(unflattedParams, {
         where: {
           [this.SequelizeModel.primaryKeyField]: id,
         },

yarn.lock

@@ -1658,6 +1658,11 @@
   resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.0.tgz#69a23a3ad29caf0097f06eda59b361ee2f0639f6"
   integrity sha1-aaI6OtKcrwCX8G7aWbNh7i8GOfY=
 
+"@types/mocha@^7.0.2":
+  version "7.0.2"
+  resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-7.0.2.tgz#b17f16cf933597e10d6d78eae3251e692ce8b0ce"
+  integrity sha512-ZvO2tAcjmMi8V/5Z3JsyofMe3hasRcaw88cto5etSVMwVQfeivGAlEYmaQgceUSVYFofVjT+ioHsATjdWcFt1w==
+
 "@types/node@*", "@types/node@^10.11.7":
   version "10.12.15"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-10.12.15.tgz#20e85651b62fd86656e57c9c9bc771ab1570bc59"
@@ -3086,7 +3091,7 @@ debug@^4.0.1:
   dependencies:
     ms "^2.1.1"
 
-debuglog@*, debuglog@^1.0.1:
+debuglog@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
   integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -3910,6 +3915,13 @@ flat@^4.1.0:
   dependencies:
     is-buffer "~2.0.3"
 
+flat@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/flat/-/flat-5.0.0.tgz#dab7d71d60413becb0ac2de9bf4304495e3af6af"
+  integrity sha512-6KSMM+cHHzXC/hpldXApL2S8Uz+QZv+tq5o/L0KQYleoG+GcwrnIJhTWC7tCOiKQp8D/fIvryINU1OZCCwevjA==
+  dependencies:
+    is-buffer "~2.0.4"
+
 flush-write-stream@^1.0.0:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/flush-write-stream/-/flush-write-stream-1.1.1.tgz#8dd7d873a1babc207d94ead0c2e0e44276ebf2e8"
@@ -4558,7 +4570,7 @@ import-lazy@^2.1.0:
   resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-2.1.0.tgz#05698e3d45c88e8d7e9d92cb0584e77f096f3e43"
   integrity sha1-BWmOPUXIjo1+nZLLBYTnfwlvPkM=
 
-imurmurhash@*, imurmurhash@^0.1.4:
+imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
 
@@ -4698,6 +4710,11 @@ is-buffer@^2.0.2, is-buffer@~2.0.3:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.3.tgz#4ecf3fcf749cbd1e472689e109ac66261a25e725"
 
+is-buffer@~2.0.4:
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.4.tgz#3e572f23c8411a5cfd9557c849e3665e0b290623"
+  integrity sha512-Kq1rokWXOPXWuaMAqZiJW4XxsmD9zGx9q4aePabbn3qCRGedtH7Cm+zV8WETitMfu1wdh+Rvd6w5egwSngUX2A==
+
 is-builtin-module@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/is-builtin-module/-/is-builtin-module-1.0.0.tgz#540572d34f7ac3119f8f76c30cbc1b1e037affbe"
@@ -5479,11 +5496,6 @@ lockfile@^1.0.4:
   dependencies:
     signal-exit "^3.0.2"
 
-lodash._baseindexof@*:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
-  integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
-
 lodash._baseuniq@~4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -5492,33 +5504,11 @@ lodash._baseuniq@~4.6.0:
     lodash._createset "~4.0.0"
     lodash._root "~3.0.0"
 
-lodash._bindcallback@*:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
-  integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
-
-lodash._cacheindexof@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
-  integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
-
-lodash._createcache@*:
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
-  integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
-  dependencies:
-    lodash._getnative "^3.0.0"
-
 lodash._createset@~4.0.0:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
   integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
 
-lodash._getnative@*, lodash._getnative@^3.0.0:
-  version "3.9.1"
-  resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
-  integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
-
 lodash._reinterpolate@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d"
@@ -5563,11 +5553,6 @@ lodash.isstring@^4.0.1:
   resolved "https://registry.yarnpkg.com/lodash.isstring/-/lodash.isstring-4.0.1.tgz#d527dfb5456eca7cc9bb95d5daeaf88ba54a5451"
   integrity sha1-1SfftUVuynzJu5XV2ur4i6VKVFE=
 
-lodash.restparam@*:
-  version "3.6.1"
-  resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
-  integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=
-
 lodash.template@^4.0.2:
   version "4.5.0"
   resolved "https://registry.yarnpkg.com/lodash.template/-/lodash.template-4.5.0.tgz#f976195cf3f347d0d5f52483569fe8031ccce8ab"