Refactor museum

src/fragmentarium/domain/Fragment.test.ts

@@ -21,7 +21,7 @@ import {
   year2017,
   year2018,
 } from 'test-support/record-fixtures'
-import Museum from './museum'
+import { Museums } from './museum'
 import { LooseDollarLine } from 'transliteration/domain/dollar-lines'
 import { Genres } from 'fragmentarium/domain/Genres'
 import Reference from 'bibliography/domain/Reference'
@@ -84,7 +84,7 @@ const config: Parameters<typeof Fragment['create']>[0] = {
     text: 'Some notes',
     parts: [{ text: 'Some notes', type: 'StringPart' }],
   },
-  museum: Museum.of('The museum'),
+  museum: Museums['THE_BRITISH_MUSEUM'],
   references: [
     new Reference(
       'DISCUSSION',

src/fragmentarium/domain/FragmentDtos.ts

@@ -9,6 +9,7 @@ import {
   Ur3Calendar,
 } from 'chronology/domain/DateBase'
 import { ArchaeologyDto } from './archaeologyDtos'
+import { MuseumKey } from './museum'
 
 interface MeasureDto {
   value?: number
@@ -91,7 +92,7 @@ export default interface FragmentDto {
   description: string
   collection: string
   legacyScript: string
-  museum: string
+  museum: MuseumKey
   width: MeasureDto
   length: MeasureDto
   thickness: MeasureDto

src/fragmentarium/domain/fragment.ts

@@ -3,7 +3,7 @@ import produce, { castDraft, Draft, immerable } from 'immer'
 
 import Reference from 'bibliography/domain/Reference'
 import { Text } from 'transliteration/domain/text'
-import Museum, { FragmentLink } from './museum'
+import { Museum } from './museum'
 import Folio from './Folio'
 import { Genres } from 'fragmentarium/domain/Genres'
 import { Joins } from './join'
@@ -218,14 +218,6 @@ export class Fragment {
     })
   }
 
-  get hasLink(): boolean {
-    return this.museum.hasFragmentLink(this)
-  }
-
-  getLink(): FragmentLink {
-    return this.museum.createLinkFor(this)
-  }
-
   filterFolios(session: Session): Fragment {
     return produce(this, (draft: Draft<Fragment>) => {
       draft.folios = this.folios.filter((folio) =>

src/fragmentarium/domain/museum.test.ts

@@ -1,145 +1,52 @@
-import Museum from './museum'
-import bmLogo from './The_British_Museum.png'
-import ybcLogo from './YBC_small.jpg'
-import {
-  externalNumbersFactory,
-  fragmentFactory,
-} from 'test-support/fragment-fixtures'
+import { Museum, Museums } from './museum'
 
 describe.each([
   [
+    'THE_BRITISH_MUSEUM',
     'The British Museum',
-    bmLogo,
-    'https://britishmuseum.org/',
+    'London',
+    'GBR',
+    'https://www.britishmuseum.org/',
     '© [The Trustees of the British Museum](https://www.britishmuseum.org/about_this_site/terms_of_use/copyright_and_permissions.aspx)',
   ],
   [
-    'The Iraq Museum, Baghdad',
-    '',
-    '',
+    'THE_IRAQ_MUSEUM',
+    'The Iraq Museum',
+    'Baghdad',
+    'IRQ',
+    'https://theiraqmuseum.com/',
     'By Permission of the State Board of Antiquities and Heritage and The Iraq Museum',
-    null,
-    null,
   ],
-  [
-    'Yale Babylonian Collection, Peabody Museum',
-    ybcLogo,
-    'https://babylonian-collection.yale.edu/',
-    'Courtesy of the [Yale Babylonian Collection](https://peabody.yale.edu/about-us/terms-use-what-you-need-know)',
-  ],
-  ['Other Museum', '', '', '', null, null],
-] as [string, string, string, string][])('%s', (name, logo, url, copyright) => {
-  const museum: Museum = Museum.of(name)
-
-  test('name', () => {
-    expect(museum.name).toEqual(name)
-  })
-
-  test('logo', () => {
-    expect(museum.logo).toEqual(logo)
-  })
-
-  test('hasUrl', () => {
-    expect(museum.hasUrl).toEqual(url !== '')
-  })
-
-  test('url', () => {
-    expect(museum.url).toEqual(url)
-  })
-
-  test('hasCopyright', () => {
-    expect(museum.hasCopyright).toEqual(copyright !== '')
-  })
-
-  test('copyright', () => {
-    expect(museum.copyright).toEqual(copyright)
-  })
-})
-
-describe('BritishMuseum', () => {
-  const bmIdNumber = 'A 1234+43'
-  const link = {
-    name: 'The British Museum',
-    logo: bmLogo,
-    url: `https://www.britishmuseum.org/collection/object/${encodeURIComponent(
-      bmIdNumber
-    )}`,
-    label: `The British Museum object ${bmIdNumber}`,
-  }
-  const britishMuseum = Museum.of(link.name)
-
-  describe('hasFragmentLink', () => {
-    test('fragment has bmIdNumber', () => {
-      const fragment = fragmentFactory.build(
-        {},
-        {
-          associations: {
-            externalNumbers: externalNumbersFactory.build({ bmIdNumber }),
-          },
-        }
-      )
-      expect(britishMuseum.hasFragmentLink(fragment)).toEqual(true)
+  ['UNKNOWN', '', '', '', '', ''],
+])(
+  '%s',
+  (
+    key,
+    expectedName,
+    expectedcity,
+    expectedcountry,
+    expectedurl,
+    expectedcopyright = ''
+  ) => {
+    const museum: Museum = Museums[key]
+    test('name', () => {
+      expect(museum.name).toEqual(expectedName)
     })
 
-    test('fragment does not have bmIdNumber', () => {
-      const fragment = fragmentFactory.build(
-        {},
-        {
-          associations: {
-            externalNumbers: externalNumbersFactory.build({ bmIdNumber: '' }),
-          },
-        }
-      )
-      expect(britishMuseum.hasFragmentLink(fragment)).toEqual(false)
+    test('city', () => {
+      expect(museum.city).toEqual(expectedcity)
     })
-  })
-
-  test('fragmentlink', () => {
-    const fragment = fragmentFactory.build(
-      {},
-      {
-        associations: {
-          externalNumbers: externalNumbersFactory.build({ bmIdNumber }),
-        },
-      }
-    )
-    expect(britishMuseum.createLinkFor(fragment)).toEqual(link)
-  })
-})
 
-describe('YaleBabylonianCollectionhMuseum', () => {
-  const accession = 'A 1234+4.3'
-  const expectedAccession = 'A 1234+4-3'
-  const link = {
-    name: 'Yale Babylonian Collection, Peabody Museum',
-    logo: ybcLogo,
-    url: `https://collections.peabody.yale.edu/search/Record/YPM-${encodeURIComponent(
-      expectedAccession
-    )}`,
-    label: `Yale Babylonian Collection, Peabody Museum`,
-  }
-  const ybc = Museum.of(link.name)
-
-  describe('hasFragmentLink', () => {
-    test('fragment has accession', () => {
-      const fragment = fragmentFactory.build({
-        accession,
-      })
-      expect(ybc.hasFragmentLink(fragment)).toEqual(true)
+    test('country', () => {
+      expect(museum.country).toEqual(expectedcountry)
     })
 
-    test('fragment does not have accession', () => {
-      const fragment = fragmentFactory.build({
-        accession: '',
-      })
-      expect(ybc.hasFragmentLink(fragment)).toEqual(false)
+    test('url', () => {
+      expect(museum.url).toEqual(expectedurl)
     })
-  })
 
-  test('fragmentlink', () => {
-    const fragment = fragmentFactory.build({
-      accession,
+    test('copyright', () => {
+      expect(museum?.copyright || '').toEqual(expectedcopyright)
     })
-    expect(ybc.createLinkFor(fragment)).toEqual(link)
-  })
-})
+  }
+)