feat(sloth-database): add queryKeys and queryKeyIDs methods

compactd · Apr 18, 2018 · 3261413 · 3261413
1 parent 578519f
commit 3261413
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 5 deletions.
diff --git a/src/models/SlothDatabase.ts b/src/models/SlothDatabase.ts
@@ -4,6 +4,7 @@ import { Subscriber, ChangeAction, ActionType } from './changes'
 import EntityConstructor from '../helpers/EntityConstructor'
 import getProtoData from '../utils/getProtoData'
 import { join } from 'path'
+import Dict from '../helpers/Dict'
 
 /**
  * This represent a Database
@@ -82,6 +83,59 @@ export default class SlothDatabase<
       })
   }
 
+  /**
+   * Queries keys. Returns an array of emitted keys
+   * 
+   * @param factory the pouch factory
+   * @param view the view identifier
+   * @param startKey the optional startkey
+   * @param endKey the optional endkey
+   */
+  queryKeys(
+    factory: PouchFactory<S>,
+    view: V,
+    startKey = '',
+    endKey = join(startKey, '\uffff')
+  ): Promise<string[]> {
+    return factory(this._name)
+      .query(view, {
+        startkey: startKey,
+        endkey: endKey,
+        include_docs: false
+      })
+      .then(({ rows }) => {
+        return rows.map(({ key }) => key)
+      })
+  }
+
+  /**
+   * Queries keys/_id map. Returns a map of emitted keys/ID
+   * 
+   * @param factory the pouch factory
+   * @param view the view identifier
+   * @param startKey the optional startkey
+   * @param endKey the optional endkey
+   */
+  queryKeysIDs(
+    factory: PouchFactory<S>,
+    view: V,
+    startKey = '',
+    endKey = join(startKey, '\uffff')
+  ) {
+    return factory(this._name)
+      .query(view, {
+        startkey: startKey,
+        endkey: endKey,
+        include_docs: false
+      })
+      .then(({ rows }) => {
+        return rows.reduce(
+          (acc, { key, id }) => ({ ...acc, [key]: id }),
+          {} as Dict<string>
+        )
+      })
+  }
+
   /**
    * Returns a database that will only find entities with _id
    * starting with the root path

diff --git a/test/integration/Track.ts b/test/integration/Track.ts
@@ -2,6 +2,7 @@ import {
   BaseEntity,
   SlothDatabase,
   SlothEntity,
+  SlothIndex,
   SlothURI,
   SlothField,
   SlothRel,
@@ -32,7 +33,9 @@ export class TrackEntity extends BaseEntity<TrackSchema> {
   @SlothURI('library', 'album', 'number', 'name')
   _id: string = ''
 
-  @SlothField() name: string = 'Track Name'
+  @SlothField()
+  @SlothIndex()
+  name: string = 'Track Name'
 
   @SlothField() number: string = '00'
 

diff --git a/test/integration/views.test.ts b/test/integration/views.test.ts
@@ -39,6 +39,16 @@ describe('views', () => {
     })
   })
 
+  test('doesnt recreate views', async () => {
+    const tracks = factory('tracks')
+    const { _rev } = await tracks.get('_design/views')
+    await Track.initSetup(factory)
+    expect(await tracks.get('_design/views')).toMatchObject({
+      views: { by_album: {} },
+      _rev
+    })
+  })
+
   test('query by view', async () => {
     const docs = await Track.queryDocs(
       factory,
@@ -48,4 +58,30 @@ describe('views', () => {
 
     expect(docs.length).toBe(2)
   })
+  test('queryKeys', async () => {
+    const docs = await Track.queryKeys(
+      factory,
+      TrackViews.ByAlbum,
+      'library/flatbush-zombies'
+    )
+
+    expect(docs.length).toBe(2)
+    expect(docs).toEqual([
+      'library/flatbush-zombies/betteroffdead',
+      'library/flatbush-zombies/betteroffdead-2'
+    ])
+  })
+  test('queryKeysIDs', async () => {
+    const docs = await Track.queryKeysIDs(
+      factory,
+      TrackViews.ByAlbum,
+      'library/flatbush-zombies'
+    )
+    expect(docs).toEqual({
+      'library/flatbush-zombies/betteroffdead':
+        'library/flatbush-zombies/betteroffdead/12/palm-trees',
+      'library/flatbush-zombies/betteroffdead-2':
+        'library/flatbush-zombies/betteroffdead-2/12/not-palm-trees'
+    })
+  })
 })
diff --git a/test/unit/decorators/SlothRel.test.ts b/test/unit/decorators/SlothRel.test.ts
@@ -4,8 +4,15 @@ test('SlothRel - fails on top of another decorator', () => {
   const obj = {}
 
   Reflect.defineProperty(obj, 'foo', { get: () => 'bar' })
+  Reflect.defineProperty(obj, 'bar', { set: () => 'bar' })
+  Reflect.defineProperty(obj, 'barz', { value: 42 })
 
   expect(() => SlothRel({} as any)(obj, 'foo')).toThrowError(
     /Cannot apply SlothRel/
   )
+  expect(() => SlothRel({} as any)(obj, 'bar')).toThrowError(
+    /Cannot apply SlothRel/
+  )
+
+  SlothRel({} as any)(obj, 'barz')
 })
diff --git a/test/unit/models/SlothDatabase.test.ts b/test/unit/models/SlothDatabase.test.ts
@@ -177,10 +177,6 @@ test('SlothDatabase#findAllIDs - calls allDocs and return ids', async () => {
   ])
 })
 
-describe('SlothDatabase#subscribe', () => {
-  test('')
-})
-
 describe('SlothDatabase#changes', () => {
   const proto = Object.assign({}, SlothDatabase.prototype, { _subscribers: [] })