feat: display locations for races

Fixes #100
eXaminator · Oct 9, 2022 · 9f4f6d4 · 9f4f6d4
1 parent d64d84b
commit 9f4f6d4
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 38 deletions.
diff --git a/src/KankaJournal/KankaJournalApplication.scss b/src/KankaJournal/KankaJournalApplication.scss
@@ -130,20 +130,9 @@
             grid-column: 2;
             padding-left: 1.5em;
 
-            &.path > a {
-                margin-right: 1em;
-                position: relative;
-
-                &:after {
-                    content: '»';
-                    position: absolute;
-                    right: -0.8em;
-                    pointer-events: none;
-                    text-shadow: none;
-                }
-
-                &:last-child:after {
-                    content: none;
+            &.path {
+                .delimiter {
+                    margin: 0 .5em;
                 }
             }
         }

diff --git a/src/KankaJournal/shared/detailRowAncestors.partial.hbs b/src/KankaJournal/shared/detailRowAncestors.partial.hbs
diff --git a/src/KankaJournal/shared/detailRowArray.partial.hbs b/src/KankaJournal/shared/detailRowArray.partial.hbs
@@ -0,0 +1,17 @@
+{{~#if references.length ~}}
+    <dt>
+        {{~#if rawLabel~}}
+            {{~rawLabel~}}
+        {{~else~}}
+            {{~ kankaLocalize 'journal' label ~}}
+        {{~/if~}}
+    </dt>
+    <dd class="path">
+    {{~#each references as | referenceId |~}}
+        {{~kankaLinkReference (kankaFindReference referenceId ../type) ~}}
+        {{#unless @last}}
+            <span class="delimiter">{{#if ../delimiter}}{{../delimiter}}{{else}}»{{/if}}</span>
+        {{/unless}}
+    {{~/each~}}
+    </dd>
+{{~/if~}}
diff --git a/src/KankaJournal/sheets/ability.partial.hbs b/src/KankaJournal/sheets/ability.partial.hbs
@@ -1,7 +1,7 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.charges label='ability.labels.charges' }}
     {{~/inline}}
 {{/../shared/baseLayout}}
diff --git a/src/KankaJournal/sheets/event.partial.hbs b/src/KankaJournal/sheets/event.partial.hbs
@@ -1,7 +1,7 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.location_id type='location' label='shared.labels.location' reference=true }}
         {{~>../shared/detailRow value=kankaEntity.date label='event.labels.date' }}
     {{~/inline}}

diff --git a/src/KankaJournal/sheets/family.partial.hbs b/src/KankaJournal/sheets/family.partial.hbs
@@ -12,7 +12,7 @@
 
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
     {{~/inline}}
 
     {{#*inline 'content'}}

diff --git a/src/KankaJournal/sheets/item.partial.hbs b/src/KankaJournal/sheets/item.partial.hbs
@@ -1,7 +1,7 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.location_id type='location' label='shared.labels.location' reference=true }}
         {{~>../shared/detailRow value=kankaEntity.character_id type='character' label='shared.labels.character' reference=true }}
     {{~/inline}}

diff --git a/src/KankaJournal/sheets/journal.partial.hbs b/src/KankaJournal/sheets/journal.partial.hbs
@@ -1,7 +1,7 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.location_id type='location' label='shared.labels.location' reference=true }}
         {{~>../shared/detailRow value=kankaEntity.character_id type='character' label='shared.labels.character' reference=true }}
         {{~>../shared/detailRow value=kankaEntity.date label='journal.labels.date' }}

diff --git a/src/KankaJournal/sheets/location.partial.hbs b/src/KankaJournal/sheets/location.partial.hbs
@@ -1,6 +1,6 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
     {{~/inline}}
 {{/../shared/baseLayout}}
diff --git a/src/KankaJournal/sheets/note.partial.hbs b/src/KankaJournal/sheets/note.partial.hbs
@@ -1,6 +1,6 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
     {{~/inline}}
 {{/../shared/baseLayout}}
diff --git a/src/KankaJournal/sheets/organisation.partial.hbs b/src/KankaJournal/sheets/organisation.partial.hbs
@@ -12,7 +12,7 @@
 
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.location_id type='location' label='shared.labels.location' reference=true }}
 
         {{~#with (kankaFilterBy (kankaFilterReferences kankaEntity.members) 'pin_id' 'regex:2|3') as | starred |~}}

diff --git a/src/KankaJournal/sheets/quest.partial.hbs b/src/KankaJournal/sheets/quest.partial.hbs
@@ -11,7 +11,7 @@
 
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type'~}}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
         {{~>../shared/detailRow value=kankaEntity.character_id type='quest' label='quest.labels.instigator' reference=true~}}
         {{~>../shared/detailRow value=kankaEntity.date label='quest.labels.date'~}}
         {{~>../shared/detailRow value=kankaEntity.is_completed label='quest.labels.completed' localizeValue='shared.value'~}}

diff --git a/src/KankaJournal/sheets/race.partial.hbs b/src/KankaJournal/sheets/race.partial.hbs
@@ -1,6 +1,7 @@
 {{#>../shared/baseLayout}}
     {{#*inline 'profile'~}}
         {{~>../shared/detailRow value=kankaEntity.type label='shared.labels.type' }}
-        {{~>../shared/detailRowAncestors ancestors=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.ancestors label='shared.labels.parent' }}
+        {{~>../shared/detailRowArray references=kankaEntity.locations type='location' label='shared.labels.location' delimiter=" " }}
     {{~/inline}}
 {{/../shared/baseLayout}}
diff --git a/src/module/TypeLoaders/RaceTypeLoader.test.ts b/src/module/TypeLoaders/RaceTypeLoader.test.ts
@@ -22,6 +22,7 @@ function createRace(data: Partial<KankaApiRace> = {}): KankaApiRace {
         entity_abilities: [],
         ancestors: [],
         children: [],
+        locations: [],
         ...data,
     } as KankaApiRace;
 }
@@ -224,5 +225,34 @@ describe('RaceTypeLoader', () => {
                 },
             });
         });
+
+        it('includes locations from the lookup array', async () => {
+            const expectedResult = createRace({
+                locations: [2001, 2004],
+            });
+
+            const entities = [
+                createEntity(1001, 2001, 'location'),
+                createEntity(1002, 2002, 'race'),
+                createEntity(1003, 2003, 'quest'),
+                createEntity(1004, 2004, 'location'),
+            ];
+
+            const loader = new RaceTypeLoader(api);
+            const collection = await loader.createReferenceCollection(4711, expectedResult, entities);
+
+            expect(collection.getRecord()).toMatchObject({
+                1001: {
+                    id: 2001,
+                    entityId: 1001,
+                    type: 'location',
+                },
+                1004: {
+                    id: 2004,
+                    entityId: 1004,
+                    type: 'location',
+                },
+            });
+        });
     });
 });
diff --git a/src/module/TypeLoaders/RaceTypeLoader.ts b/src/module/TypeLoaders/RaceTypeLoader.ts
@@ -16,6 +16,7 @@ export default class RaceTypeLoader extends AbstractTypeLoader<KankaApiRace> {
 
         await Promise.all([
             collection.addById(entity.race_id, 'race'),
+            ...entity.locations.map(location => collection.addById(location, 'location')),
             ...entity.ancestors.map(ancestor => collection.addByEntityId(ancestor)),
             ...entity.children.map(child => collection.addByEntityId(child.entity_id)),
         ]);

diff --git a/src/types/kanka.ts b/src/types/kanka.ts
@@ -376,6 +376,7 @@ export interface KankaApiQuest extends KankaApiChildEntity {
 export interface KankaApiRace extends KankaApiChildEntity {
     ancestors: KankaApiEntityId[];
     children: KankaApiChild[];
+    locations: KankaApiId[];
     race_id: KankaApiId | null;
     type: string | null;
 }