AfO Register

src/afo-register/application/AfoRegisterService.test.ts

@@ -0,0 +1,41 @@
+import { testDelegation, TestData } from 'test-support/utils'
+import AfoRegisterRepository from 'afo-register/infrastructure/AfoRegisterRepository'
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import { stringify } from 'query-string'
+import ApiClient from 'http/ApiClient'
+
+jest.mock('http/ApiClient')
+const apiClient = new (ApiClient as jest.Mock<jest.Mocked<ApiClient>>)()
+
+const afoRegisterRepository = new AfoRegisterRepository(apiClient)
+
+const resultStub = {
+  afoNumber: 'AfO 1',
+  page: '2',
+  text: 'some text',
+  textNumber: '5',
+  discussedBy: '',
+  discussedByNotes: '',
+  linesDiscussed: '',
+}
+
+const query = { afoNumber: resultStub.afoNumber, page: resultStub.page }
+const entry = new AfoRegisterRecord(resultStub)
+
+const testData: TestData<AfoRegisterRepository>[] = [
+  new TestData(
+    'search',
+    [
+      stringify({
+        afoNumber: 'AfO 1',
+        page: '2',
+      }),
+    ],
+    apiClient.fetchJson,
+    [entry],
+    [`/afo-register?${stringify(query)}`, false],
+    Promise.resolve([resultStub])
+  ),
+]
+describe('afoRegisterService', () =>
+  testDelegation(afoRegisterRepository, testData))

src/afo-register/application/AfoRegisterService.ts

@@ -0,0 +1,30 @@
+import Promise from 'bluebird'
+import AfoRegisterRecord, {
+  AfoRegisterRecordSuggestion,
+} from 'afo-register/domain/Record'
+import AfoRegisterRepository from 'afo-register/infrastructure/AfoRegisterRepository'
+
+export interface afoRegisterSearch {
+  search(query: string): Promise<readonly AfoRegisterRecord[]>
+  searchSuggestions(
+    query: string
+  ): Promise<readonly AfoRegisterRecordSuggestion[]>
+}
+
+export default class AfoRegisterService implements afoRegisterSearch {
+  private readonly afoRegisterRepository: AfoRegisterRepository
+
+  constructor(afoRegisterRepository: AfoRegisterRepository) {
+    this.afoRegisterRepository = afoRegisterRepository
+  }
+
+  search(query: string): Promise<readonly AfoRegisterRecord[]> {
+    return this.afoRegisterRepository.search(query)
+  }
+
+  searchSuggestions(
+    query: string
+  ): Promise<readonly AfoRegisterRecordSuggestion[]> {
+    return this.afoRegisterRepository.searchSuggestions(query)
+  }
+}

src/afo-register/domain/Record.test.ts

@@ -0,0 +1,72 @@
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import { fragmentFactory } from 'test-support/fragment-fixtures'
+
+describe('AfoRegisterRecord', () => {
+  const mockRecord = {
+    afoNumber: '123',
+    page: '456',
+    text: 'Sample text',
+    textNumber: '789',
+    linesDiscussed: 'Some lines',
+    discussedBy: 'John Doe',
+    discussedByNotes: 'Notes by John',
+  }
+
+  const fragment1 = fragmentFactory.build({
+    traditionalReferences: ['Sample text 789'],
+    number: 'Fragment001',
+  })
+
+  const fragment2 = fragmentFactory.build({
+    traditionalReferences: [],
+    number: 'Fragment002',
+  })
+
+  describe('constructor', () => {
+    describe('constructor', () => {
+      it('should initialize properties correctly', () => {
+        const record = new AfoRegisterRecord(mockRecord)
+        expect(record.afoNumber).toEqual('123')
+        expect(record.page).toEqual('456')
+        expect(record.text).toEqual('Sample text')
+        expect(record.textNumber).toEqual('789')
+        expect(record.linesDiscussed).toEqual('Some lines')
+        expect(record.discussedBy).toEqual('John Doe')
+        expect(record.discussedByNotes).toEqual('Notes by John')
+      })
+    })
+  })
+
+  describe('Converts to Markdown string', () => {
+    it('Returns the correct markdown string with fragments', () => {
+      const record = new AfoRegisterRecord(mockRecord)
+      const result = record.toMarkdownString([fragment1, fragment2])
+      expect(result).toEqual(
+        'Sample text 789(Fragment001), Some lines: John Doe Notes by John<small class="text-black-50 ml-3">[123, 456]</small>'
+      )
+    })
+
+    it('Handles sup tags correctly', () => {
+      const recordWithSup = new AfoRegisterRecord({
+        ...mockRecord,
+        text: 'Sample^text^',
+      })
+      const result = recordWithSup.toMarkdownString([fragment1, fragment2])
+      expect(result).toContain('<sup>text</sup>')
+    })
+  })
+
+  describe('Finds link to fragment', () => {
+    it('should return the correct link to fragment', () => {
+      const record = new AfoRegisterRecord(mockRecord)
+      const result = record.findLinkToFragment([fragment1, fragment2])
+      expect(result).toEqual('Fragment001')
+    })
+
+    it('Returns empty string if no matching fragments', () => {
+      const record = new AfoRegisterRecord(mockRecord)
+      const result = record.findLinkToFragment([fragment2])
+      expect(result).toEqual('')
+    })
+  })
+})

src/afo-register/domain/Record.ts

@@ -0,0 +1,83 @@
+import { immerable } from 'immer'
+import { Fragment } from 'fragmentarium/domain/fragment'
+
+interface RecordData {
+  readonly afoNumber: string
+  readonly page: string
+  readonly text: string
+  readonly textNumber: string
+  readonly linesDiscussed?: string
+  readonly discussedBy?: string
+  readonly discussedByNotes?: string
+}
+
+export class AfoRegisterRecordSuggestion {
+  [immerable] = true
+
+  readonly text: string
+  readonly textNumbers: string[]
+
+  constructor({
+    text,
+    textNumbers,
+  }: {
+    readonly text: string
+    readonly textNumbers: string[]
+  }) {
+    this.text = text
+    this.textNumbers = textNumbers
+  }
+}
+
+export default class AfoRegisterRecord {
+  [immerable] = true
+
+  readonly afoNumber: string
+  readonly page: string
+  readonly text: string
+  readonly textNumber: string
+  readonly linesDiscussed?: string
+  readonly discussedBy?: string
+  readonly discussedByNotes?: string
+
+  constructor({
+    afoNumber,
+    page,
+    text,
+    textNumber,
+    linesDiscussed,
+    discussedBy,
+    discussedByNotes,
+  }: RecordData) {
+    this.afoNumber = afoNumber
+    this.page = page
+    this.text = text
+    this.textNumber = textNumber
+    this.linesDiscussed = linesDiscussed
+    this.discussedBy = discussedBy
+    this.discussedByNotes = discussedByNotes
+  }
+
+  toMarkdownString(fragments: Fragment[]): string {
+    let result = this.text + (this.textNumber ? ' ' + this.textNumber : '')
+    const linkToFragment = this.findLinkToFragment(fragments)
+    if (linkToFragment) result += `(${linkToFragment})`
+    if (this.linesDiscussed) result += ', ' + this.linesDiscussed
+    if (this.discussedBy) result += ': ' + this.discussedBy
+    if (this.discussedByNotes) result += ' ' + this.discussedByNotes
+
+    result += `<small class="text-black-50 ml-3">${`[${this.afoNumber}, ${this.page}]`}</small>`
+
+    result = result.replace(/\^([^^]+)\^/g, '<sup>$1</sup>')
+    return result
+  }
+
+  findLinkToFragment(fragments: Fragment[]): string {
+    const reference = this.text + ' ' + this.textNumber
+    const matchingFragments = fragments.filter((fragment) =>
+      fragment.traditionalReferences.includes(reference)
+    )
+    if (matchingFragments.length === 0) return ''
+    return matchingFragments.map((fragment) => fragment.number).join(', ')
+  }
+}

src/afo-register/infrastructure/AfoRegisterRepository.test.ts

@@ -0,0 +1,35 @@
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import ApiClient from 'http/ApiClient'
+import AfoRegisterRepository from './AfoRegisterRepository'
+import Promise from 'bluebird'
+import { testDelegation, TestData } from 'test-support/utils'
+
+jest.mock('http/ApiClient')
+
+const apiClient = new (ApiClient as jest.Mock<jest.Mocked<ApiClient>>)()
+const afoRegisterRepository = new AfoRegisterRepository(apiClient)
+const query = '{"afoNumber": "AfO 12", "page": "321"}'
+const resultStub = {
+  afoNumber: 'AfO 12',
+  page: '321',
+  text: 'text',
+  textNumber: 'text number',
+  linesDiscussed: '',
+  discussedBy: '',
+  discussedByNotes: '',
+}
+const entry = new AfoRegisterRecord(resultStub)
+
+const testData: TestData<AfoRegisterRepository>[] = [
+  new TestData(
+    'search',
+    [query],
+    apiClient.fetchJson,
+    [entry],
+    [`/afo-register?${query}`, false],
+    Promise.resolve([resultStub])
+  ),
+]
+
+describe('AfoRegisterRepository', () =>
+  testDelegation(afoRegisterRepository, testData))

src/afo-register/infrastructure/AfoRegisterRepository.ts

@@ -0,0 +1,33 @@
+import AfoRegisterRecord, {
+  AfoRegisterRecordSuggestion,
+} from 'afo-register/domain/Record'
+import Promise from 'bluebird'
+import ApiClient from 'http/ApiClient'
+
+function createAfoRegisterRecord(data) {
+  return new AfoRegisterRecord(data)
+}
+
+function createAfoRegisterRecordSuggestion(data) {
+  return new AfoRegisterRecordSuggestion(data)
+}
+
+export default class AfoRegisterRepository {
+  private readonly apiClient: ApiClient
+
+  constructor(apiClient: ApiClient) {
+    this.apiClient = apiClient
+  }
+
+  search(query: string): Promise<AfoRegisterRecord[]> {
+    return this.apiClient
+      .fetchJson(`/afo-register?${query}`, false)
+      .then((result) => result.map(createAfoRegisterRecord))
+  }
+
+  searchSuggestions(query: string): Promise<AfoRegisterRecordSuggestion[]> {
+    return this.apiClient
+      .fetchJson(`/afo-register/suggestions?text_query=${query}`, false)
+      .then((result) => result.map(createAfoRegisterRecordSuggestion))
+  }
+}

src/afo-register/ui/AfoRegisterSearch.tsx

@@ -0,0 +1,58 @@
+import React from 'react'
+import _ from 'lodash'
+
+import withData from 'http/withData'
+
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import AfoRegisterService from 'afo-register/application/AfoRegisterService'
+import { LiteratureRedirectBox } from 'common/LiteratureRedirectBox'
+import { AfoRegisterQuery } from './AfoRegisterSearchForm'
+import { stringify } from 'query-string'
+import MarkdownAndHtmlToHtml from 'common/MarkdownAndHtmlToHtml'
+
+export const AfoRegisterRedirectBox = (
+  <LiteratureRedirectBox
+    authors="Hirsch, H.; Hunger, H.; Jursa, M.; Weszeli, M.; et al."
+    book="Archiv für Orientforschung (Register Assyriologie)"
+    notelink=""
+    subtitle="25 (1974/1977) – 54 (2021)"
+    note="By permission from the AfO Redaktion"
+    link="https://orientalistik.univie.ac.at/publikationen/afo/register/"
+    icon="pointer__hover my-2 fas fa-external-link-square-alt"
+  />
+)
+
+function afoRegisterSearch({ data }: { data: readonly AfoRegisterRecord[] }) {
+  return (
+    <>
+      <ol className="afoRegisterSearch">
+        {data.map((record, index) => (
+          <li key={`li-${index}`} className="afoRegisterSearch__record">
+            <MarkdownAndHtmlToHtml
+              key={`md-${index}`}
+              markdownAndHtml={record.toMarkdownString([])}
+            />
+          </li>
+        ))}
+      </ol>
+      {data.length > 0 && AfoRegisterRedirectBox}
+    </>
+  )
+}
+
+export default withData<
+  unknown,
+  {
+    afoRegisterService: AfoRegisterService
+    query: AfoRegisterQuery
+  },
+  readonly AfoRegisterRecord[]
+>(
+  afoRegisterSearch,
+  (props) => props.afoRegisterService.search(stringify(props.query)),
+  {
+    watch: (props) => [props.query],
+    filter: (props) => !_.isEmpty(props.query),
+    defaultData: () => [],
+  }
+)