simplify helpers: added simplify.entities

fix #29

docs/simplify_entities_data.md

@@ -24,7 +24,7 @@ wdk.simplify.entity(entity)
 ```
 You can also pass options as a second argument, that will then be passed the subfunctions: currently only [simplify claims](simplify_claims.md) and [simplify sitelinks](#simplify-sitelinks).
 ```js
-wdk.simplify.entity(entity, {
+const simplificationOptions = {
   // claims
   entityPrefix: 'wd',
   propertyPrefix: 'wdt',
@@ -36,6 +36,19 @@ wdk.simplify.entity(entity, {
   keepNonTruthy: true,
   // sitelinks
   addUrl: true
+}
+wdk.simplify.entity(entity, simplificationOptions)
+```
+
+## Simplify entities
+Same as [`wdk.simplify.entity`](#simplify-entity), but accepts the all the entities sent by the Wikidata API at once:
+```js
+const url = wdk.getEntities(['Q1', 'Q2', 'Q3'])
+fetch(url)
+.then(res => {
+  const { entities } = res.json()
+  # simplificationOptions: see wdk.simplify.entity doc above
+  const simplifiedEntities = wdk.simplify.entity(entities, simplificationOptions)
 })
 ```
 

lib/helpers/simplify_entity.js

@@ -2,7 +2,7 @@ const { simplifyClaims } = require('./simplify_claims')
 const simplify = require('./simplify_text_attributes')
 const simplifySitelinks = require('./simplify_sitelinks')
 
-module.exports = (entity, options) => {
+const simplifyEntity = (entity, options) => {
   const simplified = {
     id: entity.id,
     type: entity.type,
@@ -29,3 +29,12 @@ const simplifyIfDefined = (entity, simplified, attribute) => {
     simplified[attribute] = simplify[attribute](entity[attribute])
   }
 }
+
+const simplifyEntities = (entities, options) => {
+  return Object.keys(entities).reduce((obj, key) => {
+    obj[key] = simplifyEntity(entities[key], options)
+    return obj
+  }, {})
+}
+
+module.exports = { simplifyEntity, simplifyEntities }

lib/index.js

@@ -14,7 +14,9 @@ const claimsSimplifiers = require('./helpers/simplify_claims')
 const simplifySparqlResults = require('./helpers/simplify_sparql_results')
 
 wdk.simplify = require('../lib/helpers/simplify_text_attributes')
-wdk.simplify.entity = require('../lib/helpers/simplify_entity')
+const { simplifyEntity, simplifyEntities } = require('../lib/helpers/simplify_entity')
+wdk.simplify.entity = simplifyEntity
+wdk.simplify.entities = simplifyEntities
 wdk.simplify.claim = claimsSimplifiers.simplifyClaim
 wdk.simplify.propertyClaims = claimsSimplifiers.simplifyPropertyClaims
 wdk.simplify.claims = claimsSimplifiers.simplifyClaims
@@ -23,6 +25,7 @@ wdk.simplify.sparqlResults = simplifySparqlResults
 
 // Legacy
 wdk.simplifySparqlResults = require('./helpers/simplify_sparql_results')
+// Legacy + truthyClaims + truthyPropertyClaims
 Object.assign(wdk, claimsSimplifiers)
 
 // Aliases

test/general.js

@@ -15,6 +15,7 @@ describe('general', function () {
 
     wdk.simplify.should.be.a.Object()
     wdk.simplify.entity.should.be.a.Function()
+    wdk.simplify.entities.should.be.a.Function()
     wdk.simplify.labels.should.be.a.Function()
     wdk.simplify.descriptions.should.be.a.Function()
     wdk.simplify.aliases.should.be.a.Function()

test/simplify_entity.js

@@ -2,7 +2,7 @@ require('should')
 const Q571 = require('./data/Q571.json')
 const _ = require('lodash')
 
-const simplifyEntity = require('../lib/helpers/simplify_entity')
+const { simplifyEntity, simplifyEntities } = require('../lib/helpers/simplify_entity')
 
 describe('simplify.entity', () => {
   it('should be a function', (done) => {
@@ -11,7 +11,8 @@ describe('simplify.entity', () => {
   })
 
   it('should return a simplified entity', (done) => {
-    const simplifiedEntity = simplifyEntity(Q571)
+    const Q571Clone = _.cloneDeep(Q571)
+    const simplifiedEntity = simplifyEntity(Q571Clone)
     simplifiedEntity.labels.fr.should.equal('livre')
     simplifiedEntity.descriptions.fr.should.equal('document écrit formé de pages reliées entre elles')
     simplifiedEntity.aliases.pl.should.be.an.Array()
@@ -23,7 +24,8 @@ describe('simplify.entity', () => {
   })
 
   it('should pass options down to subfunctions', (done) => {
-    const simplifiedEntity = simplifyEntity(Q571, { keepQualifiers: true, keepIds: true, addUrl: true })
+    const Q571Clone = _.cloneDeep(Q571)
+    const simplifiedEntity = simplifyEntity(Q571Clone, { keepQualifiers: true, keepIds: true, addUrl: true })
     simplifiedEntity.labels.fr.should.equal('livre')
     simplifiedEntity.descriptions.fr.should.equal('document écrit formé de pages reliées entre elles')
     simplifiedEntity.aliases.pl.should.be.an.Array()
@@ -38,12 +40,29 @@ describe('simplify.entity', () => {
   })
 
   it('should accept partial entities', (done) => {
+    const Q571Clone = _.cloneDeep(Q571)
     const emptyEntity = simplifyEntity({})
     Object.keys(emptyEntity).length.should.equal(3)
-    const partialEntity = simplifyEntity(_.pick(Q571, 'id', 'type', 'labels'))
+    const partialEntity = simplifyEntity(_.pick(Q571Clone, 'id', 'type', 'labels'))
     Object.keys(partialEntity).length.should.equal(4)
     partialEntity.labels.should.be.an.Object()
     partialEntity.labels.fr.should.equal('livre')
     done()
   })
 })
+
+describe('simplify.entities', () => {
+  it('should accept enities objects', (done) => {
+    const Q571Clone = _.cloneDeep(Q571)
+    const entities = { Q571: Q571Clone }
+    const simplifiedEntities = simplifyEntities(entities)
+    simplifiedEntities.Q571.labels.fr.should.equal('livre')
+    simplifiedEntities.Q571.descriptions.fr.should.equal('document écrit formé de pages reliées entre elles')
+    simplifiedEntities.Q571.aliases.pl.should.be.an.Array()
+    simplifiedEntities.Q571.aliases.pl[0].should.equal('Tom')
+    simplifiedEntities.Q571.claims.P279.should.be.an.Array()
+    simplifiedEntities.Q571.claims.P279[0].should.equal('Q2342494')
+    simplifiedEntities.Q571.sitelinks.afwiki.should.equal('Boek')
+    done()
+  })
+})