remove transform default function, its dangerous (#88)

Author: jescalan

lib/index.js

@@ -14,7 +14,7 @@ const bindAllClass = require('es6bindall')
 // Anything that is not duplicated in the spike-records source will be clearly
 // explained and annotated here!
 class Contentful {
-  constructor (opts) {
+  constructor(opts) {
     Object.assign(this, validate(opts))
     // initialize the contentful api client
     this.client = contentful.createClient({
@@ -24,7 +24,7 @@ class Contentful {
     bindAllClass(this, ['apply', 'run'])
   }
 
-  apply (compiler) {
+  apply(compiler) {
     this.util = new SpikeUtil(compiler.options)
     this.util.runAll(compiler, this.run)
     let templatePairs
@@ -36,10 +36,14 @@ class Contentful {
         templatePairs = this.contentTypes.reduce((m, model, idx) => {
           if (!model.template) return m
           if (!model.template.path) {
-            throw new Error(`${model.name}.template must have a "path" property`)
+            throw new Error(
+              `${model.name}.template must have a "path" property`
+            )
           }
           if (!model.template.output) {
-            throw new Error(`${model.name}.template must have an "output" function`)
+            throw new Error(
+              `${model.name}.template must have an "output" function`
+            )
           }
           m[model.template.path] = idx
           return m
@@ -55,8 +59,11 @@ class Contentful {
       const data = this.addDataTo.contentful[conf.name]
 
       // add a reshape multi option to compile each template separately
-      options.multi = data.map((d) => {
-        return { locals: Object.assign({}, this.addDataTo, { item: d }), name: conf.template.output(d) }
+      options.multi = data.map(d => {
+        return {
+          locals: Object.assign({}, this.addDataTo, { item: d }),
+          name: conf.template.output(d)
+        }
       })
       return options
     })
@@ -66,36 +73,47 @@ class Contentful {
         writeJson(compilation, this.json, this.addDataTo.contentful)
       }
 
-      this.contentTypes.filter((ct) => ct.json).map((ct) => {
-        return writeJson(compilation, ct.json, this.addDataTo.contentful[ct.name])
+      this.contentTypes.filter(ct => ct.json).map(ct => {
+        return writeJson(
+          compilation,
+          ct.json,
+          this.addDataTo.contentful[ct.name]
+        )
       })
 
       done()
     })
   }
 
-  run (compilation, done) {
+  run(compilation, done) {
     // only pull data on the initial compile in watch mode
     if (this.addDataTo.contentful && !this.aggressiveRefresh) return done()
 
-    return W.reduce(this.contentTypes, (m, ct) => {
-      let transformFn = ct.transform
-      let options = Object.assign({
-        content_type: ct.id,
-        include: this.includeLevel
-      }, ct.filters)
-
-      if (transformFn === true) transformFn = transform
-      if (transformFn === false) transformFn = (x) => x
-
-      return W(this.client.getEntries(options))
-        .then(response => {
-          return W.map(response.items, (entry) => transformFn(entry))
-        })
-        .tap((res) => { m[ct.name] = res })
-        .yield(m)
-    }, {}).done((res) => {
-
+    return W.reduce(
+      this.contentTypes,
+      (m, ct) => {
+        let transformFn = ct.transform
+        let options = Object.assign(
+          {
+            content_type: ct.id,
+            include: this.includeLevel
+          },
+          ct.filters
+        )
+
+        if (transformFn === false) transformFn = x => x
+
+        return W(this.client.getEntries(options))
+          .then(response => {
+            return W.map(response.items, entry => transformFn(entry))
+          })
+          .tap(res => {
+            m[ct.name] = res
+          })
+          .yield(m)
+      },
+      {}
+    ).done(res => {
       this.addDataTo = Object.assign(this.addDataTo, { contentful: res })
       done()
     }, done)
@@ -106,7 +124,7 @@ class Contentful {
  * Validate options
  * @private
  */
-function validate (opts = {}) {
+function validate(opts = {}) {
   const schema = Joi.object().keys({
     accessToken: Joi.string().required(),
     spaceId: Joi.string().required(),
@@ -119,9 +137,15 @@ function validate (opts = {}) {
         name: Joi.string(),
         ordered: Joi.boolean().default(false),
         filters: Joi.object().keys({
-          limit: Joi.number().integer().min(1).max(100).default(100)
+          limit: Joi.number()
+            .integer()
+            .min(1)
+            .max(100)
+            .default(100)
         }),
-        transform: Joi.alternatives().try(Joi.boolean(), Joi.func()).default(false),
+        transform: Joi.alternatives()
+          .try(Joi.boolean(), Joi.func())
+          .default(false),
         json: Joi.string()
       })
     )
@@ -134,61 +158,13 @@ function validate (opts = {}) {
       object: { child: '!![spike-contentful constructor] option {{reason}}' }
     }
   })
-  if (res.error) { throw new Error(res.error) }
-  return res.value
-}
-
-/**
- * Transform the Contentful response object to make it less messy
- * @private
- */
-function transform (entry) {
-  Object.assign(entry.fields, extractMeta(entry.sys))
-
-  return recursiveTransform(entry, 'fields')
-}
-
-/**
- * Transform the Contentful response to remove the fields key and move the
- * data up one level.
- * @private
- */
-function recursiveTransform (obj, key) {
-  if (typeof obj !== 'object' || obj === null) {
-    return obj
-  }
-
-  if (Array.isArray(obj)) {
-    return obj.map(o => recursiveTransform(o))
+  if (res.error) {
+    throw new Error(res.error)
   }
-
-  return Object.keys(obj).reduce((prev, curr) => {
-    if (curr === key) {
-      prev = recursiveTransform(obj[curr])
-    } else if (curr === 'sys') {
-      prev = extractMeta(obj[curr])
-    } else {
-      prev[curr] = recursiveTransform(obj[curr])
-    }
-
-    return prev
-  }, {})
-}
-
-/**
- * Extracts specified meta properties from Contentful's sys object and
- * returns a new object
- * @private
- */
-function extractMeta (sys) {
-  const props = ['id', 'createdAt', 'updatedAt', 'contentType']
-  return props.reduce((m, p) => {
-    if (sys[p]) m[p] = sys[p] // include only defined fields
-    return m
-  }, {})
+  return res.value
 }
 
-function writeJson (compilation, filename, data) {
+function writeJson(compilation, filename, data) {
   const src = JSON.stringify(data, null, 2)
   compilation.assets[filename] = {
     source: () => src,
@@ -197,4 +173,3 @@ function writeJson (compilation, filename, data) {
 }
 
 module.exports = Contentful
-module.exports.transform = transform

package.json

@@ -9,18 +9,18 @@
   },
   "bugs": "https://github.com/static-dev/spike-contentful/issues",
   "dependencies": {
-    "contentful": "^4.5.0",
+    "contentful": "^5.0.5",
     "es6bindall": "^0.0.9",
     "joi": "^10.6.0",
     "when": "^3.7.8"
   },
   "devDependencies": {
-    "ava": "^0.21.0",
-    "coveralls": "^2.13.1",
-    "dotenv": "^4.0.0",
-    "nyc": "^11.0.3",
-    "reshape-standard": "^3.1.0",
-    "rimraf": "^2.6.0",
+    "ava": "^0.25.0",
+    "coveralls": "^3.0.0",
+    "dotenv": "^5.0.0",
+    "nyc": "^11.4.1",
+    "reshape-standard": "^3.3.0",
+    "rimraf": "^2.6.2",
     "spike-core": "^2.2.0",
     "standard": "^10.0.3"
   },