Add access to type categories

See #10
falling-fruit · Jul 11, 2023 · d776ab4 · d776ab4
1 parent 9ed7467
commit d776ab4
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 7 deletions.
diff --git a/db/repos/types.js b/db/repos/types.js
@@ -15,6 +15,7 @@ class Types {
       taxonomic_rank: null,
       notes: null,
       pending: true,
+      categories: [],
       ...obj
     }
     values = {

diff --git a/db/sql/types/add.sql b/db/sql/types/add.sql
@@ -6,7 +6,8 @@ INSERT INTO types (
   scientific_name,
   scientific_synonyms,
   taxonomic_rank,
-  notes
+  notes,
+  category_mask
 )
 VALUES (
   ${parent_id},
@@ -16,7 +17,8 @@ VALUES (
   ${scientific_name},
   ${scientific_synonyms},
   ${taxonomic_rank},
-  ${notes}
+  ${notes},
+  ${category_mask}
 )
 RETURNING
   id,
@@ -32,4 +34,5 @@ RETURNING
   ar_name, de_name, el_name, es_name, fr_name, he_name, it_name, nl_name,
   pl_name, pt_br_name, sk_name, sv_name, tr_name, zh_tw_name,
   eat_the_weeds_url, foraging_texas_url, fruitipedia_url, urban_mushrooms_url, wikipedia_url,
-  usda_symbol
+  usda_symbol,
+  category_mask
diff --git a/db/sql/types/list.sql b/db/sql/types/list.sql
@@ -5,6 +5,7 @@ SELECT
   en_name, en_synonyms,
   ar_name, de_name, el_name, es_name, fr_name, he_name, it_name, nl_name,
   pl_name, pt_br_name, sk_name, sv_name, tr_name, zh_tw_name,
-  eat_the_weeds_url, foraging_texas_url, fruitipedia_url, urban_mushrooms_url, wikipedia_url, 
-  usda_symbol
+  eat_the_weeds_url, foraging_texas_url, fruitipedia_url, urban_mushrooms_url, wikipedia_url,
+  usda_symbol,
+  category_mask
 FROM types
diff --git a/db/sql/types/show.sql b/db/sql/types/show.sql
@@ -5,7 +5,8 @@ SELECT
   en_name, en_synonyms,
   ar_name, de_name, el_name, es_name, fr_name, he_name, it_name, nl_name,
   pl_name, pt_br_name, sk_name, sv_name, tr_name, zh_tw_name,
-  eat_the_weeds_url, foraging_texas_url, fruitipedia_url, urban_mushrooms_url, wikipedia_url, 
-  usda_symbol
+  eat_the_weeds_url, foraging_texas_url, fruitipedia_url, urban_mushrooms_url, wikipedia_url,
+  usda_symbol,
+  category_mask
 FROM types
 WHERE id = ${id}
diff --git a/docs/components/schemas.yml b/docs/components/schemas.yml
@@ -142,6 +142,13 @@ BaseType:
         sv: ['Jabolko']
         tr: ['Elma']
         zh_tw: ['蘋果']
+    categories:
+      description: Categories.
+      type: array
+      items:
+        type: string
+        enum: [forager, freegan, honeybee, grafter]
+      example: [forager]
 SubmitType:
   title: Type (submit)
   description: Type properties that can be submitted. At least one name (in `common_names.en` or `scientific_names`) is required.

diff --git a/docs/openapi.yml b/docs/openapi.yml
@@ -1243,6 +1243,18 @@ components:
               - Elma
             zh_tw:
               - 蘋果
+        categories:
+          description: Categories.
+          type: array
+          items:
+            type: string
+            enum:
+              - forager
+              - freegan
+              - honeybee
+              - grafter
+          example:
+            - forager
     SubmitType:
       title: Type (submit)
       description: Type properties that can be submitted. At least one name (in `common_names.en` or `scientific_names`) is required.

diff --git a/helpers.js b/helpers.js
@@ -160,6 +160,16 @@ _.types_array_to_sql = function(value) {
   }
 }
 
+TYPE_CATEGORIES = ['forager', 'freegan', 'honeybee', 'grafter']
+
+_.mask_bits = function(selected, all) {
+  return all.reduce((acc, curr, i) => acc | (selected.includes(curr) ? 1 << i : 0), 0)
+}
+
+_.unmask_bits = function(mask, all) {
+  return all.filter((_, i) => mask & (1 << i))
+}
+
 _.format_type = function(type) {
   const replaced = []
   // Format scientific names: [name, synonyms...]
@@ -206,6 +216,9 @@ _.format_type = function(type) {
     type.urls.usda = `https://plants.usda.gov/home/plantProfile?symbol=${type.usda_symbol}`
   }
   replaced.push('usda_symbol')
+  // Format categories: {categories: [category, ...]}
+  type.categories = _.unmask_bits(type.category_mask, TYPE_CATEGORIES)
+  replaced.push('category_mask')
   // Drop replaced properties
   for (const key of replaced) {
     delete type[key]
@@ -227,6 +240,10 @@ _.deconstruct_type = function(type) {
     type.scientific_synonyms = type.scientific_names.slice(1).join(', ')
     delete type.scientific_names
   }
+  if (type.categories) {
+    type.category_mask = _.mask_bits(type.categories, TYPE_CATEGORIES)
+    delete type.categories
+  }
   return type
 }