Merge pull request #9 from seanbonner/feat/perfect-and-priceless-collection

Add Perfect & Priceless collection

Author: jwahdatehagh

.changeset/curated-collections-perfect-priceless.md

@@ -0,0 +1,13 @@
+---
+'@networked-art/punks-sdk': minor
+---
+
+Add the `perfect-and-priceless` curated collection: the 24 Punks printed and
+shown in Kate Vass Galerie's 2018-2019 "Perfect & Priceless" exhibition, each
+framed print backed by its seed phrase sealed in an envelope.
+
+- Resolves under every name the set is known by — `perfect & priceless`,
+  `perfect and priceless`, `kate vass`, `kate vass galerie`, `paper punks`,
+  `paper`.
+- The collection alias matcher now skips punctuation-only tokens, so the `&`
+  spelling of a name matches the same set as the spelled-out form.

sdk/README.md

@@ -110,14 +110,18 @@ skin tone.
 
 ### Curated collections
 
-Curated collections are named, sourced sets of Punk ids — `burned` and `museum`
-today, more to come. A collection alias resolves to its id set through the
-existing `includeIds` path, so it composes with the rest of a query:
+Curated collections are named, sourced sets of Punk ids — `burned`, `museum`,
+and `perfect-and-priceless` today, more to come. A collection alias resolves to
+its id set through the existing `includeIds` path, so it composes with the rest
+of a query, and a set can carry several aliases:
 
 ```ts
 punks.search({ text: 'burned punks' }) // the burned set
 punks.search({ text: 'burned alien' }) // burned ∩ alien
 punks.count({ text: 'burned OR alien' })
+
+punks.search({ text: 'paper' }) // the Perfect & Priceless set
+punks.search({ text: 'kate vass' }) // same set, by its gallery
 ```
 
 Collections can nest independently resolvable institutions, so `museum` matches

sdk/src/search-collections.json

@@ -53,5 +53,23 @@
         "ids": [9833]
       }
     }
+  },
+  "perfect-and-priceless": {
+    "title": "Perfect & Priceless Punks",
+    "description": "Punks printed and shown in Kate Vass Galerie's 2018-2019 'Perfect & Priceless' exhibition, each framed print backed by its seed phrase sealed in an envelope.",
+    "aliases": [
+      "perfect and priceless",
+      "perfect & priceless",
+      "kate vass",
+      "kate vass galerie",
+      "paper punks",
+      "paper"
+    ],
+    "source": "https://www.katevassgalerie.com/perfect-and-priceless",
+    "standard": "v2",
+    "ids": [
+      207, 269, 636, 652, 672, 722, 726, 728, 770, 795, 872, 910, 934, 1819,
+      2134, 2830, 3036, 3122, 4530, 4946, 5127, 6347, 6675, 8773
+    ]
   }
 }

sdk/src/text-parse.ts

@@ -498,12 +498,16 @@ function matchSearchCollectionEntry(
   entry: SearchCollectionEntry,
 ): number | undefined {
   let phrase = ''
-  const maxTerms = Math.min(entry.tokens.length, terms.length - start)
-  for (let consumed = 1; consumed <= maxTerms; consumed++) {
-    const term = terms[start + consumed - 1]
+  let consumed = 0
+  while (start + consumed < terms.length) {
+    const term = terms[start + consumed]
     if (term.exact) return undefined
+    consumed++
+    // Punctuation-only tokens (e.g. the `&` in `perfect & priceless`) normalize
+    // to nothing; consume them but skip them in the phrase so the surrounding
+    // words still match the `&`-free alias key.
     const normalized = normalizeSynonymText(term.text)
-    if (!normalized) return undefined
+    if (!normalized) continue
     phrase = phrase ? `${phrase} ${normalized}` : normalized
     if (phrase === entry.key) return consumed
     if (!entry.key.startsWith(`${phrase} `)) return undefined

sdk/test/collections.test.mjs

@@ -20,11 +20,16 @@ const MUSEUM = [
 const MOMA = [74, 2786, 3407, 4018, 5160, 5616, 7178, 7899]
 const ZKM = [1286, 2554, 2838, 5449]
 
+const PERFECT_AND_PRICELESS = [
+  207, 269, 636, 652, 672, 722, 726, 728, 770, 795, 872, 910, 934, 1819, 2134,
+  2830, 3036, 3122, 4530, 4946, 5127, 6347, 6675, 8773,
+]
+
 describe('curated collections', () => {
   it('bundles the burned set as validated, normalized data', () => {
     assert.deepEqual(
       searchCollections.map((collection) => collection.slug),
-      ['burned', 'museum'],
+      ['burned', 'museum', 'perfect-and-priceless'],
     )
 
     const burned = getSearchCollection('burned')
@@ -90,10 +95,11 @@ describe('curated collections', () => {
 
     assert.deepEqual(
       punks.collections.list().map((collection) => collection.slug),
-      ['burned', 'museum'],
+      ['burned', 'museum', 'perfect-and-priceless'],
     )
     assert.equal(punks.collections.has('burned'), true)
     assert.equal(punks.collections.has('museum'), true)
+    assert.equal(punks.collections.has('perfect-and-priceless'), true)
     assert.equal(punks.collections.has('missing'), false)
     assert.equal(punks.collections.get('burned').ids.length, 12)
     assert.equal(punks.collections.get('missing'), undefined)
@@ -164,4 +170,33 @@ describe('curated collections', () => {
       [2838, 5449],
     )
   })
+
+  it('resolves the Perfect & Priceless set under all its names', () => {
+    const collection = getSearchCollection('perfect-and-priceless')
+    assert.equal(collection.title, 'Perfect & Priceless Punks')
+    assert.equal(
+      collection.source,
+      'https://www.katevassgalerie.com/perfect-and-priceless',
+    )
+    assert.equal(collection.standard, 0)
+    assert.deepEqual(collection.ids, PERFECT_AND_PRICELESS)
+
+    const sdk = createOfflinePunksDataClient()
+    // The gallery name (with `&` and spelled-out `and`), the gallery, and the
+    // informal "paper" name all resolve to the same set.
+    for (const phrase of [
+      'perfect & priceless',
+      'perfect and priceless',
+      'kate vass',
+      'kate vass galerie',
+      'paper punks',
+      'paper',
+    ]) {
+      assert.deepEqual(
+        sdk.searchSync({ text: phrase }),
+        PERFECT_AND_PRICELESS,
+        `"${phrase}" should resolve to the Perfect & Priceless set`,
+      )
+    }
+  })
 })