feat: add persistent Markdown notes

This commit is contained in:
2026-10-17 00:53:28 +02:00
parent 0f49209d95
commit e36a8bbc6b
13 changed files with 584 additions and 23 deletions
@@ -55,8 +55,6 @@ import Testing
let search = try #require(descendants(content).compactMap { $0 as? NSSearchField }.first)
search.stringValue = "ct"
launcher.controlTextDidChange(Notification(name: NSControl.textDidChangeNotification, object: search))
let table = try #require(descendants(content).compactMap { $0 as? NSTableView }.first)
#expect(table.numberOfRows == 1)
_ = launcher.control(search, textView: NSTextView(), doCommandBy: #selector(NSResponder.insertNewline(_:)))
#expect(search.accessibilityLabel() == "English text to translate into Japanese")
_ = launcher.control(search, textView: NSTextView(), doCommandBy: #selector(NSResponder.cancelOperation(_:)))
@@ -3,22 +3,27 @@ import ConjureKit
import Testing
@testable import Conjure
@Test(arguments: ["launcher", "launcher-actions", "emoji", "emoji-actions", "translate-input", "translate-output", "translate-key"])
@Test(arguments: ["launcher", "launcher-actions", "emoji", "emoji-actions", "translate-input", "translate-output", "translate-key", "notes-editor"])
@MainActor func escapeDismissesEntireLauncher(_ destination: String) throws {
_ = NSApplication.shared
let suite = "ConjureEscape.\(UUID().uuidString)"
let defaults = UserDefaults(suiteName: suite)!
defer { defaults.removePersistentDomain(forName: suite) }
let notesDirectory = FileManager.default.temporaryDirectory.appendingPathComponent(suite)
defer {
defaults.removePersistentDomain(forName: suite)
try? FileManager.default.removeItem(at: notesDirectory)
}
let launcher = LauncherWindowController(
history: LaunchHistory(defaults: defaults, now: { Date(timeIntervalSinceReferenceDate: 12_000) }),
defaults: defaults)
defaults: defaults, notesDirectory: notesDirectory)
let window = try #require(launcher.window)
defer { window.orderOut(nil) }
let content = try #require(window.contentView)
func descendants(_ view: NSView) -> [NSView] { [view] + view.subviews.flatMap(descendants) }
let search = try #require(descendants(content).compactMap { $0 as? NSSearchField }.first)
if !destination.hasPrefix("launcher") {
search.stringValue = destination.hasPrefix("emoji") ? "emoji" : "translate"
search.stringValue = destination.hasPrefix("emoji") ? "emoji"
: destination.hasPrefix("notes") ? "notes" : "translate"
launcher.controlTextDidChange(Notification(name: NSControl.textDidChangeNotification, object: search))
_ = launcher.control(search, textView: NSTextView(), doCommandBy: #selector(NSResponder.insertNewline(_:)))
}
@@ -48,6 +53,9 @@ import Testing
_ = provider.target?.perform(provider.action, with: provider)
let key = try #require(descendants(content).compactMap { $0 as? NSSecureTextField }.first)
window.makeFirstResponder(key)
} else if destination == "notes-editor" {
let editor = try #require(descendants(content).compactMap { $0 as? NotesTextView }.first)
window.makeFirstResponder(editor)
}
#expect(window.isVisible)
let escape = try #require(NSEvent.keyEvent(
@@ -0,0 +1,81 @@
import AppKit
import ConjureKit
import Testing
@testable import Conjure
@Test @MainActor
func notesSwitchWithoutLeakingEditsUndoOrAttachmentsAndRestoreSelection() throws {
_ = NSApplication.shared
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
let suite = "NotesEditing.\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
defer {
try? FileManager.default.removeItem(at: directory)
defaults.removePersistentDomain(forName: suite)
}
let controller = NotesController(defaults: defaults, directory: directory)
let window = NSWindow(contentRect: NSRect(x: 0, y: 0, width: 750, height: 390), styleMask: [.borderless], backing: .buffered, defer: false)
window.contentViewController = controller
defer { window.orderOut(nil) }
func descendants(_ view: NSView) -> [NSView] { [view] + view.subviews.flatMap(descendants) }
let views = descendants(controller.view)
let editor = try #require(views.compactMap { $0 as? NotesTextView }.first)
let picker = try #require(views.compactMap { $0 as? NSPopUpButton }.first)
let create = try #require(views.compactMap { $0 as? NSButton }.first { $0.title == "New Note" })
let firstID = try #require(picker.selectedItem?.representedObject as? UUID)
// Empty notes have duplicate titles; both must remain individually selectable.
create.performClick(nil)
#expect(picker.numberOfItems == 2)
let secondID = try #require(picker.selectedItem?.representedObject as? UUID)
#expect(secondID != firstID)
editor.insertText("# Second 🦊\n**bold** and `code`", replacementRange: editor.selectedRange())
#expect((editor.textStorage?.attribute(.font, at: 0, effectiveRange: nil) as? NSFont)?.pointSize == 17)
let codeRange = (editor.string as NSString).range(of: "`code`")
let codeFont = try #require(editor.textStorage?.attribute(.font, at: codeRange.location, effectiveRange: nil) as? NSFont)
#expect(codeFont.isFixedPitch)
let firstIndex = try #require(picker.itemArray.firstIndex { $0.representedObject as? UUID == firstID })
picker.selectItem(at: firstIndex)
_ = NSApp.sendAction(try #require(picker.action), to: picker.target, from: picker)
#expect(editor.string.isEmpty)
#expect(editor.undoManager?.canUndo != true)
editor.insertText("First note", replacementRange: editor.selectedRange())
let bitmap = try #require(NSBitmapImageRep(bitmapDataPlanes: nil, pixelsWide: 1, pixelsHigh: 1, bitsPerSample: 8, samplesPerPixel: 4, hasAlpha: true, isPlanar: false, colorSpaceName: .deviceRGB, bytesPerRow: 0, bitsPerPixel: 0))
bitmap.setColor(.red, atX: 0, y: 0)
let imageURL = directory.appendingPathComponent("image.png")
try #require(bitmap.representation(using: .png, properties: [:])).write(to: imageURL)
try editor.insertImage(at: imageURL)
#expect(controller.save())
let restored = try NotesStore(directory: directory)
let first = try #require(restored.notes.first { $0.id == firstID })
#expect(first.contents.string == "First note\u{fffc}")
#expect(first.contents.attribute(.attachment, at: 10, effectiveRange: nil) is NSTextAttachment)
#expect(restored.notes.first { $0.id == secondID }?.contents.string == "# Second 🦊\n**bold** and `code`")
let reopened = NotesController(defaults: defaults, directory: directory)
let reopenedViews = descendants(reopened.view)
let reopenedEditor = try #require(reopenedViews.compactMap { $0 as? NotesTextView }.first)
#expect(reopenedEditor.string == first.contents.string)
// Removing Markdown must also remove its previous visual style without changing the source.
reopenedEditor.insertText("Plain text", replacementRange: NSRange(location: 0, length: reopenedEditor.string.utf16.count))
#expect((reopenedEditor.textStorage?.attribute(.font, at: 0, effectiveRange: nil) as? NSFont)?.pointSize == 14)
#expect(reopenedEditor.string == "Plain text")
let backup = directory.appendingPathExtension("backup")
defer { try? FileManager.default.removeItem(at: backup) }
try FileManager.default.moveItem(at: directory, to: backup)
try Data("Blocked storage".utf8).write(to: directory)
reopenedEditor.insertText("Unsaved", replacementRange: NSRange(location: 0, length: reopenedEditor.string.utf16.count))
var closed = false
reopened.closed = { closed = true }
reopened.goBack()
#expect(!closed)
#expect(!reopened.save())
let reopenedPicker = try #require(reopenedViews.compactMap { $0 as? NSPopUpButton }.first)
reopenedPicker.selectItem(at: try #require(reopenedPicker.itemArray.firstIndex { $0.representedObject as? UUID == secondID }))
_ = NSApp.sendAction(try #require(reopenedPicker.action), to: reopenedPicker.target, from: reopenedPicker)
#expect(reopenedEditor.string == "Unsaved")
#expect(reopenedPicker.selectedItem?.representedObject as? UUID == firstID)
try FileManager.default.removeItem(at: directory)
try FileManager.default.moveItem(at: backup, to: directory)
#expect(reopened.save())
reopened.goBack()
#expect(closed)
}
+103
View File
@@ -0,0 +1,103 @@
import AppKit
import ConjureKit
import Testing
@Test @MainActor
func notesRoundTripIndependentMarkdownUnicodeAndImageContents() throws {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: directory) }
let store = try NotesStore(directory: directory)
let firstID = try store.create()
let secondID = try store.create()
#expect(store.notes.count == 2)
#expect(store.notes.allSatisfy { $0.title == "Untitled Note" })
let bitmap = try #require(NSBitmapImageRep(
bitmapDataPlanes: nil, pixelsWide: 1, pixelsHigh: 1,
bitsPerSample: 8, samplesPerPixel: 4, hasAlpha: true, isPlanar: false,
colorSpaceName: .deviceRGB, bytesPerRow: 0, bitsPerPixel: 0
))
bitmap.setColor(.red, atX: 0, y: 0)
let png = try #require(bitmap.representation(using: .png, properties: [:]))
let imageFile = FileWrapper(regularFileWithContents: png)
imageFile.preferredFilename = "pixel.png"
let attachment = NSTextAttachment(fileWrapper: imageFile)
let first = NSMutableAttributedString(string: "\n # 日本語 🦊 \n**bold** and `code`\n")
first.append(NSAttributedString(attachment: attachment))
let expectedFirstText = first.string
try store.update(id: firstID, contents: first)
first.mutableString.setString("Mutated caller buffer")
#expect(store.notes.first { $0.id == firstID }?.contents.string == expectedFirstText)
#expect(store.notes.first { $0.id == firstID }?.title == "# 日本語 🦊")
try store.update(id: secondID, contents: NSAttributedString(string: "Second note"))
try store.update(id: secondID, contents: NSAttributedString(string: "## Edited\n- café\n- Ελληνικά"))
#expect(store.notes.first { $0.id == firstID }?.contents.string == expectedFirstText)
let reloaded = try NotesStore(directory: directory)
#expect(Set(reloaded.notes.map(\.id)) == Set([firstID, secondID]))
let restoredFirst = try #require(reloaded.notes.first { $0.id == firstID })
#expect(restoredFirst.contents.string == expectedFirstText)
#expect(restoredFirst.title == "# 日本語 🦊")
let restoredAttachment = try #require(restoredFirst.contents.attribute(
.attachment, at: restoredFirst.contents.length - 1, effectiveRange: nil
) as? NSTextAttachment)
let restoredPNG = try #require(restoredAttachment.fileWrapper?.regularFileContents)
#expect(restoredPNG == png)
#expect(NSImage(data: restoredPNG) != nil)
#expect(reloaded.notes.first { $0.id == secondID }?.contents.string == "## Edited\n- café\n- Ελληνικά")
}
@Test @MainActor
func notesWriteFailuresPreserveSavedMemoryAndDiskContents() throws {
let root = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: root) }
let directory = root.appendingPathComponent("Notes")
let backup = root.appendingPathComponent("SavedNotes")
let store = try NotesStore(directory: directory)
let id = try store.create()
try store.update(id: id, contents: NSAttributedString(string: "Saved contents"))
// A regular file in place of the parent directory fails even when tests run as root.
try FileManager.default.moveItem(at: directory, to: backup)
try Data("not a directory".utf8).write(to: directory)
#expect(throws: (any Error).self) {
try store.update(id: id, contents: NSAttributedString(string: "Unsaved changes"))
}
#expect(throws: (any Error).self) { try store.create() }
#expect(store.notes.count == 1)
#expect(store.notes.first?.contents.string == "Saved contents")
#expect(store.notes.first?.title == "Saved contents")
try FileManager.default.removeItem(at: directory)
try FileManager.default.moveItem(at: backup, to: directory)
let reloaded = try NotesStore(directory: directory)
#expect(reloaded.notes.first?.id == id)
#expect(reloaded.notes.first?.contents.string == "Saved contents")
}
@Test @MainActor
func corruptPersistedNotesRaiseErrorsWithoutReplacement() throws {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: directory) }
let package = directory.appendingPathComponent(UUID().uuidString + ".rtfd")
try FileManager.default.createDirectory(at: package, withIntermediateDirectories: true)
let corruptRTF = package.appendingPathComponent("TXT.rtf")
let bytes = Data("This is not an RTF document".utf8)
try bytes.write(to: corruptRTF)
#expect(throws: (any Error).self) { try NotesStore(directory: directory) }
#expect(try Data(contentsOf: corruptRTF) == bytes)
}
@Test @MainActor
func noteTitlesUseFirstNonemptyLineAndCapAtSixtyCharacters() throws {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: directory) }
let store = try NotesStore(directory: directory)
let id = try store.create()
try store.update(id: id, contents: NSAttributedString(string: "\n \t\n " + String(repeating: "🦊", count: 70) + " \nIgnored"))
#expect(store.notes.first?.title == String(repeating: "🦊", count: 60))
try store.update(id: id, contents: NSAttributedString(string: " \t\n\n"))
#expect(store.notes.first?.title == "Untitled Note")
}
@@ -38,10 +38,14 @@ import Testing
_ = NSApplication.shared
let suite = "ConjurePresentation.\(UUID().uuidString)"
let defaults = UserDefaults(suiteName: suite)!
defer { defaults.removePersistentDomain(forName: suite) }
let notesDirectory = FileManager.default.temporaryDirectory.appendingPathComponent(suite)
defer {
defaults.removePersistentDomain(forName: suite)
try? FileManager.default.removeItem(at: notesDirectory)
}
let launcher = LauncherWindowController(
history: LaunchHistory(defaults: defaults, now: { Date(timeIntervalSinceReferenceDate: 12_000) }),
defaults: defaults)
defaults: defaults, notesDirectory: notesDirectory)
let window = try #require(launcher.window)
defer { window.orderOut(nil) }
let content = try #require(window.contentView)
@@ -60,6 +64,7 @@ import Testing
switch command {
case .emoji: $0 is NSCollectionView
case .translate: $0.accessibilityLabel() == "Japanese translation"
case .notes: $0.accessibilityLabel() == "Note editor"
}
}
})