@harvard-lts/mirador-eda-plugin 0.1.2 → 0.1.4

package/src/plugins/__tests__/EdaTranscriptionPanel.spec.js

@@ -1,188 +0,0 @@
-import { render, screen, fireEvent } from "@testing-library/react"
-import { Provider } from "react-redux"
-import { configureStore } from "@reduxjs/toolkit"
-import '@testing-library/jest-dom'
-import { withStyles } from "@material-ui/core/styles"
-import EdaTranscriptionPanel from "../EdaTranscriptionPanel"
-
-const styles = () => ({ section: "section", controls: "controls", formControl: "formControl", editionLabel: "editionLabel" })
-const StyledPanel = withStyles(styles)(EdaTranscriptionPanel.component)
-
-// Mock the CompanionWindow component from Mirador to avoid theme dependency issues
-jest.mock("mirador/dist/es/src/containers/CompanionWindow", () => ({
-  __esModule: true,
-  default: ({ children, title }) => (
-    <div
-      data-testid="mock-companion-window"
-      className="mirador-companion-window mirador-companion-window-right react-draggable"
-    >
-      <div className="mirador-window-title-bar">
-        <h2>{title}</h2>
-      </div>
-      <div className="mirador-companion-window-body">
-        {children}
-      </div>
-      <div style={{ cursor: 'col-resize' }} className="react-draggable-handle"></div>
-    </div>
-  )
-}))
-import johnsonPoems1955 from "../testFixtures/johnsonPoems1955Transcription"
-import franklinVariorum1998 from "../testFixtures/franklinVariorum1998Transcription"
-
-function renderPanel({ transcriptions = [johnsonPoems1955, franklinVariorum1998], windowId = "window-1" } = {}) {
-  // Minimal reducer for testing, returns state as-is
-  const reducer = (state = {}) => state
-  // Provide transcriptions in the state as expected by getEdaTranscription
-  const preloadedState = {
-    manifests: {
-      "mock-manifest": {
-        json: {
-          items: [
-            {
-              id: "mock-canvas",
-              annotations: [
-                { items: transcriptions.map(t => ({ body: { format: "text/html", value: t } })) }
-              ]
-            }
-          ]
-        }
-      }
-    },
-    windows: {
-      [windowId]: {
-        manifestId: "mock-manifest",
-        canvasId: "mock-canvas"
-      }
-    }
-  }
-  const store = configureStore({ reducer, preloadedState })
-  return render(
-    <Provider store={store}>
-      <StyledPanel windowId={windowId} classes={styles()} />
-    </Provider>
-  )
-}
-
-describe("the EdaTranscriptionPanel should", () => {
-  it("render the sidebar panel", () => {
-    renderPanel()
-    // Check for the companion window with the right title
-    expect(screen.getAllByText("EDA Transcription")[0]).toBeInTheDocument()
-    expect(screen.getByText("Edition")).toBeInTheDocument()
-  })
-
-  it("use the paperClassName prop for width styling", () => {
-    const { container } = renderPanel()
-    // CompanionWindow component receives paperClassName={classes.paper}
-    const companionWindow = container.querySelector('.mirador-companion-window')
-    expect(companionWindow).toBeInTheDocument()
-    // We're verifying the structure exists - the actual styling is handled by Material-UI
-    // and the global styles in the component
-  })
-
-  it("use the @global.mirador-companion-window-left react-draggable for resizing", () => {
-    const { container } = renderPanel()
-    const companionWindow = container.querySelector('.mirador-companion-window-right')
-    expect(companionWindow).toBeInTheDocument()
-    const draggableElement = container.querySelector('.react-draggable')
-    expect(draggableElement).toBeInTheDocument()
-  })
-
-  it("should be resizable like other Mirador panels", () => {
-    const { container } = renderPanel()
-    expect(container.querySelector('.mirador-companion-window-right')).toBeInTheDocument()
-    const draggableElement = container.querySelector('.react-draggable')
-    expect(draggableElement).toBeInTheDocument()
-    const resizeHandle = container.querySelector('[style*="cursor: col-resize;"]') ||
-      container.querySelector('[style*="cursor: row-resize;"]')
-    expect(resizeHandle).toBeInTheDocument()
-  })
-})
-
-describe("the EdaTranscriptionPanel editions select menu should", () => {
-  it("render if there is at least one transcription", () => {
-    renderPanel({ transcriptions: [johnsonPoems1955] })
-    // The select should be present
-    expect(screen.getByRole("button")).toBeInTheDocument()
-  })
-
-  it("be disabled if there is only one transcription", () => {
-    renderPanel({ transcriptions: [johnsonPoems1955] })
-    const select = screen.getByRole("button")
-    // Material-UI handles disabled state differently in tests
-    expect(select.getAttribute("aria-disabled")).toBe("true")
-  })
-
-  it("be enabled if there are multiple transcriptions", () => {
-    renderPanel({ transcriptions: [johnsonPoems1955, franklinVariorum1998] })
-    const select = screen.getByRole("button")
-    // For enabled state, Material-UI might not set aria-disabled at all
-    expect(select.getAttribute("aria-disabled")).not.toBe("true")
-  })
-
-  it("default to the first edition", () => {
-    renderPanel()
-    expect(screen.getByText("Johnson Poems 1955")).toBeInTheDocument()
-  })
-
-  it("change when a new edition is selected", () => {
-    renderPanel()
-    const select = screen.getByRole("button")
-    fireEvent.mouseDown(select)
-    const edition2 = screen.getAllByText("Franklin Variorum 1998")[0]
-    fireEvent.click(edition2)
-    expect(screen.getAllByText("Franklin Variorum 1998").length).toBeGreaterThan(0)
-  })
-})
-
-describe("the EdaTranscriptionPanel physical line breaks checkbox should", () => {
-  it("be true (checked) by default", () => {
-    renderPanel()
-    const linebreakCheckbox = screen.getByLabelText("Physical Line Breaks")
-    expect(linebreakCheckbox).toBeChecked()
-  })
-
-  it("change values when unchecked", () => {
-    renderPanel()
-    const linebreakCheckbox = screen.getByLabelText("Physical Line Breaks")
-    fireEvent.click(linebreakCheckbox)
-    expect(linebreakCheckbox).not.toBeChecked()
-  })
-
-  it("toggle physical line breaks in rendered code", () => {
-    renderPanel()
-    // By default, linebreaks are shown
-    const htmlWithBreaks = screen.getByText("If I may have it, when it's dead,").parentElement.innerHTML
-    expect(htmlWithBreaks).toContain("<br")
-
-    // Toggle the checkbox to hide linebreaks
-    const linebreakCheckbox = screen.getByLabelText("Physical Line Breaks")
-    fireEvent.click(linebreakCheckbox)
-    // After toggling, <br> should still exist in the HTML, but the CSS class disables its display
-    // So we check the parent class
-    const sectionDiv = screen.getByText("If I may have it, when it's dead,").closest(".section")
-    expect(sectionDiv.className).not.toContain("show-linebreaks")
-  })
-})
-
-describe("the EdaTranscriptionPanel hide edits checkbox should", () => {
-  it("be false (unchecked)by default", () => {
-    renderPanel()
-    const editsCheckbox = screen.getByLabelText("Hide Edits")
-    expect(editsCheckbox).not.toBeChecked()
-  })
-
-  it("change values when checked", () => {
-    renderPanel()
-    const editsCheckbox = screen.getByLabelText("Hide Edits")
-    fireEvent.click(editsCheckbox)
-    expect(editsCheckbox).toBeChecked()
-  })
-
-  it("toggle hide edits in rendered code", () => {
-    renderPanel()
-    const htmlWithEdits = screen.getByText("If I may have it, when it's dead,").parentElement.innerHTML
-    // Check for <ins> or <rt> as editorial marks
-    expect(htmlWithEdits).toMatch(/<(ins|rt)[^>]*>/)
-  })
-})

package/src/plugins/__tests__/edaManifest.spec.js

@@ -1,110 +0,0 @@
-/** @jest-environment jsdom */
-import React from "react"
-import { getEdaTranscription } from "../transcriptionUtils"
-
-// Mock the transcriptionUtils
-jest.mock("../transcriptionUtils")
-
-describe("Emily Dickinson Manifest Support", () => {
-  // Sample Emily Dickinson manifest based on the demo files
-  const emilyDickinsonManifest = {
-    "@context": "http://iiif.io/api/presentation/3/context.json",
-    "id": "https://www.edickinson.org/manifestation/3037",
-    "type": "Manifest",
-    "label": { "en": ["Emily Dickinson Archive - J577 - If I may have it when it\"s dead"] },
-    "items": [
-      {
-        "id": "canvas/3945",
-        "type": "Canvas",
-        "annotations": [
-          {
-            "items": [
-              {
-                "body": {
-                  "format": "text/html",
-                  "value": '<div class="work-body" data-exhibit="emily-dickinson-archive" data-edition="Johnson Poems 1955">Sample transcription</div>'
-                }
-              }
-            ]
-          }
-        ]
-      }
-    ]
-  }
-
-  describe("transcription extraction", () => {
-    beforeEach(() => {
-      // Reset all mocks before each test
-      jest.clearAllMocks()
-    })
-
-    it("should identify EDA transcriptions from manifest", () => {
-      // Mock the state that would be passed to getEdaTranscription
-      const state = {
-        manifests: {
-          "manifest-1": {
-            json: emilyDickinsonManifest
-          }
-        },
-        windows: {
-          "window-1": {
-            manifestId: "manifest-1",
-            canvasId: "canvas/3945"
-          }
-        }
-      }
-
-      // Call getEdaTranscription with our mock state
-      getEdaTranscription(state, { windowId: "window-1" })
-
-      // Verify the function was called with correct state and windowId
-      expect(getEdaTranscription).toHaveBeenCalledWith(
-        state,
-        expect.objectContaining({ windowId: "window-1" })
-      )
-    })
-  })
-
-  describe("manifest structure", () => {
-    it("should match expected manifest ID format", () => {
-      const demoManifestId = "https://www.edickinson.org/manifestation/3037"
-      expect(emilyDickinsonManifest.id).toBe(demoManifestId)
-    })
-
-    it("should include required EDA transcription metadata", () => {
-      const transcription = emilyDickinsonManifest.items[0].annotations[0].items[0].body.value
-      expect(transcription).toContain('data-exhibit="emily-dickinson-archive"')
-      expect(transcription).toContain('data-edition="Johnson Poems 1955"')
-    })
-  })
-
-  describe("annotation handling", () => {
-    beforeEach(() => {
-      getEdaTranscription.mockReset()
-    })
-
-    it("should properly identify annotation content", () => {
-      const edaTranscription = '<div class="work-body" data-exhibit="emily-dickinson-archive">Sample</div>'
-      getEdaTranscription.mockReturnValue([edaTranscription])
-
-      const state = {
-        manifests: {
-          "manifest-1": {
-            json: emilyDickinsonManifest
-          }
-        },
-        windows: {
-          "window-1": {
-            manifestId: "manifest-1",
-            canvasId: "canvas/3945"
-          }
-        }
-      }
-
-      const transcriptions = getEdaTranscription(state, { windowId: "window-1" })
-
-      expect(transcriptions).toHaveLength(1)
-      expect(transcriptions[0]).toContain("emily-dickinson-archive")
-    })
-  })
-})

package/src/plugins/__tests__/nonEdaManifest.spec.js

@@ -1,64 +0,0 @@
-import { getEdaTranscription } from "../transcriptionUtils"
-
-// Sample Harvard (non-EDA) manifest
-const harvardManifest = {
-  "@context": "http://iiif.io/api/presentation/2/context.json",
-  "@id": "https://iiif.lib.harvard.edu/manifests/ids:488815",
-  "@type": "sc:Manifest",
-  "label": "Harvard University Test Manifest",
-  "sequences": [
-    {
-      "canvases": [
-        {
-          "@id": "https://iiif.lib.harvard.edu/manifests/ids:488815/canvas/canvas-488815.json",
-          "images": [{ "@type": "oa:Annotation" }]
-        }
-      ]
-    }
-  ]
-}
-
-jest.mock("../transcriptionUtils")
-
-describe("Non-Emily Dickinson manifest", () => {
-  beforeEach(() => {
-    jest.clearAllMocks()
-  })
-
-  it("should return empty transcriptions array", () => {
-    const state = {
-      manifests: {
-        "manifest-1": { json: harvardManifest }
-      },
-      windows: {
-        "window-1": {
-          manifestId: "manifest-1",
-          canvasId: "canvas-1"
-        }
-      }
-    }
-
-    getEdaTranscription.mockReturnValue([])
-
-    const transcriptions = getEdaTranscription(state, { windowId: "window-1" })
-    expect(transcriptions).toEqual([])
-  })
-
-  it("should not contain EDA metadata", () => {
-    const canvas = harvardManifest.sequences[0].canvases[0]
-    expect(canvas.annotations).toBeUndefined()
-  })
-
-  it("should handle transcription request for non-EDA manifests", () => {
-    const handleClickMock = jest.fn().mockReturnValue("panel-opened")
-
-    const props = {
-      transcriptions: [], // Empty for non-EDA manifests
-      handleClick: () => handleClickMock("edaTranscription")
-    }
-
-    const result = props.handleClick()
-    expect(handleClickMock).toHaveBeenCalledWith("edaTranscription")
-    expect(result).toBe("panel-opened")
-  })
-})